Create Payment Method
Save a bank account payout method so offramp orders can settle fiat to it.
vault.crossmint.com.Returns
Returns a PaymentMethod object.Authorizations
Body
Create request for a bank account payout method. Provide the bankAccount sub-object with the fields required by the chosen type.
Payout method type. Determines the country-specific bankAccount fields that must be provided.
bank-account-us, bank-account-mx-clabe, bank-account-co, bank-account-sepa-iban 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).
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.
Unique identifier (UUID v4), assigned by the server on creation.
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.
Human-readable label derived by the server (e.g., "Chime ••6259", "SEPA Account ••6789"). Not settable by the client.
Payout method type. Determines the country-specific bankAccount fields that are present.
bank-account-us, bank-account-mx-clabe, bank-account-co, bank-account-sepa-iban Bank account details. Present when type is a bank type. Full account numbers and IBANs are never included.
Read-only. ISO 8601 timestamp of the most recent successful offramp payout funded by this bank account. Absent if none.

