Skip to main content
POST
Saves a bank account payout method for a user so offramp orders can settle to it.
Account numbers and IBANs are tokenized by the PCI-compliant vault, so create requests must be submitted through vault.crossmint.com.

Returns

Returns a PaymentMethod object.

Authorizations

X-API-KEY
string
header
required

Body

application/json

Create request for a bank account payout method. Provide the bankAccount sub-object with the fields required by the chosen type.

type
enum<string>
required

Payout method type. Determines the country-specific bankAccount fields that must be provided.

Available options:
bank-account-us,
bank-account-mx-clabe,
bank-account-co,
bank-account-sepa-iban
userLocator
string

Identifies the target user. Format: <type>:<value> (e.g., email:alice@example.com, userId:abc123). Required when authenticating with a server API key; ignored with JWT (the JWT subject is used instead).

bankAccount
object

Bank account details. Required when type is a bank type. The exact fields depend on the country-specific type. Account numbers and IBANs are tokenized by the vault.

Response

Payment method created successfully. Returns the full PaymentMethod object including the derived displayName and the bankAccount sub-object.

A saved bank account payout method. Sensitive fields (full account numbers and IBANs) are never included in responses.

paymentMethodId
string<uuid>
required

Unique identifier (UUID v4), assigned by the server on creation.

default
boolean
required

Whether this is the user's default payment method. Only one per user can be the default; setting a new default automatically unsets the previous one.

displayName
string
required

Human-readable label derived by the server (e.g., "Chime ••6259", "SEPA Account ••6789"). Not settable by the client.

type
enum<string>
required

Payout method type. Determines the country-specific bankAccount fields that are present.

Available options:
bank-account-us,
bank-account-mx-clabe,
bank-account-co,
bank-account-sepa-iban
bankAccount
object
required

Bank account details. Present when type is a bank type. Full account numbers and IBANs are never included.

lastPayoutAt
string<date-time>

Read-only. ISO 8601 timestamp of the most recent successful offramp payout funded by this bank account. Absent if none.