Refund Bank Transfer
This guide explains how to initiate a refund for a payin bank transfer transaction.
Refund Transfer Request
- Path:
/api/v1/transfer-requests/refund - Method: POST
- Headers:
Accept: application/jsonContent-Type: application/jsonAuthorization: Bearer {merchant_api_bearer_token}
Request Body Table
| Field | Type | Required | Description |
|---|---|---|---|
| onusReference | string | Yes | The ONUS reference of the original transaction |
| businessId | string | Yes | Your business identifier |
Sample Request Body
Sample Response
{
"status": 200,
"message": "Success",
"data": {
"paymentStatus": "PENDING",
"currency": "NGN",
"amount": 15000,
"fee": 50,
"onusReference": "{onus_reference}",
"merchantReference": "{merchant_reference}"
}
}
Additional Information
- The
onusReferencemust correspond to a completed (successful) payin bank transfer transaction. - The refund is initiated asynchronously. The
paymentStatuswill bePENDINGinitially and will transition to a terminal state (SUCCESSFULorFAILED). - A webhook notification will be sent to you once the refund has been processed.
- The
feefield in the response reflects any applicable processing fee for the refund.