Refunds
Introduction
This endpoint allows you to create a refund transaction request from details of a successful transaction.
Process Flow
Step 1: Make a call to Create Refund Transaction while supplying the details of a successful transaction to be reversed.
Step 2: View Response.
NOTE:
To get a list of refund requests, make a call to get refund by merchant code and date or get refund by refund reference.
Sample Request
curl https://sandbox.interswitchng.com/paymentgateway/api/v1/refunds \
-H "Authorization: <token>" \
-H "Content-Type: application/json" \
-D '{
"id": 10174,
"refundReference": "REFUND-1543818751-JB-MX187",
"parentTransactionReference": "HelloStores0001",
"merchantCode": "MX187",
"parentPaymentId": 269089,
"refundType": "PARTIAL",
"refundAmount": 22200,
"createdDate": 1543818875243,
"refundStatus": "PENDING",
"createdBy": "[email protected]",
"reasonForRefund": "Reason for Refund!"
}'
-X POST
Sample Response
{
"id": 10174,
"refundReference": "REFUND-1543818751-JB-MX187",
"merchantCode": "MX187",
"parentPaymentId": 269089,
"refundType": "PARTIAL",
"refundAmount": 22200,
"createdDate": 1543818875243,
"refundStatus": "PENDING",
"createdBy": "[email protected]",
"reasonForRefund": "Reason for REfund!"
}
Refund Statuses
Refund Status | Comment |
|---|---|
SUCCESS | This is the first state of a refund after the refund has been created via API. This means the refund is going to be processed the next business day automatically. |
PENDING | Refund has been successfully created and is now pending fulfilment. No debit has impacted your position |
PROCESSING | Automated refund process is in progress (T+1) |
FAILED | Automated refund failed. A manual process has been triggered to credit the customer via bank position. |
COMPLETE | Automated refund was successfully processed. Customer received instant credit refund |
Updated 3 months ago