Skip to main content
GET
/
v1
/
payouts
List Payouts
curl --request GET \
  --url https://api.withflex.com/v1/payouts \
  --header 'Authorization: Bearer <token>'
{
  "payouts": [
    {
      "payout_id": "obj_01EXAMPLE00000000000000000",
      "status": "in_transit",
      "amount": 0,
      "arrival_date": "string",
      "created_at": "2024-01-01T00:00:00Z",
      "source_type": "string",
      "test_mode": false
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Use a Bearer token to access this API.

Query Parameters

​
payout_id
string | null

Filter by a specific payout ID.

Example:

"obj_01EXAMPLE00000000000000000"

​
start_date
string | null

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

Example:

"2024-01-01T00:00:00Z"

​
end_date
string | null

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

Example:

"2024-01-01T00:00:00Z"

​
limit
integer<int32> | null

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

Required range: x >= 1
Example:

10

Response

Success

​
payouts
object[]
required