Payouts (OCT)
Send card payouts (Original Credit Transactions) to a beneficiary's card.
A payout, or Original Credit Transaction (OCT), pushes funds from your settlement account at a payout partner to a beneficiary's card. Typical uses: gambling winnings, marketplace seller settlements, gig-worker earnings, crypto off-ramps and insurance claims.
Unlike a refund, a payout does not need a prior payment on the platform. Unlike an AFT, the funds leave the merchant, not the customer.
How payouts work
A payout is created with POST /payment/transfer and goes through the same engine as a payment: an order with category: payout, a transaction of type credit, a payout contract, the call to the partner, and webhooks.
- Tokenize the card
Tokenize the beneficiary card once with Create a token. Reuse the token for every later payout to the same beneficiary.
- Create the transfer
Call Create a transfer with the token in
destination_account_token, the amount and the purpose. - Follow the result
Read
statusin the response, then follow the webhooks or call Retrieve a transfer.
Scope of this version
- Card payouts.
transfer_type: oct. - One payout per call. Each call creates one order.
- Contract chosen by you. Send the payout contract in
merchant_contract. - Partner-initiated returns. Reported as
credit_reversed.
- Bank and wallet transfers. Not available in this version.
- Batch payouts. Send one call per payout.
- Automatic routing.
merchant_contractis required. - Capture, refund or cancel. A successful credit is final.
Prerequisites
| Prerequisite | Details |
|---|---|
| Payout contract | Activated on your merchant account. See Managing contracts. |
| Private API key | Public and admin keys are rejected. See Get your API keys and Authentication. |
| Webhook | Subscribed to the payout statuses. See Processing a payout. |
In this section
| Page | What you find there | Link |
|---|---|---|
| Specification | How to choose transfer_purpose, the fields required by country, and referenced payouts. | Read |
| Processing a payout | The flow, statuses, return codes, retries, credit reversals, webhooks and sandbox testing. | Read |
| Create a transfer | API Reference: every request and response field. | Open |
| Retrieve a transfer | API Reference: read a payout and its credit transaction. | Open |
Related pages
Updated 5 days ago