Skip to main content
POST
Add a payout bank account
This reference describes API version 2026-07-31. Send Commet-Version: 2026-07-31 with your request.

Authorizations

x-api-key
string
header
required

Headers

Idempotency-Key
string

Unique key used to safely retry this write for 24 hours without applying it twice.

Required string length: 1 - 200
Commet-Version
string
default:2026-07-31

API version used by this reference. Send this header to select this contract explicitly.

Body

application/json
accountNumber
string
required
Minimum string length: 1
accountHolderName
string
required
Minimum string length: 1
routingNumber
string
accountType
enum<string>
Available options:
checking,
savings
setDefault
boolean
default:false

Response

Success

id
string
required
providerExternalAccountId
string | null
required
holderName
string
required
last4
string
required
bankName
string | null
required
country
string
required
currency
string
required
accountType
enum<string> | null
required
Available options:
checking,
savings
isDefault
boolean
required
status
enum<string>
required
Available options:
active,
errored
createdAt
string<date-time>
required
object
string
required
Allowed value: "payout_bank_account"
livemode
boolean
required