GET
/
v1
/
payouts
List Payouts
curl --request GET \
  --url https://api.withflex.com/v1/payouts \
  --header 'Authorization: Bearer <token>'
{
  "payouts": [
    {
      "payout_id": "<string>",
      "status": "in_transit",
      "amount": 123,
      "arrival_date": "<string>",
      "created_at": "<string>",
      "source_type": "<string>",
      "test_mode": true
    }
  ]
}

Authorizations

Authorization
string
header
required

Use a Bearer token to access this API.

Query Parameters

payout_id
string | null
start_date
string

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

end_date
string

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

limit
integer | null
Required range: x >= 1

Response

200
application/json

The response is of type object.