> ## Documentation Index > Fetch the complete documentation index at: https://docs.crossmint.com/llms.txt > Use this file to discover all available pages before exploring further. # List Payment Methods by User > Retrieve all payment methods saved for a given user Returns a paginated list of payment methods for a given user. ## Returns An object with a `data` array containing [PaymentMethod](/api-reference/headless/payment-methods/payment-method-object) objects. Use the `cursor` parameter to paginate through results. When `nextCursor` is present, additional pages are available in that direction. ## OpenAPI ````yaml api-reference/_open-api/PaymentMethods.json GET /unstable/payment-methods openapi: 3.1.0 info: contact: email: support@crossmint.com name: Crossmint Support url: https://www.crossmint.com description: Crossmint Payment Methods API title: Crossmint Payment Methods API version: 1.0.0 servers: - description: Staging environment (testnets) url: https://staging.crossmint.com/api - description: Production environment (mainnets) url: https://www.crossmint.com/api security: [] tags: [] paths: /unstable/payment-methods: get: tags: - Payment Methods summary: List Payment Methods description: >- Returns a paginated list of payment methods for a user, newest first by default. A deleted payment method is omitted; pass `status=deleted` to list the deleted bank accounts. **API scope required**: `payment-methods.read` operationId: paymentMethods.unstable.list parameters: - description: >- Opaque cursor from a previous response (`nextCursor` or `previousCursor`). Omit it on the first request. in: query name: cursor required: false schema: type: string - description: >- Maximum number of results per page. Minimum 1, maximum 100. Default 30. in: query name: limit required: false schema: type: string - description: >- Sort direction by creation date. `desc` returns the newest first (default). `asc` returns the oldest first. in: query name: sort required: false schema: enum: - asc - desc type: string - description: Filter by payment method type. Omit to return all types. in: query name: type required: false schema: enum: - bank-account-br - bank-account-co - bank-account-id - bank-account-mx-clabe - bank-account-ng - bank-account-ph - bank-account-sepa-iban - bank-account-th - bank-account-us - bank-account-vn - bre-b - card - pix type: string - description: >- Set to 'deleted' to list the deleted bank accounts, which the unfiltered list omits. Cards carry no status and are never returned when this is set. in: query name: status required: false schema: const: deleted type: string - description: >- Filter to payment methods that have (true) or have not (false) funded a settled offramp payout. When set to false, cards are included in results. Omit to return all payment methods regardless of payout history. in: query name: hasPayout required: false schema: enum: - 'false' - 'true' type: string - description: >- Identifies the target user when authenticating with a server API key. Format: `:` (e.g., `email:alice@example.com`, `userId:abc123`, `phoneNumber:+12125551234`, `twitter:alice`). Required for API-key authentication; ignored when authenticating with a JWT (the JWT subject is used). in: query name: userLocator required: false schema: {} responses: '200': content: application/json: example: data: - card: billing: address: city: Springfield country: US line1: 123 Main St postalCode: '62701' stateOrRegion: IL name: Alice Smith phone: '+12125551234' bin: '411111' brand: visa country: US expiration: month: '12' year: '2028' fundingType: debit last4: '1111' createdAt: '2026-08-20T19:10:00.000Z' default: true displayName: Visa ••1111 paymentMethodId: d4e5f6a7-b8c9-0123-def4-567890abcdef type: card updatedAt: '2026-08-20T19:12:11.000Z' - bankAccount: accountSuffix: '7899' accountType: checking bankAddress: city: New York country: US line1: 123 Main St postalCode: '10001' stateOrRegion: NY bankName: Chase country: US currency: usd entityType: individual routingNumber: '071000013' createdAt: '2026-08-20T19:10:00.000Z' lastPayoutAt: '2026-06-15T18:00:00.000Z' paymentMethodId: dd8a59c6-aac0-47c2-9c21-686caf7f0359 reason: null status: active statusReason: null type: bank-account-us updatedAt: '2026-08-20T19:12:11.000Z' - bankAccount: accountSuffix: '6789' bankName: Deutsche Bank bic: COBADEFFXXX country: DE currency: eur entityType: individual createdAt: '2026-08-20T19:10:00.000Z' default: false displayName: Deutsche Bank ••6789 lastPayoutAt: '2026-06-15T18:00:00.000Z' paymentMethodId: 3323460b-d9d2-4ec6-b380-8a3e01e3f226 reason: null status: active statusReason: null type: bank-account-sepa-iban updatedAt: '2026-08-20T19:12:11.000Z' - bankAccount: accountHolder: name: Luis Gomez Rios accountSuffix: '7899' country: MX currency: mxn entityType: individual createdAt: '2026-08-20T19:10:00.000Z' paymentMethodId: b9f1c4d2-5e70-4a31-8c66-2f0d7a95e134 reason: null status: active statusReason: null type: bank-account-mx-clabe updatedAt: '2026-09-02T11:04:18.000Z' nextCursor: eyJsYXN0SWQiOiI2NDUifQ== previousCursor: null schema: $ref: '#/components/schemas/ListPaymentMethodsResponseDto' description: >- Paginated list of payment methods. `nextCursor` and `previousCursor` are present when more pages exist in that direction. '400': content: application/json: examples: missing_locator: summary: Missing userLocator when using API key auth value: code: PAYMENT_METHOD_INVALID_USER_LOCATOR error: true message: userLocator is required when not using JWT authentication schema: $ref: '#/components/schemas/ApiErrorDto' description: Invalid query parameters, or `userLocator` is missing. '401': content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' description: Missing or invalid API key. '403': content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' description: >- Forbidden. Ensure the credentials are correct and the authentication source is allowed. '429': content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' description: Rate limit exceeded. security: - apiKey: [] userJwt: [] - apiKey: [] components: schemas: ListPaymentMethodsResponseDto: properties: data: description: Array of payment method objects for the current page. items: description: >- A saved payment method. Sensitive fields (full PAN, CVC, full account numbers, IBANs, Bre-B keys) are never included. examples: - card: billing: name: John Doe brand: visa country: US expiration: month: '12' year: '2028' fundingType: credit last4: '4242' createdAt: '2025-01-15T10:30:00.000Z' default: true display: imageUrl: https://www.crossmint.com/assets/cards/visa.svg label: Visa ending in 4242 displayName: Visa ••4242 paymentMethodId: 3f7a9c10-2a8b-4c5d-9e2f-1b3a4c5d6e7f type: card updatedAt: '2025-01-15T10:30:00.000Z' oneOf: - properties: bankAccount: additionalProperties: false description: >- Bank account details. Present when `type` is a bank type. Full account numbers and IBANs are never included. properties: accountHolder: description: Person or company that owns the account. properties: document: description: >- Identity document of the account holder. The full number is never returned. properties: suffix: description: Last four characters of the document number. type: string type: description: >- Document type: `cc` (Cédula de Ciudadanía), `nit` (NIT), `ce` (Cédula de Extranjería), `pa` (passport), `ppt` (Permiso por Protección Temporal), `ti` (Tarjeta de Identidad), `rc` (Registro Civil), `te` (Tarjeta de Extranjería) or `die` (foreign identity document). enum: - cc - ce - die - nit - pa - ppt - rc - te - ti type: string required: - suffix - type type: object email: description: Email address of the account holder. format: email pattern: >- ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ type: string name: description: >- Full legal name of the account holder. Sent to the payout provider. minLength: 1 type: string phoneNumber: description: >- Phone number of the account holder in E.164 format. minLength: 1 type: string required: - document - name type: object accountSuffix: description: >- The last characters of the account number, CLABE or IBAN, at most four. type: string accountType: description: Type of the account. enum: - checking - electronic-deposit - savings type: string country: const: CO description: Always `CO`. type: string currency: const: cop description: >- Always 'cop'; a Colombian bank account only settles in Colombian pesos. type: string entityType: description: >- Type of the account holder. Present when sent on creation. enum: - business - individual type: string institutionId: description: >- ID of the bank, for example `co-bancolombia`. The [Bank Institution IDs](https://docs.crossmint.com/offramp/guides/bank-institution-ids) page lists every ID. type: string rails: description: >- Bank rails available for payouts to this account. `supported` lists rails a currently-available provider advertises for this bank account; Crossmint decides payer eligibility at order time, so an order can still be refused on a rail listed here. `pending` lists rails still being resolved (non-empty only while `status` is 'pending'); `status` is 'pending' while asynchronous rail resolution is still running. Absent when no payout provider serves the account, or when `status` is 'rejected'. properties: pending: description: >- Rails still being resolved. Non-empty only while `status` is `pending`. items: enum: - ach-credit - ach-same-day - ach-us - bi-fast - bre-b - citad - fednow - instapay - napas-247 - nip - pesonet - promptpay - rtp - sepa - sepa-instant - spei - wire type: string type: array status: description: >- `pending` while asynchronous rail resolution is still running. `complete` when every provider has answered. enum: - complete - pending type: string supported: description: >- Rails that a currently-available payout provider advertises for this account. items: enum: - ach-credit - ach-same-day - ach-us - bi-fast - bre-b - citad - fednow - instapay - napas-247 - nip - pesonet - promptpay - rtp - sepa - sepa-instant - spei - wire type: string type: array required: - pending - status - supported type: object verificationStatus: description: >- Result of the provider's check on the destination. Absent until a provider answers. enum: - pending-review - rejected - verified type: string required: - accountHolder - accountSuffix - accountType - country - currency - institutionId type: object createdAt: description: ISO 8601 timestamp when this payment method was created. example: '2024-01-15T10:30:00.000Z' format: date-time type: string label: description: >- The client's own name for this payment method, when one was sent. minLength: 1 type: string lastPayoutAt: description: >- Read-only. ISO 8601 timestamp of the most recent successful offramp payout funded by this bank account. Absent if none. example: '2024-01-15T10:30:00.000Z' format: date-time type: string paymentMethodId: description: >- Unique identifier (UUID v4). Crossmint assigns it on creation. minLength: 1 type: string reason: anyOf: - description: >- Deprecated. Use `statusReason`, which carries the same value. type: string - type: 'null' status: description: >- Whether a payout provider serves this destination. 'pending' while the readiness checks run, 'active' when a provider advertises a rail for it, 'rejected' when it cannot receive funds, 'deleted' when it was deleted. This describes the destination only, never the payer's eligibility. 'pending' moves to 'active', 'rejected' or 'deleted'; 'active' moves to 'rejected' or 'deleted'; 'rejected' moves only to 'deleted'. Branch on this field, never on `statusReason`. enum: - active - deleted - pending - rejected type: string statusReason: anyOf: - description: >- Why the status is 'rejected'. Null on every other status, and on a rejection with no established destination condition. Known values today: destination-not-found, destination-closed, destination-cannot-receive, no-rail-available. New codes can appear at any time, so branch on `status` and treat an unrecognised code as the status alone. type: string - type: 'null' type: const: bank-account-co description: >- Payment method type. Selects which sub-object is present: `card`, `bankAccount`, or `breB`. type: string updatedAt: description: >- ISO 8601 timestamp when this payment method was last modified. example: '2024-01-15T10:30:00.000Z' format: date-time type: string required: - bankAccount - createdAt - paymentMethodId - reason - status - statusReason - type - updatedAt title: CO bank account type: object - properties: bankAccount: additionalProperties: false description: >- Bank account details. Present when `type` is a bank type. Full account numbers and IBANs are never included. properties: accountHolder: description: >- The person or company that owns the bank account. Derived from `billing` when the record predates this field. Its address carries no country: the account's own `country` is the bank's jurisdiction. properties: address: description: >- Address of the account holder, in the country of the account. Present only on types that collect one. properties: city: description: City (max 50 characters). maxLength: 50 minLength: 1 type: string line1: description: Primary address line (max 200 characters). maxLength: 200 minLength: 1 type: string line2: description: >- Secondary address line, such as an apartment, suite, or unit (max 60 characters). maxLength: 60 type: string postalCode: description: Postal or ZIP code (max 20 characters). maxLength: 20 minLength: 1 type: string stateOrRegion: description: >- State, province, or region (max 50 characters). maxLength: 50 type: string required: - city - line1 type: object email: description: Email address of the account holder. format: email pattern: >- ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ type: string name: description: >- Full legal name of the account holder. Sent to the payout provider. minLength: 1 type: string phoneNumber: description: >- Phone number of the account holder in E.164 format. minLength: 1 type: string required: - name type: object accountSuffix: description: >- The last characters of the account number, CLABE or IBAN, at most four. type: string country: description: ISO 3166-1 alpha-2 country code of the account. enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW type: string currency: const: mxn description: Always 'mxn'; a CLABE only settles in Mexican pesos. type: string entityType: description: >- Type of the account holder. Present when sent on creation. enum: - business - individual type: string rails: description: >- Bank rails available for payouts to this account. `supported` lists rails a currently-available provider advertises for this bank account; Crossmint decides payer eligibility at order time, so an order can still be refused on a rail listed here. `pending` lists rails still being resolved (non-empty only while `status` is 'pending'); `status` is 'pending' while asynchronous rail resolution is still running. Absent when no payout provider serves the account, or when `status` is 'rejected'. properties: pending: description: >- Rails still being resolved. Non-empty only while `status` is `pending`. items: enum: - ach-credit - ach-same-day - ach-us - bi-fast - bre-b - citad - fednow - instapay - napas-247 - nip - pesonet - promptpay - rtp - sepa - sepa-instant - spei - wire type: string type: array status: description: >- `pending` while asynchronous rail resolution is still running. `complete` when every provider has answered. enum: - complete - pending type: string supported: description: >- Rails that a currently-available payout provider advertises for this account. items: enum: - ach-credit - ach-same-day - ach-us - bi-fast - bre-b - citad - fednow - instapay - napas-247 - nip - pesonet - promptpay - rtp - sepa - sepa-instant - spei - wire type: string type: array required: - pending - status - supported type: object verificationStatus: description: >- Result of the provider's check on the destination. Absent until a provider answers. enum: - pending-review - rejected - verified type: string required: - accountSuffix - country - currency type: object createdAt: description: ISO 8601 timestamp when this payment method was created. example: '2024-01-15T10:30:00.000Z' format: date-time type: string label: description: >- The client's own name for this payment method, when one was sent. minLength: 1 type: string lastPayoutAt: description: >- Read-only. ISO 8601 timestamp of the most recent successful offramp payout funded by this bank account. Absent if none. example: '2024-01-15T10:30:00.000Z' format: date-time type: string paymentMethodId: description: >- Unique identifier (UUID v4). Crossmint assigns it on creation. minLength: 1 type: string reason: anyOf: - description: >- Deprecated. Use `statusReason`, which carries the same value. type: string - type: 'null' status: description: >- Whether a payout provider serves this destination. 'pending' while the readiness checks run, 'active' when a provider advertises a rail for it, 'rejected' when it cannot receive funds, 'deleted' when it was deleted. This describes the destination only, never the payer's eligibility. 'pending' moves to 'active', 'rejected' or 'deleted'; 'active' moves to 'rejected' or 'deleted'; 'rejected' moves only to 'deleted'. Branch on this field, never on `statusReason`. enum: - active - deleted - pending - rejected type: string statusReason: anyOf: - description: >- Why the status is 'rejected'. Null on every other status, and on a rejection with no established destination condition. Known values today: destination-not-found, destination-closed, destination-cannot-receive, no-rail-available. New codes can appear at any time, so branch on `status` and treat an unrecognised code as the status alone. type: string - type: 'null' type: const: bank-account-mx-clabe description: >- Payment method type. Selects which sub-object is present: `card`, `bankAccount`, or `breB`. type: string updatedAt: description: >- ISO 8601 timestamp when this payment method was last modified. example: '2024-01-15T10:30:00.000Z' format: date-time type: string required: - bankAccount - createdAt - paymentMethodId - reason - status - statusReason - type - updatedAt title: MX CLABE type: object - properties: bankAccount: description: >- Bank account details. Present when `type` is a bank type. Full account numbers and IBANs are never included. properties: accountHolder: description: >- The person or company that owns the bank account. Derived from `billing` when the record predates this field. Its address carries no country: the account's own `country` is the bank's jurisdiction. properties: address: description: >- Address of the account holder, in the country of the account. Present only on types that collect one. properties: city: description: City (max 50 characters). maxLength: 50 minLength: 1 type: string line1: description: Primary address line (max 200 characters). maxLength: 200 minLength: 1 type: string line2: description: >- Secondary address line, such as an apartment, suite, or unit (max 60 characters). maxLength: 60 type: string postalCode: description: Postal or ZIP code (max 20 characters). maxLength: 20 minLength: 1 type: string stateOrRegion: description: >- State, province, or region (max 50 characters). maxLength: 50 type: string required: - city - line1 type: object email: description: Email address of the account holder. format: email pattern: >- ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ type: string name: description: >- Full legal name of the account holder. Sent to the payout provider. minLength: 1 type: string phoneNumber: description: >- Phone number of the account holder in E.164 format. minLength: 1 type: string required: - name type: object accountSuffix: description: >- The last characters of the account number, CLABE or IBAN, at most four. type: string accountType: description: Type of the account. Present when sent on creation. enum: - checking - savings type: string country: const: ID description: Always 'ID'. type: string currency: const: idr description: >- Always 'idr'; Indonesian bank accounts only settle in Indonesian rupiah. type: string entityType: description: >- Type of the account holder. Present when sent on creation. enum: - business - individual type: string institutionId: description: >- ID of the bank, for example `id-bca`. The [Bank Institution IDs](https://docs.crossmint.com/offramp/guides/bank-institution-ids) page lists every ID. type: string rails: description: >- Bank rails available for payouts to this account. `supported` lists rails a currently-available provider advertises for this bank account; Crossmint decides payer eligibility at order time, so an order can still be refused on a rail listed here. `pending` lists rails still being resolved (non-empty only while `status` is 'pending'); `status` is 'pending' while asynchronous rail resolution is still running. Absent when no payout provider serves the account, or when `status` is 'rejected'. properties: pending: description: >- Rails still being resolved. Non-empty only while `status` is `pending`. items: enum: - ach-credit - ach-same-day - ach-us - bi-fast - bre-b - citad - fednow - instapay - napas-247 - nip - pesonet - promptpay - rtp - sepa - sepa-instant - spei - wire type: string type: array status: description: >- `pending` while asynchronous rail resolution is still running. `complete` when every provider has answered. enum: - complete - pending type: string supported: description: >- Rails that a currently-available payout provider advertises for this account. items: enum: - ach-credit - ach-same-day - ach-us - bi-fast - bre-b - citad - fednow - instapay - napas-247 - nip - pesonet - promptpay - rtp - sepa - sepa-instant - spei - wire type: string type: array required: - pending - status - supported type: object verificationStatus: description: >- Result of the provider's check on the destination. Absent until a provider answers. enum: - pending-review - rejected - verified type: string required: - accountSuffix - country - currency - institutionId type: object createdAt: description: ISO 8601 timestamp when this payment method was created. example: '2024-01-15T10:30:00.000Z' format: date-time type: string label: description: >- The client's own name for this payment method, when one was sent. minLength: 1 type: string lastPayoutAt: description: >- Read-only. ISO 8601 timestamp of the most recent successful offramp payout funded by this bank account. Absent if none. example: '2024-01-15T10:30:00.000Z' format: date-time type: string paymentMethodId: description: >- Unique identifier (UUID v4). Crossmint assigns it on creation. minLength: 1 type: string reason: anyOf: - description: >- Deprecated. Use `statusReason`, which carries the same value. type: string - type: 'null' status: description: >- Whether a payout provider serves this destination. 'pending' while the readiness checks run, 'active' when a provider advertises a rail for it, 'rejected' when it cannot receive funds, 'deleted' when it was deleted. This describes the destination only, never the payer's eligibility. 'pending' moves to 'active', 'rejected' or 'deleted'; 'active' moves to 'rejected' or 'deleted'; 'rejected' moves only to 'deleted'. Branch on this field, never on `statusReason`. enum: - active - deleted - pending - rejected type: string statusReason: anyOf: - description: >- Why the status is 'rejected'. Null on every other status, and on a rejection with no established destination condition. Known values today: destination-not-found, destination-closed, destination-cannot-receive, no-rail-available. New codes can appear at any time, so branch on `status` and treat an unrecognised code as the status alone. type: string - type: 'null' type: const: bank-account-id description: >- Payment method type. Selects which sub-object is present: `card`, `bankAccount`, or `breB`. type: string updatedAt: description: >- ISO 8601 timestamp when this payment method was last modified. example: '2024-01-15T10:30:00.000Z' format: date-time type: string required: - bankAccount - createdAt - paymentMethodId - reason - status - statusReason - type - updatedAt title: ID bank account type: object - properties: bankAccount: description: >- Bank account details. Present when `type` is a bank type. Full account numbers and IBANs are never included. properties: accountHolder: description: >- The person or company that owns the bank account. Derived from `billing` when the record predates this field. Its address carries no country: the account's own `country` is the bank's jurisdiction. properties: address: description: >- Address of the account holder, in the country of the account. Present only on types that collect one. properties: city: description: City (max 50 characters). maxLength: 50 minLength: 1 type: string line1: description: Primary address line (max 200 characters). maxLength: 200 minLength: 1 type: string line2: description: >- Secondary address line, such as an apartment, suite, or unit (max 60 characters). maxLength: 60 type: string postalCode: description: Postal or ZIP code (max 20 characters). maxLength: 20 minLength: 1 type: string stateOrRegion: description: >- State, province, or region (max 50 characters). maxLength: 50 type: string required: - city - line1 type: object email: description: Email address of the account holder. format: email pattern: >- ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ type: string name: description: >- Full legal name of the account holder. Sent to the payout provider. minLength: 1 type: string phoneNumber: description: >- Phone number of the account holder in E.164 format. minLength: 1 type: string required: - name type: object accountSuffix: description: >- The last characters of the account number, CLABE or IBAN, at most four. type: string accountType: description: Type of the account. Present when sent on creation. enum: - checking - savings type: string country: const: NG description: Always 'NG'. type: string currency: const: ngn description: >- Always 'ngn'; Nigerian bank accounts only settle in Nigerian naira. type: string entityType: description: >- Type of the account holder. Present when sent on creation. enum: - business - individual type: string institutionId: description: >- ID of the bank, for example `ng-gt-bank`. The [Bank Institution IDs](https://docs.crossmint.com/offramp/guides/bank-institution-ids) page lists every ID. type: string rails: description: >- Bank rails available for payouts to this account. `supported` lists rails a currently-available provider advertises for this bank account; Crossmint decides payer eligibility at order time, so an order can still be refused on a rail listed here. `pending` lists rails still being resolved (non-empty only while `status` is 'pending'); `status` is 'pending' while asynchronous rail resolution is still running. Absent when no payout provider serves the account, or when `status` is 'rejected'. properties: pending: description: >- Rails still being resolved. Non-empty only while `status` is `pending`. items: enum: - ach-credit - ach-same-day - ach-us - bi-fast - bre-b - citad - fednow - instapay - napas-247 - nip - pesonet - promptpay - rtp - sepa - sepa-instant - spei - wire type: string type: array status: description: >- `pending` while asynchronous rail resolution is still running. `complete` when every provider has answered. enum: - complete - pending type: string supported: description: >- Rails that a currently-available payout provider advertises for this account. items: enum: - ach-credit - ach-same-day - ach-us - bi-fast - bre-b - citad - fednow - instapay - napas-247 - nip - pesonet - promptpay - rtp - sepa - sepa-instant - spei - wire type: string type: array required: - pending - status - supported type: object verificationStatus: description: >- Result of the provider's check on the destination. Absent until a provider answers. enum: - pending-review - rejected - verified type: string required: - accountSuffix - country - currency - institutionId type: object createdAt: description: ISO 8601 timestamp when this payment method was created. example: '2024-01-15T10:30:00.000Z' format: date-time type: string label: description: >- The client's own name for this payment method, when one was sent. minLength: 1 type: string lastPayoutAt: description: >- Read-only. ISO 8601 timestamp of the most recent successful offramp payout funded by this bank account. Absent if none. example: '2024-01-15T10:30:00.000Z' format: date-time type: string paymentMethodId: description: >- Unique identifier (UUID v4). Crossmint assigns it on creation. minLength: 1 type: string reason: anyOf: - description: >- Deprecated. Use `statusReason`, which carries the same value. type: string - type: 'null' status: description: >- Whether a payout provider serves this destination. 'pending' while the readiness checks run, 'active' when a provider advertises a rail for it, 'rejected' when it cannot receive funds, 'deleted' when it was deleted. This describes the destination only, never the payer's eligibility. 'pending' moves to 'active', 'rejected' or 'deleted'; 'active' moves to 'rejected' or 'deleted'; 'rejected' moves only to 'deleted'. Branch on this field, never on `statusReason`. enum: - active - deleted - pending - rejected type: string statusReason: anyOf: - description: >- Why the status is 'rejected'. Null on every other status, and on a rejection with no established destination condition. Known values today: destination-not-found, destination-closed, destination-cannot-receive, no-rail-available. New codes can appear at any time, so branch on `status` and treat an unrecognised code as the status alone. type: string - type: 'null' type: const: bank-account-ng description: >- Payment method type. Selects which sub-object is present: `card`, `bankAccount`, or `breB`. type: string updatedAt: description: >- ISO 8601 timestamp when this payment method was last modified. example: '2024-01-15T10:30:00.000Z' format: date-time type: string required: - bankAccount - createdAt - paymentMethodId - reason - status - statusReason - type - updatedAt title: NG bank account type: object - properties: bankAccount: description: >- Bank account details. Present when `type` is a bank type. Full account numbers and IBANs are never included. properties: accountHolder: description: >- The person or company that owns the bank account. Derived from `billing` when the record predates this field. Its address carries no country: the account's own `country` is the bank's jurisdiction. properties: address: description: >- Address of the account holder, in the country of the account. Present only on types that collect one. properties: city: description: City (max 50 characters). maxLength: 50 minLength: 1 type: string line1: description: Primary address line (max 200 characters). maxLength: 200 minLength: 1 type: string line2: description: >- Secondary address line, such as an apartment, suite, or unit (max 60 characters). maxLength: 60 type: string postalCode: description: Postal or ZIP code (max 20 characters). maxLength: 20 minLength: 1 type: string stateOrRegion: description: >- State, province, or region (max 50 characters). maxLength: 50 type: string required: - city - line1 type: object email: description: Email address of the account holder. format: email pattern: >- ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ type: string name: description: >- Full legal name of the account holder. Sent to the payout provider. minLength: 1 type: string phoneNumber: description: >- Phone number of the account holder in E.164 format. minLength: 1 type: string required: - name type: object accountSuffix: description: >- The last characters of the account number, CLABE or IBAN, at most four. type: string accountType: description: Type of the account. Present when sent on creation. enum: - checking - savings type: string country: const: PH description: Always 'PH'. type: string currency: const: php description: >- Always 'php'; Philippine bank accounts only settle in Philippine pesos. type: string entityType: description: >- Type of the account holder. Present when sent on creation. enum: - business - individual type: string institutionId: description: >- ID of the bank, for example `ph-bdo`. The [Bank Institution IDs](https://docs.crossmint.com/offramp/guides/bank-institution-ids) page lists every ID. type: string rails: description: >- Bank rails available for payouts to this account. `supported` lists rails a currently-available provider advertises for this bank account; Crossmint decides payer eligibility at order time, so an order can still be refused on a rail listed here. `pending` lists rails still being resolved (non-empty only while `status` is 'pending'); `status` is 'pending' while asynchronous rail resolution is still running. Absent when no payout provider serves the account, or when `status` is 'rejected'. properties: pending: description: >- Rails still being resolved. Non-empty only while `status` is `pending`. items: enum: - ach-credit - ach-same-day - ach-us - bi-fast - bre-b - citad - fednow - instapay - napas-247 - nip - pesonet - promptpay - rtp - sepa - sepa-instant - spei - wire type: string type: array status: description: >- `pending` while asynchronous rail resolution is still running. `complete` when every provider has answered. enum: - complete - pending type: string supported: description: >- Rails that a currently-available payout provider advertises for this account. items: enum: - ach-credit - ach-same-day - ach-us - bi-fast - bre-b - citad - fednow - instapay - napas-247 - nip - pesonet - promptpay - rtp - sepa - sepa-instant - spei - wire type: string type: array required: - pending - status - supported type: object verificationStatus: description: >- Result of the provider's check on the destination. Absent until a provider answers. enum: - pending-review - rejected - verified type: string required: - accountSuffix - country - currency - institutionId type: object createdAt: description: ISO 8601 timestamp when this payment method was created. example: '2024-01-15T10:30:00.000Z' format: date-time type: string label: description: >- The client's own name for this payment method, when one was sent. minLength: 1 type: string lastPayoutAt: description: >- Read-only. ISO 8601 timestamp of the most recent successful offramp payout funded by this bank account. Absent if none. example: '2024-01-15T10:30:00.000Z' format: date-time type: string paymentMethodId: description: >- Unique identifier (UUID v4). Crossmint assigns it on creation. minLength: 1 type: string reason: anyOf: - description: >- Deprecated. Use `statusReason`, which carries the same value. type: string - type: 'null' status: description: >- Whether a payout provider serves this destination. 'pending' while the readiness checks run, 'active' when a provider advertises a rail for it, 'rejected' when it cannot receive funds, 'deleted' when it was deleted. This describes the destination only, never the payer's eligibility. 'pending' moves to 'active', 'rejected' or 'deleted'; 'active' moves to 'rejected' or 'deleted'; 'rejected' moves only to 'deleted'. Branch on this field, never on `statusReason`. enum: - active - deleted - pending - rejected type: string statusReason: anyOf: - description: >- Why the status is 'rejected'. Null on every other status, and on a rejection with no established destination condition. Known values today: destination-not-found, destination-closed, destination-cannot-receive, no-rail-available. New codes can appear at any time, so branch on `status` and treat an unrecognised code as the status alone. type: string - type: 'null' type: const: bank-account-ph description: >- Payment method type. Selects which sub-object is present: `card`, `bankAccount`, or `breB`. type: string updatedAt: description: >- ISO 8601 timestamp when this payment method was last modified. example: '2024-01-15T10:30:00.000Z' format: date-time type: string required: - bankAccount - createdAt - paymentMethodId - reason - status - statusReason - type - updatedAt title: PH bank account type: object - properties: bankAccount: description: >- Bank account details. Present when `type` is a bank type. Full account numbers and IBANs are never included. properties: accountHolder: description: >- The person or company that owns the bank account. Derived from `billing` when the record predates this field. Its address carries no country: the account's own `country` is the bank's jurisdiction. properties: address: description: >- Address of the account holder, in the country of the account. Present only on types that collect one. properties: city: description: City (max 50 characters). maxLength: 50 minLength: 1 type: string line1: description: Primary address line (max 200 characters). maxLength: 200 minLength: 1 type: string line2: description: >- Secondary address line, such as an apartment, suite, or unit (max 60 characters). maxLength: 60 type: string postalCode: description: Postal or ZIP code (max 20 characters). maxLength: 20 minLength: 1 type: string stateOrRegion: description: >- State, province, or region (max 50 characters). maxLength: 50 type: string required: - city - line1 type: object email: description: Email address of the account holder. format: email pattern: >- ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ type: string name: description: >- Full legal name of the account holder. Sent to the payout provider. minLength: 1 type: string phoneNumber: description: >- Phone number of the account holder in E.164 format. minLength: 1 type: string required: - name type: object accountSuffix: description: >- The last characters of the account number, CLABE or IBAN, at most four. type: string accountType: description: Type of the account. Present when sent on creation. enum: - checking - savings type: string country: const: TH description: Always 'TH'. type: string currency: const: thb description: >- Always 'thb'; Thai bank accounts only settle in Thai baht. type: string entityType: description: >- Type of the account holder. Present when sent on creation. enum: - business - individual type: string institutionId: description: >- ID of the bank, for example `th-kasikorn-bank`. The [Bank Institution IDs](https://docs.crossmint.com/offramp/guides/bank-institution-ids) page lists every ID. type: string rails: description: >- Bank rails available for payouts to this account. `supported` lists rails a currently-available provider advertises for this bank account; Crossmint decides payer eligibility at order time, so an order can still be refused on a rail listed here. `pending` lists rails still being resolved (non-empty only while `status` is 'pending'); `status` is 'pending' while asynchronous rail resolution is still running. Absent when no payout provider serves the account, or when `status` is 'rejected'. properties: pending: description: >- Rails still being resolved. Non-empty only while `status` is `pending`. items: enum: - ach-credit - ach-same-day - ach-us - bi-fast - bre-b - citad - fednow - instapay - napas-247 - nip - pesonet - promptpay - rtp - sepa - sepa-instant - spei - wire type: string type: array status: description: >- `pending` while asynchronous rail resolution is still running. `complete` when every provider has answered. enum: - complete - pending type: string supported: description: >- Rails that a currently-available payout provider advertises for this account. items: enum: - ach-credit - ach-same-day - ach-us - bi-fast - bre-b - citad - fednow - instapay - napas-247 - nip - pesonet - promptpay - rtp - sepa - sepa-instant - spei - wire type: string type: array required: - pending - status - supported type: object verificationStatus: description: >- Result of the provider's check on the destination. Absent until a provider answers. enum: - pending-review - rejected - verified type: string required: - accountSuffix - country - currency - institutionId type: object createdAt: description: ISO 8601 timestamp when this payment method was created. example: '2024-01-15T10:30:00.000Z' format: date-time type: string label: description: >- The client's own name for this payment method, when one was sent. minLength: 1 type: string lastPayoutAt: description: >- Read-only. ISO 8601 timestamp of the most recent successful offramp payout funded by this bank account. Absent if none. example: '2024-01-15T10:30:00.000Z' format: date-time type: string paymentMethodId: description: >- Unique identifier (UUID v4). Crossmint assigns it on creation. minLength: 1 type: string reason: anyOf: - description: >- Deprecated. Use `statusReason`, which carries the same value. type: string - type: 'null' status: description: >- Whether a payout provider serves this destination. 'pending' while the readiness checks run, 'active' when a provider advertises a rail for it, 'rejected' when it cannot receive funds, 'deleted' when it was deleted. This describes the destination only, never the payer's eligibility. 'pending' moves to 'active', 'rejected' or 'deleted'; 'active' moves to 'rejected' or 'deleted'; 'rejected' moves only to 'deleted'. Branch on this field, never on `statusReason`. enum: - active - deleted - pending - rejected type: string statusReason: anyOf: - description: >- Why the status is 'rejected'. Null on every other status, and on a rejection with no established destination condition. Known values today: destination-not-found, destination-closed, destination-cannot-receive, no-rail-available. New codes can appear at any time, so branch on `status` and treat an unrecognised code as the status alone. type: string - type: 'null' type: const: bank-account-th description: >- Payment method type. Selects which sub-object is present: `card`, `bankAccount`, or `breB`. type: string updatedAt: description: >- ISO 8601 timestamp when this payment method was last modified. example: '2024-01-15T10:30:00.000Z' format: date-time type: string required: - bankAccount - createdAt - paymentMethodId - reason - status - statusReason - type - updatedAt title: TH bank account type: object - properties: bankAccount: description: >- Bank account details. Present when `type` is a bank type. Full account numbers and IBANs are never included. properties: accountHolder: description: >- The person or company that owns the bank account. Derived from `billing` when the record predates this field. Its address carries no country: the account's own `country` is the bank's jurisdiction. properties: address: description: >- Address of the account holder, in the country of the account. Present only on types that collect one. properties: city: description: City (max 50 characters). maxLength: 50 minLength: 1 type: string line1: description: Primary address line (max 200 characters). maxLength: 200 minLength: 1 type: string line2: description: >- Secondary address line, such as an apartment, suite, or unit (max 60 characters). maxLength: 60 type: string postalCode: description: Postal or ZIP code (max 20 characters). maxLength: 20 minLength: 1 type: string stateOrRegion: description: >- State, province, or region (max 50 characters). maxLength: 50 type: string required: - city - line1 type: object email: description: Email address of the account holder. format: email pattern: >- ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ type: string name: description: >- Full legal name of the account holder. Sent to the payout provider. minLength: 1 type: string phoneNumber: description: >- Phone number of the account holder in E.164 format. minLength: 1 type: string required: - name type: object accountSuffix: description: >- The last characters of the account number, CLABE or IBAN, at most four. type: string accountType: description: Type of the account. Present when sent on creation. enum: - checking - savings type: string country: const: VN description: Always 'VN'. type: string currency: const: vnd description: >- Always 'vnd'; Vietnamese bank accounts only settle in Vietnamese dong. type: string entityType: description: >- Type of the account holder. Present when sent on creation. enum: - business - individual type: string institutionId: description: >- ID of the bank, for example `vn-acb`. The [Bank Institution IDs](https://docs.crossmint.com/offramp/guides/bank-institution-ids) page lists every ID. type: string rails: description: >- Bank rails available for payouts to this account. `supported` lists rails a currently-available provider advertises for this bank account; Crossmint decides payer eligibility at order time, so an order can still be refused on a rail listed here. `pending` lists rails still being resolved (non-empty only while `status` is 'pending'); `status` is 'pending' while asynchronous rail resolution is still running. Absent when no payout provider serves the account, or when `status` is 'rejected'. properties: pending: description: >- Rails still being resolved. Non-empty only while `status` is `pending`. items: enum: - ach-credit - ach-same-day - ach-us - bi-fast - bre-b - citad - fednow - instapay - napas-247 - nip - pesonet - promptpay - rtp - sepa - sepa-instant - spei - wire type: string type: array status: description: >- `pending` while asynchronous rail resolution is still running. `complete` when every provider has answered. enum: - complete - pending type: string supported: description: >- Rails that a currently-available payout provider advertises for this account. items: enum: - ach-credit - ach-same-day - ach-us - bi-fast - bre-b - citad - fednow - instapay - napas-247 - nip - pesonet - promptpay - rtp - sepa - sepa-instant - spei - wire type: string type: array required: - pending - status - supported type: object verificationStatus: description: >- Result of the provider's check on the destination. Absent until a provider answers. enum: - pending-review - rejected - verified type: string required: - accountSuffix - country - currency - institutionId type: object createdAt: description: ISO 8601 timestamp when this payment method was created. example: '2024-01-15T10:30:00.000Z' format: date-time type: string label: description: >- The client's own name for this payment method, when one was sent. minLength: 1 type: string lastPayoutAt: description: >- Read-only. ISO 8601 timestamp of the most recent successful offramp payout funded by this bank account. Absent if none. example: '2024-01-15T10:30:00.000Z' format: date-time type: string paymentMethodId: description: >- Unique identifier (UUID v4). Crossmint assigns it on creation. minLength: 1 type: string reason: anyOf: - description: >- Deprecated. Use `statusReason`, which carries the same value. type: string - type: 'null' status: description: >- Whether a payout provider serves this destination. 'pending' while the readiness checks run, 'active' when a provider advertises a rail for it, 'rejected' when it cannot receive funds, 'deleted' when it was deleted. This describes the destination only, never the payer's eligibility. 'pending' moves to 'active', 'rejected' or 'deleted'; 'active' moves to 'rejected' or 'deleted'; 'rejected' moves only to 'deleted'. Branch on this field, never on `statusReason`. enum: - active - deleted - pending - rejected type: string statusReason: anyOf: - description: >- Why the status is 'rejected'. Null on every other status, and on a rejection with no established destination condition. Known values today: destination-not-found, destination-closed, destination-cannot-receive, no-rail-available. New codes can appear at any time, so branch on `status` and treat an unrecognised code as the status alone. type: string - type: 'null' type: const: bank-account-vn description: >- Payment method type. Selects which sub-object is present: `card`, `bankAccount`, or `breB`. type: string updatedAt: description: >- ISO 8601 timestamp when this payment method was last modified. example: '2024-01-15T10:30:00.000Z' format: date-time type: string required: - bankAccount - createdAt - paymentMethodId - reason - status - statusReason - type - updatedAt title: VN bank account type: object - properties: bankAccount: description: >- Bank account details. Present when `type` is a bank type. Full account numbers and IBANs are never included. properties: accountHolder: description: >- The person or company that owns the bank account. Derived from `billing` when the record predates this field. Its address carries no country: the account's own `country` is the bank's jurisdiction. properties: address: description: >- Address of the account holder, in the country of the account. Present only on types that collect one. properties: city: description: City (max 50 characters). maxLength: 50 minLength: 1 type: string line1: description: Primary address line (max 200 characters). maxLength: 200 minLength: 1 type: string line2: description: >- Secondary address line, such as an apartment, suite, or unit (max 60 characters). maxLength: 60 type: string postalCode: description: Postal or ZIP code (max 20 characters). maxLength: 20 minLength: 1 type: string stateOrRegion: description: >- State, province, or region (max 50 characters). maxLength: 50 type: string required: - city - line1 type: object email: description: Email address of the account holder. format: email pattern: >- ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ type: string name: description: >- Full legal name of the account holder. Sent to the payout provider. minLength: 1 type: string phoneNumber: description: >- Phone number of the account holder in E.164 format. minLength: 1 type: string required: - name type: object accountSuffix: description: >- The last characters of the account number, CLABE or IBAN, at most four. type: string accountType: description: Type of the account. enum: - checking - savings type: string bankAddress: anyOf: - description: >- Bank's mailing address. `null` when no branch address is on file. properties: city: description: City (max 50 characters). maxLength: 50 minLength: 1 type: string country: description: ISO 3166-1 alpha-2 country code. maxLength: 2 minLength: 2 type: string line1: description: Primary address line (max 200 characters). maxLength: 200 minLength: 1 type: string line2: description: >- Secondary address line, such as an apartment, suite, or unit (max 60 characters). maxLength: 60 type: string postalCode: description: Postal or ZIP code (max 20 characters). maxLength: 20 minLength: 1 type: string stateOrRegion: description: >- State, province, or region (max 50 characters). maxLength: 50 type: string required: - city - country - line1 - postalCode type: object - type: 'null' bankName: anyOf: - description: >- Name of the bank, or `null` if the bank could not be identified. type: string - type: 'null' country: description: ISO 3166-1 alpha-2 country code of the account. enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW type: string currency: const: usd description: >- Always 'usd'; a US bank account only settles in US dollars. type: string entityType: description: >- Type of the account holder. Present when sent on creation. enum: - business - individual type: string rails: description: >- Bank rails available for payouts to this account. `supported` lists rails a currently-available provider advertises for this bank account; Crossmint decides payer eligibility at order time, so an order can still be refused on a rail listed here. `pending` lists rails still being resolved (non-empty only while `status` is 'pending'); `status` is 'pending' while asynchronous rail resolution is still running. Absent when no payout provider serves the account, or when `status` is 'rejected'. properties: pending: description: >- Rails still being resolved. Non-empty only while `status` is `pending`. items: enum: - ach-credit - ach-same-day - ach-us - bi-fast - bre-b - citad - fednow - instapay - napas-247 - nip - pesonet - promptpay - rtp - sepa - sepa-instant - spei - wire type: string type: array status: description: >- `pending` while asynchronous rail resolution is still running. `complete` when every provider has answered. enum: - complete - pending type: string supported: description: >- Rails that a currently-available payout provider advertises for this account. items: enum: - ach-credit - ach-same-day - ach-us - bi-fast - bre-b - citad - fednow - instapay - napas-247 - nip - pesonet - promptpay - rtp - sepa - sepa-instant - spei - wire type: string type: array required: - pending - status - supported type: object routingNumber: description: ABA routing number. type: string verificationStatus: description: >- Result of the provider's check on the destination. Absent until a provider answers. enum: - pending-review - rejected - verified type: string required: - accountSuffix - accountType - bankAddress - bankName - country - currency - routingNumber type: object createdAt: description: ISO 8601 timestamp when this payment method was created. example: '2024-01-15T10:30:00.000Z' format: date-time type: string label: description: >- The client's own name for this payment method, when one was sent. minLength: 1 type: string lastPayoutAt: description: >- Read-only. ISO 8601 timestamp of the most recent successful offramp payout funded by this bank account. Absent if none. example: '2024-01-15T10:30:00.000Z' format: date-time type: string paymentMethodId: description: >- Unique identifier (UUID v4). Crossmint assigns it on creation. minLength: 1 type: string reason: anyOf: - description: >- Deprecated. Use `statusReason`, which carries the same value. type: string - type: 'null' status: description: >- Whether a payout provider serves this destination. 'pending' while the readiness checks run, 'active' when a provider advertises a rail for it, 'rejected' when it cannot receive funds, 'deleted' when it was deleted. This describes the destination only, never the payer's eligibility. 'pending' moves to 'active', 'rejected' or 'deleted'; 'active' moves to 'rejected' or 'deleted'; 'rejected' moves only to 'deleted'. Branch on this field, never on `statusReason`. enum: - active - deleted - pending - rejected type: string statusReason: anyOf: - description: >- Why the status is 'rejected'. Null on every other status, and on a rejection with no established destination condition. Known values today: destination-not-found, destination-closed, destination-cannot-receive, no-rail-available. New codes can appear at any time, so branch on `status` and treat an unrecognised code as the status alone. type: string - type: 'null' type: const: bank-account-us description: >- Payment method type. Selects which sub-object is present: `card`, `bankAccount`, or `breB`. type: string updatedAt: description: >- ISO 8601 timestamp when this payment method was last modified. example: '2024-01-15T10:30:00.000Z' format: date-time type: string required: - bankAccount - createdAt - paymentMethodId - reason - status - statusReason - type - updatedAt title: US bank account type: object - properties: bankAccount: description: >- Bank account details. Present when `type` is a bank type. Full account numbers and IBANs are never included. properties: accountHolder: description: >- The person or company that owns the bank account. Derived from `billing` when the record predates this field. Its address carries no country: the account's own `country` is the bank's jurisdiction. properties: address: description: >- Address of the account holder, in the country of the account. Present only on types that collect one. properties: city: description: City (max 50 characters). maxLength: 50 minLength: 1 type: string line1: description: Primary address line (max 200 characters). maxLength: 200 minLength: 1 type: string line2: description: >- Secondary address line, such as an apartment, suite, or unit (max 60 characters). maxLength: 60 type: string postalCode: description: Postal or ZIP code (max 20 characters). maxLength: 20 minLength: 1 type: string stateOrRegion: description: >- State, province, or region (max 50 characters). maxLength: 50 type: string required: - city - line1 type: object email: description: Email address of the account holder. format: email pattern: >- ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ type: string name: description: >- Full legal name of the account holder. Sent to the payout provider. minLength: 1 type: string phoneNumber: description: >- Phone number of the account holder in E.164 format. minLength: 1 type: string required: - name type: object accountSuffix: description: >- The last characters of the account number, CLABE or IBAN, at most four. type: string bankName: anyOf: - description: >- Name of the bank, or `null` if the bank could not be identified. type: string - type: 'null' bic: description: BIC/SWIFT code. Present when sent on creation. type: string country: description: >- Bank country, derived from the IBAN prefix. EPC SEPA scheme members only. enum: - AD - AL - AT - BE - BG - CH - CY - CZ - DE - DK - EE - ES - FI - FR - GB - GI - GR - HR - HU - IE - IS - IT - LI - LT - LU - LV - MC - MT - NL - 'NO' - PL - PT - RO - SE - SI - SK - SM - VA type: string currency: const: eur description: Always 'eur'; SEPA only transacts in Euro. type: string entityType: description: >- Type of the account holder. Present when sent on creation. enum: - business - individual type: string rails: description: >- Bank rails available for payouts to this account. `supported` lists rails a currently-available provider advertises for this bank account; Crossmint decides payer eligibility at order time, so an order can still be refused on a rail listed here. `pending` lists rails still being resolved (non-empty only while `status` is 'pending'); `status` is 'pending' while asynchronous rail resolution is still running. Absent when no payout provider serves the account, or when `status` is 'rejected'. properties: pending: description: >- Rails still being resolved. Non-empty only while `status` is `pending`. items: enum: - ach-credit - ach-same-day - ach-us - bi-fast - bre-b - citad - fednow - instapay - napas-247 - nip - pesonet - promptpay - rtp - sepa - sepa-instant - spei - wire type: string type: array status: description: >- `pending` while asynchronous rail resolution is still running. `complete` when every provider has answered. enum: - complete - pending type: string supported: description: >- Rails that a currently-available payout provider advertises for this account. items: enum: - ach-credit - ach-same-day - ach-us - bi-fast - bre-b - citad - fednow - instapay - napas-247 - nip - pesonet - promptpay - rtp - sepa - sepa-instant - spei - wire type: string type: array required: - pending - status - supported type: object verificationStatus: description: >- Result of the provider's check on the destination. Absent until a provider answers. enum: - pending-review - rejected - verified type: string required: - accountSuffix - bankName - country - currency type: object createdAt: description: ISO 8601 timestamp when this payment method was created. example: '2024-01-15T10:30:00.000Z' format: date-time type: string default: description: >- Whether this is the default payment method of the user. Only one per user can be the default. A new default unsets the previous one. type: boolean display: description: Display data for a payment method selector. properties: imageUrl: description: URL of the brand logo. format: uri type: string label: description: Label to show in a payment method selector. type: string type: object displayName: description: >- Human-readable label derived from the account details, e.g. "Visa ••1111" or "Deutsche Bank ••6789". minLength: 1 type: string label: description: >- The client's own name for this payment method, when one was sent. minLength: 1 type: string lastPayoutAt: description: >- Read-only. ISO 8601 timestamp of the most recent successful offramp payout funded by this bank account. Absent if none. example: '2024-01-15T10:30:00.000Z' format: date-time type: string paymentMethodId: description: >- Unique identifier (UUID v4). Crossmint assigns it on creation. minLength: 1 type: string reason: anyOf: - description: >- Deprecated. Use `statusReason`, which carries the same value. type: string - type: 'null' status: description: >- Whether a payout provider serves this destination. 'pending' while the readiness checks run, 'active' when a provider advertises a rail for it, 'rejected' when it cannot receive funds, 'deleted' when it was deleted. This describes the destination only, never the payer's eligibility. 'pending' moves to 'active', 'rejected' or 'deleted'; 'active' moves to 'rejected' or 'deleted'; 'rejected' moves only to 'deleted'. Branch on this field, never on `statusReason`. enum: - active - deleted - pending - rejected type: string statusReason: anyOf: - description: >- Why the status is 'rejected'. Null on every other status, and on a rejection with no established destination condition. Known values today: destination-not-found, destination-closed, destination-cannot-receive, no-rail-available. New codes can appear at any time, so branch on `status` and treat an unrecognised code as the status alone. type: string - type: 'null' type: const: bank-account-sepa-iban description: >- Payment method type. Selects which sub-object is present: `card`, `bankAccount`, or `breB`. type: string updatedAt: description: >- ISO 8601 timestamp when this payment method was last modified. example: '2024-01-15T10:30:00.000Z' format: date-time type: string required: - bankAccount - createdAt - displayName - paymentMethodId - reason - status - statusReason - type - updatedAt title: SEPA IBAN type: object - properties: breB: additionalProperties: false description: >- Bre-B key details. Present when `type` is `bre-b`. The key itself is never returned. properties: accountHolder: description: >- The person or company that owns the bank account. Derived from `billing` when the record predates this field. Its address carries no country: the account's own `country` is the bank's jurisdiction. properties: address: description: >- Address of the account holder, in the country of the account. Present only on types that collect one. properties: city: description: City (max 50 characters). maxLength: 50 minLength: 1 type: string line1: description: Primary address line (max 200 characters). maxLength: 200 minLength: 1 type: string line2: description: >- Secondary address line, such as an apartment, suite, or unit (max 60 characters). maxLength: 60 type: string postalCode: description: Postal or ZIP code (max 20 characters). maxLength: 20 minLength: 1 type: string stateOrRegion: description: >- State, province, or region (max 50 characters). maxLength: 50 type: string required: - city - line1 type: object email: description: Email address of the account holder. format: email pattern: >- ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ type: string name: description: >- Full legal name of the account holder. Sent to the payout provider. minLength: 1 type: string phoneNumber: description: >- Phone number of the account holder in E.164 format. minLength: 1 type: string required: - name type: object accountSuffix: description: >- Masked form of the key. An e-mail key is masked in place; every other key shows its last four characters. The key itself is never returned. type: string country: description: Always `CO`. enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW type: string currency: const: cop description: Always 'cop'; Bre-B only settles in Colombian pesos. type: string entityType: description: >- Type of the account holder. Present when sent on creation. enum: - business - individual type: string institutionName: description: >- Display name of the institution holding the key. Absent until a name source answers. type: string keyType: description: >- Derived from the key's format, never asserted by the client. Best effort. enum: - alphanumeric - commerce - email - identification - phone type: string rails: description: >- Rails a currently-available provider advertises for this key. properties: supported: description: >- Rails that a currently-available payout provider advertises for this account. items: enum: - ach-credit - ach-same-day - ach-us - bi-fast - bre-b - citad - fednow - instapay - napas-247 - nip - pesonet - promptpay - rtp - sepa - sepa-instant - spei - wire type: string type: array required: - supported type: object verificationStatus: description: >- Result of the provider's check on the destination. Absent until a provider answers. enum: - pending-review - rejected - verified type: string required: - accountSuffix - country - currency type: object createdAt: description: ISO 8601 timestamp when this payment method was created. example: '2024-01-15T10:30:00.000Z' format: date-time type: string label: description: >- The client's own name for this payment method, when one was sent. minLength: 1 type: string lastPayoutAt: description: >- Read-only. ISO 8601 timestamp of the most recent successful offramp payout funded by this bank account. Absent if none. example: '2024-01-15T10:30:00.000Z' format: date-time type: string paymentMethodId: description: >- Unique identifier (UUID v4). Crossmint assigns it on creation. minLength: 1 type: string reason: anyOf: - description: >- Deprecated. Use `statusReason`, which carries the same value. type: string - type: 'null' status: description: >- Whether a payout provider serves this destination. 'pending' while the readiness checks run, 'active' when a provider advertises a rail for it, 'rejected' when it cannot receive funds, 'deleted' when it was deleted. This describes the destination only, never the payer's eligibility. 'pending' moves to 'active', 'rejected' or 'deleted'; 'active' moves to 'rejected' or 'deleted'; 'rejected' moves only to 'deleted'. Branch on this field, never on `statusReason`. enum: - active - deleted - pending - rejected type: string statusReason: anyOf: - description: >- Why the status is 'rejected'. Null on every other status, and on a rejection with no established destination condition. Known values today: destination-not-found, destination-closed, destination-cannot-receive, no-rail-available. New codes can appear at any time, so branch on `status` and treat an unrecognised code as the status alone. type: string - type: 'null' type: const: bre-b description: >- Payment method type. A Bre-B key returns its details under `breB`, never `bankAccount`. type: string updatedAt: description: >- ISO 8601 timestamp when this payment method was last modified. example: '2024-01-15T10:30:00.000Z' format: date-time type: string required: - breB - createdAt - paymentMethodId - reason - status - statusReason - type - updatedAt title: CO Bre-B key type: object - properties: card: description: Card details. Present when `type` is `card`. properties: billing: description: >- Billing details of the cardholder, as sent on creation. properties: address: description: >- Billing address. When you send it, all fields except `line2` are required. properties: city: description: City (max 50 characters). maxLength: 50 minLength: 1 type: string country: description: ISO 3166-1 alpha-2 country code. maxLength: 2 minLength: 2 type: string line1: description: Primary address line (max 200 characters). maxLength: 200 minLength: 1 type: string line2: description: >- Secondary address line, such as an apartment, suite, or unit (max 60 characters). maxLength: 60 type: string postalCode: description: Postal or ZIP code (max 20 characters). maxLength: 20 minLength: 1 type: string stateOrRegion: description: >- State, province, or region (max 50 characters). maxLength: 50 type: string required: - city - country - line1 - postalCode type: object name: description: Full name of the cardholder or account holder. minLength: 1 type: string phone: description: >- Phone number in E.164 format, for example `+12125551234`. minLength: 1 type: string required: - name type: object bin: description: >- Bank Identification Number (first 6-8 digits). Present when the card network provides it. type: string brand: description: Card network brand, detected from the card number. enum: - amex - diners-club - discover - jcb - mastercard - unionpay - visa type: string country: description: >- ISO 3166-1 alpha-2 code of the country that issued the card. Present when the card network provides it. type: string expiration: description: Card expiration date. properties: month: description: 2-digit expiration month, zero-padded (`01`-`12`). type: string year: description: 4-digit expiration year. type: string required: - month - year type: object fundingType: description: >- Card funding type, detected from the BIN. Present when the issuer provides it. enum: - credit - debit - prepaid - unknown type: string last4: description: Last 4 digits of the card PAN. type: string required: - billing - brand - expiration - last4 type: object createdAt: description: ISO 8601 timestamp when this payment method was created. example: '2024-01-15T10:30:00.000Z' format: date-time type: string default: description: >- Whether this is the default payment method of the user. Only one per user can be the default. A new default unsets the previous one. type: boolean display: description: Display data for a payment method selector. properties: imageUrl: description: URL of the brand logo. format: uri type: string label: description: Label to show in a payment method selector. type: string type: object displayName: description: >- Human-readable label derived from the account details, e.g. "Visa ••1111" or "Deutsche Bank ••6789". minLength: 1 type: string paymentMethodId: description: >- Unique identifier (UUID v4). Crossmint assigns it on creation. minLength: 1 type: string type: const: card description: >- Payment method type. Selects which sub-object is present: `card`, `bankAccount`, or `breB`. type: string updatedAt: description: >- ISO 8601 timestamp when this payment method was last modified. example: '2024-01-15T10:30:00.000Z' format: date-time type: string required: - card - createdAt - displayName - paymentMethodId - type - updatedAt title: Card type: object type: array nextCursor: anyOf: - description: >- Cursor to fetch the next page. Absent or `null` when there are no more results. type: string - type: 'null' previousCursor: anyOf: - description: >- Cursor to fetch the previous page. Absent or `null` on the first page. type: string - type: 'null' required: - data type: object ApiErrorDto: properties: code: description: Machine-readable error code for programmatic handling type: string error: example: true type: boolean message: description: Human-readable error message describing what went wrong type: string parameters: additionalProperties: oneOf: - items: type: string type: array - type: string description: >- Values that explain a coded error, such as the limit that was exceeded, the amount that remains, or the list of supported currencies. type: object required: - error - message type: object securitySchemes: apiKey: description: API key required for authentication in: header name: X-API-KEY type: apiKey userJwt: bearerFormat: JWT description: >- The end user's JWT, sent as `Authorization: Bearer ` together with a client-side API key. Validated against the project's external JWT configuration. scheme: bearer type: http ````