Skip to main content
POST
Create a payout route
Requires scope: manage:pay-outs — see Required scopes. Creates an account-scoped route connecting an allow-listed payout bank account to a crypto deposit asset. The route fixes the beneficiary, lane, asset and fiat currency for every pay-out made over it. The provider is resolved internally from your tenant’s enablement — the request never names one, and provider identity is never exposed.
The recipient gate must pass. The bank account’s party needs an ACTIVE PAYOUT_RECIPIENT role on this account with cleared KYC/KYB. Add it via Add a party to an account. A party may hold PAYOUT_RECIPIENT alongside ACCOUNT_HOLDER on the same account — that is the self-payout case.
Routes are created PENDING and progress REGISTERING → ACTIVE as provider registration completes, or REJECTED on terminal failure. Only ACTIVE routes are usable, so poll List payout routes before requesting a pay-out. See Pay-outs for the full flow.

Errors

The codes this endpoint can return, in addition to the standard errors. Branch on code, never the message.

Authorizations

Path Parameters

accountId
string<uuid>
required

Unique account identifier

Body

application/json

Creates a pay-out route. The owning account comes from the path, and the provider is resolved internally — the request never names one.

payoutBankAccountId
string<uuid>
required

An allow-listed payout bank account belonging to your company

depositAsset
object
required

The crypto asset a customer sends to fund a route — a (chain, name) pair.

Response

Route created (PENDING)

success
boolean

Indicates whether the request was successful

result
object

Customer-facing route view. Provider identity is never exposed.