This API enables you process refund to a customer for a transaction.
This endpoint is protected with OAuth 2.0 Bearer token
Endpoint URL: {{base_url}}/api/v1/refunds?page=0&size=10
HTTP Method: GET
The {{base_url}} for test is https://sandbox.monnify.com but when you go live, it changes to the live url.
Supported Request Parameters
Request | ||
|---|---|---|
Field | Description | Compulsory |
page | An integer specifying page of transactions to be retrieved. Page number starts from 0. | No. Defaults to 0 |
size | An integer specifying size of transactions to be returned per page. | No. Defaults to 10 |
from | Timestamp to filter returned records. Refunds created on or after specified time will be retrieved. | No. Defaults to all records within the supplied page parameters. |
to | Timestamp to filter returned records. Refunds created on or before specified time will be retrieved. | No. Defaults to all records within the supplied page parameters. |
transactionReference | Transaction reference of the transaction for which the refund was processed. | No. Defaults to all records within the supplied page parameters |
refundStatus | The status of the refund. | No. Defaults to all records within the supplied page parameters |
Get All Refund Response
{
"requestSuccessful": true,
"responseMessage": "success",
"responseCode": "0",
"responseBody": {
"content": [
{
"refundReference": "ref001",
"transactionReference": "MNFY|20190816083102|000021",
"refundReason": "defective goods",
"customerNote": "refund-order001",
"refundAmount": 10.00,
"refundType": "PARTIAL_REFUND",
"refundStatus": "COMPLETED",
"comment": "Refund processed successfully.",
"completedOn": "17/03/2021 4:32:09 AM",
"createdOn": "17/03/2021 3:32:09 AM"
},
{
"refundReference": "ref002",
"transactionReference": "MNFY|20190816083102|000021",
"refundReason": "defective goods",
"customerNote": "refund-order002",
"refundAmount": 10.00,
"refundType": "PARTIAL_REFUND",
"refundStatus": "FAILED",
"comment": "Refund failed",
"completedOn": "17/03/2021 5:32:09 AM",
"createdOn": "17/03/2021 4:32:09 AM"
}
],
"last": true,
"totalElements": 2,
"totalPages": 1,
"size": 8,
"number": 0,
"numberOfElements": 2,
"first": true,
"empty": false
}
}