Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This API enables you process refund to a customer for a transaction.

...

Info
titleEndpoint
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.

Supported Request Parameters

Request

FieldDescriptionCompulsory

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
transactionReferenceUnique transaction reference generated by Monnify for each transactionNo
fromTimestamp to filter returned records. Refunds created on or after specified time will be retrieved.No
toTimestamp to filter returned records. Refunds created on or before specified time will be retrieved.No


Response

Code Block
languagejs
themeRDark
titleGet All Refund Response
{
   "requestSuccessful":true,
   "responseMessage":"success",
   "responseCode":"0",
   "responseBody":{
      "content":[
         {
            "transactionReference":"MNFY|0111231|123412342",
            "paymentReference":"J_12312_122",
            "transactionAmount":5000,
            "refundAmount":1200,
            "refundStatus":"IN_PROGRESS",
            "refundReason":"Order was cancelled",
            "customerNote":"Refund for order J1110",
            "refundType":"FULL_REFUND",
            "createdOn":"15/12/2020 09:38:13 AM",
            "completedOn":"15/12/2020 12:20:23 PM",
            "comment":"Refund processed successfully."
         },
         {
            "transactionReference":"MNFY|0111231|123412342",
            "paymentReference":"J_12312_122",
            "transactionAmount":5000,
            "refundAmount":1200,
            "refundStatus":"IN_PROGRESS",
            "refundReason":"Order was cancelled",
            "customerNote":"Refund for order J1110",
            "refundType":"FULL_REFUND",
            "createdOn":"15/12/2020 09:38:13 AM",
            "completedOn":"15/12/2020 12:20:23 PM",
            "comment":"Refund processed successfully."
         }
      ],
      "last":false,
      "totalElements":258,
      "totalPages":129,
      "first":true,
      "numberOfElements":2,
      "size":2,
      "number":0,
      "empty":false
   }
}

...