Skip to content
Docs/
API reference
/
/
List all payouts

List all payouts

Request

Returns a list of your payouts, sorted by creation date with the most recent first. Filters combine with AND, so a status and a beneficiary_id together return only payouts matching both.

Payouts in draft are excluded unconditionally, whatever you filter on; GET /payouts/{id} returns them. Creating a payout through this API submits it in the same call, so a payout of your own should not be sitting in draft.

Only beneficiary payouts are returned. A settlement ID will not appear in this list — retrieve those from GET /settlements.

Security
JWT
Query
beneficiary_idstring

The unique identifier of the beneficiary

Example:beneficiary_id=bene_5JU9yv0lGSUP
request_idstring

Filter payouts by the client-provided request_id. Returns at most one result.

Example:request_id=your-internal-id
statusstring

Status of payout to filter

Enum:"pending_approval""queued""in_progress""success""failed""action_required""cancelled"
beforestring

Return only resources created at or before this time. Send an ISO 8601 timestamp with an offset, such as 2025-02-18T12:03:44Z or 2025-02-18T17:33:44+05:30. A timestamp without an offset is read as UTC. A bare date (YYYY-MM-DD) means the end of that day in UTC (23:59:59.999999Z). An invalid value returns 400 Bad Request. Use this to avoid page drift. See Pagination parameters for more details.

Example:before=2025-02-18T12:03:44Z
afterstring

Return only resources created at or after this time. Send an ISO 8601 timestamp with an offset, such as 2025-01-18T12:03:44Z or 2025-01-18T17:33:44+05:30. A timestamp without an offset is read as UTC. A bare date (YYYY-MM-DD) means the start of that day in UTC (00:00:00Z). An invalid value returns 400 Bad Request. Use this to avoid page drift. See Pagination parameters for more details.

Example:after=2025-01-18T12:03:44Z
per_pageinteger

Number of resources per page. Should be between 1 and 100.

Default:20
pageinteger

Page number for pagination. Starts from 1. Get the next page number from the next field in the response.

Default:1
curl -i -X GET \
  'https://api.glomopay.com/api/v1/payouts?beneficiary_id=bene_5JU9yv0lGSUP&request_id=your-internal-id&status=pending_approval&before=2025-02-18T12%3A03%3A44Z&after=2025-01-18T12%3A03%3A44Z&per_page=20&page=1' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

List of payouts matching the filters

Bodyapplication/json
dataArray of objects(Payout)
page_metaobject(PageMeta)
Response
{
  "data": [
    { … }
  ],
  "page_meta": {
    "current": 2,
    "previous": 1,
    "next": 3,
    "per_page": 20,
    "pages": 10,
    "count": 200
  }
}