Skip to main content
GET
/
3p
/
api
/
v2
/
batch-payouts
/
processor
List Processor Batch Payouts ( STABLE )
curl --request GET \
  --url https://api.grailpay.com/3p/api/v2/batch-payouts/processor \
  --header 'Authorization: Bearer <token>'
{
  "status": true,
  "message": "",
  "data": {
    "batch_payouts": [
      {
        "uuid": "9bd53fe1-ac74-4e81-b6f2-be88b7c86a68",
        "amount": 4400,
        "trace_id": "ach_11kt6v9715jp67t",
        "payout_status": "PAYOUT_COMPLETE",
        "ach_return_code": null,
        "failure_reason": null,
        "modality": {
          "payment_rail": "fednow",
          "speed": "instant"
        },
        "created_at": "2025-02-17 11:15:15",
        "updated_at": "2025-02-18 17:15:15"
      }
    ],
    "pagination": {
      "current_page": 1,
      "total_pages": 2,
      "total_items": 12,
      "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>

Filter by start date (YYYY-MM-DD)

​
end_date
string<date>

Filter by end date (YYYY-MM-DD)

​
sort_order
enum<string>

Sort order ('oldest' or 'newest')

Available options:
oldest,
newest
​
page
integer

Page number for pagination

Example:

1

​
per_page
integer

Number of records per page

Example:

10

Response

Processor batch payouts retrieved successfully

​
status
boolean
Example:

true

​
message
string
Example:

""

​
data
object
​
errors
string | null
Example:

null

​
error_code
string | null
Example:

null