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.
| status | Meaning |
|---|---|
1 | Pending. |
2 | In review, or being paid out. |
3 | Approved and paid out. |
4 | Rejected. |
5 | Paying out failed. Inkress fixes the cause and approves it again. |
Errors
401 | The key or token is missing, wrong or revoked, is for the other environment, or doesn't have the scope this endpoint needs. |