The Payment Method Object

{
  "paymentMethodId": "9f1a6b2c-3d4e-4f50-9a61-2b3c4d5e6f70",
  "type": "bre-b",
  "status": "active",
  "reason": null,
  "breB": {
    "accountHolder": {
      "name": "Carlos Gómez",
      "phoneNumber": "+573001234567"
    },
    "accountSuffix": "CDKS",
    "currency": "cop",
    "country": "CO",
    "entityType": "individual",
    "keyType": "alphanumeric"
  }
}

{
  "paymentMethodId": "f2ecef7e-91af-4fa7-93f9-12db856c227f",
  "type": "bank-account-us",
  "bankAccount": {
    "bankName": "Chase",
    "accountSuffix": "7899",
    "currency": "usd",
    "country": "US",
    "entityType": "individual",
    "bankAddress": {
      "line1": "123 Main St",
      "city": "New York",
      "stateOrRegion": "NY",
      "postalCode": "10001",
      "country": "US"
    },
    "routingNumber": "071000013",
    "accountType": "checking"
  }
}

{
  "paymentMethodId": "3323460b-d9d2-4ec6-b380-8a3e01e3f226",
  "default": false,
  "displayName": "SEPA Account ••6789",
  "type": "bank-account-sepa-iban",
  "bankAccount": {
    "bankName": null,
    "accountSuffix": "6789",
    "currency": "eur",
    "country": "DE",
    "entityType": "individual",
    "bic": "COBADEFFXXX"
  }
}

{
  "paymentMethodId": "27bacbe1-d0ff-4bc3-b37a-ca91cc64fa39",
  "type": "bank-account-mx-clabe",
  "bankAccount": {
    "accountHolder": {
      "name": "Luis Gomez Rios",
      "phoneNumber": "+525512345678"
    },
    "accountSuffix": "7899",
    "currency": "mxn",
    "country": "MX",
    "entityType": "individual",
    "bankCode": "012",
    "institutionName": "BBVA Mexico"
  }
}

{
  "paymentMethodId": "1cad2281-bd3d-4219-8787-7dfea94c60b1",
  "type": "bank-account-co",
  "bankAccount": {
    "bankName": null,
    "accountSuffix": "7890",
    "currency": "cop",
    "country": "CO",
    "entityType": "individual",
    "bankCode": "001",
    "accountType": "savings"
  }
}

{
  "paymentMethodId": "9f1a6b2c-3d4e-4f50-9a61-2b3c4d5e6f70",
  "type": "bre-b",
  "status": "active",
  "reason": null,
  "breB": {
    "accountHolder": {
      "name": "Carlos Gómez",
      "phoneNumber": "+573001234567"
    },
    "accountSuffix": "CDKS",
    "currency": "cop",
    "country": "CO",
    "entityType": "individual",
    "keyType": "alphanumeric"
  }
}

{
  "paymentMethodId": "f2ecef7e-91af-4fa7-93f9-12db856c227f",
  "type": "bank-account-us",
  "bankAccount": {
    "bankName": "Chase",
    "accountSuffix": "7899",
    "currency": "usd",
    "country": "US",
    "entityType": "individual",
    "bankAddress": {
      "line1": "123 Main St",
      "city": "New York",
      "stateOrRegion": "NY",
      "postalCode": "10001",
      "country": "US"
    },
    "routingNumber": "071000013",
    "accountType": "checking"
  }
}

{
  "paymentMethodId": "3323460b-d9d2-4ec6-b380-8a3e01e3f226",
  "default": false,
  "displayName": "SEPA Account ••6789",
  "type": "bank-account-sepa-iban",
  "bankAccount": {
    "bankName": null,
    "accountSuffix": "6789",
    "currency": "eur",
    "country": "DE",
    "entityType": "individual",
    "bic": "COBADEFFXXX"
  }
}

{
  "paymentMethodId": "27bacbe1-d0ff-4bc3-b37a-ca91cc64fa39",
  "type": "bank-account-mx-clabe",
  "bankAccount": {
    "accountHolder": {
      "name": "Luis Gomez Rios",
      "phoneNumber": "+525512345678"
    },
    "accountSuffix": "7899",
    "currency": "mxn",
    "country": "MX",
    "entityType": "individual",
    "bankCode": "012",
    "institutionName": "BBVA Mexico"
  }
}

