The end user's JWT, sent as Authorization: Bearer <JWT> together with a client-side API key. Validated against the project's external JWT configuration.
Identifies the target user when authenticating with a server API key. Format: <type>:<value> (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).
Response
The payment method in its terminal state. A deleted payment method stays readable through Retrieve Payment Method, and through List Payment Methods with status=deleted.
CO bank account
MX CLABE
AE bank account
ID bank account
IL bank account
JO bank account
NG bank account
PH bank account
TH bank account
TR bank account
VN bank account
US bank account
SEPA IBAN
CR bank account
CO Bre-B key
Card
A saved payment method. Sensitive fields (full PAN, CVC, full account numbers, IBANs, Bre-B keys) are never included.
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.
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.
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"
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Crossmint Docs","colors":{"primary":"#36b37e","light":"#87ff8f","dark":"#001d01"},"logo":{"light":"https://mintcdn.com/crossmint/a8gPOTKEuVFcSfC3/logo/crossmint-light.png?fit=max\u0026auto=format\u0026n=a8gPOTKEuVFcSfC3\u0026q=85\u0026s=8c2671e4c8f7da6956e1508bd68c2928","dark":"https://mintcdn.com/crossmint/a8gPOTKEuVFcSfC3/logo/crossmint-dark.png?fit=max\u0026auto=format\u0026n=a8gPOTKEuVFcSfC3\u0026q=85\u0026s=272ecc17664d17b9ff24471758ff80b2"},"favicon":"https://mintcdn.com/crossmint/xq66q9GV6z6jjj95/favicon.png?fit=max\u0026auto=format\u0026n=xq66q9GV6z6jjj95\u0026q=85\u0026s=00fb89ddf6ba5b1022b9307039c08006","api":{"openapi":["api-reference/_open-api/MintingAPIs.json","api-reference/_open-api/AdminAPIs.json","api-reference/_open-api/VerifiableCredentialsAPIs.json","api-reference/_open-api/Wallets.json"],"examples":{"prefill":true}},"background":{"color":{"dark":"#090b0c"}},"navbar":{"links":[{"href":"https://www.crossmint.com/contact","label":"Support"},{"href":"https://staging.crossmint.com/console","label":"Staging Console"}],"primary":{"type":"button","label":"Console","href":"https://www.crossmint.com/console"}},"footer":{"socials":{"website":"https://www.crossmint.com","twitter":"https://twitter.com/crossmint","github":"https://github.com/crossmint"}},"integrations":{"ga4":{"measurementId":"G-CP5EDD6GVT"},"posthog":{"apiKey":"phc_tfgodwfjuO9v3Nw0tIWJNzACoi2opL7X2Ly0Mg2UCTz","apiHost":"https://eu.i.posthog.com","sessionRecording":false}},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"crossmint","hasAudioNarration":false,"actualSubdomain":"crossmint","customDomains":["docs.crossmint.com"],"gitSource":{"type":"github","owner":"paella-labs","repo":"crossbit-main","deployBranch":"main","contentDirectory":"apps/crossmint-mintlify-docs/src","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"edits":true,"issues":true,"contextualFeedback":{"allowEmail":true},"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af6194b49f0bda3596b1bf2","clientVersion":"0.0.4117","searchFilterCounts":[{"language":"default","tag":"API Reference","count":1094},{"language":"default","tag":"Wallets","count":870},{"language":"default","tag":"Kotlin SDK","count":427},{"language":"default","tag":"Swift SDK","count":237},{"language":"default","tag":"Checkout","count":196},{"language":"default","tag":"Classes","count":182},{"language":"default","tag":"Data Classes","count":182},{"language":"default","tag":"Typescript SDK","count":156},{"language":"default","tag":"Guides","count":134},{"language":"default","tag":"Structs","count":127}]},"assistantConfig":{"enableAskAiButton":true,"enableStarterQuestions":false,"enableAskAiSearchBar":false,"deflection":{"enabled":true,"type":"link","url":"https://www.crossmint.com/contact/sales"}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":".tab-container [data-component-part=\"tabs-list\"]{flex-wrap:wrap;overflow:visible;row-gap:0.25rem}.tab-container [data-component-part=\"tabs-list\"]>li{white-space:nowrap}.nav-dropdown-item,.nav-dropdown-item *{font-weight:500!important;color:rgb(75, 85, 99)!important}.nav-dropdown-item:hover,.nav-dropdown-item:hover *{color:rgb(31, 41, 55)!important}.dark .nav-dropdown-item,.dark .nav-dropdown-item *{color:rgb(156, 163, 175)!important}.dark .nav-dropdown-item:hover,.dark .nav-dropdown-item:hover *{color:rgb(209, 213, 219)!important}"}],"page":{"pagePath":"api-reference/headless/payment-methods/delete-payment-method","slug":"/api-reference/headless/payment-methods/delete-payment-method","pageMetadata":{"title":"Delete a Payment Method","description":"Soft-delete a payment method. The record is retained for compliance but can no longer be used.","openapi":"api-reference/_open-api/PaymentMethods.json DELETE /2026-09-16/payment-methods/{paymentMethodId}","href":"/api-reference/headless/payment-methods/delete-payment-method"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Soft-delete a payment method. The record is retained for compliance but can no longer be used.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,p:`p`,..._provideComponents(),...props.components},{Heading}=_components;if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Deletes a payment method. The record is retained internally but can no longer be used for payments.`}),`\n`,_jsx(Heading,{level:`2`,id:`returns`,children:`Returns`}),`\n`,_jsxs(_components.p,{children:[`Returns the `,_jsx(_components.a,{href:`/api-reference/headless/payment-methods/payment-method-object`,children:`PaymentMethod`}),` object.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Delete a Payment Method","description":"Soft-delete a payment method. The record is retained for compliance but can no longer be used.","openapi":"api-reference/_open-api/PaymentMethods.json DELETE /2026-09-16/payment-methods/{paymentMethodId}","href":"/api-reference/headless/payment-methods/delete-payment-method"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Returns","slug":"returns","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/crossmint/d1c432d03c0c4224/scripts/dd.js","/_mintlify/custom/crossmint/7fc8d54052d3edb0/scripts/hubspot.js"],"openApiReferenceData":{"operation":{"description":"Soft-delete a payment method. The record is retained for compliance but can no longer be used.","operationId":"paymentMethods.v20260916.delete","parameters":["c9f1e472-7aa0-4aaa-b58e-b858eeecf693","159c43c3-5106-4705-9706-3e8ffc292ff8"],"responses":{"200":"1f437008-e65a-4248-bd77-441e492f19f5","400":"5c5a1889-d46d-4e32-a711-6fc3117b41ca","401":"5a52dca4-7ea9-4525-8bba-d277ad656dea","403":"695ba2c2-ee1d-4bcb-b94e-eb95b61d3b5e","404":"102f01b5-bcb8-431e-9e35-7358f07e1e1f","429":"13fef9a6-9ceb-40ca-aade-8718805905b5"},"security":["9f3134a2-12de-410a-90a5-7015a77b5fc7","0df25c77-29ae-41bf-80ad-f7f1c9de21d2"],"summary":"Delete Payment Method","tags":["Payment Methods"],"method":"delete","type":"path","servers":["75a471e9-7838-4879-bd63-8640830acbb3","e573971d-7d12-4f8a-b9be-d4104ff32462"],"path":"/2026-09-16/payment-methods/{paymentMethodId}","baseUrlOptions":["https://staging.crossmint.com/api","https://www.crossmint.com/api"],"title":"Delete Payment Method","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[]},"dependencies":{"parameters":{"c9f1e472-7aa0-4aaa-b58e-b858eeecf693":{"description":"UUID of the payment method.","in":"path","name":"paymentMethodId","required":true,"schema":{"type":"string","isRequired":true,"description":"UUID of the payment method.","uniqueKey":"","typeLabel":"string"}},"159c43c3-5106-4705-9706-3e8ffc292ff8":{"description":"Identifies the target user when authenticating with a server API key. Format: `\u003ctype>:\u003cvalue>` (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":{"type":"string","isRequired":false,"description":"Identifies the target user when authenticating with a server API key. Format: `\u003ctype>:\u003cvalue>` (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).","uniqueKey":"","typeLabel":"string"}}},"responses":{"1f437008-e65a-4248-bd77-441e492f19f5":{"content":{"application/json":{"examples":{"BankAccountCo":{"title":"BankAccountCo","value":{"bankAccount":{"accountHolder":{"document":{"suffix":"7890","type":"cc"},"name":"Carlos Gómez"},"accountSuffix":"7890","accountType":"savings","country":"CO","currency":"cop","entityType":"individual","institutionId":"co-bancolombia"},"createdAt":"2026-08-20T19:10:00.000Z","paymentMethodId":"1cad2281-bd3d-4219-8787-7dfea94c60b1","reason":null,"status":"deleted","statusReason":null,"type":"bank-account-co","updatedAt":"2026-08-20T19:12:11.000Z"}},"BankAccountMx":{"title":"BankAccountMx","value":{"bankAccount":{"accountHolder":{"name":"Luis Gomez Rios","phoneNumber":"+525512345678"},"accountSuffix":"7899","country":"MX","currency":"mxn","entityType":"individual"},"createdAt":"2026-08-20T19:10:00.000Z","paymentMethodId":"27bacbe1-d0ff-4bc3-b37a-ca91cc64fa39","reason":null,"status":"deleted","statusReason":null,"type":"bank-account-mx-clabe","updatedAt":"2026-08-20T19:12:11.000Z"}},"BankAccountPh":{"title":"BankAccountPh","value":{"bankAccount":{"accountHolder":{"name":"Maria Santos","phoneNumber":"+639171234567"},"accountSuffix":"8901","country":"PH","currency":"php","entityType":"individual","institutionId":"ph-unionbank"},"createdAt":"2026-09-23T09:00:00.000Z","paymentMethodId":"5e2b7c41-9d0a-4f3b-8c6d-2a1b3c4d5e6f","reason":null,"status":"deleted","statusReason":null,"type":"bank-account-ph","updatedAt":"2026-09-23T09:00:12.000Z"}},"BankAccountUs":{"title":"BankAccountUs","value":{"bankAccount":{"accountHolder":{"name":"Alice Smith"},"accountSuffix":"7899","accountType":"checking","bankAddress":{"city":"New York","line1":"123 Main St","postalCode":"10001","stateOrRegion":"NY"},"country":"US","currency":"usd","entityType":"individual","routingNumber":"071000013"},"createdAt":"2026-08-20T19:10:00.000Z","paymentMethodId":"dd8a59c6-aac0-47c2-9c21-686caf7f0359","reason":null,"status":"deleted","statusReason":null,"type":"bank-account-us","updatedAt":"2026-08-20T19:12:11.000Z"}},"Breb":{"title":"Breb","value":{"breB":{"accountHolder":{"name":"Carlos Gómez","phoneNumber":"+573001234567"},"accountSuffix":"CDKS","country":"CO","currency":"cop","entityType":"individual","keyType":"alphanumeric"},"createdAt":"2026-08-20T19:10:00.000Z","paymentMethodId":"9f1a6b2c-3d4e-4f50-9a61-2b3c4d5e6f70","reason":null,"status":"deleted","statusReason":null,"type":"bre-b","updatedAt":"2026-08-20T19:12:11.000Z"}},"Card":{"title":"Card","value":{"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":false,"displayName":"Visa ••1111","paymentMethodId":"d4e5f6a7-b8c9-0123-def4-567890abcdef","reason":null,"status":"deleted","statusReason":null,"type":"card","updatedAt":"2026-08-20T19:12:11.000Z"}},"SEPA":{"title":"SEPA","value":{"bankAccount":{"accountHolder":{"country":"DE","name":"Hans Müller"},"accountSuffix":"6789","bic":"COBADEFFXXX","country":"DE","currency":"eur","entityType":"individual"},"createdAt":"2026-08-20T19:10:00.000Z","default":false,"paymentMethodId":"3323460b-d9d2-4ec6-b380-8a3e01e3f226","reason":null,"status":"deleted","statusReason":null,"type":"bank-account-sepa-iban","updatedAt":"2026-08-20T19:12:11.000Z"}}},"schema":{"oneOf":[{"type":"object","title":"CO bank account","description":"A saved payment method. Sensitive fields (full PAN, CVC, full account numbers, IBANs, Bre-B keys) are never included.","required":["bankAccount","createdAt","paymentMethodId","reason","status","statusReason","type","updatedAt"],"example":{"createdAt":"2025-01-15T10:30:00.000Z","paymentMethodId":"3f7a9c10-2a8b-4c5d-9e2f-1b3a4c5d6e7f","reason":null,"status":"active","statusReason":null,"type":"card","updatedAt":"2025-01-15T10:30:00.000Z"},"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","isRequired":true,"uniqueKey":"oneOf.0.bankAccount.accountHolder.document.suffix","typeLabel":"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","isRequired":true,"uniqueKey":"oneOf.0.bankAccount.accountHolder.document.type","typeLabel":"enum\u003cstring>"}},"required":["suffix","type"],"type":"object","isRequired":true,"uniqueKey":"oneOf.0.bankAccount.accountHolder.document","typeLabel":"object"},"name":{"description":"Full legal name of the account holder. Sent to the payout provider.","minLength":1,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.bankAccount.accountHolder.name","typeLabel":"string"},"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","uniqueKey":"oneOf.0.bankAccount.accountHolder.email","typeLabel":"string\u003cemail>"},"phoneNumber":{"description":"Phone number of the account holder in E.164 format.","minLength":1,"type":"string","uniqueKey":"oneOf.0.bankAccount.accountHolder.phoneNumber","typeLabel":"string"}},"required":["document","name"],"type":"object","isRequired":true,"uniqueKey":"oneOf.0.bankAccount.accountHolder","typeLabel":"object"},"accountSuffix":{"description":"The last characters of the account number, CLABE or IBAN, at most four.","type":"string","isRequired":true,"uniqueKey":"oneOf.0.bankAccount.accountSuffix","typeLabel":"string"},"accountType":{"description":"Type of the account.","enum":["checking","electronic-deposit","savings"],"type":"string","isRequired":true,"uniqueKey":"oneOf.0.bankAccount.accountType","typeLabel":"enum\u003cstring>"},"country":{"const":"CO","description":"Always `CO`.","type":"string","isRequired":true,"uniqueKey":"oneOf.0.bankAccount.country","typeLabel":"string"},"currency":{"const":"cop","description":"Always 'cop'; a Colombian bank account only settles in Colombian pesos.","type":"string","isRequired":true,"uniqueKey":"oneOf.0.bankAccount.currency","typeLabel":"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","isRequired":true,"uniqueKey":"oneOf.0.bankAccount.institutionId","typeLabel":"string"},"entityType":{"description":"Type of the account holder. Present when sent on creation.","enum":["business","individual"],"type":"string","uniqueKey":"oneOf.0.bankAccount.entityType","typeLabel":"enum\u003cstring>"},"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","bi-fast","bre-b","cash-pickup","citad","eft","fast","fednow","fedwire","instapay","napas-247","nip","npss","pesonet","promptpay","rtp-credit","same-day-ach-credit","sct","sct-inst","sinpe","spei","uaefts","zahav"],"type":"string","uniqueKey":"oneOf.0.bankAccount.rails.pending.items.[INDEX]","typeLabel":"enum\u003cstring>"},"type":"array","isRequired":true,"uniqueKey":"oneOf.0.bankAccount.rails.pending","typeLabel":"enum\u003cstring>[]"},"status":{"description":"`pending` while asynchronous rail resolution is still running. `complete` when every provider has answered.","enum":["complete","pending"],"type":"string","isRequired":true,"uniqueKey":"oneOf.0.bankAccount.rails.status","typeLabel":"enum\u003cstring>"},"supported":{"description":"Rails that a currently-available payout provider advertises for this account.","items":{"enum":["ach-credit","bi-fast","bre-b","cash-pickup","citad","eft","fast","fednow","fedwire","instapay","napas-247","nip","npss","pesonet","promptpay","rtp-credit","same-day-ach-credit","sct","sct-inst","sinpe","spei","uaefts","zahav"],"type":"string","uniqueKey":"oneOf.0.bankAccount.rails.supported.items.[INDEX]","typeLabel":"enum\u003cstring>"},"type":"array","isRequired":true,"uniqueKey":"oneOf.0.bankAccount.rails.supported","typeLabel":"enum\u003cstring>[]"}},"required":["pending","status","supported"],"type":"object","uniqueKey":"oneOf.0.bankAccount.rails","typeLabel":"object"},"verificationStatus":{"description":"Result of the provider's check on the destination. Absent until a provider answers.","enum":["pending-review","rejected","verified"],"type":"string","uniqueKey":"oneOf.0.bankAccount.verificationStatus","typeLabel":"enum\u003cstring>"}},"required":["accountHolder","accountSuffix","accountType","country","currency","institutionId"],"type":"object","isRequired":true,"uniqueKey":"oneOf.0.bankAccount","typeLabel":"object"},"createdAt":{"description":"ISO 8601 timestamp when this payment method was created.","example":"2024-01-15T10:30:00.000Z","format":"date-time","type":"string","isRequired":true,"uniqueKey":"oneOf.0.createdAt","typeLabel":"string\u003cdate-time>"},"paymentMethodId":{"description":"Unique identifier (UUID v4). Crossmint assigns it on creation.","minLength":1,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.paymentMethodId","typeLabel":"string"},"reason":{"oneOf":[{"type":"string","description":"Deprecated. Use `statusReason`, which carries the same value.","isRequired":true,"uniqueKey":"oneOf.0.reason.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.0.reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.reason","typeLabel":"string | 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","isRequired":true,"uniqueKey":"oneOf.0.status","typeLabel":"enum\u003cstring>"},"statusReason":{"oneOf":[{"type":"string","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.","isRequired":true,"uniqueKey":"oneOf.0.statusReason.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.0.statusReason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.statusReason","typeLabel":"string | null"},"type":{"const":"bank-account-co","description":"Payment method type. Selects which sub-object is present: `card`, `bankAccount`, or `breB`.","type":"string","isRequired":true,"uniqueKey":"oneOf.0.type","typeLabel":"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","isRequired":true,"uniqueKey":"oneOf.0.updatedAt","typeLabel":"string\u003cdate-time>"},"label":{"description":"The client's own name for this payment method, when one was sent.","minLength":1,"type":"string","uniqueKey":"oneOf.0.label","typeLabel":"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","uniqueKey":"oneOf.0.lastPayoutAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"oneOf.0","typeLabel":"CO bank account · object"},{"type":"object","title":"MX CLABE","description":"A saved payment method. Sensitive fields (full PAN, CVC, full account numbers, IBANs, Bre-B keys) are never included.","required":["bankAccount","createdAt","paymentMethodId","reason","status","statusReason","type","updatedAt"],"example":{"createdAt":"2025-01-15T10:30:00.000Z","paymentMethodId":"3f7a9c10-2a8b-4c5d-9e2f-1b3a4c5d6e7f","reason":null,"status":"active","statusReason":null,"type":"card","updatedAt":"2025-01-15T10:30:00.000Z"},"properties":{"bankAccount":{"additionalProperties":false,"description":"Bank account details. Present when `type` is a bank type. Full account numbers and IBANs are never included.","properties":{"accountSuffix":{"description":"The last characters of the account number, CLABE or IBAN, at most four.","type":"string","isRequired":true,"uniqueKey":"oneOf.1.bankAccount.accountSuffix","typeLabel":"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","isRequired":true,"uniqueKey":"oneOf.1.bankAccount.country","typeLabel":"enum\u003cstring>"},"currency":{"const":"mxn","description":"Always 'mxn'; a CLABE only settles in Mexican pesos.","type":"string","isRequired":true,"uniqueKey":"oneOf.1.bankAccount.currency","typeLabel":"string"},"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":{"name":{"description":"Full legal name of the account holder. Sent to the payout provider.","minLength":1,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.bankAccount.accountHolder.name","typeLabel":"string"},"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","isRequired":true,"uniqueKey":"oneOf.1.bankAccount.accountHolder.address.city","typeLabel":"string"},"line1":{"description":"Primary address line (max 200 characters).","maxLength":200,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.bankAccount.accountHolder.address.line1","typeLabel":"string"},"line2":{"description":"Secondary address line, such as an apartment, suite, or unit (max 60 characters).","maxLength":60,"type":"string","uniqueKey":"oneOf.1.bankAccount.accountHolder.address.line2","typeLabel":"string"},"postalCode":{"description":"Postal or ZIP code (max 20 characters).","maxLength":20,"minLength":1,"type":"string","uniqueKey":"oneOf.1.bankAccount.accountHolder.address.postalCode","typeLabel":"string"},"stateOrRegion":{"description":"State, province, or region (max 50 characters).","maxLength":50,"type":"string","uniqueKey":"oneOf.1.bankAccount.accountHolder.address.stateOrRegion","typeLabel":"string"}},"required":["city","line1"],"type":"object","uniqueKey":"oneOf.1.bankAccount.accountHolder.address","typeLabel":"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","uniqueKey":"oneOf.1.bankAccount.accountHolder.email","typeLabel":"string\u003cemail>"},"phoneNumber":{"description":"Phone number of the account holder in E.164 format.","minLength":1,"type":"string","uniqueKey":"oneOf.1.bankAccount.accountHolder.phoneNumber","typeLabel":"string"}},"required":["name"],"type":"object","uniqueKey":"oneOf.1.bankAccount.accountHolder","typeLabel":"object"},"entityType":{"description":"Type of the account holder. Present when sent on creation.","enum":["business","individual"],"type":"string","uniqueKey":"oneOf.1.bankAccount.entityType","typeLabel":"enum\u003cstring>"},"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","bi-fast","bre-b","cash-pickup","citad","eft","fast","fednow","fedwire","instapay","napas-247","nip","npss","pesonet","promptpay","rtp-credit","same-day-ach-credit","sct","sct-inst","sinpe","spei","uaefts","zahav"],"type":"string","uniqueKey":"oneOf.1.bankAccount.rails.pending.items.[INDEX]","typeLabel":"enum\u003cstring>"},"type":"array","isRequired":true,"uniqueKey":"oneOf.1.bankAccount.rails.pending","typeLabel":"enum\u003cstring>[]"},"status":{"description":"`pending` while asynchronous rail resolution is still running. `complete` when every provider has answered.","enum":["complete","pending"],"type":"string","isRequired":true,"uniqueKey":"oneOf.1.bankAccount.rails.status","typeLabel":"enum\u003cstring>"},"supported":{"description":"Rails that a currently-available payout provider advertises for this account.","items":{"enum":["ach-credit","bi-fast","bre-b","cash-pickup","citad","eft","fast","fednow","fedwire","instapay","napas-247","nip","npss","pesonet","promptpay","rtp-credit","same-day-ach-credit","sct","sct-inst","sinpe","spei","uaefts","zahav"],"type":"string","uniqueKey":"oneOf.1.bankAccount.rails.supported.items.[INDEX]","typeLabel":"enum\u003cstring>"},"type":"array","isRequired":true,"uniqueKey":"oneOf.1.bankAccount.rails.supported","typeLabel":"enum\u003cstring>[]"}},"required":["pending","status","supported"],"type":"object","uniqueKey":"oneOf.1.bankAccount.rails","typeLabel":"object"},"verificationStatus":{"description":"Result of the provider's check on the destination. Absent until a provider answers.","enum":["pending-review","rejected","verified"],"type":"string","uniqueKey":"oneOf.1.bankAccount.verificationStatus","typeLabel":"enum\u003cstring>"}},"required":["accountSuffix","country","currency"],"type":"object","isRequired":true,"uniqueKey":"oneOf.1.bankAccount","typeLabel":"object"},"createdAt":{"description":"ISO 8601 timestamp when this payment method was created.","example":"2024-01-15T10:30:00.000Z","format":"date-time","type":"string","isRequired":true,"uniqueKey":"oneOf.1.createdAt","typeLabel":"string\u003cdate-time>"},"paymentMethodId":{"description":"Unique identifier (UUID v4). Crossmint assigns it on creation.","minLength":1,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.paymentMethodId","typeLabel":"string"},"reason":{"oneOf":[{"type":"string","description":"Deprecated. Use `statusReason`, which carries the same value.","isRequired":true,"uniqueKey":"oneOf.1.reason.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.1.reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.reason","typeLabel":"string | 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","isRequired":true,"uniqueKey":"oneOf.1.status","typeLabel":"enum\u003cstring>"},"statusReason":{"oneOf":[{"type":"string","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.","isRequired":true,"uniqueKey":"oneOf.1.statusReason.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.1.statusReason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.statusReason","typeLabel":"string | null"},"type":{"const":"bank-account-mx-clabe","description":"Payment method type. Selects which sub-object is present: `card`, `bankAccount`, or `breB`.","type":"string","isRequired":true,"uniqueKey":"oneOf.1.type","typeLabel":"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","isRequired":true,"uniqueKey":"oneOf.1.updatedAt","typeLabel":"string\u003cdate-time>"},"label":{"description":"The client's own name for this payment method, when one was sent.","minLength":1,"type":"string","uniqueKey":"oneOf.1.label","typeLabel":"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","uniqueKey":"oneOf.1.lastPayoutAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"oneOf.1","typeLabel":"MX CLABE · object"},{"type":"object","title":"AE bank account","description":"A saved payment method. Sensitive fields (full PAN, CVC, full account numbers, IBANs, Bre-B keys) are never included.","required":["bankAccount","createdAt","paymentMethodId","reason","status","statusReason","type","updatedAt"],"example":{"createdAt":"2025-01-15T10:30:00.000Z","paymentMethodId":"3f7a9c10-2a8b-4c5d-9e2f-1b3a4c5d6e7f","reason":null,"status":"active","statusReason":null,"type":"card","updatedAt":"2025-01-15T10:30:00.000Z"},"properties":{"bankAccount":{"description":"Bank account details. Present when `type` is a bank type. Full account numbers and IBANs are never included.","properties":{"accountSuffix":{"description":"The last characters of the account number, CLABE or IBAN, at most four.","type":"string","isRequired":true,"uniqueKey":"oneOf.2.bankAccount.accountSuffix","typeLabel":"string"},"country":{"const":"AE","description":"Always 'AE'.","type":"string","isRequired":true,"uniqueKey":"oneOf.2.bankAccount.country","typeLabel":"string"},"currency":{"const":"aed","description":"Always 'aed'; UAE bank accounts only settle in UAE dirhams.","type":"string","isRequired":true,"uniqueKey":"oneOf.2.bankAccount.currency","typeLabel":"string"},"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":{"name":{"description":"Full legal name of the account holder. Sent to the payout provider.","minLength":1,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.bankAccount.accountHolder.name","typeLabel":"string"},"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","isRequired":true,"uniqueKey":"oneOf.2.bankAccount.accountHolder.address.city","typeLabel":"string"},"line1":{"description":"Primary address line (max 200 characters).","maxLength":200,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.bankAccount.accountHolder.address.line1","typeLabel":"string"},"line2":{"description":"Secondary address line, such as an apartment, suite, or unit (max 60 characters).","maxLength":60,"type":"string","uniqueKey":"oneOf.2.bankAccount.accountHolder.address.line2","typeLabel":"string"},"postalCode":{"description":"Postal or ZIP code (max 20 characters).","maxLength":20,"minLength":1,"type":"string","uniqueKey":"oneOf.2.bankAccount.accountHolder.address.postalCode","typeLabel":"string"},"stateOrRegion":{"description":"State, province, or region (max 50 characters).","maxLength":50,"type":"string","uniqueKey":"oneOf.2.bankAccount.accountHolder.address.stateOrRegion","typeLabel":"string"}},"required":["city","line1"],"type":"object","uniqueKey":"oneOf.2.bankAccount.accountHolder.address","typeLabel":"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","uniqueKey":"oneOf.2.bankAccount.accountHolder.email","typeLabel":"string\u003cemail>"},"phoneNumber":{"description":"Phone number of the account holder in E.164 format.","minLength":1,"type":"string","uniqueKey":"oneOf.2.bankAccount.accountHolder.phoneNumber","typeLabel":"string"}},"required":["name"],"type":"object","uniqueKey":"oneOf.2.bankAccount.accountHolder","typeLabel":"object"},"accountType":{"description":"Type of the account. Present when sent on creation.","enum":["checking","savings"],"type":"string","uniqueKey":"oneOf.2.bankAccount.accountType","typeLabel":"enum\u003cstring>"},"entityType":{"description":"Type of the account holder. Present when sent on creation.","enum":["business","individual"],"type":"string","uniqueKey":"oneOf.2.bankAccount.entityType","typeLabel":"enum\u003cstring>"},"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","bi-fast","bre-b","cash-pickup","citad","eft","fast","fednow","fedwire","instapay","napas-247","nip","npss","pesonet","promptpay","rtp-credit","same-day-ach-credit","sct","sct-inst","sinpe","spei","uaefts","zahav"],"type":"string","uniqueKey":"oneOf.2.bankAccount.rails.pending.items.[INDEX]","typeLabel":"enum\u003cstring>"},"type":"array","isRequired":true,"uniqueKey":"oneOf.2.bankAccount.rails.pending","typeLabel":"enum\u003cstring>[]"},"status":{"description":"`pending` while asynchronous rail resolution is still running. `complete` when every provider has answered.","enum":["complete","pending"],"type":"string","isRequired":true,"uniqueKey":"oneOf.2.bankAccount.rails.status","typeLabel":"enum\u003cstring>"},"supported":{"description":"Rails that a currently-available payout provider advertises for this account.","items":{"enum":["ach-credit","bi-fast","bre-b","cash-pickup","citad","eft","fast","fednow","fedwire","instapay","napas-247","nip","npss","pesonet","promptpay","rtp-credit","same-day-ach-credit","sct","sct-inst","sinpe","spei","uaefts","zahav"],"type":"string","uniqueKey":"oneOf.2.bankAccount.rails.supported.items.[INDEX]","typeLabel":"enum\u003cstring>"},"type":"array","isRequired":true,"uniqueKey":"oneOf.2.bankAccount.rails.supported","typeLabel":"enum\u003cstring>[]"}},"required":["pending","status","supported"],"type":"object","uniqueKey":"oneOf.2.bankAccount.rails","typeLabel":"object"},"verificationStatus":{"description":"Result of the provider's check on the destination. Absent until a provider answers.","enum":["pending-review","rejected","verified"],"type":"string","uniqueKey":"oneOf.2.bankAccount.verificationStatus","typeLabel":"enum\u003cstring>"}},"required":["accountSuffix","country","currency"],"type":"object","isRequired":true,"uniqueKey":"oneOf.2.bankAccount","typeLabel":"object"},"createdAt":{"description":"ISO 8601 timestamp when this payment method was created.","example":"2024-01-15T10:30:00.000Z","format":"date-time","type":"string","isRequired":true,"uniqueKey":"oneOf.2.createdAt","typeLabel":"string\u003cdate-time>"},"paymentMethodId":{"description":"Unique identifier (UUID v4). Crossmint assigns it on creation.","minLength":1,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.paymentMethodId","typeLabel":"string"},"reason":{"oneOf":[{"type":"string","description":"Deprecated. Use `statusReason`, which carries the same value.","isRequired":true,"uniqueKey":"oneOf.2.reason.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.2.reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.reason","typeLabel":"string | 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","isRequired":true,"uniqueKey":"oneOf.2.status","typeLabel":"enum\u003cstring>"},"statusReason":{"oneOf":[{"type":"string","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.","isRequired":true,"uniqueKey":"oneOf.2.statusReason.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.2.statusReason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.statusReason","typeLabel":"string | null"},"type":{"const":"bank-account-ae","description":"Payment method type. Selects which sub-object is present: `card`, `bankAccount`, or `breB`.","type":"string","isRequired":true,"uniqueKey":"oneOf.2.type","typeLabel":"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","isRequired":true,"uniqueKey":"oneOf.2.updatedAt","typeLabel":"string\u003cdate-time>"},"label":{"description":"The client's own name for this payment method, when one was sent.","minLength":1,"type":"string","uniqueKey":"oneOf.2.label","typeLabel":"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","uniqueKey":"oneOf.2.lastPayoutAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"oneOf.2","typeLabel":"AE bank account · object"},{"type":"object","title":"ID bank account","description":"A saved payment method. Sensitive fields (full PAN, CVC, full account numbers, IBANs, Bre-B keys) are never included.","required":["bankAccount","createdAt","paymentMethodId","reason","status","statusReason","type","updatedAt"],"example":{"createdAt":"2025-01-15T10:30:00.000Z","paymentMethodId":"3f7a9c10-2a8b-4c5d-9e2f-1b3a4c5d6e7f","reason":null,"status":"active","statusReason":null,"type":"card","updatedAt":"2025-01-15T10:30:00.000Z"},"properties":{"bankAccount":{"description":"Bank account details. Present when `type` is a bank type. Full account numbers and IBANs are never included.","properties":{"accountSuffix":{"description":"The last characters of the account number, CLABE or IBAN, at most four.","type":"string","isRequired":true,"uniqueKey":"oneOf.3.bankAccount.accountSuffix","typeLabel":"string"},"country":{"const":"ID","description":"Always 'ID'.","type":"string","isRequired":true,"uniqueKey":"oneOf.3.bankAccount.country","typeLabel":"string"},"currency":{"const":"idr","description":"Always 'idr'; Indonesian bank accounts only settle in Indonesian rupiah.","type":"string","isRequired":true,"uniqueKey":"oneOf.3.bankAccount.currency","typeLabel":"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","isRequired":true,"uniqueKey":"oneOf.3.bankAccount.institutionId","typeLabel":"string"},"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":{"name":{"description":"Full legal name of the account holder. Sent to the payout provider.","minLength":1,"type":"string","isRequired":true,"uniqueKey":"oneOf.3.bankAccount.accountHolder.name","typeLabel":"string"},"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","isRequired":true,"uniqueKey":"oneOf.3.bankAccount.accountHolder.address.city","typeLabel":"string"},"line1":{"description":"Primary address line (max 200 characters).","maxLength":200,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"oneOf.3.bankAccount.accountHolder.address.line1","typeLabel":"string"},"line2":{"description":"Secondary address line, such as an apartment, suite, or unit (max 60 characters).","maxLength":60,"type":"string","uniqueKey":"oneOf.3.bankAccount.accountHolder.address.line2","typeLabel":"string"},"postalCode":{"description":"Postal or ZIP code (max 20 characters).","maxLength":20,"minLength":1,"type":"string","uniqueKey":"oneOf.3.bankAccount.accountHolder.address.postalCode","typeLabel":"string"},"stateOrRegion":{"description":"State, province, or region (max 50 characters).","maxLength":50,"type":"string","uniqueKey":"oneOf.3.bankAccount.accountHolder.address.stateOrRegion","typeLabel":"string"}},"required":["city","line1"],"type":"object","uniqueKey":"oneOf.3.bankAccount.accountHolder.address","typeLabel":"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","uniqueKey":"oneOf.3.bankAccount.accountHolder.email","typeLabel":"string\u003cemail>"},"phoneNumber":{"description":"Phone number of the account holder in E.164 format.","minLength":1,"type":"string","uniqueKey":"oneOf.3.bankAccount.accountHolder.phoneNumber","typeLabel":"string"}},"required":["name"],"type":"object","uniqueKey":"oneOf.3.bankAccount.accountHolder","typeLabel":"object"},"accountType":{"description":"Type of the account. Present when sent on creation.","enum":["checking","savings"],"type":"string","uniqueKey":"oneOf.3.bankAccount.accountType","typeLabel":"enum\u003cstring>"},"entityType":{"description":"Type of the account holder. Present when sent on creation.","enum":["business","individual"],"type":"string","uniqueKey":"oneOf.3.bankAccount.entityType","typeLabel":"enum\u003cstring>"},"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","bi-fast","bre-b","cash-pickup","citad","eft","fast","fednow","fedwire","instapay","napas-247","nip","npss","pesonet","promptpay","rtp-credit","same-day-ach-credit","sct","sct-inst","sinpe","spei","uaefts","zahav"],"type":"string","uniqueKey":"oneOf.3.bankAccount.rails.pending.items.[INDEX]","typeLabel":"enum\u003cstring>"},"type":"array","isRequired":true,"uniqueKey":"oneOf.3.bankAccount.rails.pending","typeLabel":"enum\u003cstring>[]"},"status":{"description":"`pending` while asynchronous rail resolution is still running. `complete` when every provider has answered.","enum":["complete","pending"],"type":"string","isRequired":true,"uniqueKey":"oneOf.3.bankAccount.rails.status","typeLabel":"enum\u003cstring>"},"supported":{"description":"Rails that a currently-available payout provider advertises for this account.","items":{"enum":["ach-credit","bi-fast","bre-b","cash-pickup","citad","eft","fast","fednow","fedwire","instapay","napas-247","nip","npss","pesonet","promptpay","rtp-credit","same-day-ach-credit","sct","sct-inst","sinpe","spei","uaefts","zahav"],"type":"string","uniqueKey":"oneOf.3.bankAccount.rails.supported.items.[INDEX]","typeLabel":"enum\u003cstring>"},"type":"array","isRequired":true,"uniqueKey":"oneOf.3.bankAccount.rails.supported","typeLabel":"enum\u003cstring>[]"}},"required":["pending","status","supported"],"type":"object","uniqueKey":"oneOf.3.bankAccount.rails","typeLabel":"object"},"verificationStatus":{"description":"Result of the provider's check on the destination. Absent until a provider answers.","enum":["pending-review","rejected","verified"],"type":"string","uniqueKey":"oneOf.3.bankAccount.verificationStatus","typeLabel":"enum\u003cstring>"}},"required":["accountSuffix","country","currency","institutionId"],"type":"object","isRequired":true,"uniqueKey":"oneOf.3.bankAccount","typeLabel":"object"},"createdAt":{"description":"ISO 8601 timestamp when this payment method was created.","example":"2024-01-15T10:30:00.000Z","format":"date-time","type":"string","isRequired":true,"uniqueKey":"oneOf.3.createdAt","typeLabel":"string\u003cdate-time>"},"paymentMethodId":{"description":"Unique identifier (UUID v4). Crossmint assigns it on creation.","minLength":1,"type":"string","isRequired":true,"uniqueKey":"oneOf.3.paymentMethodId","typeLabel":"string"},"reason":{"oneOf":[{"type":"string","description":"Deprecated. Use `statusReason`, which carries the same value.","isRequired":true,"uniqueKey":"oneOf.3.reason.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.3.reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.3.reason","typeLabel":"string | 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","isRequired":true,"uniqueKey":"oneOf.3.status","typeLabel":"enum\u003cstring>"},"statusReason":{"oneOf":[{"type":"string","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.","isRequired":true,"uniqueKey":"oneOf.3.statusReason.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.3.statusReason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.3.statusReason","typeLabel":"string | null"},"type":{"const":"bank-account-id","description":"Payment method type. Selects which sub-object is present: `card`, `bankAccount`, or `breB`.","type":"string","isRequired":true,"uniqueKey":"oneOf.3.type","typeLabel":"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","isRequired":true,"uniqueKey":"oneOf.3.updatedAt","typeLabel":"string\u003cdate-time>"},"label":{"description":"The client's own name for this payment method, when one was sent.","minLength":1,"type":"string","uniqueKey":"oneOf.3.label","typeLabel":"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","uniqueKey":"oneOf.3.lastPayoutAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"oneOf.3","typeLabel":"ID bank account · object"},{"type":"object","title":"IL bank account","description":"A saved payment method. Sensitive fields (full PAN, CVC, full account numbers, IBANs, Bre-B keys) are never included.","required":["bankAccount","createdAt","paymentMethodId","reason","status","statusReason","type","updatedAt"],"example":{"createdAt":"2025-01-15T10:30:00.000Z","paymentMethodId":"3f7a9c10-2a8b-4c5d-9e2f-1b3a4c5d6e7f","reason":null,"status":"active","statusReason":null,"type":"card","updatedAt":"2025-01-15T10:30:00.000Z"},"properties":{"bankAccount":{"description":"Bank account details. Present when `type` is a bank type. Full account numbers and IBANs are never included.","properties":{"accountSuffix":{"description":"The last characters of the account number, CLABE or IBAN, at most four.","type":"string","isRequired":true,"uniqueKey":"oneOf.4.bankAccount.accountSuffix","typeLabel":"string"},"country":{"const":"IL","description":"Always 'IL'.","type":"string","isRequired":true,"uniqueKey":"oneOf.4.bankAccount.country","typeLabel":"string"},"currency":{"const":"ils","description":"Always 'ils'; Israeli bank accounts only settle in Israeli new shekels.","type":"string","isRequired":true,"uniqueKey":"oneOf.4.bankAccount.currency","typeLabel":"string"},"institutionId":{"description":"ID of the bank, for example `il-mizrahi-tefahot-bank`. The [Bank Institution IDs](https://docs.crossmint.com/offramp/guides/bank-institution-ids) page lists every ID.","type":"string","isRequired":true,"uniqueKey":"oneOf.4.bankAccount.institutionId","typeLabel":"string"},"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":{"name":{"description":"Full legal name of the account holder. Sent to the payout provider.","minLength":1,"type":"string","isRequired":true,"uniqueKey":"oneOf.4.bankAccount.accountHolder.name","typeLabel":"string"},"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","isRequired":true,"uniqueKey":"oneOf.4.bankAccount.accountHolder.address.city","typeLabel":"string"},"line1":{"description":"Primary address line (max 200 characters).","maxLength":200,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"oneOf.4.bankAccount.accountHolder.address.line1","typeLabel":"string"},"line2":{"description":"Secondary address line, such as an apartment, suite, or unit (max 60 characters).","maxLength":60,"type":"string","uniqueKey":"oneOf.4.bankAccount.accountHolder.address.line2","typeLabel":"string"},"postalCode":{"description":"Postal or ZIP code (max 20 characters).","maxLength":20,"minLength":1,"type":"string","uniqueKey":"oneOf.4.bankAccount.accountHolder.address.postalCode","typeLabel":"string"},"stateOrRegion":{"description":"State, province, or region (max 50 characters).","maxLength":50,"type":"string","uniqueKey":"oneOf.4.bankAccount.accountHolder.address.stateOrRegion","typeLabel":"string"}},"required":["city","line1"],"type":"object","uniqueKey":"oneOf.4.bankAccount.accountHolder.address","typeLabel":"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","uniqueKey":"oneOf.4.bankAccount.accountHolder.email","typeLabel":"string\u003cemail>"},"phoneNumber":{"description":"Phone number of the account holder in E.164 format.","minLength":1,"type":"string","uniqueKey":"oneOf.4.bankAccount.accountHolder.phoneNumber","typeLabel":"string"}},"required":["name"],"type":"object","uniqueKey":"oneOf.4.bankAccount.accountHolder","typeLabel":"object"},"accountType":{"description":"Type of the account. Present when sent on creation.","enum":["checking","savings"],"type":"string","uniqueKey":"oneOf.4.bankAccount.accountType","typeLabel":"enum\u003cstring>"},"entityType":{"description":"Type of the account holder. Present when sent on creation.","enum":["business","individual"],"type":"string","uniqueKey":"oneOf.4.bankAccount.entityType","typeLabel":"enum\u003cstring>"},"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","bi-fast","bre-b","cash-pickup","citad","eft","fast","fednow","fedwire","instapay","napas-247","nip","npss","pesonet","promptpay","rtp-credit","same-day-ach-credit","sct","sct-inst","sinpe","spei","uaefts","zahav"],"type":"string","uniqueKey":"oneOf.4.bankAccount.rails.pending.items.[INDEX]","typeLabel":"enum\u003cstring>"},"type":"array","isRequired":true,"uniqueKey":"oneOf.4.bankAccount.rails.pending","typeLabel":"enum\u003cstring>[]"},"status":{"description":"`pending` while asynchronous rail resolution is still running. `complete` when every provider has answered.","enum":["complete","pending"],"type":"string","isRequired":true,"uniqueKey":"oneOf.4.bankAccount.rails.status","typeLabel":"enum\u003cstring>"},"supported":{"description":"Rails that a currently-available payout provider advertises for this account.","items":{"enum":["ach-credit","bi-fast","bre-b","cash-pickup","citad","eft","fast","fednow","fedwire","instapay","napas-247","nip","npss","pesonet","promptpay","rtp-credit","same-day-ach-credit","sct","sct-inst","sinpe","spei","uaefts","zahav"],"type":"string","uniqueKey":"oneOf.4.bankAccount.rails.supported.items.[INDEX]","typeLabel":"enum\u003cstring>"},"type":"array","isRequired":true,"uniqueKey":"oneOf.4.bankAccount.rails.supported","typeLabel":"enum\u003cstring>[]"}},"required":["pending","status","supported"],"type":"object","uniqueKey":"oneOf.4.bankAccount.rails","typeLabel":"object"},"verificationStatus":{"description":"Result of the provider's check on the destination. Absent until a provider answers.","enum":["pending-review","rejected","verified"],"type":"string","uniqueKey":"oneOf.4.bankAccount.verificationStatus","typeLabel":"enum\u003cstring>"}},"required":["accountSuffix","country","currency","institutionId"],"type":"object","isRequired":true,"uniqueKey":"oneOf.4.bankAccount","typeLabel":"object"},"createdAt":{"description":"ISO 8601 timestamp when this payment method was created.","example":"2024-01-15T10:30:00.000Z","format":"date-time","type":"string","isRequired":true,"uniqueKey":"oneOf.4.createdAt","typeLabel":"string\u003cdate-time>"},"paymentMethodId":{"description":"Unique identifier (UUID v4). Crossmint assigns it on creation.","minLength":1,"type":"string","isRequired":true,"uniqueKey":"oneOf.4.paymentMethodId","typeLabel":"string"},"reason":{"oneOf":[{"type":"string","description":"Deprecated. Use `statusReason`, which carries the same value.","isRequired":true,"uniqueKey":"oneOf.4.reason.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.4.reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.4.reason","typeLabel":"string | 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","isRequired":true,"uniqueKey":"oneOf.4.status","typeLabel":"enum\u003cstring>"},"statusReason":{"oneOf":[{"type":"string","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.","isRequired":true,"uniqueKey":"oneOf.4.statusReason.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.4.statusReason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.4.statusReason","typeLabel":"string | null"},"type":{"const":"bank-account-il","description":"Payment method type. Selects which sub-object is present: `card`, `bankAccount`, or `breB`.","type":"string","isRequired":true,"uniqueKey":"oneOf.4.type","typeLabel":"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","isRequired":true,"uniqueKey":"oneOf.4.updatedAt","typeLabel":"string\u003cdate-time>"},"label":{"description":"The client's own name for this payment method, when one was sent.","minLength":1,"type":"string","uniqueKey":"oneOf.4.label","typeLabel":"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","uniqueKey":"oneOf.4.lastPayoutAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"oneOf.4","typeLabel":"IL bank account · object"},{"type":"object","title":"JO bank account","description":"A saved payment method. Sensitive fields (full PAN, CVC, full account numbers, IBANs, Bre-B keys) are never included.","required":["bankAccount","createdAt","paymentMethodId","reason","status","statusReason","type","updatedAt"],"example":{"createdAt":"2025-01-15T10:30:00.000Z","paymentMethodId":"3f7a9c10-2a8b-4c5d-9e2f-1b3a4c5d6e7f","reason":null,"status":"active","statusReason":null,"type":"card","updatedAt":"2025-01-15T10:30:00.000Z"},"properties":{"bankAccount":{"description":"Bank account details. Present when `type` is a bank type. Full account numbers and IBANs are never included.","properties":{"accountSuffix":{"description":"The last characters of the account number, CLABE or IBAN, at most four.","type":"string","isRequired":true,"uniqueKey":"oneOf.5.bankAccount.accountSuffix","typeLabel":"string"},"country":{"const":"JO","description":"Always 'JO'.","type":"string","isRequired":true,"uniqueKey":"oneOf.5.bankAccount.country","typeLabel":"string"},"currency":{"const":"jod","description":"Always 'jod'; Jordanian bank accounts only settle in Jordanian dinars.","type":"string","isRequired":true,"uniqueKey":"oneOf.5.bankAccount.currency","typeLabel":"string"},"institutionId":{"description":"ID of the bank, for example `jo-arab-bank`. The [Bank Institution IDs](https://docs.crossmint.com/offramp/guides/bank-institution-ids) page lists every ID.","type":"string","isRequired":true,"uniqueKey":"oneOf.5.bankAccount.institutionId","typeLabel":"string"},"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":{"name":{"description":"Full legal name of the account holder. Sent to the payout provider.","minLength":1,"type":"string","isRequired":true,"uniqueKey":"oneOf.5.bankAccount.accountHolder.name","typeLabel":"string"},"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","isRequired":true,"uniqueKey":"oneOf.5.bankAccount.accountHolder.address.city","typeLabel":"string"},"line1":{"description":"Primary address line (max 200 characters).","maxLength":200,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"oneOf.5.bankAccount.accountHolder.address.line1","typeLabel":"string"},"line2":{"description":"Secondary address line, such as an apartment, suite, or unit (max 60 characters).","maxLength":60,"type":"string","uniqueKey":"oneOf.5.bankAccount.accountHolder.address.line2","typeLabel":"string"},"postalCode":{"description":"Postal or ZIP code (max 20 characters).","maxLength":20,"minLength":1,"type":"string","uniqueKey":"oneOf.5.bankAccount.accountHolder.address.postalCode","typeLabel":"string"},"stateOrRegion":{"description":"State, province, or region (max 50 characters).","maxLength":50,"type":"string","uniqueKey":"oneOf.5.bankAccount.accountHolder.address.stateOrRegion","typeLabel":"string"}},"required":["city","line1"],"type":"object","uniqueKey":"oneOf.5.bankAccount.accountHolder.address","typeLabel":"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","uniqueKey":"oneOf.5.bankAccount.accountHolder.email","typeLabel":"string\u003cemail>"},"phoneNumber":{"description":"Phone number of the account holder in E.164 format.","minLength":1,"type":"string","uniqueKey":"oneOf.5.bankAccount.accountHolder.phoneNumber","typeLabel":"string"}},"required":["name"],"type":"object","uniqueKey":"oneOf.5.bankAccount.accountHolder","typeLabel":"object"},"accountType":{"description":"Type of the account. Present when sent on creation.","enum":["checking","savings"],"type":"string","uniqueKey":"oneOf.5.bankAccount.accountType","typeLabel":"enum\u003cstring>"},"entityType":{"description":"Type of the account holder. Present when sent on creation.","enum":["business","individual"],"type":"string","uniqueKey":"oneOf.5.bankAccount.entityType","typeLabel":"enum\u003cstring>"},"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","bi-fast","bre-b","cash-pickup","citad","eft","fast","fednow","fedwire","instapay","napas-247","nip","npss","pesonet","promptpay","rtp-credit","same-day-ach-credit","sct","sct-inst","sinpe","spei","uaefts","zahav"],"type":"string","uniqueKey":"oneOf.5.bankAccount.rails.pending.items.[INDEX]","typeLabel":"enum\u003cstring>"},"type":"array","isRequired":true,"uniqueKey":"oneOf.5.bankAccount.rails.pending","typeLabel":"enum\u003cstring>[]"},"status":{"description":"`pending` while asynchronous rail resolution is still running. `complete` when every provider has answered.","enum":["complete","pending"],"type":"string","isRequired":true,"uniqueKey":"oneOf.5.bankAccount.rails.status","typeLabel":"enum\u003cstring>"},"supported":{"description":"Rails that a currently-available payout provider advertises for this account.","items":{"enum":["ach-credit","bi-fast","bre-b","cash-pickup","citad","eft","fast","fednow","fedwire","instapay","napas-247","nip","npss","pesonet","promptpay","rtp-credit","same-day-ach-credit","sct","sct-inst","sinpe","spei","uaefts","zahav"],"type":"string","uniqueKey":"oneOf.5.bankAccount.rails.supported.items.[INDEX]","typeLabel":"enum\u003cstring>"},"type":"array","isRequired":true,"uniqueKey":"oneOf.5.bankAccount.rails.supported","typeLabel":"enum\u003cstring>[]"}},"required":["pending","status","supported"],"type":"object","uniqueKey":"oneOf.5.bankAccount.rails","typeLabel":"object"},"verificationStatus":{"description":"Result of the provider's check on the destination. Absent until a provider answers.","enum":["pending-review","rejected","verified"],"type":"string","uniqueKey":"oneOf.5.bankAccount.verificationStatus","typeLabel":"enum\u003cstring>"}},"required":["accountSuffix","country","currency","institutionId"],"type":"object","isRequired":true,"uniqueKey":"oneOf.5.bankAccount","typeLabel":"object"},"createdAt":{"description":"ISO 8601 timestamp when this payment method was created.","example":"2024-01-15T10:30:00.000Z","format":"date-time","type":"string","isRequired":true,"uniqueKey":"oneOf.5.createdAt","typeLabel":"string\u003cdate-time>"},"paymentMethodId":{"description":"Unique identifier (UUID v4). Crossmint assigns it on creation.","minLength":1,"type":"string","isRequired":true,"uniqueKey":"oneOf.5.paymentMethodId","typeLabel":"string"},"reason":{"oneOf":[{"type":"string","description":"Deprecated. Use `statusReason`, which carries the same value.","isRequired":true,"uniqueKey":"oneOf.5.reason.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.5.reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.5.reason","typeLabel":"string | 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","isRequired":true,"uniqueKey":"oneOf.5.status","typeLabel":"enum\u003cstring>"},"statusReason":{"oneOf":[{"type":"string","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.","isRequired":true,"uniqueKey":"oneOf.5.statusReason.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.5.statusReason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.5.statusReason","typeLabel":"string | null"},"type":{"const":"bank-account-jo","description":"Payment method type. Selects which sub-object is present: `card`, `bankAccount`, or `breB`.","type":"string","isRequired":true,"uniqueKey":"oneOf.5.type","typeLabel":"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","isRequired":true,"uniqueKey":"oneOf.5.updatedAt","typeLabel":"string\u003cdate-time>"},"label":{"description":"The client's own name for this payment method, when one was sent.","minLength":1,"type":"string","uniqueKey":"oneOf.5.label","typeLabel":"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","uniqueKey":"oneOf.5.lastPayoutAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"oneOf.5","typeLabel":"JO bank account · object"},{"type":"object","title":"NG bank account","description":"A saved payment method. Sensitive fields (full PAN, CVC, full account numbers, IBANs, Bre-B keys) are never included.","required":["bankAccount","createdAt","paymentMethodId","reason","status","statusReason","type","updatedAt"],"example":{"createdAt":"2025-01-15T10:30:00.000Z","paymentMethodId":"3f7a9c10-2a8b-4c5d-9e2f-1b3a4c5d6e7f","reason":null,"status":"active","statusReason":null,"type":"card","updatedAt":"2025-01-15T10:30:00.000Z"},"properties":{"bankAccount":{"description":"Bank account details. Present when `type` is a bank type. Full account numbers and IBANs are never included.","properties":{"accountSuffix":{"description":"The last characters of the account number, CLABE or IBAN, at most four.","type":"string","isRequired":true,"uniqueKey":"oneOf.6.bankAccount.accountSuffix","typeLabel":"string"},"country":{"const":"NG","description":"Always 'NG'.","type":"string","isRequired":true,"uniqueKey":"oneOf.6.bankAccount.country","typeLabel":"string"},"currency":{"const":"ngn","description":"Always 'ngn'; Nigerian bank accounts only settle in Nigerian naira.","type":"string","isRequired":true,"uniqueKey":"oneOf.6.bankAccount.currency","typeLabel":"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","isRequired":true,"uniqueKey":"oneOf.6.bankAccount.institutionId","typeLabel":"string"},"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":{"name":{"description":"Full legal name of the account holder. Sent to the payout provider.","minLength":1,"type":"string","isRequired":true,"uniqueKey":"oneOf.6.bankAccount.accountHolder.name","typeLabel":"string"},"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","isRequired":true,"uniqueKey":"oneOf.6.bankAccount.accountHolder.address.city","typeLabel":"string"},"line1":{"description":"Primary address line (max 200 characters).","maxLength":200,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"oneOf.6.bankAccount.accountHolder.address.line1","typeLabel":"string"},"line2":{"description":"Secondary address line, such as an apartment, suite, or unit (max 60 characters).","maxLength":60,"type":"string","uniqueKey":"oneOf.6.bankAccount.accountHolder.address.line2","typeLabel":"string"},"postalCode":{"description":"Postal or ZIP code (max 20 characters).","maxLength":20,"minLength":1,"type":"string","uniqueKey":"oneOf.6.bankAccount.accountHolder.address.postalCode","typeLabel":"string"},"stateOrRegion":{"description":"State, province, or region (max 50 characters).","maxLength":50,"type":"string","uniqueKey":"oneOf.6.bankAccount.accountHolder.address.stateOrRegion","typeLabel":"string"}},"required":["city","line1"],"type":"object","uniqueKey":"oneOf.6.bankAccount.accountHolder.address","typeLabel":"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","uniqueKey":"oneOf.6.bankAccount.accountHolder.email","typeLabel":"string\u003cemail>"},"phoneNumber":{"description":"Phone number of the account holder in E.164 format.","minLength":1,"type":"string","uniqueKey":"oneOf.6.bankAccount.accountHolder.phoneNumber","typeLabel":"string"}},"required":["name"],"type":"object","uniqueKey":"oneOf.6.bankAccount.accountHolder","typeLabel":"object"},"accountType":{"description":"Type of the account. Present when sent on creation.","enum":["checking","savings"],"type":"string","uniqueKey":"oneOf.6.bankAccount.accountType","typeLabel":"enum\u003cstring>"},"entityType":{"description":"Type of the account holder. Present when sent on creation.","enum":["business","individual"],"type":"string","uniqueKey":"oneOf.6.bankAccount.entityType","typeLabel":"enum\u003cstring>"},"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","bi-fast","bre-b","cash-pickup","citad","eft","fast","fednow","fedwire","instapay","napas-247","nip","npss","pesonet","promptpay","rtp-credit","same-day-ach-credit","sct","sct-inst","sinpe","spei","uaefts","zahav"],"type":"string","uniqueKey":"oneOf.6.bankAccount.rails.pending.items.[INDEX]","typeLabel":"enum\u003cstring>"},"type":"array","isRequired":true,"uniqueKey":"oneOf.6.bankAccount.rails.pending","typeLabel":"enum\u003cstring>[]"},"status":{"description":"`pending` while asynchronous rail resolution is still running. `complete` when every provider has answered.","enum":["complete","pending"],"type":"string","isRequired":true,"uniqueKey":"oneOf.6.bankAccount.rails.status","typeLabel":"enum\u003cstring>"},"supported":{"description":"Rails that a currently-available payout provider advertises for this account.","items":{"enum":["ach-credit","bi-fast","bre-b","cash-pickup","citad","eft","fast","fednow","fedwire","instapay","napas-247","nip","npss","pesonet","promptpay","rtp-credit","same-day-ach-credit","sct","sct-inst","sinpe","spei","uaefts","zahav"],"type":"string","uniqueKey":"oneOf.6.bankAccount.rails.supported.items.[INDEX]","typeLabel":"enum\u003cstring>"},"type":"array","isRequired":true,"uniqueKey":"oneOf.6.bankAccount.rails.supported","typeLabel":"enum\u003cstring>[]"}},"required":["pending","status","supported"],"type":"object","uniqueKey":"oneOf.6.bankAccount.rails","typeLabel":"object"},"verificationStatus":{"description":"Result of the provider's check on the destination. Absent until a provider answers.","enum":["pending-review","rejected","verified"],"type":"string","uniqueKey":"oneOf.6.bankAccount.verificationStatus","typeLabel":"enum\u003cstring>"}},"required":["accountSuffix","country","currency","institutionId"],"type":"object","isRequired":true,"uniqueKey":"oneOf.6.bankAccount","typeLabel":"object"},"createdAt":{"description":"ISO 8601 timestamp when this payment method was created.","example":"2024-01-15T10:30:00.000Z","format":"date-time","type":"string","isRequired":true,"uniqueKey":"oneOf.6.createdAt","typeLabel":"string\u003cdate-time>"},"paymentMethodId":{"description":"Unique identifier (UUID v4). Crossmint assigns it on creation.","minLength":1,"type":"string","isRequired":true,"uniqueKey":"oneOf.6.paymentMethodId","typeLabel":"string"},"reason":{"oneOf":[{"type":"string","description":"Deprecated. Use `statusReason`, which carries the same value.","isRequired":true,"uniqueKey":"oneOf.6.reason.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.6.reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.6.reason","typeLabel":"string | 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","isRequired":true,"uniqueKey":"oneOf.6.status","typeLabel":"enum\u003cstring>"},"statusReason":{"oneOf":[{"type":"string","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.","isRequired":true,"uniqueKey":"oneOf.6.statusReason.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.6.statusReason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.6.statusReason","typeLabel":"string | null"},"type":{"const":"bank-account-ng","description":"Payment method type. Selects which sub-object is present: `card`, `bankAccount`, or `breB`.","type":"string","isRequired":true,"uniqueKey":"oneOf.6.type","typeLabel":"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","isRequired":true,"uniqueKey":"oneOf.6.updatedAt","typeLabel":"string\u003cdate-time>"},"label":{"description":"The client's own name for this payment method, when one was sent.","minLength":1,"type":"string","uniqueKey":"oneOf.6.label","typeLabel":"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","uniqueKey":"oneOf.6.lastPayoutAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"oneOf.6","typeLabel":"NG bank account · object"},{"type":"object","title":"PH bank account","description":"A saved payment method. Sensitive fields (full PAN, CVC, full account numbers, IBANs, Bre-B keys) are never included.","required":["bankAccount","createdAt","paymentMethodId","reason","status","statusReason","type","updatedAt"],"example":{"createdAt":"2025-01-15T10:30:00.000Z","paymentMethodId":"3f7a9c10-2a8b-4c5d-9e2f-1b3a4c5d6e7f","reason":null,"status":"active","statusReason":null,"type":"card","updatedAt":"2025-01-15T10:30:00.000Z"},"properties":{"bankAccount":{"description":"Bank account details. Present when `type` is a bank type. Full account numbers and IBANs are never included.","properties":{"accountSuffix":{"description":"The last characters of the account number, CLABE or IBAN, at most four.","type":"string","isRequired":true,"uniqueKey":"oneOf.7.bankAccount.accountSuffix","typeLabel":"string"},"country":{"const":"PH","description":"Always 'PH'.","type":"string","isRequired":true,"uniqueKey":"oneOf.7.bankAccount.country","typeLabel":"string"},"currency":{"const":"php","description":"Always 'php'; Philippine bank accounts only settle in Philippine pesos.","type":"string","isRequired":true,"uniqueKey":"oneOf.7.bankAccount.currency","typeLabel":"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","isRequired":true,"uniqueKey":"oneOf.7.bankAccount.institutionId","typeLabel":"string"},"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":{"name":{"description":"Full legal name of the account holder. Sent to the payout provider.","minLength":1,"type":"string","isRequired":true,"uniqueKey":"oneOf.7.bankAccount.accountHolder.name","typeLabel":"string"},"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","isRequired":true,"uniqueKey":"oneOf.7.bankAccount.accountHolder.address.city","typeLabel":"string"},"line1":{"description":"Primary address line (max 200 characters).","maxLength":200,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"oneOf.7.bankAccount.accountHolder.address.line1","typeLabel":"string"},"line2":{"description":"Secondary address line, such as an apartment, suite, or unit (max 60 characters).","maxLength":60,"type":"string","uniqueKey":"oneOf.7.bankAccount.accountHolder.address.line2","typeLabel":"string"},"postalCode":{"description":"Postal or ZIP code (max 20 characters).","maxLength":20,"minLength":1,"type":"string","uniqueKey":"oneOf.7.bankAccount.accountHolder.address.postalCode","typeLabel":"string"},"stateOrRegion":{"description":"State, province, or region (max 50 characters).","maxLength":50,"type":"string","uniqueKey":"oneOf.7.bankAccount.accountHolder.address.stateOrRegion","typeLabel":"string"}},"required":["city","line1"],"type":"object","uniqueKey":"oneOf.7.bankAccount.accountHolder.address","typeLabel":"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","uniqueKey":"oneOf.7.bankAccount.accountHolder.email","typeLabel":"string\u003cemail>"},"phoneNumber":{"description":"Phone number of the account holder in E.164 format.","minLength":1,"type":"string","uniqueKey":"oneOf.7.bankAccount.accountHolder.phoneNumber","typeLabel":"string"}},"required":["name"],"type":"object","uniqueKey":"oneOf.7.bankAccount.accountHolder","typeLabel":"object"},"accountType":{"description":"Type of the account. Present when sent on creation.","enum":["checking","savings"],"type":"string","uniqueKey":"oneOf.7.bankAccount.accountType","typeLabel":"enum\u003cstring>"},"entityType":{"description":"Type of the account holder. Present when sent on creation.","enum":["business","individual"],"type":"string","uniqueKey":"oneOf.7.bankAccount.entityType","typeLabel":"enum\u003cstring>"},"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","bi-fast","bre-b","cash-pickup","citad","eft","fast","fednow","fedwire","instapay","napas-247","nip","npss","pesonet","promptpay","rtp-credit","same-day-ach-credit","sct","sct-inst","sinpe","spei","uaefts","zahav"],"type":"string","uniqueKey":"oneOf.7.bankAccount.rails.pending.items.[INDEX]","typeLabel":"enum\u003cstring>"},"type":"array","isRequired":true,"uniqueKey":"oneOf.7.bankAccount.rails.pending","typeLabel":"enum\u003cstring>[]"},"status":{"description":"`pending` while asynchronous rail resolution is still running. `complete` when every provider has answered.","enum":["complete","pending"],"type":"string","isRequired":true,"uniqueKey":"oneOf.7.bankAccount.rails.status","typeLabel":"enum\u003cstring>"},"supported":{"description":"Rails that a currently-available payout provider advertises for this account.","items":{"enum":["ach-credit","bi-fast","bre-b","cash-pickup","citad","eft","fast","fednow","fedwire","instapay","napas-247","nip","npss","pesonet","promptpay","rtp-credit","same-day-ach-credit","sct","sct-inst","sinpe","spei","uaefts","zahav"],"type":"string","uniqueKey":"oneOf.7.bankAccount.rails.supported.items.[INDEX]","typeLabel":"enum\u003cstring>"},"type":"array","isRequired":true,"uniqueKey":"oneOf.7.bankAccount.rails.supported","typeLabel":"enum\u003cstring>[]"}},"required":["pending","status","supported"],"type":"object","uniqueKey":"oneOf.7.bankAccount.rails","typeLabel":"object"},"verificationStatus":{"description":"Result of the provider's check on the destination. Absent until a provider answers.","enum":["pending-review","rejected","verified"],"type":"string","uniqueKey":"oneOf.7.bankAccount.verificationStatus","typeLabel":"enum\u003cstring>"}},"required":["accountSuffix","country","currency","institutionId"],"type":"object","isRequired":true,"uniqueKey":"oneOf.7.bankAccount","typeLabel":"object"},"createdAt":{"description":"ISO 8601 timestamp when this payment method was created.","example":"2024-01-15T10:30:00.000Z","format":"date-time","type":"string","isRequired":true,"uniqueKey":"oneOf.7.createdAt","typeLabel":"string\u003cdate-time>"},"paymentMethodId":{"description":"Unique identifier (UUID v4). Crossmint assigns it on creation.","minLength":1,"type":"string","isRequired":true,"uniqueKey":"oneOf.7.paymentMethodId","typeLabel":"string"},"reason":{"oneOf":[{"type":"string","description":"Deprecated. Use `statusReason`, which carries the same value.","isRequired":true,"uniqueKey":"oneOf.7.reason.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.7.reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.7.reason","typeLabel":"string | 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","isRequired":true,"uniqueKey":"oneOf.7.status","typeLabel":"enum\u003cstring>"},"statusReason":{"oneOf":[{"type":"string","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.","isRequired":true,"uniqueKey":"oneOf.7.statusReason.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.7.statusReason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.7.statusReason","typeLabel":"string | null"},"type":{"const":"bank-account-ph","description":"Payment method type. Selects which sub-object is present: `card`, `bankAccount`, or `breB`.","type":"string","isRequired":true,"uniqueKey":"oneOf.7.type","typeLabel":"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","isRequired":true,"uniqueKey":"oneOf.7.updatedAt","typeLabel":"string\u003cdate-time>"},"label":{"description":"The client's own name for this payment method, when one was sent.","minLength":1,"type":"string","uniqueKey":"oneOf.7.label","typeLabel":"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","uniqueKey":"oneOf.7.lastPayoutAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"oneOf.7","typeLabel":"PH bank account · object"},{"type":"object","title":"TH bank account","description":"A saved payment method. Sensitive fields (full PAN, CVC, full account numbers, IBANs, Bre-B keys) are never included.","required":["bankAccount","createdAt","paymentMethodId","reason","status","statusReason","type","updatedAt"],"example":{"createdAt":"2025-01-15T10:30:00.000Z","paymentMethodId":"3f7a9c10-2a8b-4c5d-9e2f-1b3a4c5d6e7f","reason":null,"status":"active","statusReason":null,"type":"card","updatedAt":"2025-01-15T10:30:00.000Z"},"properties":{"bankAccount":{"description":"Bank account details. Present when `type` is a bank type. Full account numbers and IBANs are never included.","properties":{"accountSuffix":{"description":"The last characters of the account number, CLABE or IBAN, at most four.","type":"string","isRequired":true,"uniqueKey":"oneOf.8.bankAccount.accountSuffix","typeLabel":"string"},"country":{"const":"TH","description":"Always 'TH'.","type":"string","isRequired":true,"uniqueKey":"oneOf.8.bankAccount.country","typeLabel":"string"},"currency":{"const":"thb","description":"Always 'thb'; Thai bank accounts only settle in Thai baht.","type":"string","isRequired":true,"uniqueKey":"oneOf.8.bankAccount.currency","typeLabel":"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","isRequired":true,"uniqueKey":"oneOf.8.bankAccount.institutionId","typeLabel":"string"},"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":{"name":{"description":"Full legal name of the account holder. Sent to the payout provider.","minLength":1,"type":"string","isRequired":true,"uniqueKey":"oneOf.8.bankAccount.accountHolder.name","typeLabel":"string"},"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","isRequired":true,"uniqueKey":"oneOf.8.bankAccount.accountHolder.address.city","typeLabel":"string"},"line1":{"description":"Primary address line (max 200 characters).","maxLength":200,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"oneOf.8.bankAccount.accountHolder.address.line1","typeLabel":"string"},"line2":{"description":"Secondary address line, such as an apartment, suite, or unit (max 60 characters).","maxLength":60,"type":"string","uniqueKey":"oneOf.8.bankAccount.accountHolder.address.line2","typeLabel":"string"},"postalCode":{"description":"Postal or ZIP code (max 20 characters).","maxLength":20,"minLength":1,"type":"string","uniqueKey":"oneOf.8.bankAccount.accountHolder.address.postalCode","typeLabel":"string"},"stateOrRegion":{"description":"State, province, or region (max 50 characters).","maxLength":50,"type":"string","uniqueKey":"oneOf.8.bankAccount.accountHolder.address.stateOrRegion","typeLabel":"string"}},"required":["city","line1"],"type":"object","uniqueKey":"oneOf.8.bankAccount.accountHolder.address","typeLabel":"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","uniqueKey":"oneOf.8.bankAccount.accountHolder.email","typeLabel":"string\u003cemail>"},"phoneNumber":{"description":"Phone number of the account holder in E.164 format.","minLength":1,"type":"string","uniqueKey":"oneOf.8.bankAccount.accountHolder.phoneNumber","typeLabel":"string"}},"required":["name"],"type":"object","uniqueKey":"oneOf.8.bankAccount.accountHolder","typeLabel":"object"},"accountType":{"description":"Type of the account. Present when sent on creation.","enum":["checking","savings"],"type":"string","uniqueKey":"oneOf.8.bankAccount.accountType","typeLabel":"enum\u003cstring>"},"entityType":{"description":"Type of the account holder. Present when sent on creation.","enum":["business","individual"],"type":"string","uniqueKey":"oneOf.8.bankAccount.entityType","typeLabel":"enum\u003cstring>"},"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","bi-fast","bre-b","cash-pickup","citad","eft","fast","fednow","fedwire","instapay","napas-247","nip","npss","pesonet","promptpay","rtp-credit","same-day-ach-credit","sct","sct-inst","sinpe","spei","uaefts","zahav"],"type":"string","uniqueKey":"oneOf.8.bankAccount.rails.pending.items.[INDEX]","typeLabel":"enum\u003cstring>"},"type":"array","isRequired":true,"uniqueKey":"oneOf.8.bankAccount.rails.pending","typeLabel":"enum\u003cstring>[]"},"status":{"description":"`pending` while asynchronous rail resolution is still running. `complete` when every provider has answered.","enum":["complete","pending"],"type":"string","isRequired":true,"uniqueKey":"oneOf.8.bankAccount.rails.status","typeLabel":"enum\u003cstring>"},"supported":{"description":"Rails that a currently-available payout provider advertises for this account.","items":{"enum":["ach-credit","bi-fast","bre-b","cash-pickup","citad","eft","fast","fednow","fedwire","instapay","napas-247","nip","npss","pesonet","promptpay","rtp-credit","same-day-ach-credit","sct","sct-inst","sinpe","spei","uaefts","zahav"],"type":"string","uniqueKey":"oneOf.8.bankAccount.rails.supported.items.[INDEX]","typeLabel":"enum\u003cstring>"},"type":"array","isRequired":true,"uniqueKey":"oneOf.8.bankAccount.rails.supported","typeLabel":"enum\u003cstring>[]"}},"required":["pending","status","supported"],"type":"object","uniqueKey":"oneOf.8.bankAccount.rails","typeLabel":"object"},"verificationStatus":{"description":"Result of the provider's check on the destination. Absent until a provider answers.","enum":["pending-review","rejected","verified"],"type":"string","uniqueKey":"oneOf.8.bankAccount.verificationStatus","typeLabel":"enum\u003cstring>"}},"required":["accountSuffix","country","currency","institutionId"],"type":"object","isRequired":true,"uniqueKey":"oneOf.8.bankAccount","typeLabel":"object"},"createdAt":{"description":"ISO 8601 timestamp when this payment method was created.","example":"2024-01-15T10:30:00.000Z","format":"date-time","type":"string","isRequired":true,"uniqueKey":"oneOf.8.createdAt","typeLabel":"string\u003cdate-time>"},"paymentMethodId":{"description":"Unique identifier (UUID v4). Crossmint assigns it on creation.","minLength":1,"type":"string","isRequired":true,"uniqueKey":"oneOf.8.paymentMethodId","typeLabel":"string"},"reason":{"oneOf":[{"type":"string","description":"Deprecated. Use `statusReason`, which carries the same value.","isRequired":true,"uniqueKey":"oneOf.8.reason.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.8.reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.8.reason","typeLabel":"string | 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","isRequired":true,"uniqueKey":"oneOf.8.status","typeLabel":"enum\u003cstring>"},"statusReason":{"oneOf":[{"type":"string","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.","isRequired":true,"uniqueKey":"oneOf.8.statusReason.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.8.statusReason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.8.statusReason","typeLabel":"string | null"},"type":{"const":"bank-account-th","description":"Payment method type. Selects which sub-object is present: `card`, `bankAccount`, or `breB`.","type":"string","isRequired":true,"uniqueKey":"oneOf.8.type","typeLabel":"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","isRequired":true,"uniqueKey":"oneOf.8.updatedAt","typeLabel":"string\u003cdate-time>"},"label":{"description":"The client's own name for this payment method, when one was sent.","minLength":1,"type":"string","uniqueKey":"oneOf.8.label","typeLabel":"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","uniqueKey":"oneOf.8.lastPayoutAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"oneOf.8","typeLabel":"TH bank account · object"},{"type":"object","title":"TR bank account","description":"A saved payment method. Sensitive fields (full PAN, CVC, full account numbers, IBANs, Bre-B keys) are never included.","required":["bankAccount","createdAt","paymentMethodId","reason","status","statusReason","type","updatedAt"],"example":{"createdAt":"2025-01-15T10:30:00.000Z","paymentMethodId":"3f7a9c10-2a8b-4c5d-9e2f-1b3a4c5d6e7f","reason":null,"status":"active","statusReason":null,"type":"card","updatedAt":"2025-01-15T10:30:00.000Z"},"properties":{"bankAccount":{"description":"Bank account details. Present when `type` is a bank type. Full account numbers and IBANs are never included.","properties":{"accountSuffix":{"description":"The last characters of the account number, CLABE or IBAN, at most four.","type":"string","isRequired":true,"uniqueKey":"oneOf.9.bankAccount.accountSuffix","typeLabel":"string"},"country":{"const":"TR","description":"Always 'TR'.","type":"string","isRequired":true,"uniqueKey":"oneOf.9.bankAccount.country","typeLabel":"string"},"currency":{"const":"try","description":"Always 'try'; Turkish bank accounts only settle in Turkish lira.","type":"string","isRequired":true,"uniqueKey":"oneOf.9.bankAccount.currency","typeLabel":"string"},"institutionId":{"description":"ID of the bank, for example `tr-akbank`. The [Bank Institution IDs](https://docs.crossmint.com/offramp/guides/bank-institution-ids) page lists every ID.","type":"string","isRequired":true,"uniqueKey":"oneOf.9.bankAccount.institutionId","typeLabel":"string"},"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":{"name":{"description":"Full legal name of the account holder. Sent to the payout provider.","minLength":1,"type":"string","isRequired":true,"uniqueKey":"oneOf.9.bankAccount.accountHolder.name","typeLabel":"string"},"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","isRequired":true,"uniqueKey":"oneOf.9.bankAccount.accountHolder.address.city","typeLabel":"string"},"line1":{"description":"Primary address line (max 200 characters).","maxLength":200,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"oneOf.9.bankAccount.accountHolder.address.line1","typeLabel":"string"},"line2":{"description":"Secondary address line, such as an apartment, suite, or unit (max 60 characters).","maxLength":60,"type":"string","uniqueKey":"oneOf.9.bankAccount.accountHolder.address.line2","typeLabel":"string"},"postalCode":{"description":"Postal or ZIP code (max 20 characters).","maxLength":20,"minLength":1,"type":"string","uniqueKey":"oneOf.9.bankAccount.accountHolder.address.postalCode","typeLabel":"string"},"stateOrRegion":{"description":"State, province, or region (max 50 characters).","maxLength":50,"type":"string","uniqueKey":"oneOf.9.bankAccount.accountHolder.address.stateOrRegion","typeLabel":"string"}},"required":["city","line1"],"type":"object","uniqueKey":"oneOf.9.bankAccount.accountHolder.address","typeLabel":"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","uniqueKey":"oneOf.9.bankAccount.accountHolder.email","typeLabel":"string\u003cemail>"},"phoneNumber":{"description":"Phone number of the account holder in E.164 format.","minLength":1,"type":"string","uniqueKey":"oneOf.9.bankAccount.accountHolder.phoneNumber","typeLabel":"string"}},"required":["name"],"type":"object","uniqueKey":"oneOf.9.bankAccount.accountHolder","typeLabel":"object"},"accountType":{"description":"Type of the account. Present when sent on creation.","enum":["checking","savings"],"type":"string","uniqueKey":"oneOf.9.bankAccount.accountType","typeLabel":"enum\u003cstring>"},"entityType":{"description":"Type of the account holder. Present when sent on creation.","enum":["business","individual"],"type":"string","uniqueKey":"oneOf.9.bankAccount.entityType","typeLabel":"enum\u003cstring>"},"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","bi-fast","bre-b","cash-pickup","citad","eft","fast","fednow","fedwire","instapay","napas-247","nip","npss","pesonet","promptpay","rtp-credit","same-day-ach-credit","sct","sct-inst","sinpe","spei","uaefts","zahav"],"type":"string","uniqueKey":"oneOf.9.bankAccount.rails.pending.items.[INDEX]","typeLabel":"enum\u003cstring>"},"type":"array","isRequired":true,"uniqueKey":"oneOf.9.bankAccount.rails.pending","typeLabel":"enum\u003cstring>[]"},"status":{"description":"`pending` while asynchronous rail resolution is still running. `complete` when every provider has answered.","enum":["complete","pending"],"type":"string","isRequired":true,"uniqueKey":"oneOf.9.bankAccount.rails.status","typeLabel":"enum\u003cstring>"},"supported":{"description":"Rails that a currently-available payout provider advertises for this account.","items":{"enum":["ach-credit","bi-fast","bre-b","cash-pickup","citad","eft","fast","fednow","fedwire","instapay","napas-247","nip","npss","pesonet","promptpay","rtp-credit","same-day-ach-credit","sct","sct-inst","sinpe","spei","uaefts","zahav"],"type":"string","uniqueKey":"oneOf.9.bankAccount.rails.supported.items.[INDEX]","typeLabel":"enum\u003cstring>"},"type":"array","isRequired":true,"uniqueKey":"oneOf.9.bankAccount.rails.supported","typeLabel":"enum\u003cstring>[]"}},"required":["pending","status","supported"],"type":"object","uniqueKey":"oneOf.9.bankAccount.rails","typeLabel":"object"},"verificationStatus":{"description":"Result of the provider's check on the destination. Absent until a provider answers.","enum":["pending-review","rejected","verified"],"type":"string","uniqueKey":"oneOf.9.bankAccount.verificationStatus","typeLabel":"enum\u003cstring>"}},"required":["accountSuffix","country","currency","institutionId"],"type":"object","isRequired":true,"uniqueKey":"oneOf.9.bankAccount","typeLabel":"object"},"createdAt":{"description":"ISO 8601 timestamp when this payment method was created.","example":"2024-01-15T10:30:00.000Z","format":"date-time","type":"string","isRequired":true,"uniqueKey":"oneOf.9.createdAt","typeLabel":"string\u003cdate-time>"},"paymentMethodId":{"description":"Unique identifier (UUID v4). Crossmint assigns it on creation.","minLength":1,"type":"string","isRequired":true,"uniqueKey":"oneOf.9.paymentMethodId","typeLabel":"string"},"reason":{"oneOf":[{"type":"string","description":"Deprecated. Use `statusReason`, which carries the same value.","isRequired":true,"uniqueKey":"oneOf.9.reason.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.9.reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.9.reason","typeLabel":"string | 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","isRequired":true,"uniqueKey":"oneOf.9.status","typeLabel":"enum\u003cstring>"},"statusReason":{"oneOf":[{"type":"string","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.","isRequired":true,"uniqueKey":"oneOf.9.statusReason.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.9.statusReason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.9.statusReason","typeLabel":"string | null"},"type":{"const":"bank-account-tr","description":"Payment method type. Selects which sub-object is present: `card`, `bankAccount`, or `breB`.","type":"string","isRequired":true,"uniqueKey":"oneOf.9.type","typeLabel":"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","isRequired":true,"uniqueKey":"oneOf.9.updatedAt","typeLabel":"string\u003cdate-time>"},"label":{"description":"The client's own name for this payment method, when one was sent.","minLength":1,"type":"string","uniqueKey":"oneOf.9.label","typeLabel":"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","uniqueKey":"oneOf.9.lastPayoutAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"oneOf.9","typeLabel":"TR bank account · object"},{"type":"object","title":"VN bank account","description":"A saved payment method. Sensitive fields (full PAN, CVC, full account numbers, IBANs, Bre-B keys) are never included.","required":["bankAccount","createdAt","paymentMethodId","reason","status","statusReason","type","updatedAt"],"example":{"createdAt":"2025-01-15T10:30:00.000Z","paymentMethodId":"3f7a9c10-2a8b-4c5d-9e2f-1b3a4c5d6e7f","reason":null,"status":"active","statusReason":null,"type":"card","updatedAt":"2025-01-15T10:30:00.000Z"},"properties":{"bankAccount":{"description":"Bank account details. Present when `type` is a bank type. Full account numbers and IBANs are never included.","properties":{"accountSuffix":{"description":"The last characters of the account number, CLABE or IBAN, at most four.","type":"string","isRequired":true,"uniqueKey":"oneOf.10.bankAccount.accountSuffix","typeLabel":"string"},"country":{"const":"VN","description":"Always 'VN'.","type":"string","isRequired":true,"uniqueKey":"oneOf.10.bankAccount.country","typeLabel":"string"},"currency":{"const":"vnd","description":"Always 'vnd'; Vietnamese bank accounts only settle in Vietnamese dong.","type":"string","isRequired":true,"uniqueKey":"oneOf.10.bankAccount.currency","typeLabel":"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","isRequired":true,"uniqueKey":"oneOf.10.bankAccount.institutionId","typeLabel":"string"},"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":{"name":{"description":"Full legal name of the account holder. Sent to the payout provider.","minLength":1,"type":"string","isRequired":true,"uniqueKey":"oneOf.10.bankAccount.accountHolder.name","typeLabel":"string"},"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","isRequired":true,"uniqueKey":"oneOf.10.bankAccount.accountHolder.address.city","typeLabel":"string"},"line1":{"description":"Primary address line (max 200 characters).","maxLength":200,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"oneOf.10.bankAccount.accountHolder.address.line1","typeLabel":"string"},"line2":{"description":"Secondary address line, such as an apartment, suite, or unit (max 60 characters).","maxLength":60,"type":"string","uniqueKey":"oneOf.10.bankAccount.accountHolder.address.line2","typeLabel":"string"},"postalCode":{"description":"Postal or ZIP code (max 20 characters).","maxLength":20,"minLength":1,"type":"string","uniqueKey":"oneOf.10.bankAccount.accountHolder.address.postalCode","typeLabel":"string"},"stateOrRegion":{"description":"State, province, or region (max 50 characters).","maxLength":50,"type":"string","uniqueKey":"oneOf.10.bankAccount.accountHolder.address.stateOrRegion","typeLabel":"string"}},"required":["city","line1"],"type":"object","uniqueKey":"oneOf.10.bankAccount.accountHolder.address","typeLabel":"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","uniqueKey":"oneOf.10.bankAccount.accountHolder.email","typeLabel":"string\u003cemail>"},"phoneNumber":{"description":"Phone number of the account holder in E.164 format.","minLength":1,"type":"string","uniqueKey":"oneOf.10.bankAccount.accountHolder.phoneNumber","typeLabel":"string"}},"required":["name"],"type":"object","uniqueKey":"oneOf.10.bankAccount.accountHolder","typeLabel":"object"},"accountType":{"description":"Type of the account. Present when sent on creation.","enum":["checking","savings"],"type":"string","uniqueKey":"oneOf.10.bankAccount.accountType","typeLabel":"enum\u003cstring>"},"entityType":{"description":"Type of the account holder. Present when sent on creation.","enum":["business","individual"],"type":"string","uniqueKey":"oneOf.10.bankAccount.entityType","typeLabel":"enum\u003cstring>"},"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","bi-fast","bre-b","cash-pickup","citad","eft","fast","fednow","fedwire","instapay","napas-247","nip","npss","pesonet","promptpay","rtp-credit","same-day-ach-credit","sct","sct-inst","sinpe","spei","uaefts","zahav"],"type":"string","uniqueKey":"oneOf.10.bankAccount.rails.pending.items.[INDEX]","typeLabel":"enum\u003cstring>"},"type":"array","isRequired":true,"uniqueKey":"oneOf.10.bankAccount.rails.pending","typeLabel":"enum\u003cstring>[]"},"status":{"description":"`pending` while asynchronous rail resolution is still running. `complete` when every provider has answered.","enum":["complete","pending"],"type":"string","isRequired":true,"uniqueKey":"oneOf.10.bankAccount.rails.status","typeLabel":"enum\u003cstring>"},"supported":{"description":"Rails that a currently-available payout provider advertises for this account.","items":{"enum":["ach-credit","bi-fast","bre-b","cash-pickup","citad","eft","fast","fednow","fedwire","instapay","napas-247","nip","npss","pesonet","promptpay","rtp-credit","same-day-ach-credit","sct","sct-inst","sinpe","spei","uaefts","zahav"],"type":"string","uniqueKey":"oneOf.10.bankAccount.rails.supported.items.[INDEX]","typeLabel":"enum\u003cstring>"},"type":"array","isRequired":true,"uniqueKey":"oneOf.10.bankAccount.rails.supported","typeLabel":"enum\u003cstring>[]"}},"required":["pending","status","supported"],"type":"object","uniqueKey":"oneOf.10.bankAccount.rails","typeLabel":"object"},"verificationStatus":{"description":"Result of the provider's check on the destination. Absent until a provider answers.","enum":["pending-review","rejected","verified"],"type":"string","uniqueKey":"oneOf.10.bankAccount.verificationStatus","typeLabel":"enum\u003cstring>"}},"required":["accountSuffix","country","currency","institutionId"],"type":"object","isRequired":true,"uniqueKey":"oneOf.10.bankAccount","typeLabel":"object"},"createdAt":{"description":"ISO 8601 timestamp when this payment method was created.","example":"2024-01-15T10:30:00.000Z","format":"date-time","type":"string","isRequired":true,"uniqueKey":"oneOf.10.createdAt","typeLabel":"string\u003cdate-time>"},"paymentMethodId":{"description":"Unique identifier (UUID v4). Crossmint assigns it on creation.","minLength":1,"type":"string","isRequired":true,"uniqueKey":"oneOf.10.paymentMethodId","typeLabel":"string"},"reason":{"oneOf":[{"type":"string","description":"Deprecated. Use `statusReason`, which carries the same value.","isRequired":true,"uniqueKey":"oneOf.10.reason.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.10.reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.10.reason","typeLabel":"string | 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","isRequired":true,"uniqueKey":"oneOf.10.status","typeLabel":"enum\u003cstring>"},"statusReason":{"oneOf":[{"type":"string","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.","isRequired":true,"uniqueKey":"oneOf.10.statusReason.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.10.statusReason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.10.statusReason","typeLabel":"string | null"},"type":{"const":"bank-account-vn","description":"Payment method type. Selects which sub-object is present: `card`, `bankAccount`, or `breB`.","type":"string","isRequired":true,"uniqueKey":"oneOf.10.type","typeLabel":"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","isRequired":true,"uniqueKey":"oneOf.10.updatedAt","typeLabel":"string\u003cdate-time>"},"label":{"description":"The client's own name for this payment method, when one was sent.","minLength":1,"type":"string","uniqueKey":"oneOf.10.label","typeLabel":"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","uniqueKey":"oneOf.10.lastPayoutAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"oneOf.10","typeLabel":"VN bank account · object"},{"type":"object","title":"US bank account","description":"A saved payment method. Sensitive fields (full PAN, CVC, full account numbers, IBANs, Bre-B keys) are never included.","required":["bankAccount","createdAt","paymentMethodId","reason","status","statusReason","type","updatedAt"],"example":{"createdAt":"2025-01-15T10:30:00.000Z","paymentMethodId":"3f7a9c10-2a8b-4c5d-9e2f-1b3a4c5d6e7f","reason":null,"status":"active","statusReason":null,"type":"card","updatedAt":"2025-01-15T10:30:00.000Z"},"properties":{"bankAccount":{"description":"Bank account details. Present when `type` is a bank type. Full account numbers and IBANs are never included.","properties":{"accountSuffix":{"description":"The last characters of the account number, CLABE or IBAN, at most four.","type":"string","isRequired":true,"uniqueKey":"oneOf.11.bankAccount.accountSuffix","typeLabel":"string"},"accountType":{"description":"Type of the account.","enum":["checking","savings"],"type":"string","isRequired":true,"uniqueKey":"oneOf.11.bankAccount.accountType","typeLabel":"enum\u003cstring>"},"bankAddress":{"oneOf":[{"type":"object","description":"Where the bank is, as sent on creation. `null` when none was sent.","required":["city","line1","postalCode"],"properties":{"city":{"description":"City (max 50 characters).","maxLength":50,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"oneOf.11.bankAccount.bankAddress.oneOf.0.city","typeLabel":"string"},"line1":{"description":"Primary address line (max 200 characters).","maxLength":200,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"oneOf.11.bankAccount.bankAddress.oneOf.0.line1","typeLabel":"string"},"postalCode":{"description":"Postal or ZIP code (max 20 characters).","maxLength":20,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"oneOf.11.bankAccount.bankAddress.oneOf.0.postalCode","typeLabel":"string"},"country":{"description":"ISO 3166-1 alpha-2 country code. Present only on older accounts.","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","uniqueKey":"oneOf.11.bankAccount.bankAddress.oneOf.0.country","typeLabel":"enum\u003cstring>"},"line2":{"description":"Secondary address line, such as an apartment, suite, or unit (max 60 characters).","maxLength":60,"type":"string","uniqueKey":"oneOf.11.bankAccount.bankAddress.oneOf.0.line2","typeLabel":"string"},"stateOrRegion":{"description":"State, province, or region (max 50 characters).","maxLength":50,"type":"string","uniqueKey":"oneOf.11.bankAccount.bankAddress.oneOf.0.stateOrRegion","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.11.bankAccount.bankAddress.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.11.bankAccount.bankAddress.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.11.bankAccount.bankAddress","typeLabel":"object | 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","isRequired":true,"uniqueKey":"oneOf.11.bankAccount.country","typeLabel":"enum\u003cstring>"},"currency":{"const":"usd","description":"Always 'usd'; a US bank account only settles in US dollars.","type":"string","isRequired":true,"uniqueKey":"oneOf.11.bankAccount.currency","typeLabel":"string"},"routingNumber":{"description":"ABA routing number.","type":"string","isRequired":true,"uniqueKey":"oneOf.11.bankAccount.routingNumber","typeLabel":"string"},"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":{"name":{"description":"Full legal name of the account holder. Sent to the payout provider.","minLength":1,"type":"string","isRequired":true,"uniqueKey":"oneOf.11.bankAccount.accountHolder.name","typeLabel":"string"},"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","isRequired":true,"uniqueKey":"oneOf.11.bankAccount.accountHolder.address.city","typeLabel":"string"},"line1":{"description":"Primary address line (max 200 characters).","maxLength":200,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"oneOf.11.bankAccount.accountHolder.address.line1","typeLabel":"string"},"line2":{"description":"Secondary address line, such as an apartment, suite, or unit (max 60 characters).","maxLength":60,"type":"string","uniqueKey":"oneOf.11.bankAccount.accountHolder.address.line2","typeLabel":"string"},"postalCode":{"description":"Postal or ZIP code (max 20 characters).","maxLength":20,"minLength":1,"type":"string","uniqueKey":"oneOf.11.bankAccount.accountHolder.address.postalCode","typeLabel":"string"},"stateOrRegion":{"description":"State, province, or region (max 50 characters).","maxLength":50,"type":"string","uniqueKey":"oneOf.11.bankAccount.accountHolder.address.stateOrRegion","typeLabel":"string"}},"required":["city","line1"],"type":"object","uniqueKey":"oneOf.11.bankAccount.accountHolder.address","typeLabel":"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","uniqueKey":"oneOf.11.bankAccount.accountHolder.email","typeLabel":"string\u003cemail>"},"phoneNumber":{"description":"Phone number of the account holder in E.164 format.","minLength":1,"type":"string","uniqueKey":"oneOf.11.bankAccount.accountHolder.phoneNumber","typeLabel":"string"}},"required":["name"],"type":"object","uniqueKey":"oneOf.11.bankAccount.accountHolder","typeLabel":"object"},"entityType":{"description":"Type of the account holder. Present when sent on creation.","enum":["business","individual"],"type":"string","uniqueKey":"oneOf.11.bankAccount.entityType","typeLabel":"enum\u003cstring>"},"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","bi-fast","bre-b","cash-pickup","citad","eft","fast","fednow","fedwire","instapay","napas-247","nip","npss","pesonet","promptpay","rtp-credit","same-day-ach-credit","sct","sct-inst","sinpe","spei","uaefts","zahav"],"type":"string","uniqueKey":"oneOf.11.bankAccount.rails.pending.items.[INDEX]","typeLabel":"enum\u003cstring>"},"type":"array","isRequired":true,"uniqueKey":"oneOf.11.bankAccount.rails.pending","typeLabel":"enum\u003cstring>[]"},"status":{"description":"`pending` while asynchronous rail resolution is still running. `complete` when every provider has answered.","enum":["complete","pending"],"type":"string","isRequired":true,"uniqueKey":"oneOf.11.bankAccount.rails.status","typeLabel":"enum\u003cstring>"},"supported":{"description":"Rails that a currently-available payout provider advertises for this account.","items":{"enum":["ach-credit","bi-fast","bre-b","cash-pickup","citad","eft","fast","fednow","fedwire","instapay","napas-247","nip","npss","pesonet","promptpay","rtp-credit","same-day-ach-credit","sct","sct-inst","sinpe","spei","uaefts","zahav"],"type":"string","uniqueKey":"oneOf.11.bankAccount.rails.supported.items.[INDEX]","typeLabel":"enum\u003cstring>"},"type":"array","isRequired":true,"uniqueKey":"oneOf.11.bankAccount.rails.supported","typeLabel":"enum\u003cstring>[]"}},"required":["pending","status","supported"],"type":"object","uniqueKey":"oneOf.11.bankAccount.rails","typeLabel":"object"},"verificationStatus":{"description":"Result of the provider's check on the destination. Absent until a provider answers.","enum":["pending-review","rejected","verified"],"type":"string","uniqueKey":"oneOf.11.bankAccount.verificationStatus","typeLabel":"enum\u003cstring>"}},"required":["accountSuffix","accountType","bankAddress","country","currency","routingNumber"],"type":"object","isRequired":true,"uniqueKey":"oneOf.11.bankAccount","typeLabel":"object"},"createdAt":{"description":"ISO 8601 timestamp when this payment method was created.","example":"2024-01-15T10:30:00.000Z","format":"date-time","type":"string","isRequired":true,"uniqueKey":"oneOf.11.createdAt","typeLabel":"string\u003cdate-time>"},"paymentMethodId":{"description":"Unique identifier (UUID v4). Crossmint assigns it on creation.","minLength":1,"type":"string","isRequired":true,"uniqueKey":"oneOf.11.paymentMethodId","typeLabel":"string"},"reason":{"oneOf":[{"type":"string","description":"Deprecated. Use `statusReason`, which carries the same value.","isRequired":true,"uniqueKey":"oneOf.11.reason.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.11.reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.11.reason","typeLabel":"string | 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","isRequired":true,"uniqueKey":"oneOf.11.status","typeLabel":"enum\u003cstring>"},"statusReason":{"oneOf":[{"type":"string","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.","isRequired":true,"uniqueKey":"oneOf.11.statusReason.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.11.statusReason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.11.statusReason","typeLabel":"string | null"},"type":{"const":"bank-account-us","description":"Payment method type. Selects which sub-object is present: `card`, `bankAccount`, or `breB`.","type":"string","isRequired":true,"uniqueKey":"oneOf.11.type","typeLabel":"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","isRequired":true,"uniqueKey":"oneOf.11.updatedAt","typeLabel":"string\u003cdate-time>"},"label":{"description":"The client's own name for this payment method, when one was sent.","minLength":1,"type":"string","uniqueKey":"oneOf.11.label","typeLabel":"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","uniqueKey":"oneOf.11.lastPayoutAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"oneOf.11","typeLabel":"US bank account · object"},{"type":"object","title":"SEPA IBAN","description":"A saved payment method. Sensitive fields (full PAN, CVC, full account numbers, IBANs, Bre-B keys) are never included.","required":["bankAccount","createdAt","paymentMethodId","reason","status","statusReason","type","updatedAt"],"example":{"createdAt":"2025-01-15T10:30:00.000Z","default":true,"display":{"imageUrl":"https://www.crossmint.com/assets/cards/visa.svg","label":"Visa ending in 4242"},"paymentMethodId":"3f7a9c10-2a8b-4c5d-9e2f-1b3a4c5d6e7f","reason":null,"status":"active","statusReason":null,"type":"card","updatedAt":"2025-01-15T10:30:00.000Z"},"properties":{"bankAccount":{"description":"Bank account details. Present when `type` is a bank type. Full account numbers and IBANs are never included.","properties":{"accountSuffix":{"description":"The last characters of the account number, CLABE or IBAN, at most four.","type":"string","isRequired":true,"uniqueKey":"oneOf.12.bankAccount.accountSuffix","typeLabel":"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","isRequired":true,"uniqueKey":"oneOf.12.bankAccount.country","typeLabel":"enum\u003cstring>"},"currency":{"const":"eur","description":"Always 'eur'; SEPA only transacts in Euro.","type":"string","isRequired":true,"uniqueKey":"oneOf.12.bankAccount.currency","typeLabel":"string"},"accountHolder":{"description":"The person who owns the bank account, as sent on creation.","properties":{"name":{"description":"Full legal name of the account holder. Sent to the payout provider.","minLength":1,"type":"string","isRequired":true,"uniqueKey":"oneOf.12.bankAccount.accountHolder.name","typeLabel":"string"},"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","isRequired":true,"uniqueKey":"oneOf.12.bankAccount.accountHolder.address.city","typeLabel":"string"},"line1":{"description":"Primary address line (max 200 characters).","maxLength":200,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"oneOf.12.bankAccount.accountHolder.address.line1","typeLabel":"string"},"line2":{"description":"Secondary address line, such as an apartment, suite, or unit (max 60 characters).","maxLength":60,"type":"string","uniqueKey":"oneOf.12.bankAccount.accountHolder.address.line2","typeLabel":"string"},"postalCode":{"description":"Postal or ZIP code (max 20 characters).","maxLength":20,"minLength":1,"type":"string","uniqueKey":"oneOf.12.bankAccount.accountHolder.address.postalCode","typeLabel":"string"},"stateOrRegion":{"description":"State, province, or region (max 50 characters).","maxLength":50,"type":"string","uniqueKey":"oneOf.12.bankAccount.accountHolder.address.stateOrRegion","typeLabel":"string"}},"required":["city","line1"],"type":"object","uniqueKey":"oneOf.12.bankAccount.accountHolder.address","typeLabel":"object"},"country":{"description":"Country where the account holder lives or is registered. Absent on older accounts.","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","uniqueKey":"oneOf.12.bankAccount.accountHolder.country","typeLabel":"enum\u003cstring>"},"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","uniqueKey":"oneOf.12.bankAccount.accountHolder.email","typeLabel":"string\u003cemail>"},"phoneNumber":{"description":"Phone number of the account holder in E.164 format.","minLength":1,"type":"string","uniqueKey":"oneOf.12.bankAccount.accountHolder.phoneNumber","typeLabel":"string"}},"required":["name"],"type":"object","uniqueKey":"oneOf.12.bankAccount.accountHolder","typeLabel":"object"},"bic":{"description":"BIC/SWIFT code. Present when sent on creation.","type":"string","uniqueKey":"oneOf.12.bankAccount.bic","typeLabel":"string"},"entityType":{"description":"Type of the account holder. Present when sent on creation.","enum":["business","individual"],"type":"string","uniqueKey":"oneOf.12.bankAccount.entityType","typeLabel":"enum\u003cstring>"},"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","bi-fast","bre-b","cash-pickup","citad","eft","fast","fednow","fedwire","instapay","napas-247","nip","npss","pesonet","promptpay","rtp-credit","same-day-ach-credit","sct","sct-inst","sinpe","spei","uaefts","zahav"],"type":"string","uniqueKey":"oneOf.12.bankAccount.rails.pending.items.[INDEX]","typeLabel":"enum\u003cstring>"},"type":"array","isRequired":true,"uniqueKey":"oneOf.12.bankAccount.rails.pending","typeLabel":"enum\u003cstring>[]"},"status":{"description":"`pending` while asynchronous rail resolution is still running. `complete` when every provider has answered.","enum":["complete","pending"],"type":"string","isRequired":true,"uniqueKey":"oneOf.12.bankAccount.rails.status","typeLabel":"enum\u003cstring>"},"supported":{"description":"Rails that a currently-available payout provider advertises for this account.","items":{"enum":["ach-credit","bi-fast","bre-b","cash-pickup","citad","eft","fast","fednow","fedwire","instapay","napas-247","nip","npss","pesonet","promptpay","rtp-credit","same-day-ach-credit","sct","sct-inst","sinpe","spei","uaefts","zahav"],"type":"string","uniqueKey":"oneOf.12.bankAccount.rails.supported.items.[INDEX]","typeLabel":"enum\u003cstring>"},"type":"array","isRequired":true,"uniqueKey":"oneOf.12.bankAccount.rails.supported","typeLabel":"enum\u003cstring>[]"}},"required":["pending","status","supported"],"type":"object","uniqueKey":"oneOf.12.bankAccount.rails","typeLabel":"object"},"verificationStatus":{"description":"Result of the provider's check on the destination. Absent until a provider answers.","enum":["pending-review","rejected","verified"],"type":"string","uniqueKey":"oneOf.12.bankAccount.verificationStatus","typeLabel":"enum\u003cstring>"}},"required":["accountSuffix","country","currency"],"type":"object","isRequired":true,"uniqueKey":"oneOf.12.bankAccount","typeLabel":"object"},"createdAt":{"description":"ISO 8601 timestamp when this payment method was created.","example":"2024-01-15T10:30:00.000Z","format":"date-time","type":"string","isRequired":true,"uniqueKey":"oneOf.12.createdAt","typeLabel":"string\u003cdate-time>"},"paymentMethodId":{"description":"Unique identifier (UUID v4). Crossmint assigns it on creation.","minLength":1,"type":"string","isRequired":true,"uniqueKey":"oneOf.12.paymentMethodId","typeLabel":"string"},"reason":{"oneOf":[{"type":"string","description":"Deprecated. Use `statusReason`, which carries the same value.","isRequired":true,"uniqueKey":"oneOf.12.reason.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.12.reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.12.reason","typeLabel":"string | 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","isRequired":true,"uniqueKey":"oneOf.12.status","typeLabel":"enum\u003cstring>"},"statusReason":{"oneOf":[{"type":"string","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.","isRequired":true,"uniqueKey":"oneOf.12.statusReason.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.12.statusReason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.12.statusReason","typeLabel":"string | null"},"type":{"const":"bank-account-sepa-iban","description":"Payment method type. Selects which sub-object is present: `card`, `bankAccount`, or `breB`.","type":"string","isRequired":true,"uniqueKey":"oneOf.12.type","typeLabel":"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","isRequired":true,"uniqueKey":"oneOf.12.updatedAt","typeLabel":"string\u003cdate-time>"},"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","uniqueKey":"oneOf.12.default","typeLabel":"boolean"},"display":{"description":"Display data for a payment method selector.","properties":{"imageUrl":{"description":"URL of the brand logo.","format":"uri","type":"string","uniqueKey":"oneOf.12.display.imageUrl","typeLabel":"string\u003curi>"},"label":{"description":"Label to show in a payment method selector.","type":"string","uniqueKey":"oneOf.12.display.label","typeLabel":"string"}},"type":"object","uniqueKey":"oneOf.12.display","typeLabel":"object"},"label":{"description":"The client's own name for this payment method, when one was sent.","minLength":1,"type":"string","uniqueKey":"oneOf.12.label","typeLabel":"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","uniqueKey":"oneOf.12.lastPayoutAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"oneOf.12","typeLabel":"SEPA IBAN · object"},{"type":"object","title":"CR bank account","description":"A saved payment method. Sensitive fields (full PAN, CVC, full account numbers, IBANs, Bre-B keys) are never included.","required":["bankAccount","createdAt","paymentMethodId","reason","status","statusReason","type","updatedAt"],"example":{"createdAt":"2025-01-15T10:30:00.000Z","paymentMethodId":"3f7a9c10-2a8b-4c5d-9e2f-1b3a4c5d6e7f","reason":null,"status":"active","statusReason":null,"type":"card","updatedAt":"2025-01-15T10:30:00.000Z"},"properties":{"bankAccount":{"description":"Bank account details. Present when `type` is a bank type. Full account numbers and IBANs are never included.","properties":{"accountSuffix":{"description":"The last characters of the account number, CLABE or IBAN, at most four.","type":"string","isRequired":true,"uniqueKey":"oneOf.13.bankAccount.accountSuffix","typeLabel":"string"},"country":{"const":"CR","description":"Always 'CR'.","type":"string","isRequired":true,"uniqueKey":"oneOf.13.bankAccount.country","typeLabel":"string"},"currency":{"const":"crc","description":"Always 'crc'; Costa Rican bank accounts only settle in Costa Rican colones.","type":"string","isRequired":true,"uniqueKey":"oneOf.13.bankAccount.currency","typeLabel":"string"},"institutionId":{"description":"ID of the bank, for example `cr-banco-nacional`. The [Bank Institution IDs](https://docs.crossmint.com/offramp/guides/bank-institution-ids) page lists every ID.","type":"string","isRequired":true,"uniqueKey":"oneOf.13.bankAccount.institutionId","typeLabel":"string"},"accountHolder":{"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","isRequired":true,"uniqueKey":"oneOf.13.bankAccount.accountHolder.document.suffix","typeLabel":"string"},"type":{"description":"Document type: `cf` (Cédula Física, for a person), `cj` (Cédula Jurídica, for a company) or `dimex` (Documento de Identidad Migratorio para Extranjeros, for a foreign resident).","enum":["cf","cj","dimex"],"type":"string","isRequired":true,"uniqueKey":"oneOf.13.bankAccount.accountHolder.document.type","typeLabel":"enum\u003cstring>"}},"required":["suffix","type"],"type":"object","isRequired":true,"uniqueKey":"oneOf.13.bankAccount.accountHolder.document","typeLabel":"object"},"name":{"description":"Full legal name of the account holder. Sent to the payout provider.","minLength":1,"type":"string","isRequired":true,"uniqueKey":"oneOf.13.bankAccount.accountHolder.name","typeLabel":"string"},"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","isRequired":true,"uniqueKey":"oneOf.13.bankAccount.accountHolder.address.city","typeLabel":"string"},"line1":{"description":"Primary address line (max 200 characters).","maxLength":200,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"oneOf.13.bankAccount.accountHolder.address.line1","typeLabel":"string"},"line2":{"description":"Secondary address line, such as an apartment, suite, or unit (max 60 characters).","maxLength":60,"type":"string","uniqueKey":"oneOf.13.bankAccount.accountHolder.address.line2","typeLabel":"string"},"postalCode":{"description":"Postal or ZIP code (max 20 characters).","maxLength":20,"minLength":1,"type":"string","uniqueKey":"oneOf.13.bankAccount.accountHolder.address.postalCode","typeLabel":"string"},"stateOrRegion":{"description":"State, province, or region (max 50 characters).","maxLength":50,"type":"string","uniqueKey":"oneOf.13.bankAccount.accountHolder.address.stateOrRegion","typeLabel":"string"}},"required":["city","line1"],"type":"object","uniqueKey":"oneOf.13.bankAccount.accountHolder.address","typeLabel":"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","uniqueKey":"oneOf.13.bankAccount.accountHolder.email","typeLabel":"string\u003cemail>"},"phoneNumber":{"description":"Phone number of the account holder in E.164 format.","minLength":1,"type":"string","uniqueKey":"oneOf.13.bankAccount.accountHolder.phoneNumber","typeLabel":"string"}},"required":["document","name"],"type":"object","uniqueKey":"oneOf.13.bankAccount.accountHolder","typeLabel":"object"},"accountType":{"description":"Type of the account. Present when sent on creation.","enum":["checking","savings"],"type":"string","uniqueKey":"oneOf.13.bankAccount.accountType","typeLabel":"enum\u003cstring>"},"entityType":{"description":"Type of the account holder. Present when sent on creation.","enum":["business","individual"],"type":"string","uniqueKey":"oneOf.13.bankAccount.entityType","typeLabel":"enum\u003cstring>"},"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","bi-fast","bre-b","cash-pickup","citad","eft","fast","fednow","fedwire","instapay","napas-247","nip","npss","pesonet","promptpay","rtp-credit","same-day-ach-credit","sct","sct-inst","sinpe","spei","uaefts","zahav"],"type":"string","uniqueKey":"oneOf.13.bankAccount.rails.pending.items.[INDEX]","typeLabel":"enum\u003cstring>"},"type":"array","isRequired":true,"uniqueKey":"oneOf.13.bankAccount.rails.pending","typeLabel":"enum\u003cstring>[]"},"status":{"description":"`pending` while asynchronous rail resolution is still running. `complete` when every provider has answered.","enum":["complete","pending"],"type":"string","isRequired":true,"uniqueKey":"oneOf.13.bankAccount.rails.status","typeLabel":"enum\u003cstring>"},"supported":{"description":"Rails that a currently-available payout provider advertises for this account.","items":{"enum":["ach-credit","bi-fast","bre-b","cash-pickup","citad","eft","fast","fednow","fedwire","instapay","napas-247","nip","npss","pesonet","promptpay","rtp-credit","same-day-ach-credit","sct","sct-inst","sinpe","spei","uaefts","zahav"],"type":"string","uniqueKey":"oneOf.13.bankAccount.rails.supported.items.[INDEX]","typeLabel":"enum\u003cstring>"},"type":"array","isRequired":true,"uniqueKey":"oneOf.13.bankAccount.rails.supported","typeLabel":"enum\u003cstring>[]"}},"required":["pending","status","supported"],"type":"object","uniqueKey":"oneOf.13.bankAccount.rails","typeLabel":"object"},"verificationStatus":{"description":"Result of the provider's check on the destination. Absent until a provider answers.","enum":["pending-review","rejected","verified"],"type":"string","uniqueKey":"oneOf.13.bankAccount.verificationStatus","typeLabel":"enum\u003cstring>"}},"required":["accountSuffix","country","currency","institutionId"],"type":"object","isRequired":true,"uniqueKey":"oneOf.13.bankAccount","typeLabel":"object"},"createdAt":{"description":"ISO 8601 timestamp when this payment method was created.","example":"2024-01-15T10:30:00.000Z","format":"date-time","type":"string","isRequired":true,"uniqueKey":"oneOf.13.createdAt","typeLabel":"string\u003cdate-time>"},"paymentMethodId":{"description":"Unique identifier (UUID v4). Crossmint assigns it on creation.","minLength":1,"type":"string","isRequired":true,"uniqueKey":"oneOf.13.paymentMethodId","typeLabel":"string"},"reason":{"oneOf":[{"type":"string","description":"Deprecated. Use `statusReason`, which carries the same value.","isRequired":true,"uniqueKey":"oneOf.13.reason.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.13.reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.13.reason","typeLabel":"string | 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","isRequired":true,"uniqueKey":"oneOf.13.status","typeLabel":"enum\u003cstring>"},"statusReason":{"oneOf":[{"type":"string","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.","isRequired":true,"uniqueKey":"oneOf.13.statusReason.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.13.statusReason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.13.statusReason","typeLabel":"string | null"},"type":{"const":"bank-account-cr","description":"Payment method type. Selects which sub-object is present: `card`, `bankAccount`, or `breB`.","type":"string","isRequired":true,"uniqueKey":"oneOf.13.type","typeLabel":"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","isRequired":true,"uniqueKey":"oneOf.13.updatedAt","typeLabel":"string\u003cdate-time>"},"label":{"description":"The client's own name for this payment method, when one was sent.","minLength":1,"type":"string","uniqueKey":"oneOf.13.label","typeLabel":"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","uniqueKey":"oneOf.13.lastPayoutAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"oneOf.13","typeLabel":"CR bank account · object"},{"type":"object","title":"CO Bre-B key","description":"A saved payment method. Sensitive fields (full PAN, CVC, full account numbers, IBANs, Bre-B keys) are never included.","required":["breB","createdAt","paymentMethodId","reason","status","statusReason","type","updatedAt"],"example":{"createdAt":"2025-01-15T10:30:00.000Z","paymentMethodId":"3f7a9c10-2a8b-4c5d-9e2f-1b3a4c5d6e7f","reason":null,"status":"active","statusReason":null,"type":"card","updatedAt":"2025-01-15T10:30:00.000Z"},"properties":{"breB":{"additionalProperties":false,"description":"Bre-B key details. Present when `type` is `bre-b`. The key itself is never returned.","properties":{"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","isRequired":true,"uniqueKey":"oneOf.14.breB.accountSuffix","typeLabel":"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","isRequired":true,"uniqueKey":"oneOf.14.breB.country","typeLabel":"enum\u003cstring>"},"currency":{"const":"cop","description":"Always 'cop'; Bre-B only settles in Colombian pesos.","type":"string","isRequired":true,"uniqueKey":"oneOf.14.breB.currency","typeLabel":"string"},"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":{"name":{"description":"Full legal name of the account holder. Sent to the payout provider.","minLength":1,"type":"string","isRequired":true,"uniqueKey":"oneOf.14.breB.accountHolder.name","typeLabel":"string"},"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","isRequired":true,"uniqueKey":"oneOf.14.breB.accountHolder.address.city","typeLabel":"string"},"line1":{"description":"Primary address line (max 200 characters).","maxLength":200,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"oneOf.14.breB.accountHolder.address.line1","typeLabel":"string"},"line2":{"description":"Secondary address line, such as an apartment, suite, or unit (max 60 characters).","maxLength":60,"type":"string","uniqueKey":"oneOf.14.breB.accountHolder.address.line2","typeLabel":"string"},"postalCode":{"description":"Postal or ZIP code (max 20 characters).","maxLength":20,"minLength":1,"type":"string","uniqueKey":"oneOf.14.breB.accountHolder.address.postalCode","typeLabel":"string"},"stateOrRegion":{"description":"State, province, or region (max 50 characters).","maxLength":50,"type":"string","uniqueKey":"oneOf.14.breB.accountHolder.address.stateOrRegion","typeLabel":"string"}},"required":["city","line1"],"type":"object","uniqueKey":"oneOf.14.breB.accountHolder.address","typeLabel":"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","uniqueKey":"oneOf.14.breB.accountHolder.email","typeLabel":"string\u003cemail>"},"phoneNumber":{"description":"Phone number of the account holder in E.164 format.","minLength":1,"type":"string","uniqueKey":"oneOf.14.breB.accountHolder.phoneNumber","typeLabel":"string"}},"required":["name"],"type":"object","uniqueKey":"oneOf.14.breB.accountHolder","typeLabel":"object"},"entityType":{"description":"Type of the account holder. Present when sent on creation.","enum":["business","individual"],"type":"string","uniqueKey":"oneOf.14.breB.entityType","typeLabel":"enum\u003cstring>"},"institutionName":{"description":"Display name of the institution holding the key. Absent until a name source answers.","type":"string","uniqueKey":"oneOf.14.breB.institutionName","typeLabel":"string"},"keyType":{"description":"Derived from the key's format, never asserted by the client. Best effort.","enum":["alphanumeric","commerce","email","identification","phone"],"type":"string","uniqueKey":"oneOf.14.breB.keyType","typeLabel":"enum\u003cstring>"},"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","bi-fast","bre-b","cash-pickup","citad","eft","fast","fednow","fedwire","instapay","napas-247","nip","npss","pesonet","promptpay","rtp-credit","same-day-ach-credit","sct","sct-inst","sinpe","spei","uaefts","zahav"],"type":"string","uniqueKey":"oneOf.14.breB.rails.supported.items.[INDEX]","typeLabel":"enum\u003cstring>"},"type":"array","isRequired":true,"uniqueKey":"oneOf.14.breB.rails.supported","typeLabel":"enum\u003cstring>[]"}},"required":["supported"],"type":"object","uniqueKey":"oneOf.14.breB.rails","typeLabel":"object"},"verificationStatus":{"description":"Result of the provider's check on the destination. Absent until a provider answers.","enum":["pending-review","rejected","verified"],"type":"string","uniqueKey":"oneOf.14.breB.verificationStatus","typeLabel":"enum\u003cstring>"}},"required":["accountSuffix","country","currency"],"type":"object","isRequired":true,"uniqueKey":"oneOf.14.breB","typeLabel":"object"},"createdAt":{"description":"ISO 8601 timestamp when this payment method was created.","example":"2024-01-15T10:30:00.000Z","format":"date-time","type":"string","isRequired":true,"uniqueKey":"oneOf.14.createdAt","typeLabel":"string\u003cdate-time>"},"paymentMethodId":{"description":"Unique identifier (UUID v4). Crossmint assigns it on creation.","minLength":1,"type":"string","isRequired":true,"uniqueKey":"oneOf.14.paymentMethodId","typeLabel":"string"},"reason":{"oneOf":[{"type":"string","description":"Deprecated. Use `statusReason`, which carries the same value.","isRequired":true,"uniqueKey":"oneOf.14.reason.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.14.reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.14.reason","typeLabel":"string | 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","isRequired":true,"uniqueKey":"oneOf.14.status","typeLabel":"enum\u003cstring>"},"statusReason":{"oneOf":[{"type":"string","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.","isRequired":true,"uniqueKey":"oneOf.14.statusReason.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.14.statusReason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.14.statusReason","typeLabel":"string | null"},"type":{"const":"bre-b","description":"Payment method type. A Bre-B key returns its details under `breB`, never `bankAccount`.","type":"string","isRequired":true,"uniqueKey":"oneOf.14.type","typeLabel":"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","isRequired":true,"uniqueKey":"oneOf.14.updatedAt","typeLabel":"string\u003cdate-time>"},"label":{"description":"The client's own name for this payment method, when one was sent.","minLength":1,"type":"string","uniqueKey":"oneOf.14.label","typeLabel":"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","uniqueKey":"oneOf.14.lastPayoutAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"oneOf.14","typeLabel":"CO Bre-B key · object"},{"type":"object","title":"Card","description":"A saved payment method. Sensitive fields (full PAN, CVC, full account numbers, IBANs, Bre-B keys) are never included.","required":["card","createdAt","displayName","paymentMethodId","reason","status","statusReason","type","updatedAt"],"example":{"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","reason":null,"status":"active","statusReason":null,"type":"card","updatedAt":"2025-01-15T10:30:00.000Z"},"properties":{"card":{"description":"Card details. Present when `type` is `card`.","properties":{"billing":{"description":"Billing details of the cardholder, as sent on creation.","properties":{"name":{"description":"Full name of the cardholder or account holder.","minLength":1,"type":"string","isRequired":true,"uniqueKey":"oneOf.15.card.billing.name","typeLabel":"string"},"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","isRequired":true,"uniqueKey":"oneOf.15.card.billing.address.city","typeLabel":"string"},"country":{"description":"ISO 3166-1 alpha-2 country code.","maxLength":2,"minLength":2,"type":"string","isRequired":true,"uniqueKey":"oneOf.15.card.billing.address.country","typeLabel":"string"},"line1":{"description":"Primary address line (max 200 characters).","maxLength":200,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"oneOf.15.card.billing.address.line1","typeLabel":"string"},"postalCode":{"description":"Postal or ZIP code (max 20 characters).","maxLength":20,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"oneOf.15.card.billing.address.postalCode","typeLabel":"string"},"line2":{"description":"Secondary address line, such as an apartment, suite, or unit (max 60 characters).","maxLength":60,"type":"string","uniqueKey":"oneOf.15.card.billing.address.line2","typeLabel":"string"},"stateOrRegion":{"description":"State, province, or region (max 50 characters).","maxLength":50,"type":"string","uniqueKey":"oneOf.15.card.billing.address.stateOrRegion","typeLabel":"string"}},"required":["city","country","line1","postalCode"],"type":"object","uniqueKey":"oneOf.15.card.billing.address","typeLabel":"object"},"phone":{"description":"Phone number in E.164 format, for example `+12125551234`.","minLength":1,"type":"string","uniqueKey":"oneOf.15.card.billing.phone","typeLabel":"string"}},"required":["name"],"type":"object","isRequired":true,"uniqueKey":"oneOf.15.card.billing","typeLabel":"object"},"brand":{"description":"Card network brand, detected from the card number.","enum":["amex","diners-club","discover","jcb","mastercard","unionpay","visa"],"type":"string","isRequired":true,"uniqueKey":"oneOf.15.card.brand","typeLabel":"enum\u003cstring>"},"expiration":{"description":"Card expiration date.","properties":{"month":{"description":"2-digit expiration month, zero-padded (`01`-`12`).","type":"string","isRequired":true,"uniqueKey":"oneOf.15.card.expiration.month","typeLabel":"string"},"year":{"description":"4-digit expiration year.","type":"string","isRequired":true,"uniqueKey":"oneOf.15.card.expiration.year","typeLabel":"string"}},"required":["month","year"],"type":"object","isRequired":true,"uniqueKey":"oneOf.15.card.expiration","typeLabel":"object"},"last4":{"description":"Last 4 digits of the card PAN.","type":"string","isRequired":true,"uniqueKey":"oneOf.15.card.last4","typeLabel":"string"},"bin":{"description":"Bank Identification Number (first 6-8 digits). Present when the card network provides it.","type":"string","uniqueKey":"oneOf.15.card.bin","typeLabel":"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","uniqueKey":"oneOf.15.card.country","typeLabel":"string"},"fundingType":{"description":"Card funding type, detected from the BIN. Present when the issuer provides it.","enum":["credit","debit","prepaid","unknown"],"type":"string","uniqueKey":"oneOf.15.card.fundingType","typeLabel":"enum\u003cstring>"}},"required":["billing","brand","expiration","last4"],"type":"object","isRequired":true,"uniqueKey":"oneOf.15.card","typeLabel":"object"},"createdAt":{"description":"ISO 8601 timestamp when this payment method was created.","example":"2024-01-15T10:30:00.000Z","format":"date-time","type":"string","isRequired":true,"uniqueKey":"oneOf.15.createdAt","typeLabel":"string\u003cdate-time>"},"displayName":{"description":"Human-readable label derived from the account details, e.g. \"Visa ••1111\" or \"Deutsche Bank ••6789\".","minLength":1,"type":"string","isRequired":true,"uniqueKey":"oneOf.15.displayName","typeLabel":"string"},"paymentMethodId":{"description":"Unique identifier (UUID v4). Crossmint assigns it on creation.","minLength":1,"type":"string","isRequired":true,"uniqueKey":"oneOf.15.paymentMethodId","typeLabel":"string"},"reason":{"description":"Deprecated. Use `statusReason`, which carries the same value.","type":"null","isRequired":true,"uniqueKey":"oneOf.15.reason","typeLabel":"null"},"status":{"description":"Whether the card is saved. 'active' while it is saved, 'deleted' once it is deleted. A deleted card never returns to 'active'. Branch on this field, never on `statusReason`.","enum":["active","deleted"],"type":"string","isRequired":true,"uniqueKey":"oneOf.15.status","typeLabel":"enum\u003cstring>"},"statusReason":{"description":"Always `null` on a card; cards carry no destination condition.","type":"null","isRequired":true,"uniqueKey":"oneOf.15.statusReason","typeLabel":"null"},"type":{"const":"card","description":"Payment method type. Selects which sub-object is present: `card`, `bankAccount`, or `breB`.","type":"string","isRequired":true,"uniqueKey":"oneOf.15.type","typeLabel":"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","isRequired":true,"uniqueKey":"oneOf.15.updatedAt","typeLabel":"string\u003cdate-time>"},"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","uniqueKey":"oneOf.15.default","typeLabel":"boolean"},"display":{"description":"Display data for a payment method selector.","properties":{"imageUrl":{"description":"URL of the brand logo.","format":"uri","type":"string","uniqueKey":"oneOf.15.display.imageUrl","typeLabel":"string\u003curi>"},"label":{"description":"Label to show in a payment method selector.","type":"string","uniqueKey":"oneOf.15.display.label","typeLabel":"string"}},"type":"object","uniqueKey":"oneOf.15.display","typeLabel":"object"}},"uniqueKey":"oneOf.15","typeLabel":"Card · object"}],"uniqueKey":"","typeLabel":"CO bank account · object | MX CLABE · object | AE bank account · object | ID bank account · object | IL bank account · object | JO bank account · object | NG bank account · object | PH bank account · object | TH bank account · object | TR bank account · object | VN bank account · object | US bank account · object | SEPA IBAN · object | CR bank account · object | CO Bre-B key · object | Card · object"},"exampleType":"examples"}},"description":"The payment method in its terminal state. A deleted payment method stays readable through Retrieve Payment Method, and through List Payment Methods with `status=deleted`.","exampleType":"examples"},"5c5a1889-d46d-4e32-a711-6fc3117b41ca":{"content":{"application/json":{"examples":{"missing_locator":{"title":"missing_locator","value":{"code":"PAYMENT_METHOD_INVALID_USER_LOCATOR","error":true,"message":"userLocator is required when not using JWT authentication"}}},"schema":{"properties":{"error":{"example":true,"type":"boolean","isRequired":true,"uniqueKey":"error","typeLabel":"boolean"},"message":{"description":"Human-readable error message describing what went wrong","type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"description":"Machine-readable error code for programmatic handling","type":"string","uniqueKey":"code","typeLabel":"string"},"parameters":{"additionalProperties":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"parameters.additionalProperties.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"parameters.additionalProperties.oneOf.0","typeLabel":"string[]"},{"type":"string","uniqueKey":"parameters.additionalProperties.oneOf.1","typeLabel":"string"}],"uniqueKey":"parameters.additionalProperties","typeLabel":"string[] | 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","uniqueKey":"parameters","typeLabel":"object"}},"required":["error","message"],"type":"object","uniqueKey":"","typeLabel":"object"},"exampleType":"examples"}},"description":"Invalid request, or `userLocator` is missing.","exampleType":"examples"},"5a52dca4-7ea9-4525-8bba-d277ad656dea":{"content":{"application/json":{"schema":{"properties":{"error":{"example":true,"type":"boolean","isRequired":true,"uniqueKey":"error","typeLabel":"boolean"},"message":{"description":"Human-readable error message describing what went wrong","type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"description":"Machine-readable error code for programmatic handling","type":"string","uniqueKey":"code","typeLabel":"string"},"parameters":{"additionalProperties":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"parameters.additionalProperties.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"parameters.additionalProperties.oneOf.0","typeLabel":"string[]"},{"type":"string","uniqueKey":"parameters.additionalProperties.oneOf.1","typeLabel":"string"}],"uniqueKey":"parameters.additionalProperties","typeLabel":"string[] | 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","uniqueKey":"parameters","typeLabel":"object"}},"required":["error","message"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":true,"message":"\u003cstring>","code":"\u003cstring>","parameters":{}}}},"exampleType":"generated"}},"description":"Missing or invalid API key.","exampleType":"generated"},"695ba2c2-ee1d-4bcb-b94e-eb95b61d3b5e":{"content":{"application/json":{"schema":{"properties":{"error":{"example":true,"type":"boolean","isRequired":true,"uniqueKey":"error","typeLabel":"boolean"},"message":{"description":"Human-readable error message describing what went wrong","type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"description":"Machine-readable error code for programmatic handling","type":"string","uniqueKey":"code","typeLabel":"string"},"parameters":{"additionalProperties":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"parameters.additionalProperties.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"parameters.additionalProperties.oneOf.0","typeLabel":"string[]"},{"type":"string","uniqueKey":"parameters.additionalProperties.oneOf.1","typeLabel":"string"}],"uniqueKey":"parameters.additionalProperties","typeLabel":"string[] | 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","uniqueKey":"parameters","typeLabel":"object"}},"required":["error","message"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":true,"message":"\u003cstring>","code":"\u003cstring>","parameters":{}}}},"exampleType":"generated"}},"description":"Forbidden. Ensure the credentials are correct and the authentication source is allowed.","exampleType":"generated"},"102f01b5-bcb8-431e-9e35-7358f07e1e1f":{"content":{"application/json":{"schema":{"properties":{"error":{"example":true,"type":"boolean","isRequired":true,"uniqueKey":"error","typeLabel":"boolean"},"message":{"description":"Human-readable error message describing what went wrong","type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"description":"Machine-readable error code for programmatic handling","type":"string","uniqueKey":"code","typeLabel":"string"},"parameters":{"additionalProperties":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"parameters.additionalProperties.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"parameters.additionalProperties.oneOf.0","typeLabel":"string[]"},{"type":"string","uniqueKey":"parameters.additionalProperties.oneOf.1","typeLabel":"string"}],"uniqueKey":"parameters.additionalProperties","typeLabel":"string[] | 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","uniqueKey":"parameters","typeLabel":"object"}},"required":["error","message"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":true,"message":"\u003cstring>","code":"\u003cstring>","parameters":{}}}},"exampleType":"generated"}},"description":"No payment method matches `paymentMethodId` for this user.","exampleType":"generated"},"13fef9a6-9ceb-40ca-aade-8718805905b5":{"content":{"application/json":{"schema":{"properties":{"error":{"example":true,"type":"boolean","isRequired":true,"uniqueKey":"error","typeLabel":"boolean"},"message":{"description":"Human-readable error message describing what went wrong","type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"description":"Machine-readable error code for programmatic handling","type":"string","uniqueKey":"code","typeLabel":"string"},"parameters":{"additionalProperties":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"parameters.additionalProperties.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"parameters.additionalProperties.oneOf.0","typeLabel":"string[]"},{"type":"string","uniqueKey":"parameters.additionalProperties.oneOf.1","typeLabel":"string"}],"uniqueKey":"parameters.additionalProperties","typeLabel":"string[] | 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","uniqueKey":"parameters","typeLabel":"object"}},"required":["error","message"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":true,"message":"\u003cstring>","code":"\u003cstring>","parameters":{}}}},"exampleType":"generated"}},"description":"Rate limit exceeded.","exampleType":"generated"}},"security":{"9f3134a2-12de-410a-90a5-7015a77b5fc7":{"apiKey":{"description":"API key required for authentication","in":"header","name":"X-API-KEY","type":"apiKey","scopes":[],"schemeName":"apiKey"},"userJwt":{"bearerFormat":"JWT","description":"The end user's JWT, sent as `Authorization: Bearer \u003cJWT>` together with a client-side API key. Validated against the project's external JWT configuration.","scheme":"bearer","type":"http","scopes":[],"schemeName":"userJwt"}},"0df25c77-29ae-41bf-80ad-f7f1c9de21d2":{"apiKey":{"description":"API key required for authentication","in":"header","name":"X-API-KEY","type":"apiKey","scopes":[],"schemeName":"apiKey"}}},"servers":{"75a471e9-7838-4879-bd63-8640830acbb3":{"description":"Staging environment (testnets)","url":"https://staging.crossmint.com/api"},"e573971d-7d12-4f8a-b9be-d4104ff32462":{"description":"Production environment (mainnets)","url":"https://www.crossmint.com/api"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"description":"API key required for authentication","in":"header","name":"X-API-KEY","type":"apiKey","scopes":[],"schemeName":"apiKey"},"schema":{"title":"X-API-KEY","type":"string","description":"API key required for authentication","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"apiKey","name":"X-API-KEY"},{"scheme":{"bearerFormat":"JWT","description":"The end user's JWT, sent as `Authorization: Bearer \u003cJWT>` together with a client-side API key. Validated against the project's external JWT configuration.","scheme":"bearer","type":"http","scopes":[],"schemeName":"userJwt"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"The end user's JWT, sent as `Authorization: Bearer \u003cJWT>` together with a client-side API key. Validated against the project's external JWT configuration.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"userJwt","name":"Authorization"}],"title":"apiKey \u0026 userJwt"},{"schemes":[{"scheme":{"description":"API key required for authentication","in":"header","name":"X-API-KEY","type":"apiKey","scopes":[],"schemeName":"apiKey"},"schema":{"title":"X-API-KEY","type":"string","description":"API key required for authentication","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"apiKey","name":"X-API-KEY"}],"title":"apiKey"}]},"originalFileLocation":"api-reference/_open-api/PaymentMethods.json"},"subdomain":"crossmint","siteName":"Crossmint Docs","title":"Delete a Payment Method - Crossmint Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-17T16:36:17.706Z","originalFileLocation":"api-reference/headless/payment-methods/delete-payment-method.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Soft-delete a payment method. The record is retained for compliance but can no longer be used.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Crossmint Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/crossmint/-1hhMU0vchFPUD3H/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/crossmint/-1hhMU0vchFPUD3H/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/crossmint/-1hhMU0vchFPUD3H/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/crossmint/-1hhMU0vchFPUD3H/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/crossmint/-1hhMU0vchFPUD3H/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/crossmint/-1hhMU0vchFPUD3H/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/crossmint/-1hhMU0vchFPUD3H/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/crossmint/-1hhMU0vchFPUD3H/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/crossmint/-1hhMU0vchFPUD3H/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Delete a Payment Method - Crossmint Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Soft-delete a payment method. The record is retained for compliance but can no longer be used.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Crossmint Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.crossmint.com/api-reference/headless/payment-methods/delete-payment-method\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://crossmint.mintlify.site/_mintlify/api/og/v2?division=Payment+Methods\u0026amp;title=Delete+a+Payment+Method\u0026amp;description=Soft-delete+a+payment+method.+The+record+is+retained+for+compliance+but+can+no+longer+be+used.\u0026amp;theme=b8bba0b38c114479513683ad\u0026amp;signature=e379843ac0045f1e6268cc624a00a97f0fc0a4a5ea1a991ad9affec359ba3bef\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Delete a Payment Method - Crossmint Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Soft-delete a payment method. The record is retained for compliance but can no longer be used.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://crossmint.mintlify.site/_mintlify/api/og/v2?division=Payment+Methods\u0026amp;title=Delete+a+Payment+Method\u0026amp;description=Soft-delete+a+payment+method.+The+record+is+retained+for+compliance+but+can+no+longer+be+used.\u0026amp;theme=b8bba0b38c114479513683ad\u0026amp;signature=e379843ac0045f1e6268cc624a00a97f0fc0a4a5ea1a991ad9affec359ba3bef\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/crossmint/-1hhMU0vchFPUD3H/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Crossmint Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#36b37e\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.crossmint.com/api-reference/headless/payment-methods/delete-payment-method\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/headless/payment-methods/delete-payment-method.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.crossmint.com/#organization\",\"name\":\"Crossmint Docs\",\"url\":\"https://docs.crossmint.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/crossmint/a8gPOTKEuVFcSfC3/logo/crossmint-light.png?fit=max\u0026auto=format\u0026n=a8gPOTKEuVFcSfC3\u0026q=85\u0026s=8c2671e4c8f7da6956e1508bd68c2928\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.crossmint.com#website\",\"name\":\"Crossmint Docs\",\"url\":\"https://docs.crossmint.com\",\"publisher\":{\"@id\":\"https://docs.crossmint.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.crossmint.com/api-reference/headless/payment-methods/delete-payment-method#webpage\",\"url\":\"https://docs.crossmint.com/api-reference/headless/payment-methods/delete-payment-method\",\"name\":\"Delete a Payment Method\",\"description\":\"Soft-delete a payment method. The record is retained for compliance but can no longer be used.\",\"dateModified\":\"2026-09-17T16:36:17.706Z\",\"isPartOf\":{\"@id\":\"https://docs.crossmint.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.crossmint.com/api-reference/headless/payment-methods/delete-payment-method#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.crossmint.com/api-reference/headless/payment-methods/delete-payment-method#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://docs.crossmint.com/api-reference/headless/create-order\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"REST\",\"item\":\"https://docs.crossmint.com/api-reference/headless/create-order\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Payment Methods\",\"item\":\"https://docs.crossmint.com/api-reference/headless/payment-methods/payment-method-object\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Delete a Payment Method\",\"item\":\"https://docs.crossmint.com/api-reference/headless/payment-methods/delete-payment-method\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.crossmint.com/api-reference/headless/payment-methods/delete-payment-method#apireference\",\"headline\":\"Delete a Payment Method\",\"name\":\"Delete a Payment Method\",\"description\":\"Soft-delete a payment method. The record is retained for compliance but can no longer be used.\",\"url\":\"https://docs.crossmint.com/api-reference/headless/payment-methods/delete-payment-method\",\"mainEntityOfPage\":{\"@id\":\"https://docs.crossmint.com/api-reference/headless/payment-methods/delete-payment-method#webpage\"},\"dateModified\":\"2026-09-17T16:36:17.706Z\",\"publisher\":{\"@id\":\"https://docs.crossmint.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.crossmint.com#website\"}}]}\u003c/script>","agentPointerHref":"/api-reference/headless/payment-methods/delete-payment-method.md","siteName":"Crossmint Docs","nav":{"global":null,"tabs":[{"tab":"Get Started","pages":[{"title":"Get Started","href":"/introduction/platform-overview"}]},{"tab":"Wallets","pages":[{"title":"Wallets","href":"/wallets/overview"}]},{"tab":"Identity","pages":[{"title":"Identity","href":"/identity/overview"}]},{"tab":"Stablecoin Orchestration","pages":[{"title":"Stablecoin Orchestration","href":"/stablecoin-orchestration/overview"}]},{"tab":"Checkout","groups":[{"group":"Introduction","pages":[{"title":"Overview","href":"/payments/introduction"},{"title":"Choose Your Integration","href":"/payments/concepts/choose-your-integration"}]},{"group":"Quickstarts ⚡","pages":[{"group":"Embedded","pages":[{"title":"Overview","href":"/payments/embedded/overview"},{"title":"React - Apple \u0026 Google Pay","href":"/payments/embedded/quickstarts/apple-pay-only"},{"title":"React - Webview","href":"/payments/embedded/quickstarts/credit-card"},{"title":"React Native - Webview","href":"/payments/embedded/quickstarts/credit-card-memecoin-react-native"},{"title":"Flutter - Webview","href":"/payments/embedded/quickstarts/credit-card-memecoin-flutter"}]},{"group":"Hosted","pages":[{"title":"Overview","href":"/payments/pay-button/overview"},{"title":"Hosted Checkout","href":"/payments/pay-button/quickstart"}]},{"group":"Headless","pages":[{"title":"Overview","href":"/payments/headless/overview"},{"title":"Pay with Card","href":"/payments/headless/quickstarts/credit-card"},{"title":"Pay with USDC","href":"/payments/headless/quickstarts/paying-usdc"},{"title":"Pay with Other Crypto","href":"/payments/headless/quickstarts/crypto"}]}]},{"group":"Concepts","pages":[{"title":"How Checkout Works","href":"/payments/concepts/how-checkout-works"},{"title":"Supported Assets","href":"/payments/concepts/supported-assets"},{"title":"Payment Methods","href":"/payments/concepts/payment-methods"},{"title":"Environments \u0026 API Keys","href":"/payments/concepts/environments-and-api-keys"}]},{"group":"Guides","pages":[{"title":"Select Items","href":"/payments/guides/select-items"},{"title":"Specify Recipient","href":"/payments/guides/specify-recipient"},{"title":"Enable Payment Methods","href":"/payments/guides/enable-payment-methods"},{"title":"Track Orders","href":"/payments/guides/track-orders"},{"title":"Handle Errors","href":"/payments/guides/handle-errors"},{"group":"Customize","pages":[{"title":"Appearance","href":"/payments/guides/appearance"},{"title":"Localization","href":"/payments/guides/localization"},{"title":"Hooks \u0026 Events","href":"/payments/guides/hooks-and-events"},{"title":"Receipt Customization","href":"/payments/advanced/receipt-customization"}]},{"group":"Go Live","pages":[{"title":"Testing Tips","href":"/payments/advanced/testing-tips"},{"title":"Production Checklist","href":"/payments/guides/production-checklist"},{"title":"Improving Conversion","href":"/payments/advanced/improving-conversion"},{"title":"Supporting Your Customers","href":"/payments/headless/guides/supporting-your-customers"}]},{"group":"Advanced","pages":[{"title":"Check Token Support","href":"/payments/guides/check-token-support"},{"title":"Use Connected Wallet as Payer","href":"/payments/embedded/guides/custom-payer"},{"title":"Apple Pay Integration Guide","href":"/payments/embedded/guides/apple-pay"},{"title":"Google Pay Mobile","href":"/payments/embedded/guides/google-pay"},{"title":"Mobile WebView Integration","href":"/payments/embedded/guides/webview-integration"},{"title":"Webhooks","href":"/payments/advanced/webhooks"},{"group":"NFTs","pages":[{"title":"Create/Deploy an NFT Collection","sidebarTitle":"Create New Collection","href":"/payments/guides/create-collection"},{"title":"Register External Collection","href":"/payments/guides/register-collection"},{"title":"NFT Marketplaces \u0026 Launchpads","href":"/payments/advanced/marketplaces-and-launchpads"},{"title":"NFT Drops Priced in USDC","href":"/payments/advanced/usdc-support"},{"title":"NFT Drops Gated by Accesslists","href":"/payments/advanced/accesslists"},{"title":"Mint to Specific Template","href":"/payments/advanced/mint-to-specific-template"}]}]}]},{"group":"API Reference","pages":[{"group":"REST","icon":"brackets-curly","pages":[{"group":"Orders","pages":[{"title":"Create Order","openapi":"api-reference/_open-api/Orders.json POST /2022-06-09/orders","href":"/api-reference/headless/create-order"},{"openapi":"api-reference/_open-api/Orders.json GET /2022-06-09/orders/{orderId}","title":"Get Order","href":"/api-reference/headless/get-order"},{"openapi":"api-reference/_open-api/Orders.json GET /2022-06-09/orders","title":"List Orders","href":"/api-reference/headless/list-orders"},{"openapi":"api-reference/_open-api/Orders.json PATCH /2022-06-09/orders/{orderId}","title":"Update Order","href":"/api-reference/headless/edit-order"},{"title":"Process Payment","openapi":"api-reference/_open-api/Orders.json POST /2022-06-09/orders/{orderId}/payment","href":"/api-reference/headless/process-payment"}]},{"group":"Supported Assets","pages":[{"title":"Get All Tokens","openapi":"api-reference/_open-api/Orders.json GET /2024-09-26/tokens","href":"/api-reference/headless/get-all-tokens"},{"title":"Check Token Support","openapi":"api-reference/_open-api/Orders.json GET /v1-alpha2/tokens/{tokenLocator}","href":"/api-reference/headless/check-token-support"}]},{"group":"Payment Methods","pages":[{"title":"The Payment Method Object","href":"/api-reference/headless/payment-methods/payment-method-object"},{"title":"Create Payment Method","openapi":"api-reference/_open-api/PaymentMethods.json POST /2026-09-16/payment-methods","href":"/api-reference/headless/payment-methods/create-payment-method"},{"title":"List Payment Methods by User","openapi":"api-reference/_open-api/PaymentMethods.json GET /2026-09-16/payment-methods","href":"/api-reference/headless/payment-methods/list-payment-methods"},{"title":"Retrieve a Payment Method","openapi":"api-reference/_open-api/PaymentMethods.json GET /2026-09-16/payment-methods/{paymentMethodId}","href":"/api-reference/headless/payment-methods/get-payment-method"},{"title":"Update a Payment Method","description":"Update the default status of an existing payment method","openapi":"api-reference/_open-api/PaymentMethods.json PATCH /2026-09-16/payment-methods/{paymentMethodId}","href":"/api-reference/headless/payment-methods/update-payment-method"},{"title":"Delete a Payment Method","openapi":"api-reference/_open-api/PaymentMethods.json DELETE /2026-09-16/payment-methods/{paymentMethodId}","href":"/api-reference/headless/payment-methods/delete-payment-method"}]}]},{"title":"Error \u0026 Status Codes","description":"Reference for order phase/status values and normalized payment error codes","mode":"wide","href":"/payments/reference/error-and-status-codes"},{"group":"React SDK","icon":"/images/icons/react.svg","pages":[{"title":"Get Started","href":"/sdk-reference/checkout/react/get-started"},{"title":"Providers","href":"/sdk-reference/checkout/react/providers"},{"title":"Hooks","href":"/sdk-reference/checkout/react/hooks"},{"title":"Components","href":"/sdk-reference/checkout/react/components"}]},{"group":"React Native SDK","icon":"/images/icons/react-native.svg","pages":[{"title":"Get Started","href":"/sdk-reference/checkout/react-native/get-started"},{"title":"Providers","href":"/sdk-reference/checkout/react-native/providers"},{"title":"Hooks","href":"/sdk-reference/checkout/react-native/hooks"},{"title":"Components","href":"/sdk-reference/checkout/react-native/components"}]},{"group":"Flutter SDK","icon":"/images/icons/flutter.svg","pages":[{"title":"Get Started","href":"/sdk-reference/checkout/flutter/get-started"},{"title":"Widgets","href":"/sdk-reference/checkout/flutter/widgets"},{"title":"Models","href":"/sdk-reference/checkout/flutter/models"},{"group":"Classes","pages":[{"title":"CrossmintCheckoutAppearance","href":"/sdk-reference/checkout/flutter/classes/crossmint-checkout-appearance"},{"title":"CrossmintCheckoutCollectionLineItem","href":"/sdk-reference/checkout/flutter/classes/crossmint-checkout-collection-line-item"},{"title":"CrossmintCheckoutConfig","href":"/sdk-reference/checkout/flutter/classes/crossmint-checkout-config"},{"title":"CrossmintCheckoutController","href":"/sdk-reference/checkout/flutter/classes/crossmint-checkout-controller"},{"title":"CrossmintCheckoutCryptoPayment","href":"/sdk-reference/checkout/flutter/classes/crossmint-checkout-crypto-payment"},{"title":"CrossmintCheckoutDiagnostic","href":"/sdk-reference/checkout/flutter/classes/crossmint-checkout-diagnostic"},{"title":"CrossmintCheckoutEmailRecipient","href":"/sdk-reference/checkout/flutter/classes/crossmint-checkout-email-recipient"},{"title":"CrossmintCheckoutExistingOrder","href":"/sdk-reference/checkout/flutter/classes/crossmint-checkout-existing-order"},{"title":"CrossmintCheckoutFiatPayment","href":"/sdk-reference/checkout/flutter/classes/crossmint-checkout-fiat-payment"},{"title":"CrossmintCheckoutLineItem","href":"/sdk-reference/checkout/flutter/classes/crossmint-checkout-line-item"},{"title":"CrossmintCheckoutNewOrder","href":"/sdk-reference/checkout/flutter/classes/crossmint-checkout-new-order"},{"title":"CrossmintCheckoutOrder","href":"/sdk-reference/checkout/flutter/classes/crossmint-checkout-order"},{"title":"CrossmintCheckoutPayer","href":"/sdk-reference/checkout/flutter/classes/crossmint-checkout-payer"},{"title":"CrossmintCheckoutPayment","href":"/sdk-reference/checkout/flutter/classes/crossmint-checkout-payment"},{"title":"CrossmintCheckoutPhysicalAddress","href":"/sdk-reference/checkout/flutter/classes/crossmint-checkout-physical-address"},{"title":"CrossmintCheckoutPhysicalRecipient","href":"/sdk-reference/checkout/flutter/classes/crossmint-checkout-physical-recipient"},{"title":"CrossmintCheckoutProductLineItem","href":"/sdk-reference/checkout/flutter/classes/crossmint-checkout-product-line-item"},{"title":"CrossmintCheckoutRawLineItem","href":"/sdk-reference/checkout/flutter/classes/crossmint-checkout-raw-line-item"},{"title":"CrossmintCheckoutRecipient","href":"/sdk-reference/checkout/flutter/classes/crossmint-checkout-recipient"},{"title":"CrossmintCheckoutTokenExecutionLineItem","href":"/sdk-reference/checkout/flutter/classes/crossmint-checkout-token-execution-line-item"},{"title":"CrossmintCheckoutTokenLineItem","href":"/sdk-reference/checkout/flutter/classes/crossmint-checkout-token-line-item"},{"title":"CrossmintCheckoutTransactionFailure","href":"/sdk-reference/checkout/flutter/classes/crossmint-checkout-transaction-failure"},{"title":"CrossmintCheckoutTransactionResult","href":"/sdk-reference/checkout/flutter/classes/crossmint-checkout-transaction-result"},{"title":"CrossmintCheckoutTransactionSuccess","href":"/sdk-reference/checkout/flutter/classes/crossmint-checkout-transaction-success"},{"title":"CrossmintCheckoutWalletRecipient","href":"/sdk-reference/checkout/flutter/classes/crossmint-checkout-wallet-recipient"},{"title":"CrossmintEmbeddedCheckout","href":"/sdk-reference/checkout/flutter/classes/crossmint-embedded-checkout"},{"title":"CrossmintEvmWalletCheckoutPayer","href":"/sdk-reference/checkout/flutter/classes/crossmint-evm-wallet-checkout-payer"},{"title":"CrossmintIdentityVerification","href":"/sdk-reference/checkout/flutter/classes/crossmint-identity-verification"},{"title":"CrossmintIdentityVerificationCredentials","href":"/sdk-reference/checkout/flutter/classes/crossmint-identity-verification-credentials"},{"title":"CrossmintIdentityVerificationError","href":"/sdk-reference/checkout/flutter/classes/crossmint-identity-verification-error"}]},{"group":"Enums","pages":[{"title":"CrossmintCheckoutDefaultMethod","href":"/sdk-reference/checkout/flutter/enums/crossmint-checkout-default-method"},{"title":"CrossmintCheckoutDiagnosticSeverity","href":"/sdk-reference/checkout/flutter/enums/crossmint-checkout-diagnostic-severity"},{"title":"CrossmintIdentityVerificationErrorReason","href":"/sdk-reference/checkout/flutter/enums/crossmint-identity-verification-error-reason"},{"title":"CrossmintIdentityVerificationHandling","href":"/sdk-reference/checkout/flutter/enums/crossmint-identity-verification-handling"},{"title":"CrossmintIdentityVerificationStatus","href":"/sdk-reference/checkout/flutter/enums/crossmint-identity-verification-status"}]},{"group":"Type Aliases","pages":[{"title":"CrossmintCheckoutLoadingBuilder","href":"/sdk-reference/checkout/flutter/type-aliases/crossmint-checkout-loading-builder"},{"title":"CrossmintIdentityVerificationLoadingBuilder","href":"/sdk-reference/checkout/flutter/type-aliases/crossmint-identity-verification-loading-builder"}]}]},{"group":"Swift SDK","icon":"/images/icons/swift.svg","pages":[{"group":"Classes","pages":[{"title":"CrossmintCheckoutController","href":"/sdk-reference/checkout/swift/classes/crossmintcheckoutcontroller"}]},{"group":"Enums","pages":[{"title":"CheckoutEnvironment","href":"/sdk-reference/checkout/swift/enums/checkoutenvironment"},{"title":"CheckoutError","href":"/sdk-reference/checkout/swift/enums/checkouterror"},{"title":"CheckoutLength","href":"/sdk-reference/checkout/swift/enums/checkoutlength"},{"title":"CheckoutLocale","href":"/sdk-reference/checkout/swift/enums/checkoutlocale"},{"title":"CheckoutLogLevel","href":"/sdk-reference/checkout/swift/enums/checkoutloglevel"},{"title":"IdentityVerificationHandling","href":"/sdk-reference/checkout/swift/enums/identityverificationhandling"},{"title":"IdentityVerificationStatus","href":"/sdk-reference/checkout/swift/enums/identityverificationstatus"},{"title":"OfframpStatus","href":"/sdk-reference/checkout/swift/enums/offrampstatus"}]},{"group":"Structs","pages":[{"title":"AnyCodable","href":"/sdk-reference/checkout/swift/structs/anycodable"},{"title":"CheckoutAllowedMethods","href":"/sdk-reference/checkout/swift/structs/checkoutallowedmethods"},{"title":"CheckoutAppearance","href":"/sdk-reference/checkout/swift/structs/checkoutappearance"},{"title":"CheckoutAppearanceRules","href":"/sdk-reference/checkout/swift/structs/checkoutappearancerules"},{"title":"CheckoutAppearanceVariables","href":"/sdk-reference/checkout/swift/structs/checkoutappearancevariables"},{"title":"CheckoutColor","href":"/sdk-reference/checkout/swift/structs/checkoutcolor"},{"title":"CheckoutColorStyle","href":"/sdk-reference/checkout/swift/structs/checkoutcolorstyle"},{"title":"CheckoutCryptoPayment","href":"/sdk-reference/checkout/swift/structs/checkoutcryptopayment"},{"title":"CheckoutDestinationInputRule","href":"/sdk-reference/checkout/swift/structs/checkoutdestinationinputrule"},{"title":"CheckoutFiatPayment","href":"/sdk-reference/checkout/swift/structs/checkoutfiatpayment"},{"title":"CheckoutFontSource","href":"/sdk-reference/checkout/swift/structs/checkoutfontsource"},{"title":"CheckoutFontStyle","href":"/sdk-reference/checkout/swift/structs/checkoutfontstyle"},{"title":"CheckoutFontWeight","href":"/sdk-reference/checkout/swift/structs/checkoutfontweight"},{"title":"CheckoutGlobalMessageRule","href":"/sdk-reference/checkout/swift/structs/checkoutglobalmessagerule"},{"title":"CheckoutInputRule","href":"/sdk-reference/checkout/swift/structs/checkoutinputrule"},{"title":"CheckoutLabelRule","href":"/sdk-reference/checkout/swift/structs/checkoutlabelrule"},{"title":"CheckoutLineItems","href":"/sdk-reference/checkout/swift/structs/checkoutlineitems"},{"title":"CheckoutOrder","href":"/sdk-reference/checkout/swift/structs/checkoutorder"},{"title":"CheckoutOrderUpdate","href":"/sdk-reference/checkout/swift/structs/checkoutorderupdate"},{"title":"CheckoutPayment","href":"/sdk-reference/checkout/swift/structs/checkoutpayment"},{"title":"CheckoutPrimaryButtonRule","href":"/sdk-reference/checkout/swift/structs/checkoutprimarybuttonrule"},{"title":"CheckoutReceiptEmailInputRule","href":"/sdk-reference/checkout/swift/structs/checkoutreceiptemailinputrule"},{"title":"CheckoutRecipient","href":"/sdk-reference/checkout/swift/structs/checkoutrecipient"},{"title":"CheckoutStateStyle","href":"/sdk-reference/checkout/swift/structs/checkoutstatestyle"},{"title":"CheckoutTabRule","href":"/sdk-reference/checkout/swift/structs/checkouttabrule"},{"title":"CheckoutVariablesColorStyle","href":"/sdk-reference/checkout/swift/structs/checkoutvariablescolorstyle"},{"title":"CrossmintEmbeddedCheckout","href":"/sdk-reference/checkout/swift/structs/crossmintembeddedcheckout"},{"title":"CrossmintEmbeddedOfframp","href":"/sdk-reference/checkout/swift/structs/crossmintembeddedofframp"},{"title":"CrossmintIdentityVerification","href":"/sdk-reference/checkout/swift/structs/crossmintidentityverification"},{"title":"EmbeddedOfframpCredentials","href":"/sdk-reference/checkout/swift/structs/embeddedofframpcredentials"},{"title":"EmbeddedOfframpPayer","href":"/sdk-reference/checkout/swift/structs/embeddedofframppayer"},{"title":"IdentityVerificationCredentials","href":"/sdk-reference/checkout/swift/structs/identityverificationcredentials"},{"title":"IdentityVerificationError","href":"/sdk-reference/checkout/swift/structs/identityverificationerror"},{"title":"OfframpCompletion","href":"/sdk-reference/checkout/swift/structs/offrampcompletion"},{"title":"OfframpError","href":"/sdk-reference/checkout/swift/structs/offramperror"},{"title":"OfframpMessage","href":"/sdk-reference/checkout/swift/structs/offrampmessage"},{"title":"OfframpSignatureRejectedError","href":"/sdk-reference/checkout/swift/structs/offrampsignaturerejectederror"},{"title":"OfframpStatusChange","href":"/sdk-reference/checkout/swift/structs/offrampstatuschange"},{"title":"OfframpTransaction","href":"/sdk-reference/checkout/swift/structs/offramptransaction"}]}]},{"group":"Kotlin SDK","icon":"/images/icons/kotlin.png","pages":[{"title":"Kotlin SDK Reference","href":"/sdk-reference/checkout/kotlin/index"},{"group":"Composables","pages":[{"title":"CrossmintEmbeddedCheckout","href":"/sdk-reference/checkout/kotlin/composables/crossmint-embedded-checkout"}]},{"group":"Classes","pages":[{"title":"CheckoutColor","href":"/sdk-reference/checkout/kotlin/classes/checkout-color"},{"title":"CheckoutError.EncodingError","href":"/sdk-reference/checkout/kotlin/classes/checkout-error-encoding-error"},{"title":"CheckoutError.InvalidConfiguration","href":"/sdk-reference/checkout/kotlin/classes/checkout-error-invalid-configuration"},{"title":"CheckoutError.NotImplemented","href":"/sdk-reference/checkout/kotlin/classes/checkout-error-not-implemented"},{"title":"CheckoutFontWeight","href":"/sdk-reference/checkout/kotlin/classes/checkout-font-weight"},{"title":"CheckoutLength","href":"/sdk-reference/checkout/kotlin/classes/checkout-length"}]},{"group":"Data Classes","pages":[{"title":"CheckoutAllowedMethods","href":"/sdk-reference/checkout/kotlin/data-classes/checkout-allowed-methods"},{"title":"CheckoutAppearance","href":"/sdk-reference/checkout/kotlin/data-classes/checkout-appearance"},{"title":"CheckoutAppearanceRules","href":"/sdk-reference/checkout/kotlin/data-classes/checkout-appearance-rules"},{"title":"CheckoutAppearanceVariables","href":"/sdk-reference/checkout/kotlin/data-classes/checkout-appearance-variables"},{"title":"CheckoutColorStyle","href":"/sdk-reference/checkout/kotlin/data-classes/checkout-color-style"},{"title":"CheckoutCryptoPayment","href":"/sdk-reference/checkout/kotlin/data-classes/checkout-crypto-payment"},{"title":"CheckoutDestinationInputRule","href":"/sdk-reference/checkout/kotlin/data-classes/checkout-destination-input-rule"},{"title":"CheckoutFiatPayment","href":"/sdk-reference/checkout/kotlin/data-classes/checkout-fiat-payment"},{"title":"CheckoutFontSource","href":"/sdk-reference/checkout/kotlin/data-classes/checkout-font-source"},{"title":"CheckoutFontStyle","href":"/sdk-reference/checkout/kotlin/data-classes/checkout-font-style"},{"title":"CheckoutGlobalMessageRule","href":"/sdk-reference/checkout/kotlin/data-classes/checkout-global-message-rule"},{"title":"CheckoutInputRule","href":"/sdk-reference/checkout/kotlin/data-classes/checkout-input-rule"},{"title":"CheckoutLabelRule","href":"/sdk-reference/checkout/kotlin/data-classes/checkout-label-rule"},{"title":"CheckoutLineItems","href":"/sdk-reference/checkout/kotlin/data-classes/checkout-line-items"},{"title":"CheckoutPayment","href":"/sdk-reference/checkout/kotlin/data-classes/checkout-payment"},{"title":"CheckoutPrimaryButtonRule","href":"/sdk-reference/checkout/kotlin/data-classes/checkout-primary-button-rule"},{"title":"CheckoutReceiptEmailInputRule","href":"/sdk-reference/checkout/kotlin/data-classes/checkout-receipt-email-input-rule"},{"title":"CheckoutRecipient","href":"/sdk-reference/checkout/kotlin/data-classes/checkout-recipient"},{"title":"CheckoutStateStyle","href":"/sdk-reference/checkout/kotlin/data-classes/checkout-state-style"},{"title":"CheckoutTabRule","href":"/sdk-reference/checkout/kotlin/data-classes/checkout-tab-rule"},{"title":"CheckoutVariablesColorStyle","href":"/sdk-reference/checkout/kotlin/data-classes/checkout-variables-color-style"}]},{"group":"Enums","pages":[{"title":"CheckoutEnvironment","href":"/sdk-reference/checkout/kotlin/enums/checkout-environment"},{"title":"CheckoutPaymentMethod","href":"/sdk-reference/checkout/kotlin/enums/checkout-payment-method"},{"title":"IdentityVerificationHandling","href":"/sdk-reference/checkout/kotlin/enums/identity-verification-handling"}]},{"group":"Sealed Classes","pages":[{"title":"CheckoutError","href":"/sdk-reference/checkout/kotlin/sealed-classes/checkout-error"}]},{"group":"Objects","pages":[{"title":"CheckoutAppearanceVariables.Companion","href":"/sdk-reference/checkout/kotlin/objects/checkout-appearance-variables-companion"},{"title":"CheckoutColor.Companion","href":"/sdk-reference/checkout/kotlin/objects/checkout-color-companion"},{"title":"CheckoutColorStyle.Companion","href":"/sdk-reference/checkout/kotlin/objects/checkout-color-style-companion"},{"title":"CheckoutFontSource.Companion","href":"/sdk-reference/checkout/kotlin/objects/checkout-font-source-companion"},{"title":"CheckoutFontStyle.Companion","href":"/sdk-reference/checkout/kotlin/objects/checkout-font-style-companion"},{"title":"CheckoutFontWeight.Companion","href":"/sdk-reference/checkout/kotlin/objects/checkout-font-weight-companion"},{"title":"CheckoutInputRule.Companion","href":"/sdk-reference/checkout/kotlin/objects/checkout-input-rule-companion"},{"title":"CheckoutLength.Companion","href":"/sdk-reference/checkout/kotlin/objects/checkout-length-companion"},{"title":"CheckoutPrimaryButtonRule.Companion","href":"/sdk-reference/checkout/kotlin/objects/checkout-primary-button-rule-companion"},{"title":"CheckoutTabRule.Companion","href":"/sdk-reference/checkout/kotlin/objects/checkout-tab-rule-companion"},{"title":"CheckoutVariablesColorStyle.Companion","href":"/sdk-reference/checkout/kotlin/objects/checkout-variables-color-style-companion"}]}]}]}]},{"tab":"Onramp","pages":[{"title":"Onramp","href":"/onramp/overview"}]},{"tab":"Offramp","pages":[{"title":"Offramp","href":"/offramp/overview"}]},{"tab":"Agents","pages":[{"title":"Agents","href":"/agents/overview"}]},{"tab":"Others","menu":[{"item":"Tokenization","pages":[{"title":"Tokenization","href":"/tokenization/introduction"}]}],"pages":[{"title":"Others","href":"/tokenization/introduction"}]}]},"basePath":"","title":"Delete a Payment Method - Crossmint Docs","buildId":"dpl_41S5Z2jG9QnfDRwN1KZrLdBwj7DM","deploymentId":"dpl_41S5Z2jG9QnfDRwN1KZrLdBwj7DM","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DDP9JXtj.js","utils-8yQyvEtx.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-CBCFR8Sn.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-rQaXkUHa.js","snippetPresets-J5KpBTgV.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BVxVH4Cj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BxdQ2vIi.js","shallow-BjV2tFiD.js","getApiPlaygroundDisplay-C_55tL4O.js","CodeSnippet-C0JpiCOC.js","CodeSnippets-w9Ps7djG.js","Page-DTNSD-0M.js","getPastedJson-BDfB-H8d.js","icon-g-kUkkO9.js","MethodPill-v4l6fq0h.js","DuplicateIcon-CvLo-CfU.js","createIcon-165clrrV.js","DynamicMarkdown-D3RQ-fEj.js","SectionHeading-vvo-3yLf.js","axios-vUo_bRtp.js","Markdown-CMT1uFWQ.js","clsx-C8f2yC9R.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CI2D8R2Y.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-k78Wrw_e.js"]}