Sign in

v1

latestOpenAPI 3.0.32026-07-23215362.6 KB
Payouts

Payouts

Retrieve a list of Payouts with optional filtering and pagination.

get/v1/payouts

Query parameters

afterstring

When provided, specifies the last item returned in previous page, used to fetch the next page. Fetches the first page when omitted.

limitstring integer

When provided, specifies the number of items to return in the page. Uses default page size of 10 when omitted.

payoutIdstring uuid

Filter by transfer ID

beneficiaryIdstring uuid

Filter by destination customer ID

beneficiaryCurrencystring

Filter by beneficiary currency

sourceCurrencystring

Filter by source currency

status'PENDING_AUTHORIZATION' | 'PROCESSING' | 'COMPLETED' | 'FAILED'

Filter by status

requestedAtstring date-time

Filter by request date lower bound, exclusive

Response

Successful response

afterstring nullable

The token of the last item in the response

totalCountstring integer

The total number of items in the entire filtered data set