Get Refund Details
Retrieve the current status of one manual card refund using its refund_reference.
See the Refund Overview for the funding and processing lifecycle.
Endpoint
GET https://backendapi.sayswitchgroup.com/api/v1/refund/status/{refund_reference}Request Examples
curl --request GET \
--url https://backendapi.sayswitchgroup.com/api/v1/refund/status/REFUND_REFERENCE \
--header "Authorization: Bearer YOUR_SECRET_KEY" \
--header "Accept: application/json"Keep your secret key and this request on your server.
Response
{
"success": true,
"message": "Refund retrieved.",
"data": {
"refund_reference": "REF_2026_001",
"transaction_reference": "USD_TXN_2026_001",
"amount": "100.00",
"fee": "1.00",
"total_reserved": "101.00",
"funding": {
"status": "awaiting_settlement",
"available_reserved": "40.00",
"pending_reserved": "61.00",
"pending_funded_amount": "0.00",
"pending_remaining": "61.00",
"funded_at": null
},
"currency": "USD",
"status": "awaiting_settlement",
"external_reference": null,
"requested_at": "2026-09-28T10:00:00+01:00",
"completed_at": null
}
}| Field | Description |
|---|---|
refund_reference | SaySwitch reference for this refund. |
transaction_reference | Reference of the original successful card transaction. |
amount | Amount returned to the customer. |
fee | Refund processing fee determined by the merchant’s agreement. |
total_reserved | Refund amount plus fee that was reserved. |
funding | Funding state and the available/pending balance reservation split. |
funding.status | awaiting_settlement, funded, or released. |
funding.available_reserved | Amount reserved immediately from available balance. |
funding.pending_reserved | Amount reserved from eligible pending balance. |
funding.pending_funded_amount | Pending reservation already funded through settlement. |
funding.pending_remaining | Pending reservation still awaiting settlement. |
funding.funded_at | Time the refund became fully funded, or null. |
currency | Refund currency. Currently USD. |
status | Current refund status: awaiting_settlement, pending, processing, success, failed, or rejected. |
external_reference | Processing reference when available. |
requested_at | ISO 8601 time when the request was accepted. |
completed_at | ISO 8601 completion time, or null before successful completion. |
Refund status describes the processing lifecycle, while funding.status describes whether its reserved money is ready. Only treat the refund as complete when data.status is success. An awaiting_settlement, pending, processing, or failed refund has not completed.
An awaiting_settlement refund moves to pending automatically after its pending reservation settles. Do not resubmit it and do not attempt to change its status manually.
Refund Not Found
HTTP 404:
{
"success": false,
"message": "Refund not found."
}If full S2S payload encryption is enabled, this GET request has no encrypted body, but the response is encrypted and must be decrypted using your existing response-decryption process.