Get Refunds

This API retrieves a list of refund transactions. It provides details about each refund, including its reference, amount, status, and other relevant metadata.

Response

Field Name	Type	Description
requestSuccessful	boolean	Indicates whether the request was processed successfully.
responseMessage	string	A message indicating the status of the request (e.g., "success").
responseCode	string	A code representing the outcome of the request.
responseBody	object	Contains details of the refund transactions and pagination data.
├── contents	array	A list of refund transactions.
│ ├── transactionReference	string	The reference ID of the original transaction.
│ ├── refundReference	string	The reference ID of the refund transaction.
│ ├── refundAmount	decimal	The amount that was refunded.
│ ├── refundReason	string	The reason provided for initiating the refund.
│ ├── customerNote	string	An optional note from the customer regarding the refund.
│ ├── refundType	string	Indicates whether the refund is partial or full (e.g., "PARTIAL_REFUND").
│ ├── refundStatus	string	The current status of the refund request (e.g., "COMPLETED").
│ ├── refundStrategy	string	The method used to process the refund (e.g., "MERCHANT_WALLET").
│ ├── comment	string	Additional comments about the refund status.
│ ├── completedOn	string	The timestamp when the refund was completed.
│ ├── createdOn	string	The timestamp when the refund request was created.
├── pageable	object	Contains pagination details for the response.
│ ├── sort	object	Contains sorting details.
│ │ ├── sorted	boolean	Indicates if the results are sorted.
│ │ ├── unsorted	boolean	Indicates if the results are not sorted.
│ │ ├── empty	boolean	Indicates if the sorting criteria are empty.
│ ├── pageSize	integer	The number of elements per page.
│ ├── pageNumber	integer	The current page number.
│ ├── offset	integer	The offset of the first element in the page.
│ ├── paged	boolean	Indicates whether pagination is enabled.
│ ├── unpaged	boolean	Indicates whether pagination is disabled.
├── sort	object	Contains sorting details at the top level.
│ ├── sorted	boolean	Indicates if the results are sorted.
│ ├── unsorted	boolean	Indicates if the results are not sorted.
│ ├── empty	boolean	Indicates if the sorting criteria are empty.
├── last	boolean	Indicates whether the current page is the last page.
├── first	boolean	Indicates whether the current page is the first page.
├── empty	boolean	Indicates whether the response contains no elements.
├── totalElements	integer	The total number of elements available.
├── totalPages	integer	The total number of pages available.
├── noOfElements	integer	The number of elements returned in the current response.
├── size	integer	The maximum number of elements per page.
├── number	integer	The current page index.

application/json

Body

Example

{
    "requestSuccessful": true,
    "responseMessage": "success",
    "responseCode": "0",
    "responseBody": {
        "contents": [
            {
                "transactionReference": "000012240124191535300537886000",
                "refundReference": "909090911",
                "refundAmount": 10,
                "refundReason": "Order cancelled!",
                "customerNote": "An optional note",
                "refundType": "PARTIAL_REFUND",
                "refundStatus": "COMPLETED",
                "refundStrategy": "MERCHANT_WALLET",
                "comment": "Transaction refund is in progress.",
                "completedOn": "25/01/2024 01:39:13 AM",
                "createdOn": "25/01/2024 01:35:27 AM"
            }
        ],
        "pageable": {
            "sort": {
                "sorted": false,
                "unsorted": false,
                "empty": false
            },
            "pageSize": 0,
            "pageNumber": 0,
            "offset": 0,
            "paged": false,
            "unpaged": false
        },
        "sort": {
            "sorted": false,
            "unsorted": false,
            "empty": false
        },
        "last": false,
        "first": false,
        "empty": false,
        "totalElements": 1,
        "totalPages": 0,
        "noOfElements": 100,
        "size": 1000,
        "number": 1
    }
}

Response

Request

Request samples

Responses

Get Refunds

Response#

Request

Request samples

Responses

Response