Sign in

v1

latestOpenAPI 3.0.02026-07-24103118224.7 KB
Accounts

Register a bank payout destination

Creates a bank account as a payout destination. Request body must be nested (bank, owner, address) — not flat. Use GET /api/account/bank-form for fields and includeExample=true for a sample body. Use X-On-Behalf-Of to target a sub-merchant.

post/api/account/bank

Request body

OR
OR

Response

Register a bank payout destination successful

idstring required

Unique identifier of the payout destination

object'bank-account' | 'wallet' required

Destination type

accountOwnerNamestring nullable required

Account owner name

bankInfostring nullable required

Masked IBAN or account number (last 4 digits only)

ibanstring nullable required

Full IBAN (bank destinations only)

accountNumberstring nullable required

Full account number (bank destinations only)

bicstring nullable required

Bank BIC / SWIFT code (bank destinations only)

routingNumberstring nullable required

Bank routing number (bank destinations only)

businessNamestring nullable required

Business name (business bank destinations only)

addressstring nullable required

Wallet address (wallet destinations only)

countrystring nullable required

ISO-3166 alpha-2 country code (bank destinations only)

networkstring nullable required

On-chain network (wallet destinations only)

labelstring nullable required

Custom label

isArchivedboolean required

Whether the destination has been archived

createdAtstring date-time required

Creation timestamp

updatedAtstring date-time required

Last update timestamp

isAvailableboolean nullable required

Whether this destination is available for the current currency filter

withdrawalsstring[] nullable required

List of withdrawal ids that used this destination

needsFileToWithdrawboolean required

True for bank accounts that require a file upload before withdrawal

payoutPausedboolean required

True when payouts to this bank account are temporarily paused

Example response

{
  "id": "acc_1234567890abcdef",
  "accountOwnerName": "John Doe",
  "bankInfo": "….4242",
  "iban": "FR7630006000011234567890189",
  "accountNumber": "1234567890",
  "bic": "BNPAFRPP",
  "routingNumber": "021000021",
  "businessName": "Acme Inc.",
  "address": "0xABC123…",
  "country": "FR",
  "network": "base",
  "label": "My USDC wallet",
  "isAvailable": true
}