Skip to main content
GET
/
3p
/
api
/
v2
/
batch-refunds
Get All Batch Refunds ( STABLE )
curl --request GET \
  --url https://api.grailpay.com/3p/api/v2/batch-refunds \
  --header 'Authorization: Bearer <token>'
{
  "status": true,
  "message": "",
  "data": {
    "batch_refunds": [
      {
        "batch_refund_uuid": "9bd53fe1-ac74-4e81-b6f2-be88b7c86a68",
        "amount": 10000,
        "date": "2024-04-18 01:00:20"
      }
    ],
    "pagination": {
      "current_page": 1,
      "total_pages": 3,
      "total_items": 30,
      "per_page": 10
    }
  },
  "errors": null,
  "error_code": null
}

Authorizations

​
Authorization
string
header
required

Token-based authentication using Authorization: Bearer <YOUR_API_KEY> provided by the GrailPay Support Team.

Query Parameters

​
start_date
string<date>

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

Example:

"2024-03-01"

​
end_date
string<date>

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

Example:

"2024-03-10"

​
sort_order
enum<string>

Sorting order: 'oldest' for ascending, 'newest' for descending.

Available options:
oldest,
newest
Example:

"newest"

​
page
integer

Page number for pagination.

Example:

1

​
per_page
integer

Number of items per page.

Example:

10

Response

Batch refunds retrieved successfully

​
status
boolean
Example:

true

​
message
string
Example:

""

​
data
object
​
errors
string | null
Example:

null

​
error_code
string | null
Example:

null