Sign in

v1

latestOpenAPI 3.0.12026-07-2679100267.2 KB
Online Checkout

Refund checkout transaction

You can use this endpoint to refund a checkout transaction.

post/v1/checkout/refund

Headers

accountIdstring uuid required
Example:890022ce-bae0-45c1-9b9d-ee7872e6ca27

The parent accountId of the business.

Request body

transactionIdstring required

The ID of the transaction to be refunded

amountnumber double

The amount to be refunded

accountNumberstring

The account number for the refund

bankCodestring

The bank code for the refund

Example request

{
  "transactionId": "TXN-123456789",
  "amount": 5000,
  "accountNumber": "0123456789",
  "bankCode": "058"
}

Response

OK - your request was successful.

codestring required

Response Code

descriptionstring required

Refund successful

Example response

{
  "code": "00",
  "description": "Success",
  "data": {
    "success": true,
    "message": "Refund processed successfully"
  }
}