Skip to main content

Reversal Requests

POST /reversal-requests​

Parameters​

  • tenantId (string, header, required): The ID of the tenant.

Request Body​

Example Value​

{
  "merchantId": "string",
  "businessId": "string",
  "saleId": "string",
  "returnedProductDetails": [
    {
      "productId": "string",
      "quantity": 0
    }
  ],
  "comment": "string",
  "paymentMethod": "string",
  "creditType": "string",
  "accountDetails": {
    "accountNumber": "string",
    "bankCode": "string"
  }
}

Responses​

200 OK

Media Type: application/json

{
  "message": "string",
  "data": {
    "id": "string",
    "tenantId": "string",
    "merchantId": "string",
    "businessId": "string",
    "countryCode": "string",
    "type": "REVERSAL",
    "paymentMethod": "QR",
    "status": "PENDING",
    "reference": "string",
    "amount": 0,
    "statusMessage": "string",
    "attempts": 0,
    "nextRetry": "2024-07-18T17:13:50.654Z",
    "extra": {
      "comment": "string",
      "accountDetails": {
        "accountNumber": "string",
        "bankCode": "string"
      },
      "returnedProductDetails": [
        {
          "productId": "string",
          "quantity": 0
        }
      ]
    },
    "createdAt": "2024-07-18T17:13:50.654Z",
    "updatedAt": "2024-07-18T17:13:50.654Z"
  },
  "meta": {
    "currentPage": 0,
    "from": 0,
    "to": 0,
    "perPage": 0,
    "total": 0,
    "lastPage": 0
  }
}

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST

curl --request POST \ 
 --url  /reversal-requests \ 
 --header 'accept: application/json' \ 
 --header 'content-type: application/json'

RESPONSE

Click Try It! to start a request and see the response here!