Inkress DevelopersPayouts · Request a payout
API reference / Payouts
Request a payout
POST/api/v1/financial_requestspayouts:create
Asks Inkress to pay part of the merchant's balance to their bank. It starts pending; Inkress approves or rejects it. Apps can't approve their own requests.
Body
totalnumberrequired
Amount in the major unit, up to the available balance.
typeintegerrequired
1 for a payout.
kindstring
standard or early.
source_idinteger
The wallet it comes from. Its currency is used when you leave out currency_code.
currency_codestring
JMD or USD.
destination_idinteger
The bank account, if the merchant has more than one.
reference_idstring
Your own ID.
Headers
Authorizationheaderrequired
Bearer with your secret key, or the merchant's OAuth token.
Returns
The payout request, status 1.
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. |
422 | The amount is over the balance, or the business hasn't finished identity checks. |