Documentation

Get all batch refunds

This API retrieves a list of all batch refunds. The response provides details for each batch refund, including the total amount and relevant timestamps. Pagination options are available to efficiently manage large datasets.


📘

Authentication Route

This route is secured with processor token authentication.


Endpoint

   /3p/api/v2/batch-refunds

 


Query Parameter

FieldsTypeIs RequiredDescription
per_pageintegerNoBy default: 10

Min: 1
Max: 100
start_datestringNoThis parameter will filter the user's records based on the creation date of the batch refund.

Date format: Y-m-d
end_datestringNoThis parameter will filter the user's records based on the creation date of the batch refund.

Date format: Y-m-d
sort_orderstringNoBy default: newest

Possible Value:
newest
oldest
pageintegerNoBy default: 1

Min: 1

Response

{
    "status": true,
    "message": "",
    "data": {
        "batch_refunds": [
            {
                "batch_refund_uuid": "9bd53fe1-ac74-4e81-b6f2-be88b7c86a68",
                "amount": 10000,
          	    "date": "2024-04-18 01:00:20"
            },
            {
                "batch_refund_uuid": "9bd945fb-c942-402b-8420-bbcf5094fd9b",
                "amount": 12000,
          	    "date": "2024-04-19 01:00:20"
            }
        ],
        "pagination": {
            "current_page": 1,
            "total_pages": 3,
            "total_items": 30,
            "per_page": 10
        }
    },
    "errors": null,
    "error_code": null
}