Balance and payouts

Your balance is money from settled charges, kept per currency. Payouts move it to your payout destination. Live mode only: test mode has no real money to pay out.

Where the money goes

You set the payout destination in the dashboard, under Payouts. It is either a US bank account (wire, in USD) or a USDC wallet on a supported network. Changing it needs you to enter your account password again, takes effect only after a waiting period, and is not possible with an API key. A new destination may also have to be verified by the payout provider before it can receive money.

Routes

GET /balance: one line per currency with available, pending, on_hold, in_transit and outstanding_debt, in the smallest currency unit.
GET /payouts: your payouts. See Pagination. Each row has id, amount, currency, status, destination_label (masked), created, and arrival_date.
GET /payouts/{id}: one payout, with items[] showing the charges inside it.
POST /payouts: ask for a payout of everything payable now (live mode, verified business). It answers 201 with the payouts it created, or 200 with "Nothing is payable right now."
GET /payout-destinations: the destinations, masked. Creating or cancelling one is for dashboard sign-ins only.

The balance lines

Name
available
Type
integer
Description
Payable now.
Name
pending
Type
integer
Description
Settled, but still inside the settlement delay (two days unless the platform was configured otherwise).
Name
on_hold
Type
integer
Description
Frozen by an open dispute.
Name
in_transit
Type
integer
Description
In a payout that has not been paid yet.
Name
outstanding_debt
Type
integer
Description
Refunds or lost disputes on money already paid out, taken from the next payout.

When a payout is paid

arrival_date is set when the payout is completed (Unix seconds). It is not a forecast of when money will arrive: while a payout is pending or in transit it is empty. The dashboard shows it as "Paid on".

Payouts are only available once your business verification is approved, and only while the platform has payouts switched on.