Refund checkout transaction

You can use this endpoint to refund a checkout transaction.

POST /v1/checkout/refund

Refund checkout transaction

cURL

curl --request POST \
  --url https://api.nomba.com/v1/checkout/refund \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'accountId: <accountid>' \
  --data '
{
  "transactionId": "TXN-123456789",
  "amount": 5000,
  "accountNumber": "0123456789",
  "bankCode": "058"
}
'

200

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

Authorizations

Authorization · string · header · required

Nomba authenticates API calls with OAuth2 HTTP bearer tokens. There are two methods of authentication; Client-Credentials method and PKCE (Proof Key for Code Exchange) method. In each of the methods, You will get an ACCESS_TOKEN. You need to use an "Authorization" HTTP header to provide your ACCESS_TOKEN. For example: Authorization: {ACCESS_TOKEN}.

Headers

accountId · string<uuid> · required

The parent accountId of the business.

Example:

"890022ce-bae0-45c1-9b9d-ee7872e6ca27"

Body

application/json

The request payload required to refund a checkout transaction.

The request object for refunding a checkout transaction

transactionId · string · required

The ID of the transaction to be refunded

Example:

"TXN-123456789"

amount · number<double>

The amount to be refunded

Example:

5000

accountNumber · string

The account number for the refund

Required string length: 10

Example:

"0123456789"

bankCode · string

The bank code for the refund

Example:

"058"

Response

200

application/json

OK - your request was successful.

code · string · required

Response Code

Example:

"00"

description · string · required

Refund successful

Example:

"Success"

data · object · required

The response object for checkout operations

Show child attributes