Skip to content
API Reference
/
/
List all payouts

List all payouts

Request

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""in_progress""success""failed""action_required""cancelled"
beforestring, (timestamp)

ISO-8601 timestamp in UTC to filter resources created before this time. Use this to avoid Page drift issue. See Pagination parameters for more details.

Example:before=2025-02-18T12:03:44Z
afterstring, (timestamp)

ISO-8601 timestamp in UTC to filter resources created after this time. Use this to avoid Page drift issue. 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
GET
/payouts
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
  }
}