Skip to main content

What to send

You also send an Idempotency-Key header: a unique value, like a UUID, for each payout. If you send the same request again with the same key, for example after a timeout, we return the first payout instead of paying twice.
Not sure what it will cost? Check the fee first. The fee is taken from your balance on top of the amount.

Picking a bank

network is the code of a payout channel. The list of channels changes over time, so load it from the API and let your users pick from it. Don’t hard-code channel codes in your app.
cURL
Here is a recent snapshot of the bank channels. This is a sample only, always use the codes the API returns. Codes never change, so it’s safe to store one after a user picks it. If a channel is later switched off, sending a payout to its code returns a 400 saying the channel is currently unavailable, and no money moves.
Bank channels may appear in the payout channels list before bank payouts are fully open. Check that the channel’s code is in the list before letting users send to it.
Before you send a bank payout, confirm the account number belongs to the name you have. This catches typos and mismatches before money moves. GET /v1/transfers/account-lookup/:network/:account_number
cURL
json
Show account_name to the user so they can confirm it matches who they meant to pay, then send the payout.

Send a payout

What you get back

json

Look up a payout

Fraud checks

Every payout goes through automatic fraud checks. If one looks unusual:
  • its status becomes pending_review;
  • you get an email and a transfer.flagged webhook;
  • no more payouts can go to that account until you review it in the dashboard.
Review flagged payouts quickly so your normal payouts aren’t held up.

Common errors