{"templateId":"markdown","versions":[{"version":"v2026.03","label":"v2026.03","link":"/products/payments-direct-2/api-docs/concepts/financial-instruments","default":true,"active":true,"folderId":"eb16255d"},{"version":"v2025.11","label":"v2025.11","link":"/products/payments-direct-2/v2025.11/api-docs/concepts/financial-instruments","default":false,"active":false,"folderId":"eb16255d"}],"sharedDataIds":{"sidebar":"sidebar-products/payments-direct-2/@v2025.11/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition","tabs","tab"]},"type":"markdown"},"seo":{"title":"Financial instruments","description":"User guides, API reference, and support resources.","siteUrl":"https://docs.ripple.com/products/custody","lang":"en-US","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"financial-instruments","__idx":0},"children":["Financial instruments"]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Identity Management v3"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This topic describes the v3 identity model. ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Identity Management v3"]}," is recommended for all new integrations."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The supported payment corridors are:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["US • USD"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["EU • EUR"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["MX • MXN"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["BR • BRL"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["CO • COP"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["CA • CAD"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["GB • GBP"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["NG • NGN"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["SWIFT • USD"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For migration details or questions, contact your Ripple representative."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["financial instrument"]}," represents the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["account or wallet details"]}," used to send or receive funds in a payment. While a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["payment identity"]}," describes ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["who"]}," the party is, a financial instrument describes ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["where"]}," the money goes — for example, a US ACH bank account, a SEPA IBAN, a PIX key, or a local bank payout rail."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Financial instruments are managed by the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Identity Management v3"]}," and are always associated with a specific identity. Each instrument specifies a payment rail (such as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["US_ACH"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EU_SEPA"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["MX_SPEI"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BR_PIX"]},"), a currency, and a rail-specific payload (routing codes, account numbers, IBANs, CLABE, PIX keys, and so on)."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Identity Management v3"]}," separates identities and instruments so that you can:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Reuse a single KYC’d identity across different payout rails and currencies."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Manage ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["multiple bank accounts or payout methods"]}," for the same party."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Rotate or replace accounts without duplicating identities or losing history."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"what-youll-learn","__idx":1},"children":["What you’ll learn"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In this topic, you’ll learn:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["How financial instruments relate to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["payment identities"]}," and the overall payment workflow."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Which metadata fields apply to every financial instrument (such as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["financialInstrumentType"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["currency"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["country"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["label"]},")."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["What rail-specific objects look like for common payout rails (for example, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["usAch"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["euSepa"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["mxSpei"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["gbFps"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["brPix"]},")."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["How ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["one identity can have multiple financial instruments"]},", enabling a single party to hold several bank accounts or payout rails."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["How to think about validation rules, corridor coverage, and best practices when modeling bank accounts and payout methods."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"relationship-between-identities-instruments-and-payments","__idx":2},"children":["Relationship between identities, instruments, and payments"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Financial instruments are scoped to identities:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Each financial instrument belongs to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["exactly one identity"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The instrument does ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["not"]}," store personal details; it only stores account/wallet data."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The identity’s ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["paymentRole"]}," (ORIGINATOR or BENEFICIARY) determines whether the instrument is used to fund or receive payments."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When building payments:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["payment object"]}," references the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["identity"]}," and ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["financial instrument"]}," by ID."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The payment orchestration layer uses the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["financialInstrumentType"]}," to determine which payout rail to use (for example, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["US_ACH"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["MX_SPEI"]},")."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Corridor-specific rules ensure that instrument type, currency, and corridor are compatible."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For details on the identity model, see ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/payments-direct-2/api-docs/concepts/payment-identities"},"children":["Payment identities"]},"."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"financial-instrument-structure","__idx":3},"children":["Financial instrument structure"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["At a high level, a financial instrument consists of:"]}]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Metadata describing the instrument (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["currency"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["label"]},", etc.)."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A single rail-specific object (for example, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["usAch"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["mxSpei"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["euSepa"]},") that contains the account fields required for that rail."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Conceptual shape:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"financialInstrumentId\": \"3fc74743-e7f3-414a-9fcf-eb8c1d52356a\",\n  \"financialInstrumentType\": \"US_ACH\",\n  \"currency\": \"USD\",\n  \"label\": \"US bank account\",\n  \"country\": \"US\",\n  \"createdAt\": \"2025-10-01T18:46:47.430Z\",\n  \"updatedAt\": \"2025-10-01T18:46:47.430Z\",\n\n  // one rail-specific object, depending on financialInstrumentType\n  \"usAch\": {\n    \"bankName\": \"Bank of Example\",\n    \"bankRoutingNumber\": \"266231608\",\n    \"accountNumber\": \"60480\",\n    \"accountType\": \"CHECKING\"\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"One rail per instrument"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Only one of the rail-specific objects (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["usAch"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["mxSpei"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["euSepa"]},", and so on) is populated for a given instrument."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"financial-instrument-metadata","__idx":4},"children":["Financial instrument metadata"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following fields apply to every financial instrument, regardless of rail."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Example"},"children":["Example"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["financialInstrumentId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Server-generated unique identifier for the financial instrument. Stable across all versions."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["\"3fc74743-e7f3-414a-9fcf-eb8c1d52356a\""]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["financialInstrumentType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Payment rail used by this instrument. Values include ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["US_ACH"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["US_FEDWIRE"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["MX_SPEI"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EU_SEPA"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GB_FPS"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CA_EFT"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["NG_BANK_PAYOUT"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BR_PIX"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BR_TED"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CO_PSE"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SWIFT"]},"."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["\"US_ACH\""]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["currency"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ISO 4217 currency code of the instrument (for example, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["USD"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EUR"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["MXN"]},"). Must be compatible with the chosen rail and corridor."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["\"USD\""]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["label"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["User-defined label to help your systems distinguish instruments (for example, by region or usage)."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["\"US bank account\""]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["country"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Country code (ISO 3166-1 alpha-2) where the instrument is held or used."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["\"US\""]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["createdAt"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["RFC 3339 timestamp when the instrument was created."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["\"2023-11-02T18:26:00.000Z\""]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["updatedAt"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["RFC 3339 timestamp when the instrument was last updated."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["\"2023-11-03T18:26:00.000Z\""]}]}]}]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Metadata only onlist"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When listing instruments, the API returns ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["metadata only"]}," (no rail-specific fields) for each instrument."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To see full rail-specific details, retrieve the instrument by ID."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"multiple-financial-instruments-per-identity","__idx":5},"children":["Multiple financial instruments per identity"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Identity Management v3"]},", an identity can have one or more financial instruments (bank accounts or other payout methods) attached to it. This allows you to keep a single, reusable KYC record for a party while managing multiple payout accounts and rails underneath that identity."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Identity vs financial instrument"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["identity"]}," describes who you are paying or collecting from:",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["identityType"]}," (INDIVIDUAL or BUSINESS)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["paymentRole"]}," (ORIGINATOR or BENEFICIARY)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["PII fields such as names, addresses, registration documents, and contact details."]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["financial instrument"]}," describes how and where funds are delivered:",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["financialInstrumentType"]}," (for example, US_ACH, EU_SEPA, MX_SPEI, BR_PIX)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["currency"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["country"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Rail-specific fields such as routing numbers, IBANs, CLABE, PIX keys, and so on."]}]}]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"success","name":"Reusing identities"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["By separating these two concepts, you can reuse the same identity across different corridors, currencies, and payout rails without duplicating PII."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"lifecycle-and-api-workflow","__idx":6},"children":["Lifecycle and API workflow"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Each financial instrument is managed as a child resource of an identity:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Create an identity"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /v3/identities"]}," to create the identity with its PII and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["internalId"]},".",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Add one or more financial instruments"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /v3/identities/{identity-id}/financial-instruments"]}," to attach a new bank account or payout method to that identity.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"You specify:",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["financialInstrumentType"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["currency"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The corresponding rail object (for example, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["usAch"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["euSepa"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["mxSpei"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["brPix"]},") with its required fields.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["List instruments for an identity"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /v3/identities/{identity-id}/financial-instruments"]}," to see all instruments attached to an identity. The response returns a list of instruments with metadata (IDs, types, currencies, labels, timestamps).",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Get details for a single instrument"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /v3/identities/{identity-id}/financial-instruments/{financial-instrument-id}"]}," to retrieve full rail-specific details, such as account numbers and routing codes.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Update or deactivate instruments"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]}," to update editable fields (for example, changing a label or updating a bank account number where allowed)."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE"]}," to deactivate an instrument so it can no longer be used for new payments. Historical usage remains available for audit."]}]}]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning","name":"Deactivation"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Deactivating an identity also deactivates its financial instruments and prevents them from being used in new payments."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-scenarios","__idx":7},"children":["Example scenarios"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Multiple financial instruments per identity are useful when:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["A single beneficiary uses multiple accounts"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"For example, a vendor in Mexico may want:",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["An MXN SPEI account for local MXN payouts (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["MX_SPEI"]},"), and"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A USD ACH account for USD payouts (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["US_ACH"]},").",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["A corporate beneficiary has multi-currency accounts"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"For example, a business might maintain EUR SEPA, GBP FPS, and USD ACH accounts. All of these can live under the same BUSINESS BENEFICIARY identity, each as a separate financial instrument.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["You rotate or replace accounts without duplicating identities"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"If a beneficiary changes their bank account, you can:",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Add a new financial instrument,"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Switch new payments to the new instrument, and"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Deactivate the old instrument,while keeping the identity (and its history) intact."]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"best-practices","__idx":8},"children":["Best practices"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Use the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["label"]}," field on financial instruments to make accounts easy to distinguish (for example, \"operating-USD\", \"payroll-EUR\", \"MXN-SPEI-local\")."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Avoid creating multiple identities for the same real-world party just to handle different bank accounts; prefer a single identity with multiple financial instruments."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Use identity-level tags to express business segmentation (for example, [\"vendor-emea\", \"high-value\"]) and handle account-specific details at the financial instrument level."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"financial-instrument-types","__idx":9},"children":["Financial instrument types"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["financialInstrumentType"]}," determines which rail-specific object is populated and what fields are required."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Typical use"},"children":["Typical use"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Common currency"},"children":["Common currency"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["US_ACH"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["U.S. Automated Clearing House batch processing network."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Domestic U.S. bank transfers (ACH/RTP-backed)."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["\"USD\""]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["US_FEDWIRE"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["U.S. Fedwire real-time gross settlement system for high-value domestic transfers."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["High-value domestic USD bank transfers."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["\"USD\""]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["MX_SPEI"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Mexico’s real-time interbank transfer system (SPEI)."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["MX domestic bank payouts in MXN."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["\"MXN\""]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["EU_SEPA"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["SEPA credit transfer rails for EUR-denominated payments across SEPA countries."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["EUR bank payouts to SEPA-region accounts (IBAN)."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["\"EUR\""]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["GB_FPS"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["UK Faster Payments Service and CHAPS."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["GBP payouts to UK bank accounts."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["\"GBP\""]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["CA_EFT"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Canada’s Electronic Funds Transfer system."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["CAD payouts to Canadian bank accounts."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["\"CAD\""]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["NG_BANK_PAYOUT"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Nigeria bank payout rail."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["NGN payouts to Nigerian bank accounts."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["\"NGN\""]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["BR_PIX"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Brazil’s instant payment platform (PIX) operated by the Central Bank of Brazil."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["BRL payouts to PIX accounts using PIX keys."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["\"BRL\""]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["CO_PSE"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Colombia’s secure online banking payment system (PSE)."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["COP payouts to Colombian bank accounts over PSE."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["\"COP\""]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["BR_TED"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Brazil’s Electronic Funds Transfer (TED) system for higher-value transactions."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["BRL payouts to Brazilian bank accounts over TED."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["\"BRL\""]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["SWIFT"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["International bank wire transfers via the SWIFT network."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Cross-border payouts to bank accounts in SWIFT-connected countries."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Varies (USD)"]}]}]}]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Corridor coverage"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Each instrument type is supported only for specific country–currency corridors."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For full corridor coverage, see ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/payments-direct-2/introduction/payout-network"},"children":["Payout network"]},"."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"bank-account-rails-and-fields","__idx":10},"children":["Bank account rails and fields"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This section summarizes the key fields for each bank-account-based instrument."]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"div","attributes":{"label":"US_ACH","disable":false},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["usAch"]}," object is used when ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["financialInstrumentType"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["US_ACH"]},"."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Example"},"children":["Example"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["bankName"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Name of the bank holding the account."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["\"Bank of Example\""]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["bankRoutingNumber"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["9-digit routing number (ABA Routing Transit Number)."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["\"266231608\""]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["accountNumber"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Account number to be credited."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["\"60480\""]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["accountType"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Type of bank account. Values include CHECKING and SAVINGS."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["\"CHECKING\""]}]}]}]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Usage notes"},"children":[{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["currency"]}," is typically ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["USD"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Used for U.S. domestic payouts over ACH (and related real-time rails where applicable)."]}]}]}]},{"$$mdtype":"Tag","name":"div","attributes":{"label":"US_FEDWIRE","disable":false},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["usFedwire"]}," object is used when ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["financialInstrumentType"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["US_FEDWIRE"]},"."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Example"},"children":["Example"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["bankName"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Name of the bank where funds will be credited."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["\"Bank of Example\""]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["bankRoutingNumber"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["9-digit ABA routing number of the beneficiary’s bank."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["\"266231608\""]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["accountNumber"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Account number to be credited (high-value Fedwire destination)."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["\"60480\""]}]}]}]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Usage notes"},"children":[{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["currency"]}," is typically ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["USD"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Intended for high-value or time-critical U.S. domestic transfers."]}]}]}]},{"$$mdtype":"Tag","name":"div","attributes":{"label":"MX_SPEI","disable":false},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["mxSpei"]}," object is used when ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["financialInstrumentType"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["MX_SPEI"]},"."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Example"},"children":["Example"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["bankName"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Name of the Mexican bank."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["\"Bank of Example\""]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["clabe"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["18-digit CLABE account identifier for the beneficiary."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["\"014027000005555558\""]}]}]}]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Usage notes"},"children":[{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["currency"]}," is typically ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["MXN"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Used for MXN payouts to Mexican bank accounts."]}]}]}]},{"$$mdtype":"Tag","name":"div","attributes":{"label":"EU_SEPA","disable":false},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["euSepa"]}," object is used when ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["financialInstrumentType"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EU_SEPA"]},"."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Example"},"children":["Example"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["bankName"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Name of the bank."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["\"Bank of Example\""]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["iban"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["IBAN of the account (15–34 characters, country and checksum-prefixed)."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["\"DE89370400440532013000\""]}]}]}]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Usage notes"},"children":[{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["currency"]}," is typically ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EUR"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["IBAN must follow SEPA-format rules; validation is enforced by the API."]}]}]}]},{"$$mdtype":"Tag","name":"div","attributes":{"label":"GB_FPS","disable":false},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["gbFps"]}," object is used when ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["financialInstrumentType"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GB_FPS"]},"."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Example"},"children":["Example"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["bankName"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Name of the UK bank."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["\"Bank of Example\""]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["sortCode"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["6-digit sort code for the bank/branch."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["\"123456\""]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["accountNumber"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["8-digit account number."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["\"12345678\""]}]}]}]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Usage notes"},"children":[{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["currency"]}," is typically ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GBP"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Used for Faster Payments/CHAPS-style payouts."]}]}]}]},{"$$mdtype":"Tag","name":"div","attributes":{"label":"CA_EFT","disable":false},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["caEft"]}," object is used when ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["financialInstrumentType"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CA_EFT"]},"."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Example"},"children":["Example"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["bankName"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Name of the Canadian financial institution."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["\"Bank of Example\""]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["institutionNumber"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["3-digit institution number."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["\"123\""]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["transitNumber"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["5-digit transit number for the branch."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["\"12345\""]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["accountNumber"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Account number (typically 7–12 digits)."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["\"12345678\""]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["accountType"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Type of bank account. Values include CHECKING and SAVINGS."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["\"CHECKING\""]}]}]}]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Usage notes"},"children":[{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["currency"]}," is typically ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CAD"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Used for Canadian domestic payouts over EFT."]}]}]}]},{"$$mdtype":"Tag","name":"div","attributes":{"label":"NG_BANK_PAYOUT","disable":false},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ngBankPayout"]}," object is used when ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["financialInstrumentType"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["NG_BANK_PAYOUT"]},"."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Example"},"children":["Example"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["bankName"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Name of the beneficiary’s bank."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["\"Bank of Example\""]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["bankCode"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Bank identifier code (format depends on the destination country)."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["\"12345\""]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["accountNumber"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Account number at the destination bank."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["\"12345678\""]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["country"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["2-letter ISO country code representing the destination country."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["\"GH\""]}]}]}]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Usage notes"},"children":[{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["currency"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["NGN"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Used for bank payouts in supported African markets; exact format and limits are corridor-specific."]}]}]}]},{"$$mdtype":"Tag","name":"div","attributes":{"label":"CO_PSE","disable":false},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["coPse"]}," object is used when ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["financialInstrumentType"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CO_PSE"]},"."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Example"},"children":["Example"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["bankName"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Name of the Colombian bank."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["\"Bank of Example\""]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["bankCode"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["5-digit code for the beneficiary’s bank."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["\"12345\""]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["accountNumber"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Account number for the PSE payout."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["\"12345678\""]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["accountType"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Type of account. Values include CURRENT and SAVINGS."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["\"CURRENT\""]}]}]}]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Usage notes"},"children":[{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["currency"]}," is typically ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["COP"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Used for Colombian PSE payouts."]}]}]}]},{"$$mdtype":"Tag","name":"div","attributes":{"label":"BR_TED","disable":false},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["brTed"]}," object is used when ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["financialInstrumentType"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BR_TED"]},"."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Example"},"children":["Example"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["bankName"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Name of the Brazilian bank."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["\"Bank of Example\""]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["bankCode"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["8-digit code for the beneficiary’s bank."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["\"12345678\""]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["branchNumber"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["4-digit branch number for the beneficiary’s account."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["\"1234\""]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["accountNumber"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["10-digit account number for the beneficiary."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["\"1234567890\""]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["accountType"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Type of bank account. Values include CHECKING and SAVINGS."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["\"CHECKING\""]}]}]}]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Usage notes"},"children":[{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["currency"]}," is typically ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BRL"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Used for Brazilian bank transfers via TED."]}]}]}]},{"$$mdtype":"Tag","name":"div","attributes":{"label":"BR_PIX","disable":false},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["brPix"]}," object is used when ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["financialInstrumentType"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BR_PIX"]},"."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Example"},"children":["Example"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["bankName"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Name of the Brazilian bank."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["\"Bank of Example\""]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["bankCode"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["BICFI bank code for the beneficiary’s bank (8–11 characters)."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["\"BRASBRRJBHE\""]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["branchNumber"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Bank branch number (4–6 digits)."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["\"0001\""]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["pixKey"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The PIX key for the beneficiary: an email address, phone number, CPF/CNPJ, or EVP random key."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["\"fake@example.com\""]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["pixKeyType"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Type of PIX key provided. Values: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CPF"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CNPJ"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EMAIL"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PHONE"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EVP"]},"."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["\"EMAIL\""]}]}]}]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Usage notes"},"children":[{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["currency"]}," is typically ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BRL"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Used for Brazilian instant payments via PIX."]}]}]}]},{"$$mdtype":"Tag","name":"div","attributes":{"label":"SWIFT","disable":false},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["swift"]}," object is used when ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["financialInstrumentType"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SWIFT"]},"."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Example"},"children":["Example"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["bankName"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Name of the beneficiary’s bank."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["\"Chase Bank\""]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["swiftCode"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["SWIFT/BIC code of the beneficiary’s bank (8 or 11 characters)."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["\"CHASUS33\""]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["accountHolderName"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Name of the account holder at the receiving bank."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["\"Widgets Org\""]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["accountNumber"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Account number at the beneficiary’s bank (IBAN or local account number, up to 34 characters)."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["\"000123456789\""]}]}]}]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Usage notes"},"children":[{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["currency"]}," is typically ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["USD"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Used for international cross-border wire transfers via the SWIFT network."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Settlement time is 1–4 business days depending on corridor."]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"validation-and-data-requirements","__idx":11},"children":["Validation and data requirements"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Financial instrument data is validated in two ways:"]}]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Structural validation",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Identity Management v3"]}," ensures required fields for the specified ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["financialInstrumentType"]}," are present."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Field patterns (length, character sets, IBAN/CLABE formats, routing formats, and so on) are enforced."]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Corridor compatibility",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Only certain combinations of instrument type, currency, and payout corridor are supported."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["If an instrument cannot be used for any corridor you’re enabled for, creation or updates may fail."]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"identity-validation-with-validatepayoutrails","__idx":12},"children":["Identity validation with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["validatePayoutRails"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When creating a financial instrument, the associated identity must have all required PII for the specified ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["financialInstrumentType"]},". You can use the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["validatePayoutRails"]}," field on the identity to validate PII requirements upfront:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["If you specified ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["validatePayoutRails"]}," when creating the identity (for example, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["[\"US_ACH\", \"MX_SPEI\"]"]},"), the identity's PII was already validated against those rails."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["When you create a financial instrument with a matching ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["financialInstrumentType"]}," (for example, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["US_ACH"]},"), the instrument creation succeeds immediately because the identity is already validated."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["If you create a financial instrument for a rail ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["not"]}," listed in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["validatePayoutRails"]},", the identity's PII is validated at instrument creation time. If required fields are missing, the request fails with ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["400 Bad Request"]},"."]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Upfront validation"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Using ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["validatePayoutRails"]}," on identities helps catch PII issues early, before you attempt to create financial instruments or payments. For details, see ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/payments-direct-2/api-docs/concepts/payment-identities#validating-identities-for-specific-payout-rails"},"children":["Validating identities for specific payout rails"]},"."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"next-steps","__idx":13},"children":["Next steps"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["To see how to create, update, list, and deactivate financial instruments using the API, continue with ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/payments-direct-2/api-docs/tutorials/create-and-manage-financial-instruments"},"children":["Create and manage financial instruments"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["To review how account details connect back to KYC data and specific payment roles, see ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/payments-direct-2/api-docs/concepts/payment-identities"},"children":["Payment identities"]},"."]}]}]},"headings":[{"value":"Financial instruments","id":"financial-instruments","depth":1},{"value":"What you’ll learn","id":"what-youll-learn","depth":2},{"value":"Relationship between identities, instruments, and payments","id":"relationship-between-identities-instruments-and-payments","depth":2},{"value":"Financial instrument structure","id":"financial-instrument-structure","depth":2},{"value":"Financial instrument metadata","id":"financial-instrument-metadata","depth":2},{"value":"Multiple financial instruments per identity","id":"multiple-financial-instruments-per-identity","depth":2},{"value":"Lifecycle and API workflow","id":"lifecycle-and-api-workflow","depth":2},{"value":"Example scenarios","id":"example-scenarios","depth":3},{"value":"Best practices","id":"best-practices","depth":3},{"value":"Financial instrument types","id":"financial-instrument-types","depth":2},{"value":"Bank account rails and fields","id":"bank-account-rails-and-fields","depth":2},{"value":"Validation and data requirements","id":"validation-and-data-requirements","depth":2},{"value":"Identity validation with validatePayoutRails","id":"identity-validation-with-validatepayoutrails","depth":3},{"value":"Next steps","id":"next-steps","depth":2}],"frontmatter":{"title":"Financial instruments","seo":{"title":"Financial instruments"}},"lastModified":"2026-04-03T15:45:06.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/payments-direct-2/api-docs/concepts/financial-instruments","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}