Refunds

Void or refund transactions

You may want to refund or void a transaction for a myriad of reasons.
To get started, send the following request:

1
2
3
4
curl --request POST
--url {{base_url}}/refund/
--header 'content-type: application/json'
--data '{"reference":"XXXXX","secret":"XXXXX", "amount": "XXXX"}'
1
2
3
4
5
{
"secret": "sk_live_xxx", // Secret key
"reference": "BP_LIVE_XXX", // Payment Reference
"amount": "1.00" // Optional
}

The amount parameter is optional.
Sending the request without the amount parameter will refund the total transaction amount.
Sending the request with the amount parameter with a value less than the transaction amount will perform a partial refund.

Sample Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
"status": "success",
"message": "Gateway Response",
"data": {
"payment_reference": "BP_LIVE_XXX",
"refund_reference": "BP_LIVE_REFUND_XXX",
"responsecode": "00",
"responsemessage": "Approved",
"refund": {
"amount": 10.00,
"currency": "USD"
}
}
}

Content

  • Refunds
  • Sample Response
  • Still questions?