v1
latestOpenAPI 3.1.02026-07-26540161.7 KBGet Refund Status
This API lets you get the details of a refund using the unique reference
get/collections/refund/{reference}
Path parameters
referencestring required
The refund's unique identifier
Response
200
Example response
{
"success": true,
"message": "Refund fetched successfully",
"data": {
"id": 21,
"collectionReference": "96d1fc1c-2570-4a50-8eca-1277c4a90c0d",
"reference": "cba44033-bcaa-4df6-9e68-6b3cf7f251ca",
"currency": "NGN",
"amountRefunded": "5914.000000",
"refundType": "overpayment",
"payeeAccountNumber": "7821444125",
"collectionExpectedAmount": "850.000000",
"collectionAmountReceived": "6764.000000",
"collectionAmountSettled": "6662.201800",
"collectionVarianceType": "overpayment",
"collectionVirtualAccountId": "655ec84f1f3ce30f00efad7f",
"refundStatus": "processing",
"completedAt": "2023-12-07 17:39:00",
"initiatedAt": "2023-12-05 15:07:18",
"payee": {
"accountNumber": "7821444125",
"bankCode": "042",
"bankName": "gtb"
}
}
}