This API enables you to process a refund to a customer for a transaction.Endpoint
Info | ||
---|---|---|
| ||
GET: https://sandbox.monnify.com This endpoint is protected with OAuth 2.0 Bearer token. To find out more about authorization for Monnify endpoints, check Here |
Endpoint URL: {{base_url}}/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
HTTP Method: GET
Info |
---|
The {{base_url}} for test is |
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 |
Response
...
. 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
Code Block | ||
---|---|---|
| ||
{ "requestSuccessful": true, "responseMessage": "success", "responseCode": "0", "responseBody": { "content": [ { "transactionReferencerefundReference": "MNFY|0111231|123412342ref001", "paymentReferencetransactionReference":"J_12312_122 "MNFY|20190816083102|000021", "transactionAmountrefundReason":5000, "defective goods", "refundAmountcustomerNote":1200, "refund-order001", "refundStatusrefundAmount":"IN_PROGRESS", 10.00, "refundReasonrefundType":"Order was cancelled", "PARTIAL_REFUND", "customerNoterefundStatus": "COMPLETED"Refund, for order J1110", "refundTypecomment":"FULL_REFUND "Refund processed successfully.", "createdOncompletedOn": "1517/1203/20202021 094:3832:1309 AM", "completedOncreatedOn": "1517/1203/20202021 123:2032:2309 PMAM", "comment":"Refund processed successfully."}, }, { { "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": "1517/1203/20202021 125:2032:2309 PMAM", "commentcreatedOn": "Refund processed successfully."17/03/2021 4:32:09 AM" } ], "last":false true, "totalElements":258 2, "totalPages":129 1, "firstsize":true 8, "numberOfElementsnumber":2 0, "sizenumberOfElements": 2, "numberfirst":0 true, "empty": false } } |