PaymentMethod objects represent your user’s payment instruments. You can use them with any of the Crossmint products like Checkout, Onramp, and Offramp.
Type Values Value Description cardCredit or debit card. bank-account-usUS bank account. Used to receive and send USD payments. bank-account-mxSPEI for Mexican bank accounts (18-digit CLABE). bank-account-coPSE for Colombian bank accounts. sepaSEPA transfers for SEPA-area bank accounts.
Attributes Unique identifier for the payment method.
Whether this is the user’s default payment method.
Human-readable label for the payment method (e.g. "Visa ••1111", "Chime ••6259").
Payment method type. One of card, bank-account-us, bank-account-mx, bank-account-co, or sepa.
Card details. Present when type is card. Card brand. Can be visa, mastercard, amex, discover, jcb, unionpay, or diners-club.
Last four digits of the card number.
Two-digit expiration month.
Four-digit expiration year.
Billing details for the cardholder. Phone number (E.164 format).
Card funding type. Can be credit, debit, prepaid, or unknown.
Bank Identification Number (first 6-8 digits of the card number).
Two-letter country code of the card issuer.
Bank account details. Present when type is bank-account-us, bank-account-mx, bank-account-co, or sepa. Billing details for the account holder. Phone number (E.164 format).
ISO 3166-1 alpha-2 country code.
Name of the bank. null if not resolvable.
Last four digits of the account number, CLABE, or IBAN.
ISO 4217 currency code (e.g. usd, mxn, eur, cop).
ISO 3166-1 alpha-2 country code.
Account holder type. Can be individual or business.
Show US-specific properties (bank-account-us)
Nine-digit ABA routing number.
Show MX-specific properties (bank-account-mx)
Three-digit bank code derived from the CLABE.
Show CO-specific properties (bank-account-co)
Bank code assigned by Banco de la República.
Show SEPA-specific properties (sepa)
BIC/SWIFT code (8 or 11 characters).
Card
SEPA
US Bank Account
MX Bank Account
CO Bank Account
{ "paymentMethodId" : "d4e5f6a7-b8c9-0123-def4-567890abcdef" , "default" : true , "displayName" : "Visa ••1111" , "type" : "card" , "card" : { "brand" : "visa" , "last4" : "1111" , "expiration" : { "month" : "12" , "year" : "2028" }, "billing" : { "name" : "Alice Smith" , "phone" : "+12125551234" , "address" : { "line1" : "123 Main St" , "city" : "Springfield" , "stateOrRegion" : "IL" , "postalCode" : "62701" , "country" : "US" } }, "fundingType" : "debit" , "bin" : "411111" , "country" : "US" } }
