This API enables you process refund to a customer for a transaction.
...
| Info | ||
|---|---|---|
| ||
GET: https://sandbox.monnify.com/api/v1/refunds?page=0&size=10 |
Please note that this endpoint is protected using OAuth2 Token. Visit Authentication section of this document for details on OAuth2 Token.
...
| 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 |
Response
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"requestSuccessful": true,
"responseMessage": "success",
"responseCode": "0",
"responseBody": {
"content": [
{
"transactionReferencerefundReference": "MNFY|0111231|123412342ref001",
"paymentReferencetransactionReference":"J_12312_122 "MNFY|20190816083102|000021",
"transactionAmount":5000, "refundReason": "defective goods",
"refundAmount":1200,
"refundStatuscustomerNote":"IN_PROGRESS "refund-order001",
"refundReasonrefundAmount":"Order was cancelled", 10.00,
"customerNoterefundType":"Refund for order J1110", "PARTIAL_REFUND",
"refundTyperefundStatus": "FULL_REFUNDCOMPLETED",
"createdOncomment": "15/12/2020 09:38:13 AMRefund processed successfully.",
"completedOn":"15/12/2020 12:20:23 PM", "2021-04-14 16:30:01.0",
"commentcreatedOn": "Refund processed successfully."2021-04-14 16:29:23.0"
},
{
"transactionReferencerefundReference": "MNFY|0111231|123412342ref002",
"paymentReferencetransactionReference":"J_12312_122 "MNFY|20190816083102|000021",
"transactionAmount":5000, "refundReason": "defective goods",
"refundAmount":1200, "refundStatuscustomerNote":"IN_PROGRESS "refund-order002",
"refundReasonrefundAmount":"Order was cancelled", 10.00,
"customerNoterefundType":"Refund for order J1110", "PARTIAL_REFUND",
"refundTyperefundStatus": "FULL_REFUNDFAILED",
"createdOncomment": "15/12/2020 09:38:13 AM",Refund failed",
"completedOn":"15/12/2020 12:20:23 PM", "2021-04-14 16:24:05.0",
"commentcreatedOn": "Refund processed successfully.2021-04-14 16:23:37.0"
}
],
"last":false true,
"totalElements":258 2,
"totalPages":129 1,
"firstsize":true 8,
"numberOfElementsnumber":2 0,
"sizenumberOfElements": 2,
"numberfirst":0 true,
"empty": false
}
} |