The Payment Method Object

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

type names the account identifier (the capture schema Crossmint collects and validates) — never the payment rail, scheme, or clearing house. The same saved account can be paid over multiple rails; rail selection happens at payment execution time.

Value	Description
`card`	Credit or debit card.
`bank-account-us`	US bank account (routing number + account number).
`bank-account-mx-clabe`	Mexican bank account, identified by an 18-digit CLABE.
`bank-account-co`	Colombian bank account (bank code + account number + national document).
`bank-account-sepa-iban`	Bank account identified by an IBAN within the supported SEPA scope.

bank-account-sepa-iban is the payment-method type; sepa and sepa-instant are rail values within it. A SEPA IBAN account can support both rails.

Attributes

string

required

Unique identifier for the payment method.

boolean

required

Whether this is the user’s default payment method.

string

required

Human-readable label for the payment method (e.g. "Visa ••1111", "Chime ••6259").

string

required

Payment method type. One of card, bank-account-us, bank-account-mx-clabe, bank-account-co, or bank-account-sepa-iban.

object

Card details. Present when type is card.

Show properties

string

required

Card brand. Can be visa, mastercard, amex, discover, jcb, unionpay, or diners-club.

string

required

Last four digits of the card number.

object

required

Show properties

string

Two-digit expiration month.

string

Four-digit expiration year.

object

required

Billing details for the cardholder.

Show properties

string

required

Full name.

string

Phone number (E.164 format).

object

Billing address.

string

Card funding type. Can be credit, debit, prepaid, or unknown.

string

Bank Identification Number (first 6-8 digits of the card number).

string

Two-letter country code of the card issuer.

object

Bank account details. Present when type is bank-account-us, bank-account-mx-clabe, bank-account-co, or bank-account-sepa-iban.

Show common properties

object

required

Billing details for the account holder.

Show properties

string

required

Full name.

string

Phone number (E.164 format).

object

Show properties

string

required

string

required

string

required

string

required

ISO 3166-1 alpha-2 country code.

string | null

Name of the bank. null if not resolvable.

string

required

Last four digits of the account number, CLABE, or IBAN.

string

required

ISO 4217 currency code (e.g. usd, mxn, eur, cop).

string

required

ISO 3166-1 alpha-2 country code.

string

Account holder type. individual or business. Required on creation. May be absent on records created before the field was enforced.

object

Read-only. The payout rails a currently-available provider has confirmed for this account. Absent when no payout provider currently serves the account.

Show properties

string

required

pending while asynchronous rail resolution is still running for optional rails (baseline rails appear immediately); complete once resolved.

string[]

required

Rail values this account supports. See Payment Schemes for the current rail catalog and indicative delivery times.

string[]

required

Rails still being resolved. Non-empty only while status is pending; [] once status is complete.

Show US-specific properties (bank-account-us)

object

Bank branch address.

string

Nine-digit ABA routing number.

string

checking or savings.

Show MX-specific properties (bank-account-mx-clabe)

string

Three-digit bank code derived from the CLABE.

Show CO-specific properties (bank-account-co)

string

Bank code assigned by Banco de la República.

string

checking or savings.

Show SEPA-specific properties (bank-account-sepa-iban)

string

BIC/SWIFT code (8 or 11 characters).

string

Read-only. Bank accounts only. ISO 8601 timestamp of the most recent successful offramp payout funded by this account. Absent until the first payout.

{
  "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"
  }
}

{
  "paymentMethodId": "3323460b-d9d2-4ec6-b380-8a3e01e3f226",
  "default": false,
  "displayName": "Deutsche Bank ••6789",
  "type": "bank-account-sepa-iban",
  "bankAccount": {
    "billing": {
      "name": "Hans Müller",
      "phone": "+4915112345678",
      "address": {
        "line1": "Unter den Linden 1",
        "city": "Berlin",
        "stateOrRegion": "BE",
        "postalCode": "10117",
        "country": "DE"
      }
    },
    "bankName": "Deutsche Bank",
    "accountSuffix": "6789",
    "currency": "eur",
    "country": "DE",
    "entityType": "individual",
    "bic": "COBADEFFXXX"
  }
}

{
  "paymentMethodId": "f2ecef7e-91af-4fa7-93f9-12db856c227f",
  "default": false,
  "displayName": "Chime ••6259",
  "type": "bank-account-us",
  "bankAccount": {
    "billing": {
      "name": "Alice Smith",
      "phone": "+12125551234",
      "address": {
        "line1": "123 Main St",
        "city": "New York",
        "stateOrRegion": "NY",
        "postalCode": "10001",
        "country": "US"
      }
    },
    "bankName": "Chime",
    "accountSuffix": "6259",
    "currency": "usd",
    "country": "US",
    "entityType": "individual",
    "bankAddress": {
      "line1": "123 Main St",
      "city": "New York",
      "stateOrRegion": "NY",
      "postalCode": "10001",
      "country": "US"
    },
    "routingNumber": "091300010",
    "accountType": "checking",
    "rails": { "status": "complete", "supported": ["rtp", "ach-same-day", "ach-us"], "pending": [] }
  }
}

{
  "paymentMethodId": "27bacbe1-d0ff-4bc3-b37a-ca91cc64fa39",
  "default": false,
  "displayName": "MX Bank Account ••9719",
  "type": "bank-account-mx-clabe",
  "bankAccount": {
    "billing": {
      "name": "Javier Toledo",
      "phone": "+525512345678",
      "address": {
        "line1": "Av. Reforma 1",
        "city": "Mexico City",
        "stateOrRegion": "CDMX",
        "postalCode": "06600",
        "country": "MX"
      }
    },
    "bankName": null,
    "accountSuffix": "9719",
    "currency": "mxn",
    "country": "MX",
    "entityType": "individual",
    "bankCode": "138"
  }
}

{
  "paymentMethodId": "1cad2281-bd3d-4219-8787-7dfea94c60b1",
  "default": false,
  "displayName": "CO Bank Account ••7890",
  "type": "bank-account-co",
  "bankAccount": {
    "billing": {
      "name": "Carlos Gómez",
      "phone": "+573001234567",
      "address": {
        "line1": "Carrera 7",
        "city": "Bogotá",
        "stateOrRegion": "DC",
        "postalCode": "110010",
        "country": "CO"
      }
    },
    "bankName": null,
    "accountSuffix": "7890",
    "currency": "cop",
    "country": "CO",
    "entityType": "individual",
    "bankCode": "001",
    "accountType": "savings"
  }
}

Introduction

Hosted (pop-up)

Embedded

Headless (API)

Advanced Guides

API Reference

Type Values

Attributes

​Type Values

​Attributes

Type Values

Attributes