Skip to content
API referenceAPI v1admin-sdk 1.1.52Search docs⌘K
Payouts · List payouts
API reference / Payouts

List payouts

GET/api/v1/financial_requestspayouts:read

The merchant's payout requests.

Query parameters

pageinteger

Page number, from 1.

page_sizeinteger

Items per page.

orderstring

Sort, e.g. id desc for newest first.

statusinteger

Only this status.

typeinteger

1 payouts.

Headers

Authorizationheaderrequired

Bearer with your secret key, or the merchant's OAuth token.

Returns

entries and pagination.

statusMeaning
1Pending.
2In review, or being paid out.
3Approved and paid out.
4Rejected.
5Paying out failed. Inkress fixes the cause and approves it again.

Errors

401The key or token is missing, wrong or revoked, is for the other environment, or doesn't have the scope this endpoint needs.