Refund Transaction Status (TSQ)
Using a single API, you can request/call for the transaction status of an initiated Refund.
Authorization
Set value to `Bearer SECRET_KEY
Content-type
Set value to application/json
GET:
{{baseurl}}/transaction/refunds/:query/status
Query key
Required?
Description
transactionReference
Yes
This can be either:
1. the refund transaction
reference. This reference provides the details and status of the refund processed.
2. the original transaction
reference. This reference provides a list of all refunds associated with the transaction (in cases of multiple partial refunds).
Sample response:
{
"success": true,
"message": "Refund Transaction fetched successfully",
"data": {
"refund": {
"type": "full",
"_id": "65d7356de4e2a1cxxxxxxx",
"merchant": "65d5e4f44ef2d99xxxxxxxx",
"transactionReference": "dfa61b8b95a9",
"amount": 1000,
"reference": "Rdfa61b8b95a9-c4cmjvfndg-1",
"currency": "NGN",
"channel": "dashboard",
"party": "xxxxx",
"reason": "customer disputes",
"status": "successful",
"createdAt": "2024-02-22T11:52:13.371Z",
"updatedAt": "2024-02-22T12:19:05.507Z",
"__v": 0,
"meta": {}
},
"transaction": {
"_id": "65d6467306037xxxxxxx",
"transType": "collection",
"status": "reversed",
"toAmount": 100000,
"toCurrency": "NGN",
"merchantId": "65d5e4f44ef2dxxxxxxxxx",
"transactionReference": "dfa61b8xxxx",
"customerEmail": "test+customer101@startbutton.africa",
"paymentPartnerId": "644a475218872xxxxxxxxxxx",
"paymentCode": "9085ccxxxxxx",
"isRecurrent": false,
"postProcess": null,
"settleCurrency": "NGN",
"paymentRateComboId": "65d618930603xxxxxxx",
"customEmails": [],
"createdAt": "2024-02-21T18:52:35.445Z",
"updatedAt": "2024-02-22T12:38:07.579Z",
"exchangeRate": 1,
"usdBuyRate": 1,
"usdSellRate": 1,
"feeAmount": 2600,
"paidAt": "2024-02-21T18:59:50.266Z",
"toWallet": "65d643a115f808f07c5e3e80",
"meta": {
"refunds": {
"amount": 100000,
"transactions": 1
}
},
"fromBalanceAfterLedger": 0,
"fromBalanceAfterAvailable": 0
}
}
}
Last updated