v1

latestOpenAPI 3.1.02026-07-2684271522.2 KB

Payouts

List Payouts

Returns a list of payouts.

get/v1/payouts

Query parameters

payout_idstring nullable

Filter by a specific payout ID.

Example:fpo_01J9XR8M3K7VZ8N2YB4WJ6T0RA

Filter by a specific payout ID.

start_datestring

A timestamp encoded as an RFC 3339 / ISO 8601 string (e.g. 2026-06-15T14:30:00Z).

Example:string

Filter payouts created after this date (ISO 8601 format: 2023-10-01T00:00:00Z).

end_datestring

A timestamp encoded as an RFC 3339 / ISO 8601 string (e.g. 2026-06-15T14:30:00Z).

Example:string

Filter payouts created before this date (ISO 8601 format: 2023-10-01T00:00:00Z).

limitinteger nullable

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

Example:10

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

Response

An envelope wrapping a list of payout objects.

Example response

{
  "payouts": [
    {
      "payout_id": "fpo_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
      "status": "in_transit",
      "amount": 2500,
      "arrival_date": "string",
      "created_at": "2026-06-15T14:30:00Z",
      "test_mode": false
    }
  ]
}