{
  "paymentMethodId": "1cad2281-bd3d-4219-8787-7dfea94c60b1",
  "type": "bank-account-co",
  "bankAccount": {
    "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 (Clave Bancaria Estandarizada).
`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.
`bre-b`	Colombian Bre-B key: an `@handle`, a mobile number, an e-mail, an identity document, or a commerce code.

Attributes

string

required

Unique identifier for the payout method.

boolean

Whether this is the user’s default payout method. Returned for bank-account-sepa-iban only.

string

Server-derived label, returned for bank-account-sepa-iban only (e.g. "SEPA Account ••6789"). Absent on every other payout method; read label there.

string

required

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

object

Bank account details. Absent when type is bre-b, which returns breB instead.

Show common properties

object

The person or company that owns the account. Always the value the client sent, never the bank’s record of the holder. Derived from billing when the record predates this field.

Show properties

string

required

Full legal name.

string

E-mail address.

string

Phone number (E.164 format).

object

Holder address, without a country: the account’s own country is the bank’s jurisdiction. Present only on types that collect one. Never on bank-account-mx-clabe.

string | null

Name of the bank. null if not resolvable. Absent for bank-account-mx-clabe, which returns institutionName instead.

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.

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.

string

Display-only name of the institution holding the CLABE. Absent until the destination lookup answers. Not bankName: a large share of CLABEs are issued by STP and the fintechs that ride on it.

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).

object

Bre-B key details. Present when type is bre-b, in place of bankAccount. The key itself is never returned.

Show properties

object

The person or company that owns the key. Always the value the client sent.

Show properties

string

required

Full legal name.

string

E-mail address.

string

Phone number (E.164 format).

string

required

Masked form of the key. An e-mail key is masked in place. Every other key shows its last four characters.

string

required

Always cop. Bre-B only settles in Colombian pesos.

string

required

Always CO.

string

Key holder type. individual or business.

string

Category of the key, derived from its format. One of alphanumeric, phone, email, identification, or commerce. A client-supplied value is refused.

string

Display name of the institution that holds the key. Absent until a name source answers.

object

Read-only. The payout rails a currently-available provider advertises for this key. Absent when no provider serves the key.

Show properties

string[]

required

Rail values this key supports. Bre-B carries supported alone, without the status and pending fields an ordinary bank account returns.

string

The client’s own name for this payout method, when one was sent on creation. At most 255 characters.

string

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

{
  "paymentMethodId": "9f1a6b2c-3d4e-4f50-9a61-2b3c4d5e6f70",
  "type": "bre-b",
  "status": "active",
  "reason": null,
  "breB": {
    "accountHolder": {
      "name": "Carlos Gómez",
      "phoneNumber": "+573001234567"
    },
    "accountSuffix": "CDKS",
    "currency": "cop",
    "country": "CO",
    "entityType": "individual",
    "keyType": "alphanumeric"
  }
}

{
  "paymentMethodId": "f2ecef7e-91af-4fa7-93f9-12db856c227f",
  "type": "bank-account-us",
  "bankAccount": {
    "bankName": "Chase",
    "accountSuffix": "7899",
    "currency": "usd",
    "country": "US",
    "entityType": "individual",
    "bankAddress": {
      "line1": "123 Main St",
      "city": "New York",
      "stateOrRegion": "NY",
      "postalCode": "10001",
      "country": "US"
    },
    "routingNumber": "071000013",
    "accountType": "checking"
  }
}

{
  "paymentMethodId": "3323460b-d9d2-4ec6-b380-8a3e01e3f226",
  "default": false,
  "displayName": "SEPA Account ••6789",
  "type": "bank-account-sepa-iban",
  "bankAccount": {
    "bankName": null,
    "accountSuffix": "6789",
    "currency": "eur",
    "country": "DE",
    "entityType": "individual",
    "bic": "COBADEFFXXX"
  }
}

{
  "paymentMethodId": "27bacbe1-d0ff-4bc3-b37a-ca91cc64fa39",
  "type": "bank-account-mx-clabe",
  "bankAccount": {
    "accountHolder": {
      "name": "Luis Gomez Rios",
      "phoneNumber": "+525512345678"
    },
    "accountSuffix": "7899",
    "currency": "mxn",
    "country": "MX",
    "entityType": "individual",
    "bankCode": "012",
    "institutionName": "BBVA Mexico"
  }
}

{
  "paymentMethodId": "1cad2281-bd3d-4219-8787-7dfea94c60b1",
  "type": "bank-account-co",
  "bankAccount": {
    "bankName": null,
    "accountSuffix": "7890",
    "currency": "cop",
    "country": "CO",
    "entityType": "individual",
    "bankCode": "001",
    "accountType": "savings"
  }
}

Introduction

Quickstarts ⚡

Concepts

Guides

API Reference

Type Values

Attributes

​Type Values

​Attributes

Type Values

Attributes