The Payment Method Object

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

{
  "paymentMethodId": "3323460b-d9d2-4ec6-b380-8a3e01e3f226",
  "default": false,
  "displayName": "SEPA Account ••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": null,
    "accountSuffix": "6789",
    "currency": "eur",
    "country": "DE",
    "entityType": "individual",
    "bic": "COBADEFFXXX"
  }
}

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

PaymentMethod objects represent the bank account payout methods that offramp orders settle fiat to. Save one with the Create Payment Method endpoint, then reference its paymentMethodId as the recipient when creating an offramp order.

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 payout execution time.

Value	Description
`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.

Attributes

paymentMethodId

string

required

Unique identifier for the payout method.

default

boolean

required

Whether this is the user’s default payout method.

displayName

string

required

Human-readable label for the payout method (e.g. "Chime ••6259", "SEPA Account ••6789").

type

string

required

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

bankAccount

object

required

Bank account details.

Show common properties

billing

object

required

Billing details for the account holder.

Show properties

name

string

required

Full name.

phone

string

Phone number (E.164 format).

address

object

Show properties

line1

string

required

line2

string

city

string

required

stateOrRegion

string

postalCode

string

required

country

string

required

ISO 3166-1 alpha-2 country code.

bankName

string | null

Name of the bank. null if not resolvable.

accountSuffix

string

required

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

currency

string

required

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

country

string

required

ISO 3166-1 alpha-2 country code.

entityType

string

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

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

bankAddress

object

Bank branch address.

routingNumber

string

Nine-digit ABA routing number.

accountType

string

checking or savings.

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

bankCode

string

Three-digit bank code derived from the CLABE.

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

bankCode

string

Bank code assigned by Banco de la República.

accountType

string

checking or savings.

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

bic

string

BIC/SWIFT code (8 or 11 characters).

lastPayoutAt

string

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

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

{
  "paymentMethodId": "3323460b-d9d2-4ec6-b380-8a3e01e3f226",
  "default": false,
  "displayName": "SEPA Account ••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": null,
    "accountSuffix": "6789",
    "currency": "eur",
    "country": "DE",
    "entityType": "individual",
    "bic": "COBADEFFXXX"
  }
}

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

List Orders Create Payment Method

⌘I

Introduction

Quickstarts ⚡

Concepts

Guides

API Reference

Type Values

Attributes

​Type Values

​Attributes

Type Values

Attributes