Inkress DevelopersPayouts · Get a payout
API reference / Payouts
Get a payout
GET/api/v1/financial_requests/:idpayouts:read
One payout request.
Path parameters
idintegerrequired
The payout's ID.
Headers
Authorizationheaderrequired
Bearer with your secret key, or the merchant's OAuth token.
Returns
The payout.
| 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. |
200 | result: false: there's no such object, or it isn't yours. |