If this transfer cannot be created because the funding source is temporarily busy processing another update, this endpoint may return 409 resource_state_conflict.
This is a transient, retryable response. You may safely retry the same request with the same Idempotency-Key.
The id of the Bridge customer that you are moving funds on behalf of.
source
object
required
The source of the transfer, which could be an external bank account, a bridge account, or a crypto wallet address.
Show child attributes
destination
object
required
The destination of the transfer, which could be an external bank account, a bridge account, or a crypto wallet address.
Show child attributes
client_reference_id
string
A client-provided reference ID that uniquely identifies a resource in the client's system
Required string length: 1 - 256
amount
string
Amount of the transfer, expressed as a decimal string. Examples include "100.25", "0.1", "1.234567", "1.01" etc.
It is denominated in the source currency if that is a fiat currency, or in the fiat currency to which the source currency is pegged.
developer_fee
string
The fee, expressed as a decimal string, represents the amount you wish to reserve for your own account. This fee is the final amount deducted from what your customer ultimately receives, rather than a percentage.
It is denominated in the source currency if that is a fiat currency, or in the fiat currency to which the source currency is pegged.
developer_fee_percent
string
The fee percent, expressed as a decimal string from 0.0 to 100.0, represents the percentage of the transfer you wish to reserve for your own account.
This field must be set instead of developer_fee when using Flexible Amounts.
dry_run
boolean
Whether to validate the transfer route without creating a transfer. If set to true, a valid transfer will return a TransferRouteResponse indicating the transfer would have been valid. The same error response will be returned for an invalid transfer as in the non-dry-run case.
features
object
Features that should be enabled for this transfer. See Transfer Features for more details.
Show child attributes
return_instructions
object
Optional instructions for where to send funds if the transfer is returned (e.g. refund). Only supported when the source payment rail is crypto. When the source is Stellar, memo is required.
Show child attributes
initiation
object
Payment initiation context. Required when the source Bridge Wallet's GET response includes initiation_required: true. Omit for wallets that do not return that field. Not returned in transfer responses.
Show child attributes
travel_rule_data
object
Travel Rule data for this transfer. Use this when the same originator or beneficiary should apply to this transfer's movement. If the payload is only known after the transfer exists or is specific to a single movement, you can also submit the same object with POST /travel_rule_data/{id}.
Amount of the transfer, expressed as a decimal string. Examples include "100.25", "0.1", "1.234567", "1.01" etc.
It is denominated in the source currency if that is a fiat currency, or in the fiat currency to which the source currency is pegged.
currency
enum<string>
required
Fiat currency for the transfer amount and developer fee. It's the source currency if that is a fiat currency or the fiat currency to which the source currency is pegged.
Available options:
usd,
eur,
mxn,
brl,
cop,
gbp
on_behalf_of
string
required
The id of the Bridge customer that you are moving funds on behalf of.
developer_fee
string
required
The fee, expressed as a decimal string, represents the amount you wish to reserve for your own account. This fee is the final amount deducted from what your customer ultimately receives, rather than a percentage.
It is denominated in the source currency if that is a fiat currency, or in the fiat currency to which the source currency is pegged.
source
object
required
The source of the transfer, which could be an external bank account, a bridge account, or a crypto wallet address
Show child attributes
destination
object
required
The destination of the transfer, which could be an external bank account, a bridge account, or a crypto wallet address
Show child attributes
state
enum<string>
required
read-only
Status of the transfer. See Transfer States for more details.
Available options:
awaiting_funds,
in_review,
funds_received,
payment_submitted,
payment_processed,
canceled,
undeliverable,
returned,
refund_in_flight,
refund_failed,
refunded
created_at
string<date-time>
required
read-only
Time of creation of the transfer
updated_at
string<date-time>
required
read-only
Time of update of the transfer
client_reference_id
string
A client-provided reference ID that uniquely identifies a resource in the client's system
Required string length: 1 - 256
developer_fee_percent
string
The fee percent, expressed as a decimal string from 0.0 to 100.0, represents the percentage of the transfer you wish to reserve for your own account.
This field must be set instead of developer_fee when using Flexible Amounts.
source_deposit_instructions
Fiat · object
read-only
Instructions for a fiat bank deposit. Which bank fields are present depends on the payment rail.
Receipt information of a transfer. Not present on static templates or transfers with a flexible amount.
Show child attributes
return_details
object
read-only
Return information, if the transfer has been returned.
Show child attributes
return_instructions
object
read-only
Optional return instructions configured when creating or updating the transfer.
Show child attributes
exchange_details
object
read-only
Exchange details for the associated trade, if applicable.
Show child attributes
template_id
string
read-only
The ID of the static template transfer from which this transfer was instantiated. Only present for transfers created from a template.
Required string length: 1 - 42
Pattern: [a-z0-9]*
first_confirmed_at
string<date-time>
read-only
Time when the withdrawal transaction received its first on-chain confirmation. Only present for crypto withdrawal transfers where this feature is enabled for the developer.
swift_tracking
object
read-only
SWIFT gpi tracking of a payout sent through BNY. Only present for SWIFT destinations where this feature is enabled for the developer.
Show child attributes
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Bridge","colors":{"primary":"#047857","light":"#047857","dark":"#047857"},"logo":{"light":"https://mintcdn.com/bridge-727305d3/Zr0t-7SjjubLpKla/logo/bridge-logo-wordmark-dark.svg?fit=max\u0026auto=format\u0026n=Zr0t-7SjjubLpKla\u0026q=85\u0026s=c91d77ec31a41686da7d32d0c999b34a","dark":"https://mintcdn.com/bridge-727305d3/Zr0t-7SjjubLpKla/logo/bridge-logo-wordmark-light.svg?fit=max\u0026auto=format\u0026n=Zr0t-7SjjubLpKla\u0026q=85\u0026s=5a0980c2f0de4ea7c2f263c589a1cff6"},"favicon":"https://mintcdn.com/bridge-727305d3/Zr0t-7SjjubLpKla/logo/favicon-docs.svg?fit=max\u0026auto=format\u0026n=Zr0t-7SjjubLpKla\u0026q=85\u0026s=7804dcb568bd9fc9cd8a04d82d37e03f","api":{"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json"},"appearance":{"default":"light","strict":true},"navbar":{"links":[{"href":"https://bridge.coastdemo.com/share/693741a8dc19176c45ad2004?mode=link","label":"Demo"},{"href":"https://support.bridge.xyz/","label":"Support"}],"primary":{"type":"button","label":"Bridge Dashboard","href":"https://dashboard.bridge.xyz/"}},"footer":{"socials":{"x":"https://x.com/stablecoin","linkedin":"https://linkedin.com/company/bridge-apis"}},"fonts":{"heading":{"family":"Abc Diatype Regular","source":"https://cdn.prod.website-files.com/66c78bffc753432b33c4f61a/66c78bffc753432b33c4f654_ABC%20Diatype%20Regular.ttf","format":"woff2"},"body":{"family":"Abc Diatype Regular","source":"https://cdn.prod.website-files.com/66c78bffc753432b33c4f61a/66c78bffc753432b33c4f654_ABC%20Diatype%20Regular.ttf","format":"woff2"}},"integrations":{"gtm":{"tagId":"GTM-W79785BK"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity"],"display":"header"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"bridge-727305d3","hasAudioNarration":false,"actualSubdomain":"bridge-727305d3","customDomains":["apidocs.bridge.xyz"],"gitSource":{"type":"github","owner":"withbridge","repo":"bridge-api-docs-mintlify","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"edits":false,"agentFeedback":false},"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":"6afb57815be3cc8d577f9984","clientVersion":"0.0.4167","searchFilterCounts":[{"language":"default","tag":"API reference","count":136},{"language":"default","tag":"Endpoints","count":131},{"language":"default","tag":"Developer Platform","count":95},{"language":"default","tag":"Cards","count":43},{"language":"default","tag":"Customers","count":43},{"language":"default","tag":"Get Started","count":34},{"language":"default","tag":"Guides","count":25},{"language":"default","tag":"Orchestration","count":22},{"language":"default","tag":"Transfers","count":14},{"language":"default","tag":"Issuance","count":13}]},"assistantConfig":{"enableStarterQuestions":true,"enableContextualStarterQuestions":false},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[],"starterQuestions":[{"_id":"6a95e7c5dbba852a7e9d61cd","deploymentId":"68794f73dbdb837ef9af8c37","questionText":"Which endpoint can I use to create a Virtual Account?","status":"active","generatedBy":"manual","createdAt":"2026-08-31T20:44:53.966Z","updatedAt":"2026-08-31T20:44:53.966Z","__v":0},{"_id":"6a95e78ddbba852a7e9d5f5b","deploymentId":"68794f73dbdb837ef9af8c37","questionText":"Which payment rails are supported?","status":"active","generatedBy":"manual","createdAt":"2026-08-31T20:43:57.235Z","updatedAt":"2026-08-31T20:43:57.235Z","__v":0},{"_id":"6a95e766dbba852a7e9d5c38","deploymentId":"68794f73dbdb837ef9af8c37","questionText":"What's required to KYC a customer?","status":"active","generatedBy":"manual","createdAt":"2026-08-31T20:43:18.066Z","updatedAt":"2026-08-31T20:43:54.236Z","__v":0}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"body{color:#1e293b;font-family:'Inter', sans-serif}#sidebar{border-right:1px solid rgba(203, 213, 225, 0.6)}#navbar{background-color:#ffffff}.nav-logo{width:63px!important;height:24px!important;top:2px}.eyebrow{color:#6b7280!important}.dark .eyebrow{color:#9ca3af!important}a,.button-primary{color:#047857;font-weight:500;transition:color 0.2s ease}a:hover,.button-primary:hover{color:#065f46}#navbar a[href=\"/\"]:hover,#navbar a[href^=\"/get-started/\"]:hover,#navbar a[href^=\"/platform/\"]:hover,#navbar a[href^=\"/api-reference/\"]:hover,#navbar a[href^=\"/changelog/\"]:hover{color:#065f46!important;border-color:#047857!important;text-decoration-color:#047857!important}#navbar a[href=\"/\"]:hover>div:last-child,#navbar a[href^=\"/get-started/\"]:hover>div:last-child,#navbar a[href^=\"/platform/\"]:hover>div:last-child,#navbar a[href^=\"/api-reference/\"]:hover>div:last-child,#navbar a[href^=\"/changelog/\"]:hover>div:last-child{background-color:#047857!important}#topbar-cta-button>a:hover{color:#ffffff!important}#topbar-cta-button>a:hover>span:first-child{background-color:#065f46!important;opacity:1!important}.button-secondary{background-color:#047857;color:#ffffff;border-radius:0.375rem;padding:0.5rem 1rem;font-weight:500;transition:background-color 0.2s ease}.button-secondary:hover{background-color:#10b981}.card,.api-doc-box,.sidebar-section{box-shadow:0 1px 3px rgba(0, 0, 0, 0.05);border-radius:0.5rem}.hero h1{font-size:52px;font-weight:400}.hero subline{font-size:24px;font-weight:400;font-kerning:auto}.hero icon{text-decoration-color:white}.bg-dots-gradient{background-image:radial-gradient(#23cd94 0.5px, transparent 0.5px),\n linear-gradient(to bottom, #d4f2ef, #f7fafc, white);background-size:10px 10px, auto;background-repeat:repeat, no-repeat}"}],"page":{"pagePath":"api-reference/transfers/create-a-transfer","slug":"/api-reference/transfers/create-a-transfer","pageMetadata":{"title":"Create a transfer","description":"Create a transfer.\n\nIf this transfer cannot be created because the funding source is temporarily busy processing another update, this endpoint may return `409 resource_state_conflict`.\nThis is a transient, retryable response. You may safely retry the same request with the same `Idempotency-Key`.\n","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /transfers","href":"/api-reference/transfers/create-a-transfer","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Create a transfer.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"If this transfer cannot be created because the funding source is temporarily busy processing another update, this endpoint may return \", _jsx(_components.code, {\n children: \"409 resource_state_conflict\"\n }), \".\\nThis is a transient, retryable response. You may safely retry the same request with the same \", _jsx(_components.code, {\n children: \"Idempotency-Key\"\n }), \".\"]\n })]\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}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create a transfer","description":"Create a transfer.\n\nIf this transfer cannot be created because the funding source is temporarily busy processing another update, this endpoint may return `409 resource_state_conflict`.\nThis is a transient, retryable response. You may safely retry the same request with the same `Idempotency-Key`.\n","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /transfers","href":"/api-reference/transfers/create-a-transfer","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Create a transfer","description":"Create a transfer.\n\nIf this transfer cannot be created because the funding source is temporarily busy processing another update, this endpoint may return `409 resource_state_conflict`.\nThis is a transient, retryable response. You may safely retry the same request with the same `Idempotency-Key`.\n","tags":["Transfers"],"parameters":["8a9ab0b4-deab-4e34-9e0b-9f192ab9f898"],"requestBody":"cebc082c-84ac-4531-a2d6-611596cafee7","responses":{"201":"67fe9b4d-658f-455d-82be-73d2b41e380b","400":"2d20f6cc-1c70-464b-aecd-6153adc15863","401":"579a7f02-cc36-4275-99c6-017dd28f1afe","403":"8f3cd4e3-22e4-4c7d-bb73-0611e6c5fad8","409":"c4d462b8-082f-4e89-9fc4-be5f221caafe","500":"1dea53f9-0791-476e-b79a-bb906035ec52"},"method":"post","type":"path","servers":["8cfd91ab-6780-4f17-8205-744d686f1bbb"],"security":["ab600454-21be-4dfb-bb8b-e5b838e20b79"],"path":"/transfers","baseUrlOptions":["https://api.bridge.xyz/v0"],"title":"Create a transfer","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"8a9ab0b4-deab-4e34-9e0b-9f192ab9f898":{"in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"requestBody":{"description":"Transfer object to be created","required":true,"content":{"application/json":{"schema":{"required":["on_behalf_of","source","destination"],"properties":{"on_behalf_of":{"description":"The id of the Bridge customer that you are moving funds on behalf of.","type":"string","isRequired":true,"uniqueKey":"on_behalf_of","typeLabel":"string"},"source":{"type":"object","description":"The source of the transfer, which could be an external bank account, a bridge account, or a crypto wallet address.","required":["currency","payment_rail"],"properties":{"currency":{"type":"string","enum":["brl","cop","eur","eurc","gbp","mxn","ousd","path_usd","pyusd","usd","usdb","usdc","usdt","usdl_linea"],"description":"When `eur` is specified as the source currency:\n 1. the source rail must be `sepa`;\n 2. only `usdc` or `eurc` are supported as the destination currency","isRequired":true,"uniqueKey":"source.currency","typeLabel":"enum\u003cstring>"},"payment_rail":{"type":"string","enum":["ach","wire","ach_push","ach_same_day","fednow","arbitrum","avalanche_c_chain","base","bre_b","co_bank_transfer","bridge_wallet","celo","ethereum","faster_payments","linea","optimism","pix","polygon","sepa","solana","spei","stellar","swift","tempo","tron","xdc"],"description":"When `sepa` is specified as the source rail:\n 1. the source currency must be `eur`;\n 2. only `usdc` or `eurc` are supported as the destination currency \n\n **Note: This is the intended payment rail, and may differ from the actual payment rail used to onramp the funds.**","isRequired":true,"uniqueKey":"source.payment_rail","typeLabel":"enum\u003cstring>"},"bridge_wallet_id":{"description":"(Bridge Wallet only) The ID of the Bridge Wallet to draw funds from","type":"string","pattern":"[a-z0-9]*","minLength":1,"maxLength":42,"uniqueKey":"source.bridge_wallet_id","typeLabel":"string"},"co_bank_transfer":{"description":"(co_bank_transfer only) Details for Colombian bank transfers.","type":"object","required":["redirect_url"],"properties":{"redirect_url":{"description":"URL to redirect the customer to after completing the bank transfer. Must be a valid HTTPS URL. HTTP URLs are not supported.","type":"string","writeOnly":true,"isRequired":true,"uniqueKey":"source.co_bank_transfer.redirect_url","typeLabel":"string"},"expiry_date":{"description":"Optional ISO 8601 expiry timestamp for the payment session. Defaults to 24 hours from creation.","type":"string","writeOnly":true,"uniqueKey":"source.co_bank_transfer.expiry_date","typeLabel":"string"},"sender_data":{"description":"Sender information for the CO bank transfer. If omitted, the payer must manually provide this information via the payment link. If provided, fields will be pre-populated for the payer. Sensitive fields are masked in responses (e.g. document_number shows `***3456`).","type":"object","required":["full_name","document_type","document_number","email","phone_number"],"properties":{"full_name":{"description":"Full name of the sender","type":"string","isRequired":true,"uniqueKey":"source.co_bank_transfer.sender_data.full_name","typeLabel":"string"},"document_type":{"description":"Colombian document type identifier. `cc` = Cédula de Ciudadanía, `ce` = Cédula de Extranjería, `nit` = NIT (tax ID), `rut` = RUT (worker registration), `pa` = Passport, `ppt` = Permiso de Protección Temporal.\n","type":"string","enum":["cc","ce","nit","rut","pa","ppt","ti","rc","te","die","nd"],"isRequired":true,"uniqueKey":"source.co_bank_transfer.sender_data.document_type","typeLabel":"enum\u003cstring>"},"document_number":{"description":"Document number of the sender. Masked in responses (e.g. ***3456).","type":"string","isRequired":true,"uniqueKey":"source.co_bank_transfer.sender_data.document_number","typeLabel":"string"},"email":{"description":"Email address of the sender","type":"string","isRequired":true,"uniqueKey":"source.co_bank_transfer.sender_data.email","typeLabel":"string"},"phone_number":{"description":"Phone number of the sender in E.164 format (e.g. +573001234567)","type":"string","isRequired":true,"uniqueKey":"source.co_bank_transfer.sender_data.phone_number","typeLabel":"string"}},"uniqueKey":"source.co_bank_transfer.sender_data","typeLabel":"object"}},"uniqueKey":"source.co_bank_transfer","typeLabel":"object"},"from_address":{"description":"The crypto wallet address that the customer will send funds from, in order to kick off this transfer.","type":"string","uniqueKey":"source.from_address","typeLabel":"string"}},"isRequired":true,"uniqueKey":"source","typeLabel":"object"},"destination":{"type":"object","description":"The destination of the transfer, which could be an external bank account, a bridge account, or a crypto wallet address.","required":["currency","payment_rail"],"properties":{"currency":{"type":"string","enum":["brl","cop","eur","eurc","gbp","mxn","ousd","path_usd","pyusd","usd","usdb","usdc","usdt","usdl_linea"],"description":"When `eur` is specified as the destination currency, the destination rail must be `sepa`.","isRequired":true,"uniqueKey":"destination.currency","typeLabel":"enum\u003cstring>"},"payment_rail":{"type":"string","enum":["ach","wire","ach_push","ach_same_day","fednow","arbitrum","avalanche_c_chain","base","bre_b","co_bank_transfer","celo","ethereum","fiat_deposit_return","linea","optimism","polygon","sepa","solana","spei","stellar","swift","tempo","tron","xdc"],"description":"When `sepa` is specified as the destination payment rail, the destination currency must be `eur`; when `swift` is specified as the destination payment rail, the destination currency must be `usd`.","isRequired":true,"uniqueKey":"destination.payment_rail","typeLabel":"enum\u003cstring>"},"external_account_id":{"description":"External bank account Bridge should send the funds to. The currency associated with the External Account must match the destination currency.","type":"string","pattern":"[a-z0-9]*","minLength":1,"maxLength":42,"uniqueKey":"destination.external_account_id","typeLabel":"string"},"bridge_wallet_id":{"description":"The Bridge Wallet to which Bridge will send the funds. The chain associated with the Bridge Wallet must match the destination payment rail.","type":"string","pattern":"[a-z0-9]*","minLength":1,"maxLength":42,"uniqueKey":"destination.bridge_wallet_id","typeLabel":"string"},"wire_message":{"type":"string","description":"A message to be sent with a wire transfer. It can have up to 140 characters. This message will be validated against 4 lines, each with a max length of 35 characters according to the Fedwire standard.","maxLength":256,"minLength":1,"uniqueKey":"destination.wire_message","typeLabel":"string"},"sepa_reference":{"description":"A reference message to be sent with a SEPA transaction. We recommend you set a unique value to help you and your customers track payments end to end. It must be from 6 to 140 characters. The allowed characters are `a-z`, `A-Z`, `0-9`, spaces, ampersand (`\u0026`), hyphen (`-`), full stop (`.`), and solidus (`/`). If not populated, the default value is \"Payment via Bridge {unique_token}\".","type":"string","minLength":6,"maxLength":140,"uniqueKey":"destination.sepa_reference","typeLabel":"string"},"swift_reference":{"description":"A payment reference message or remittance information to be included in a SWIFT transaction. It can have at most 4 lines (separated by \"\\n\"), each line with a max length of 35 chars. The allowed characters are `a-z`, `A-Z`, `0-9`, special characters (`/` `-` `?` `:` `(` `)` `.` `,` `'` `+`), and space","type":"string","minLength":1,"maxLength":140,"uniqueKey":"destination.swift_reference","typeLabel":"string"},"spei_reference":{"description":"A payment reference message or remittance information to be included in a SPEI transaction. The allowed characters are alphanumeric `a-z`, `A-Z`, `0-9`, and space","type":"string","minLength":1,"maxLength":40,"uniqueKey":"destination.spei_reference","typeLabel":"string"},"reference":{"oneOf":[{"type":"string","title":"Faster Payments","description":"A payment reference message for newer payment rails (e.g. Pix, Faster Payments, and FedNow).\n","maxLength":18,"minLength":1,"uniqueKey":"destination.reference.oneOf.0","typeLabel":"string"},{"type":"string","title":"Pix","description":"A payment reference message for newer payment rails (e.g. Pix, Faster Payments, and FedNow).\n","maxLength":100,"minLength":1,"uniqueKey":"destination.reference.oneOf.1","typeLabel":"string"}],"uniqueKey":"destination.reference","typeLabel":"string"},"charge_bearer":{"description":"Which party bears the charges for the SWIFT transaction. Defaults to `sha` when not specified. Accepted on both request and response.","type":"string","enum":["our","sha","ben"],"uniqueKey":"destination.charge_bearer","typeLabel":"enum\u003cstring>"},"swift_details":{"description":"Additional instructions for the SWIFT payout. Only accepted when `payment_rail` is `swift`, and only returned when instructions have been set. On update, a provided object replaces the existing instructions in full, and an empty object clears them. When omitted, the existing instructions are retained, including when the destination account changes. Instructions are cleared when `payment_rail` changes to a value other than `swift`.","properties":{"instructed_currency":{"description":"The currency in which the beneficiary is to be credited, as a lowercase three-letter ISO 4217 code. When omitted, no conversion is requested and the payout is sent in the destination currency of the transfer or liquidation address. The exchange rate is determined when the payout is processed. Unsupported currencies are rejected.","type":"string","minLength":3,"maxLength":3,"example":"sgd","uniqueKey":"destination.swift_details.instructed_currency","typeLabel":"string"},"purpose":{"description":"The purpose of the payment, in the form the destination country requires: a local purpose code or a short free-text description. Required when `instructed_currency` is a currency other than `aud`, `cad`, `fjd`, or `usd`. At most 35 characters. Allowed characters are `a-z`, `A-Z`, `0-9`, space, and `/ - ? : ( ) . , ' +`.","type":"string","minLength":1,"maxLength":35,"uniqueKey":"destination.swift_details.purpose","typeLabel":"string"},"category_purpose_code":{"description":"The category purpose code that indicates how banks should process the payment, for destination countries that use one. Accepts an ISO 20022 category purpose code (e.g. `SALA`, case-insensitive) or a code from the destination country's own list. At most 35 characters. Allowed characters are `a-z`, `A-Z`, `0-9`, space, and `/ - ? : ( ) . , ' +`.","type":"string","minLength":1,"maxLength":35,"uniqueKey":"destination.swift_details.category_purpose_code","typeLabel":"string"}},"type":"object","uniqueKey":"destination.swift_details","typeLabel":"object"},"ach_reference":{"description":"A reference message to be sent with an ACH transaction. It can be at most 10 characters, A-Z, a-z, 0-9, and spaces.","type":"string","minLength":1,"maxLength":10,"uniqueKey":"destination.ach_reference","typeLabel":"string"},"blockchain_memo":{"type":"string","description":"The memo to include when sending funds on chain. Only allowed for blockchains that support memos such as Stellar","uniqueKey":"destination.blockchain_memo","typeLabel":"string"},"deposit_id":{"description":"A UUID that uniquely identifies a deposit","type":"string","pattern":"[a-z0-9]*","minLength":1,"maxLength":42,"uniqueKey":"destination.deposit_id","typeLabel":"string"},"amount":{"description":"Specify the destination amount for the recipient to receive. Learn more at [Fixed Outputs Integration Guide](https://apidocs.bridge.xyz/get-started/guides/move-money/fixed_outputs_integration_guide).\n\nDenominated in the destination currency.\n\nExpressed as a decimal string. Examples include \"100.25\", \"0.1\", \"1.234567\", \"1.01\" etc.","type":"string","uniqueKey":"destination.amount","typeLabel":"string"},"to_address":{"description":"The crypto wallet address that the customer wishes to ultimately receive funds at, in order to complete this transfer","type":"string","uniqueKey":"destination.to_address","typeLabel":"string"}},"isRequired":true,"uniqueKey":"destination","typeLabel":"object"},"client_reference_id":{"description":"A client-provided reference ID that uniquely identifies a resource in the client's system","type":"string","minLength":1,"maxLength":256,"uniqueKey":"client_reference_id","typeLabel":"string"},"amount":{"description":"Amount of the transfer, expressed as a decimal string. Examples include \"100.25\", \"0.1\", \"1.234567\", \"1.01\" etc.\n\nIt is denominated in the source currency if that is a fiat currency, or in the fiat currency to which the source currency is pegged.","type":"string","uniqueKey":"amount","typeLabel":"string"},"developer_fee":{"description":"The fee, expressed as a decimal string, represents the amount you wish to reserve for your own account. This fee is the final amount deducted from what your customer ultimately receives, rather than a percentage.\n\nIt is denominated in the source currency if that is a fiat currency, or in the fiat currency to which the source currency is pegged.","type":"string","uniqueKey":"developer_fee","typeLabel":"string"},"developer_fee_percent":{"description":"The fee percent, expressed as a decimal string from `0.0` to `100.0`, represents the percentage of the transfer you wish to reserve for your own account.\n\nThis field must be set instead of `developer_fee` when using [Flexible Amounts](https://apidocs.bridge.xyz/platform/orchestration/fees-and-mins/devfees#transfers-with-fixed-amounts).","type":"string","uniqueKey":"developer_fee_percent","typeLabel":"string"},"dry_run":{"description":"Whether to validate the transfer route without creating a transfer. If set to true, a valid transfer will return a `TransferRouteResponse` indicating the transfer would have been valid. The same error response will be returned for an invalid transfer as in the non-dry-run case.","type":"boolean","uniqueKey":"dry_run","typeLabel":"boolean"},"features":{"description":"Features that should be enabled for this transfer. See [Transfer Features](https://apidocs.bridge.xyz/platform/orchestration/transfers/transfer-features) for more details.","type":"object","properties":{"flexible_amount":{"type":"boolean","description":"Allows for variable amounts to be accepted. When true, omit `amount` from the request body. Required to be `true` when the source payment rail is `swift`.","uniqueKey":"features.flexible_amount","typeLabel":"boolean"},"static_template":{"type":"boolean","uniqueKey":"features.static_template","typeLabel":"boolean"},"allow_any_from_address":{"type":"boolean","uniqueKey":"features.allow_any_from_address","typeLabel":"boolean"}},"uniqueKey":"features","typeLabel":"object"},"return_instructions":{"description":"Optional instructions for where to send funds if the transfer is returned (e.g. refund). Only supported when the source payment rail is crypto. When the source is Stellar, `memo` is required.","type":"object","required":["address"],"properties":{"address":{"description":"The crypto wallet address to send returned funds to. Must be valid for the source payment rail's chain.","type":"string","isRequired":true,"uniqueKey":"return_instructions.address","typeLabel":"string"},"memo":{"description":"Memo to include with the return transaction. Required when the source payment rail is Stellar; optional for other memo-capable chains.","type":"string","uniqueKey":"return_instructions.memo","typeLabel":"string"}},"uniqueKey":"return_instructions","typeLabel":"object"},"initiation":{"type":"object","description":"Payment initiation context. Required when the source Bridge Wallet's GET response includes `initiation_required: true`. Omit for wallets that do not return that field. Not returned in transfer responses.","required":["channel","subchannel","attestations"],"properties":{"channel":{"description":"How the payment was initiated. Use `p2p_mobile_payment` for peer-to-peer transfers initiated on a mobile device; `other_mobile_payment` for non-P2P mobile-initiated payments (e.g. a merchant payment via a mobile app); `other` for payments not relying on a mobile device.","type":"string","enum":["p2p_mobile_payment","other_mobile_payment","other"],"isRequired":true,"uniqueKey":"initiation.channel","typeLabel":"enum\u003cstring>"},"subchannel":{"description":"Whether the payment was made remotely or in person. Use `remote` for payments initiated from a distance (mobile app, online banking, or e-commerce checkout); `non_remote` for payments made in person (physical card, payment terminal, or contactless tap).","type":"string","enum":["remote","non_remote"],"isRequired":true,"uniqueKey":"initiation.subchannel","typeLabel":"enum\u003cstring>"},"attestations":{"type":"object","required":["sca"],"properties":{"sca":{"type":"object","required":["outcome"],"properties":{"outcome":{"description":"Whether Strong Customer Authentication (SCA) was applied or which regulatory exemption or non-applicability reason covers this payment. Use `sca_used` when the user authenticated with SCA. Otherwise, choose the value that applies: `payment_to_self` — payer and payee are the same person (remote only); `trusted_beneficiaries` — payee is on the user's pre-approved list; `recurring_transaction` — amount and payee match a previously SCA-authorized recurring series; `contactless_low_value` — contactless card payment below the low-value threshold (non-remote only); `unattended_terminal_for_transport` — automated terminal for transport fares or parking (non-remote only); `low_value` — remote payment below the low-value threshold (remote only); `secure_corporate_payment` — dedicated corporate payment process with controls equivalent to SCA (remote only); `transaction_risk_analysis` — PSP has performed real-time risk analysis and the transaction falls within permitted thresholds (remote only); `merchant_initiated_transaction` — payment triggered by the merchant without the payer present, on a pre-authorized mandate (remote only); `not_applicable` — this flow requires initiation context but SCA and SCA exemptions do not apply; `other` — another recognized exemption not listed above.","type":"string","enum":["sca_used","payment_to_self","trusted_beneficiaries","recurring_transaction","contactless_low_value","unattended_terminal_for_transport","low_value","secure_corporate_payment","transaction_risk_analysis","merchant_initiated_transaction","not_applicable","other"],"isRequired":true,"uniqueKey":"initiation.attestations.sca.outcome","typeLabel":"enum\u003cstring>"},"auth_factors":{"description":"Authentication factor metadata. Optional when `outcome` is `sca_used`; if provided, it must contain at least two entries from different `category` values (e.g. one `possession` factor and one `knowledge` factor). Omit this field for any other outcome.","type":"array","minItems":2,"items":{"type":"object","required":["category","authenticated_at","reference"],"properties":{"category":{"description":"The type of authentication factor used. Must be one of: `knowledge` (something only the user knows, e.g. a PIN or password), `possession` (something only the user has, e.g. a phone receiving an OTP or a hardware token), or `inherence` (something the user is, e.g. a fingerprint or face scan). When `outcome` is `sca_used`, the two factors in `auth_factors` must belong to two different categories.","type":"string","enum":["knowledge","possession","inherence"],"isRequired":true,"uniqueKey":"initiation.attestations.sca.auth_factors.items.[INDEX].category","typeLabel":"enum\u003cstring>"},"authenticated_at":{"description":"The ISO 8601 timestamp when this factor was authenticated.","type":"string","format":"date-time","isRequired":true,"uniqueKey":"initiation.attestations.sca.auth_factors.items.[INDEX].authenticated_at","typeLabel":"string\u003cdate-time>"},"reference":{"description":"Your internal identifier for this authentication event (e.g. a session ID, transaction ID, or audit log reference). Used for reconciliation; Bridge does not validate its format.","type":"string","isRequired":true,"uniqueKey":"initiation.attestations.sca.auth_factors.items.[INDEX].reference","typeLabel":"string"}},"uniqueKey":"initiation.attestations.sca.auth_factors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"initiation.attestations.sca.auth_factors","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"initiation.attestations.sca","typeLabel":"object"}},"isRequired":true,"uniqueKey":"initiation.attestations","typeLabel":"object"}},"uniqueKey":"initiation","typeLabel":"object"},"travel_rule_data":{"type":"object","description":"Travel Rule data for this transfer. Use this when the same originator or beneficiary should apply to this transfer's movement. If the payload is only known after the transfer exists or is specific to a single movement, you can also submit the same object with `POST /travel_rule_data/{id}`.","example":{"originator":{"name":"Jane Smith","address":{"street_line_1":"123 Market St","street_line_2":null,"city":"San Francisco","state":"CA","postal_code":"94105","country":"USA"},"identifying_information":{"type":"national_id","number":"1234567890","issuing_country":"USA"},"birth_date":"2000-01-31","place_of_birth":{"city":"San Francisco","country":"USA"},"wallet_type":"self_custodied","wallet_attested_ownership_at":"2026-04-01T12:00:00Z"},"beneficiary":{"is_self":true,"wallet_type":"external"}},"properties":{"originator":{"type":"object","description":"The party sending the crypto.","properties":{"is_self":{"type":"boolean","description":"Set to `true` when this party is the same person or business as the Bridge customer on the resource. When `true`, Bridge uses the customer's name and address on file instead of relying on `name` and `address` in this payload.","uniqueKey":"travel_rule_data.originator.is_self","typeLabel":"boolean"},"name":{"type":"string","description":"Legal name of the originator or beneficiary. Usually omitted when `is_self` is `true`.","uniqueKey":"travel_rule_data.originator.name","typeLabel":"string"},"address":{"type":"object","description":"Mailing or legal address of the originator. Usually omitted when `is_self` is `true`.","properties":{"street_line_1":{"type":"string","uniqueKey":"travel_rule_data.originator.address.street_line_1","typeLabel":"string"},"street_line_2":{"type":"string","uniqueKey":"travel_rule_data.originator.address.street_line_2","typeLabel":"string"},"city":{"type":"string","uniqueKey":"travel_rule_data.originator.address.city","typeLabel":"string"},"state":{"type":"string","description":"ISO 3166-2 subdivision code.","uniqueKey":"travel_rule_data.originator.address.state","typeLabel":"string"},"postal_code":{"type":"string","uniqueKey":"travel_rule_data.originator.address.postal_code","typeLabel":"string"},"country":{"description":"Three-letter alpha-3 country code as defined in the ISO 3166-1 spec.","type":"string","minLength":3,"maxLength":3,"uniqueKey":"travel_rule_data.originator.address.country","typeLabel":"string"}},"uniqueKey":"travel_rule_data.originator.address","typeLabel":"object"},"wallet_type":{"type":"string","description":"Indicates the custody model for the wallet. Use `self_custodied` for customer-owned wallets (customer controls private keys), `hosted` for wallets managed by a developer or regulated entity on behalf of the customer, or `external` for wallets belonging to external exchanges or smart contracts.","enum":["hosted","external","self_custodied"],"uniqueKey":"travel_rule_data.originator.wallet_type","typeLabel":"enum\u003cstring>"},"wallet_attested_ownership_at":{"type":"string","format":"date-time","description":"Required when `wallet_type` is `self-custodied` or `hosted`. Must be a timestamp in the past indicating when wallet ownership was attested.","uniqueKey":"travel_rule_data.originator.wallet_attested_ownership_at","typeLabel":"string\u003cdate-time>"},"identifying_information":{"type":"array","items":{"type":"object","required":["issuing_country","type"],"properties":{"type":{"type":"string","description":"Tax identification number type or government-issued ID document type (see enum). Country-specific tax and national ID lists: [Individuals](https://apidocs.bridge.xyz/docs/individual-tax-identification-numbers-by-country), [Businesses](https://apidocs.bridge.xyz/docs/business-tax-identification-numbers-by-country).\n\n**EEA / BBSA (policy in `eea_requirements.rb`):** In-scope individuals and UBOs need **both** a valid national-ID-type entry and a valid TIN per [EEA updated requirements](https://apidocs.bridge.xyz/platform/customers/customers/eea-updated-requirements). In-scope businesses need business registration **and** business tax ID types per country tables there. **TIN issuing country** must match residence (individuals) or incorporation (businesses). **Foreign tax** outside the incorporation country: set `has_foreign_tax_registration` on the business customer and add TIN objects per jurisdiction ([foreign tax / tax residency](https://apidocs.bridge.xyz/platform/customers/customers/eea-updated-requirements#tax-residency-status-foreign-tax-registry)).\n","enum":["drivers_license","matriculate_id","military_id","national_id","passport","permanent_residency_id","state_or_provincial_id","visa","abn","acn","ahv","ak","aom","arbn","avs","bc","bce","bin","bir","bp","brn","bsn","bvn","cc","cdi","cedula_juridica","cf","cif","cin","cipc","cn","cnp","cnpj","cpf","cpr","crc","crib","crn","cro","cui","cuil","curp","cuit","cvr","edrpou","ein","embg","emirates_id","en","fin","fn","gstin","gui","hetu","hkid","hn","ic","ico","id","id_broj","idno","idnp","idnr","if","iin","ik","inn","ird","itin","itr","iva","jmbg","kbo","kvk","matricule","mf","mn","ms","mst","nic","nicn","nie","nif","nin","nino","nip","nipc","nipt","nit","npwp","nric","nrn","nrt","ntn","nuit","nzbn","oib","orgnr","other","pan","partita_iva","pesel","pib","pin","pk","ppsn","qid","rc","regon","rfc","ricn","rif","rn","rnc","rnokpp","rp","rrn","rtn","ruc","rut","si","sin","siren","siret","spi","ssm","ssn","steuer_id","strn","tckn","tfn","tin","tpin","trn","ucn","uen","uic","uid","usc","ust_idnr","utr","vat","vkn","voen","y_tunnus"],"isRequired":true,"uniqueKey":"travel_rule_data.originator.identifying_information.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"issuing_country":{"type":"string","description":"The ISO 3166-1 (three-character) country code that issued the provided document.","isRequired":true,"uniqueKey":"travel_rule_data.originator.identifying_information.items.[INDEX].issuing_country","typeLabel":"string"},"number":{"type":"string","description":"The unique identifier of the document. Required if this document is being used as a tax identification number (e.g., you are providing a passport or national_id with no other identification).","uniqueKey":"travel_rule_data.originator.identifying_information.items.[INDEX].number","typeLabel":"string"},"description":{"type":"string","description":"A description describing the provided document. This field is required when `other` is selected.","uniqueKey":"travel_rule_data.originator.identifying_information.items.[INDEX].description","typeLabel":"string"},"expiration":{"type":"string","description":"The expiration date of the given document in yyyy-mm-dd format.","uniqueKey":"travel_rule_data.originator.identifying_information.items.[INDEX].expiration","typeLabel":"string"},"image_front":{"type":"string","description":"This field is optionally accepted for tax_id types, but required for government_id types. Base64 encoded image* of the front side of the provided document, following the data-uri scheme i.e. data:image/[type];base64,[base_64_encoded_file_contents], with a minimum size of 200px x 200px\n\n*Maximum File Size: 15MB\n\n*Valid file types: .pdf, .jpeg, .jpg, .png, .heic, .tif\n\n_Note: When combined with an `image_back`, the combined size of both images must not exceed 24MB._\n","uniqueKey":"travel_rule_data.originator.identifying_information.items.[INDEX].image_front","typeLabel":"string"},"image_back":{"type":"string","description":"Base64 encoded image* of the back side of the provided document, following the data-uri scheme i.e. data:image/[type];base64,[base_64_encoded_file_contents], with a minimum size of 200px x 200px\n\n*Maximum File Size: 15MB\n\n*Valid file types: .pdf, .jpeg, .jpg, .png, .heic, .tif\n\n_Note: When combined with an `image_front`, the combined size of both images must not exceed 24MB._\n","uniqueKey":"travel_rule_data.originator.identifying_information.items.[INDEX].image_back","typeLabel":"string"}},"uniqueKey":"travel_rule_data.originator.identifying_information.items.[INDEX]","typeLabel":"object"},"title":"Identification Information","description":"List of identification objects for the originator. Do **not** include `image_front` or `image_back` fields in this context; those are not accepted in Travel Rule submissions.\n","uniqueKey":"travel_rule_data.originator.identifying_information","typeLabel":"Identification Information · object[]"},"birth_date":{"type":"string","description":"Date of birth in format yyyy-mm-dd.","minLength":10,"maxLength":10,"uniqueKey":"travel_rule_data.originator.birth_date","typeLabel":"string"},"place_of_birth":{"type":"object","description":"Country (and optionally city) of birth. **EEA / BBSA in-scope customers:** supply when onboarding individuals or associated persons under the [EEA updated requirements](https://apidocs.bridge.xyz/platform/customers/customers/eea-updated-requirements#country-of-birth-and-city-of-birth). This is a sparse address — no street address. At least `country` should be present when the object is sent; `city` is recommended and will be required by EU law in 2027.\n","properties":{"country":{"type":"string","minLength":3,"maxLength":3,"description":"ISO 3166-1 alpha-3 country code for the place of birth.","uniqueKey":"travel_rule_data.originator.place_of_birth.country","typeLabel":"string"},"city":{"type":"string","minLength":1,"description":"City of birth (recommended for EEA).","uniqueKey":"travel_rule_data.originator.place_of_birth.city","typeLabel":"string"}},"uniqueKey":"travel_rule_data.originator.place_of_birth","typeLabel":"object"},"legal_entity_identifier":{"type":"string","description":"The Legal Entity Identifier (LEI) or equivalent (e.g. VAT number) of the originator. Provide this when the originator is a legal entity rather than an individual.","uniqueKey":"travel_rule_data.originator.legal_entity_identifier","typeLabel":"string"}},"uniqueKey":"travel_rule_data.originator","typeLabel":"object"},"beneficiary":{"type":"object","description":"The party receiving the crypto.","properties":{"is_self":{"type":"boolean","description":"Set to `true` when this party is the same person or business as the Bridge customer on the resource. When `true`, Bridge uses the customer's name and address on file instead of relying on `name` and `address` in this payload.","uniqueKey":"travel_rule_data.beneficiary.is_self","typeLabel":"boolean"},"name":{"type":"string","description":"Legal name of the originator or beneficiary. Usually omitted when `is_self` is `true`.","uniqueKey":"travel_rule_data.beneficiary.name","typeLabel":"string"},"address":{"type":"object","description":"Mailing or legal address of the beneficiary. Usually omitted when `is_self` is `true`.","properties":{"street_line_1":{"type":"string","uniqueKey":"travel_rule_data.beneficiary.address.street_line_1","typeLabel":"string"},"street_line_2":{"type":"string","uniqueKey":"travel_rule_data.beneficiary.address.street_line_2","typeLabel":"string"},"city":{"type":"string","uniqueKey":"travel_rule_data.beneficiary.address.city","typeLabel":"string"},"state":{"type":"string","description":"ISO 3166-2 subdivision code.","uniqueKey":"travel_rule_data.beneficiary.address.state","typeLabel":"string"},"postal_code":{"type":"string","uniqueKey":"travel_rule_data.beneficiary.address.postal_code","typeLabel":"string"},"country":{"description":"Three-letter alpha-3 country code as defined in the ISO 3166-1 spec.","type":"string","minLength":3,"maxLength":3,"uniqueKey":"travel_rule_data.beneficiary.address.country","typeLabel":"string"}},"uniqueKey":"travel_rule_data.beneficiary.address","typeLabel":"object"},"wallet_type":{"type":"string","description":"Indicates the custody model for the wallet. Use `self_custodied` for customer-owned wallets (customer controls private keys), `hosted` for wallets managed by a developer or regulated entity on behalf of the customer, or `external` for wallets belonging to external exchanges or smart contracts.","enum":["hosted","external","self_custodied"],"uniqueKey":"travel_rule_data.beneficiary.wallet_type","typeLabel":"enum\u003cstring>"},"wallet_attested_ownership_at":{"type":"string","format":"date-time","description":"Required when `wallet_type` is `self-custodied` or `hosted`. Must be a timestamp in the past indicating when wallet ownership was attested.","uniqueKey":"travel_rule_data.beneficiary.wallet_attested_ownership_at","typeLabel":"string\u003cdate-time>"},"legal_entity_identifier":{"type":"string","description":"The Legal Entity Identifier (LEI) or equivalent (e.g. VAT number) of the beneficiary. Provide this when the beneficiary is a legal entity rather than an individual.","uniqueKey":"travel_rule_data.beneficiary.legal_entity_identifier","typeLabel":"string"}},"uniqueKey":"travel_rule_data.beneficiary","typeLabel":"object"}},"uniqueKey":"travel_rule_data","typeLabel":"object"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"on_behalf_of":"\u003cstring>","source":{"bridge_wallet_id":"\u003cstring>","from_address":"\u003cstring>"},"destination":{"external_account_id":"\u003cstring>","bridge_wallet_id":"\u003cstring>","wire_message":"\u003cstring>","sepa_reference":"\u003cstring>","swift_reference":"\u003cstring>","spei_reference":"\u003cstring>","reference":"\u003cstring>","swift_details":{"instructed_currency":"sgd","purpose":"\u003cstring>","category_purpose_code":"\u003cstring>"},"ach_reference":"\u003cstring>","blockchain_memo":"\u003cstring>","deposit_id":"\u003cstring>","amount":"\u003cstring>","to_address":"\u003cstring>"},"client_reference_id":"\u003cstring>","amount":"\u003cstring>","developer_fee":"\u003cstring>","developer_fee_percent":"\u003cstring>","dry_run":true,"features":{"flexible_amount":true,"static_template":true,"allow_any_from_address":true},"travel_rule_data":{"originator":{"name":"Jane Smith","address":{"street_line_1":"123 Market St","street_line_2":null,"city":"San Francisco","state":"CA","postal_code":"94105","country":"USA"},"identifying_information":{"type":"national_id","number":"1234567890","issuing_country":"USA"},"birth_date":"2000-01-31","place_of_birth":{"city":"San Francisco","country":"USA"},"wallet_type":"self_custodied","wallet_attested_ownership_at":"2026-04-01T12:00:00Z"},"beneficiary":{"is_self":true,"wallet_type":"external"}}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"67fe9b4d-658f-455d-82be-73d2b41e380b":{"description":"Transfer object created","content":{"application/json":{"schema":{"oneOf":[{"type":"object","required":["id","amount","developer_fee","currency","on_behalf_of","source","destination","state","created_at","updated_at"],"properties":{"id":{"description":"A UUID that uniquely identifies a resource","type":"string","pattern":"[a-z0-9]*","minLength":1,"maxLength":42,"readOnly":true,"isRequired":true,"uniqueKey":"oneOf.0.id","typeLabel":"string"},"amount":{"description":"Amount of the transfer, expressed as a decimal string. Examples include \"100.25\", \"0.1\", \"1.234567\", \"1.01\" etc.\n\nIt is denominated in the source currency if that is a fiat currency, or in the fiat currency to which the source currency is pegged.","type":"string","isRequired":true,"uniqueKey":"oneOf.0.amount","typeLabel":"string"},"currency":{"type":"string","enum":["usd","eur","mxn","brl","cop","gbp"],"description":"Fiat currency for the transfer amount and developer fee. It's the source currency if that is a fiat currency or the fiat currency to which the source currency is pegged.","isRequired":true,"uniqueKey":"oneOf.0.currency","typeLabel":"enum\u003cstring>"},"on_behalf_of":{"description":"The id of the Bridge customer that you are moving funds on behalf of.","type":"string","isRequired":true,"uniqueKey":"oneOf.0.on_behalf_of","typeLabel":"string"},"developer_fee":{"description":"The fee, expressed as a decimal string, represents the amount you wish to reserve for your own account. This fee is the final amount deducted from what your customer ultimately receives, rather than a percentage.\n\nIt is denominated in the source currency if that is a fiat currency, or in the fiat currency to which the source currency is pegged.","type":"string","isRequired":true,"uniqueKey":"oneOf.0.developer_fee","typeLabel":"string"},"source":{"type":"object","description":"The source of the transfer, which could be an external bank account, a bridge account, or a crypto wallet address","required":["currency","payment_rail"],"properties":{"currency":{"type":"string","description":"The source currency","enum":["brl","cop","eur","eurc","gbp","mxn","ousd","path_usd","pyusd","usd","usdb","usdc","usdt","usdl_linea"],"isRequired":true,"uniqueKey":"oneOf.0.source.currency","typeLabel":"enum\u003cstring>"},"payment_rail":{"type":"string","description":"The intended source payment rail","enum":["ach","wire","ach_push","ach_same_day","fednow","arbitrum","avalanche_c_chain","base","bre_b","co_bank_transfer","bridge_wallet","celo","ethereum","faster_payments","linea","optimism","pix","polygon","sepa","solana","spei","stellar","swift","tempo","tron","xdc"],"isRequired":true,"uniqueKey":"oneOf.0.source.payment_rail","typeLabel":"enum\u003cstring>"},"payment_scheme":{"type":"string","enum":["sepa_credit","sepa_instant"],"description":"(SEPA only) The payment scheme used for this transaction, such as SEPA Credit Transfer or SEPA Instant","readOnly":true,"uniqueKey":"oneOf.0.source.payment_scheme","typeLabel":"enum\u003cstring>"},"omad":{"description":"(Wire only) The OMAD of a wire transfer, if available","type":"string","pattern":"[a-z0-9]*","minLength":1,"maxLength":40,"deprecated":true,"readOnly":true,"uniqueKey":"oneOf.0.source.omad","typeLabel":"string"},"imad":{"description":"(Wire only) The IMAD of a wire transfer, if available","type":"string","pattern":"[a-z0-9]*","minLength":1,"maxLength":40,"readOnly":true,"uniqueKey":"oneOf.0.source.imad","typeLabel":"string"},"trace_number":{"description":"The trace number of an ACH transfer","type":"string","pattern":"[0-9]","minLength":15,"maxLength":15,"readOnly":true,"uniqueKey":"oneOf.0.source.trace_number","typeLabel":"string"},"bank_beneficiary_name":{"description":"(Wire only) The name of the beneficiary of the bank account that the customer sent the deposit to","type":"string","readOnly":true,"uniqueKey":"oneOf.0.source.bank_beneficiary_name","typeLabel":"string"},"bank_beneficiary_address":{"description":"(Wire only) The address of the beneficiary of the bank account that the customer sent the deposit to","type":"string","readOnly":true,"uniqueKey":"oneOf.0.source.bank_beneficiary_address","typeLabel":"string"},"bank_routing_number":{"description":"(Wire only) The routing number of the bank that the customer sent the deposit to","type":"string","readOnly":true,"uniqueKey":"oneOf.0.source.bank_routing_number","typeLabel":"string"},"bank_name":{"description":"(Wire, SPEI, and PIX only) The name of the bank that the customer sent the deposit from. For PIX, only present when the sending bank reports it.","type":"string","readOnly":true,"uniqueKey":"oneOf.0.source.bank_name","typeLabel":"string"},"originator_name":{"description":"(Wire only) The originator name of this wire","type":"string","readOnly":true,"uniqueKey":"oneOf.0.source.originator_name","typeLabel":"string"},"originator_address":{"description":"(Wire only) The originator address of this wire","type":"string","readOnly":true,"uniqueKey":"oneOf.0.source.originator_address","typeLabel":"string"},"wire_message":{"description":"(Wire only) The memo for this wire","type":"string","readOnly":true,"uniqueKey":"oneOf.0.source.wire_message","typeLabel":"string"},"bridge_wallet_id":{"description":"(Bridge Wallet only) The ID of the Bridge Wallet to draw funds from","type":"string","pattern":"[a-z0-9]*","minLength":1,"maxLength":42,"uniqueKey":"oneOf.0.source.bridge_wallet_id","typeLabel":"string"},"sender_name":{"description":"(ACH, FedNow, and RTP only) The name of the business or individual who initiated the transaction","type":"string","readOnly":true,"uniqueKey":"oneOf.0.source.sender_name","typeLabel":"string"},"sender_bank_routing_number":{"description":"(ACH, FedNow, and RTP only) The routing number of the entity that initiated this transaction","type":"string","readOnly":true,"uniqueKey":"oneOf.0.source.sender_bank_routing_number","typeLabel":"string"},"end_to_end_id":{"description":"The end-to-end ID of the instant payment (FedNow or RTP), assigned by the sending bank, and is not guaranteed to be unique across payments.","type":"string","readOnly":true,"uniqueKey":"oneOf.0.source.end_to_end_id","typeLabel":"string"},"description":{"description":"(ACH only) The description of the deposit that the customer sent","type":"string","readOnly":true,"uniqueKey":"oneOf.0.source.description","typeLabel":"string"},"tracking_number":{"description":"The primary tracking identifier for this fiat transaction. Format varies by payment rail (e.g., UETR for SWIFT/SEPA/FPS, clave de rastreo for SPEI, end-to-end ID for PIX).","type":"string","readOnly":true,"uniqueKey":"oneOf.0.source.tracking_number","typeLabel":"string"},"clabe":{"description":"(SPEI only) The 18-digit CLABE of the sender who initiated this SPEI transaction","type":"string","pattern":"^[0-9]+$","minLength":18,"maxLength":18,"readOnly":true,"uniqueKey":"oneOf.0.source.clabe","typeLabel":"string"},"account_number":{"description":"The account number of the sender who initiated this transaction, when the sending bank reports it. SPEI transactions use `clabe` instead.","type":"string","readOnly":true,"uniqueKey":"oneOf.0.source.account_number","typeLabel":"string"},"bank_code":{"description":"(SPEI and PIX only) The code of the sender's bank that initiated this transaction. For SPEI this is the Banxico bank code; for PIX this is the 8-digit ISPB code.","type":"string","readOnly":true,"uniqueKey":"oneOf.0.source.bank_code","typeLabel":"string"},"transaction_id":{"description":"Deprecated: use tracking_number instead. The unique transaction identifier for this payment.","type":"string","deprecated":true,"readOnly":true,"uniqueKey":"oneOf.0.source.transaction_id","typeLabel":"string"},"co_bank_transfer":{"description":"(co_bank_transfer only) Details for Colombian bank transfers.","type":"object","required":["redirect_url"],"properties":{"sender_data":{"description":"Sender information for the CO bank transfer. If omitted, the payer must manually provide this information via the payment link. If provided, fields will be pre-populated for the payer. Sensitive fields are masked in responses (e.g. document_number shows `***3456`).","type":"object","required":["full_name","document_type","document_number","email","phone_number"],"properties":{"full_name":{"description":"Full name of the sender","type":"string","isRequired":true,"uniqueKey":"oneOf.0.source.co_bank_transfer.sender_data.full_name","typeLabel":"string"},"document_type":{"description":"Colombian document type identifier. `cc` = Cédula de Ciudadanía, `ce` = Cédula de Extranjería, `nit` = NIT (tax ID), `rut` = RUT (worker registration), `pa` = Passport, `ppt` = Permiso de Protección Temporal.\n","type":"string","enum":["cc","ce","nit","rut","pa","ppt","ti","rc","te","die","nd"],"isRequired":true,"uniqueKey":"oneOf.0.source.co_bank_transfer.sender_data.document_type","typeLabel":"enum\u003cstring>"},"document_number":{"description":"Document number of the sender. Masked in responses (e.g. ***3456).","type":"string","isRequired":true,"uniqueKey":"oneOf.0.source.co_bank_transfer.sender_data.document_number","typeLabel":"string"},"email":{"description":"Email address of the sender","type":"string","isRequired":true,"uniqueKey":"oneOf.0.source.co_bank_transfer.sender_data.email","typeLabel":"string"},"phone_number":{"description":"Phone number of the sender in E.164 format (e.g. +573001234567)","type":"string","isRequired":true,"uniqueKey":"oneOf.0.source.co_bank_transfer.sender_data.phone_number","typeLabel":"string"}},"uniqueKey":"oneOf.0.source.co_bank_transfer.sender_data","typeLabel":"object"}},"uniqueKey":"oneOf.0.source.co_bank_transfer","typeLabel":"object"},"payment_received_rail":{"oneOf":[{"type":"string","description":"The rail on which the payment was actually received. Set once the funds have been onramped. A payment sent with `fednow` can be received over `rtp`.","enum":["ach","wire","ach_push","ach_same_day","fednow","arbitrum","avalanche_c_chain","base","bre_b","co_bank_transfer","bridge_wallet","celo","ethereum","faster_payments","linea","optimism","pix","polygon","sepa","solana","spei","stellar","swift","tempo","tron","xdc"],"uniqueKey":"oneOf.0.source.payment_received_rail.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","description":"The rail on which the payment was actually received. Set once the funds have been onramped. A payment sent with `fednow` can be received over `rtp`.","enum":["rtp"],"uniqueKey":"oneOf.0.source.payment_received_rail.oneOf.1","typeLabel":"enum\u003cstring>"}],"uniqueKey":"oneOf.0.source.payment_received_rail","typeLabel":"enum\u003cstring>"},"from_address":{"description":"The crypto wallet address that the customer will send funds from, in order to kick off this transfer","type":"string","uniqueKey":"oneOf.0.source.from_address","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.0.source","typeLabel":"object"},"destination":{"type":"object","description":"The destination of the transfer, which could be an external bank account, a bridge account, or a crypto wallet address","required":["currency","payment_rail"],"properties":{"currency":{"type":"string","description":"The destination currency","enum":["brl","cop","eur","eurc","gbp","mxn","ousd","path_usd","pyusd","usd","usdb","usdc","usdt","usdl_linea"],"isRequired":true,"uniqueKey":"oneOf.0.destination.currency","typeLabel":"enum\u003cstring>"},"payment_rail":{"type":"string","description":"The destination payment rail","enum":["ach","wire","ach_push","ach_same_day","arbitrum","avalanche_c_chain","base","bre_b","co_bank_transfer","celo","ethereum","fiat_deposit_return","linea","optimism","polygon","sepa","solana","spei","stellar","swift","tempo","tron","xdc"],"isRequired":true,"uniqueKey":"oneOf.0.destination.payment_rail","typeLabel":"enum\u003cstring>"},"external_account_id":{"description":"External bank account Bridge should send the funds to. The currency associated with the External Account must match the destination currency.","type":"string","pattern":"[a-z0-9]*","minLength":1,"maxLength":42,"uniqueKey":"oneOf.0.destination.external_account_id","typeLabel":"string"},"bridge_wallet_id":{"description":"The Bridge Wallet to which Bridge will send the funds. The chain associated with the Bridge Wallet must match the destination payment rail.","type":"string","pattern":"[a-z0-9]*","minLength":1,"maxLength":42,"uniqueKey":"oneOf.0.destination.bridge_wallet_id","typeLabel":"string"},"omad":{"description":"(Wire only) The OMAD of a wire transfer, if available","type":"string","pattern":"[a-z0-9]*","minLength":1,"maxLength":40,"deprecated":true,"readOnly":true,"uniqueKey":"oneOf.0.destination.omad","typeLabel":"string"},"imad":{"description":"(Wire only) The IMAD of a wire transfer, if available","type":"string","pattern":"[a-z0-9]*","minLength":1,"maxLength":40,"readOnly":true,"uniqueKey":"oneOf.0.destination.imad","typeLabel":"string"},"trace_number":{"description":"The trace number of an ACH transfer","type":"string","pattern":"[0-9]","minLength":15,"maxLength":15,"readOnly":true,"uniqueKey":"oneOf.0.destination.trace_number","typeLabel":"string"},"end_to_end_id":{"description":"The end-to-end ID of the instant payment (FedNow or RTP), assigned by the sending bank, and is not guaranteed to be unique across payments.","type":"string","readOnly":true,"uniqueKey":"oneOf.0.destination.end_to_end_id","typeLabel":"string"},"wire_message":{"type":"string","description":"A message to be sent with a wire transfer, only allowed when the payment rail is a wire. This message will be validated against 4 lines, each with a max length of 35 char according to the Fedwire standard.","maxLength":256,"minLength":1,"uniqueKey":"oneOf.0.destination.wire_message","typeLabel":"string"},"sepa_reference":{"description":"A reference message to be sent with a SEPA transaction. We recommend you set a unique value to help you and your customers track payments end to end. It must be from 6 to 140 characters. The allowed characters are `a-z`, `A-Z`, `0-9`, spaces, ampersand (`\u0026`), hyphen (`-`), full stop (`.`), and solidus (`/`). If not populated, the default value is \"Payment via Bridge {unique_token}\".","type":"string","minLength":6,"maxLength":140,"uniqueKey":"oneOf.0.destination.sepa_reference","typeLabel":"string"},"swift_reference":{"description":"A payment reference message or remittance information to be included in a SWIFT transaction. It can have at most 4 lines (separated by \"\\n\"), each line with a max length of 35 chars. The allowed characters are `a-z`, `A-Z`, `0-9`, special characters (`/` `-` `?` `:` `(` `)` `.` `,` `'` `+`), and space","type":"string","minLength":1,"maxLength":140,"uniqueKey":"oneOf.0.destination.swift_reference","typeLabel":"string"},"spei_reference":{"description":"A payment reference message or remittance information to be included in a SPEI transaction. The allowed characters are alphanumeric `a-z`, `A-Z`, `0-9`, and space","type":"string","minLength":1,"maxLength":40,"uniqueKey":"oneOf.0.destination.spei_reference","typeLabel":"string"},"reference":{"oneOf":[{"type":"string","title":"Faster Payments","description":"A payment reference message for newer payment rails (e.g. Pix, Faster Payments, and FedNow).\n","maxLength":18,"minLength":1,"uniqueKey":"oneOf.0.destination.reference.oneOf.0","typeLabel":"string"},{"type":"string","title":"Pix","description":"A payment reference message for newer payment rails (e.g. Pix, Faster Payments, and FedNow).\n","maxLength":100,"minLength":1,"uniqueKey":"oneOf.0.destination.reference.oneOf.1","typeLabel":"string"}],"uniqueKey":"oneOf.0.destination.reference","typeLabel":"string"},"charge_bearer":{"description":"Which party bears the charges for the SWIFT transaction. Defaults to `sha` when not specified. Accepted on both request and response.","type":"string","enum":["our","sha","ben"],"uniqueKey":"oneOf.0.destination.charge_bearer","typeLabel":"enum\u003cstring>"},"swift_details":{"description":"Additional instructions for the SWIFT payout. Only accepted when `payment_rail` is `swift`, and only returned when instructions have been set. On update, a provided object replaces the existing instructions in full, and an empty object clears them. When omitted, the existing instructions are retained, including when the destination account changes. Instructions are cleared when `payment_rail` changes to a value other than `swift`.","properties":{"instructed_currency":{"description":"The currency in which the beneficiary is to be credited, as a lowercase three-letter ISO 4217 code. When omitted, no conversion is requested and the payout is sent in the destination currency of the transfer or liquidation address. The exchange rate is determined when the payout is processed. Unsupported currencies are rejected.","type":"string","minLength":3,"maxLength":3,"example":"sgd","uniqueKey":"oneOf.0.destination.swift_details.instructed_currency","typeLabel":"string"},"purpose":{"description":"The purpose of the payment, in the form the destination country requires: a local purpose code or a short free-text description. Required when `instructed_currency` is a currency other than `aud`, `cad`, `fjd`, or `usd`. At most 35 characters. Allowed characters are `a-z`, `A-Z`, `0-9`, space, and `/ - ? : ( ) . , ' +`.","type":"string","minLength":1,"maxLength":35,"uniqueKey":"oneOf.0.destination.swift_details.purpose","typeLabel":"string"},"category_purpose_code":{"description":"The category purpose code that indicates how banks should process the payment, for destination countries that use one. Accepts an ISO 20022 category purpose code (e.g. `SALA`, case-insensitive) or a code from the destination country's own list. At most 35 characters. Allowed characters are `a-z`, `A-Z`, `0-9`, space, and `/ - ? : ( ) . , ' +`.","type":"string","minLength":1,"maxLength":35,"uniqueKey":"oneOf.0.destination.swift_details.category_purpose_code","typeLabel":"string"}},"type":"object","uniqueKey":"oneOf.0.destination.swift_details","typeLabel":"object"},"ach_reference":{"description":"A reference message to be sent with an ACH transaction. It can be at most 10 characters, A-Z, a-z, 0-9, and spaces.","type":"string","minLength":1,"maxLength":10,"uniqueKey":"oneOf.0.destination.ach_reference","typeLabel":"string"},"uetr":{"description":"Deprecated: use tracking_number instead. The unique end-to-end transaction reference, for tracing purposes.","type":"string","readOnly":true,"deprecated":true,"uniqueKey":"oneOf.0.destination.uetr","typeLabel":"string"},"blockchain_memo":{"type":"string","description":"A message to be sent with a crypto transaction, only allowed when the payment rail supports memo, e.g. Stellar.","uniqueKey":"oneOf.0.destination.blockchain_memo","typeLabel":"string"},"deposit_id":{"description":"A UUID that uniquely identifies a deposit","type":"string","pattern":"[a-z0-9]*","minLength":1,"maxLength":42,"uniqueKey":"oneOf.0.destination.deposit_id","typeLabel":"string"},"tracking_number":{"description":"The primary tracking identifier for this fiat transaction. Format varies by payment rail (e.g., UETR for SWIFT/SEPA/FPS, clave de rastreo for SPEI, end-to-end ID for PIX).","type":"string","readOnly":true,"uniqueKey":"oneOf.0.destination.tracking_number","typeLabel":"string"},"transaction_id":{"description":"Deprecated: use tracking_number instead. The unique transaction identifier for this payment.","type":"string","deprecated":true,"readOnly":true,"uniqueKey":"oneOf.0.destination.transaction_id","typeLabel":"string"},"sending_institution_name":{"description":"The name of the institution sending the funds","type":"string","readOnly":true,"uniqueKey":"oneOf.0.destination.sending_institution_name","typeLabel":"string"},"amount":{"description":"The destination amount for the recipient to receive. Present when the transfer was created with a destination amount (Fixed Outputs).\n\nDenominated in the destination currency.\n\nExpressed as a decimal string. Examples include \"100.25\", \"0.1\", \"1.234567\", \"1.01\" etc.","type":"string","readOnly":true,"uniqueKey":"oneOf.0.destination.amount","typeLabel":"string"},"to_address":{"description":"The crypto wallet address that the customer wishes to ultimately receive funds at, in order to complete this transfer","type":"string","uniqueKey":"oneOf.0.destination.to_address","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.0.destination","typeLabel":"object"},"state":{"type":"string","enum":["awaiting_funds","in_review","funds_received","payment_submitted","payment_processed","canceled","undeliverable","returned","refund_in_flight","refund_failed","refunded"],"description":"Status of the transfer. See [Transfer States](https://apidocs.bridge.xyz/platform/orchestration/transfers/transfer-states) for more details.","readOnly":true,"isRequired":true,"uniqueKey":"oneOf.0.state","typeLabel":"enum\u003cstring>"},"created_at":{"readOnly":true,"type":"string","description":"Time of creation of the transfer","format":"date-time","isRequired":true,"uniqueKey":"oneOf.0.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"readOnly":true,"type":"string","description":"Time of update of the transfer","format":"date-time","isRequired":true,"uniqueKey":"oneOf.0.updated_at","typeLabel":"string\u003cdate-time>"},"client_reference_id":{"description":"A client-provided reference ID that uniquely identifies a resource in the client's system","type":"string","minLength":1,"maxLength":256,"uniqueKey":"oneOf.0.client_reference_id","typeLabel":"string"},"developer_fee_percent":{"description":"The fee percent, expressed as a decimal string from `0.0` to `100.0`, represents the percentage of the transfer you wish to reserve for your own account.\n\nThis field must be set instead of `developer_fee` when using [Flexible Amounts](https://apidocs.bridge.xyz/platform/orchestration/fees-and-mins/devfees#transfers-with-fixed-amounts).","type":"string","uniqueKey":"oneOf.0.developer_fee_percent","typeLabel":"string"},"source_deposit_instructions":{"oneOf":[{"type":"object","title":"Fiat","description":"Instructions for a fiat bank deposit. Which bank fields are present depends on the payment rail.","required":["payment_rail","amount","currency"],"readOnly":true,"example":{"payment_rail":"wire","amount":"75.0","currency":"usd","deposit_message":"BVI7depositmessage","bank_name":"Bank name","bank_address":"Bank address","bank_routing_number":"123456789","bank_account_number":"1234567890","bank_beneficiary_name":"Bank beneficiary","bank_beneficiary_address":"Bank beneficiary address"},"properties":{"payment_rail":{"type":"string","enum":["ach_push","bre_b","co_bank_transfer","faster_payments","fednow","pix","sepa","spei","swift","wire"],"description":"The fiat payment rail that Bridge is expecting funds to arrive on","isRequired":true,"uniqueKey":"oneOf.0.source_deposit_instructions.oneOf.0.payment_rail","typeLabel":"enum\u003cstring>"},"amount":{"description":"Amount of the deposit in the source currency, expressed as a decimal string. Examples include \"100.25\", \"0.1\", \"1.234567\", \"1.01\" etc.","type":"string","isRequired":true,"uniqueKey":"oneOf.0.source_deposit_instructions.oneOf.0.amount","typeLabel":"string"},"currency":{"type":"string","enum":["usd","eur","mxn","brl","cop","gbp"],"description":"The source currency","isRequired":true,"uniqueKey":"oneOf.0.source_deposit_instructions.oneOf.0.currency","typeLabel":"enum\u003cstring>"},"deposit_message":{"description":"The message that the customer MUST include in their `wire memo/message`, `ach push description`, or `sepa reference`.","type":"string","uniqueKey":"oneOf.0.source_deposit_instructions.oneOf.0.deposit_message","typeLabel":"string"},"bank_name":{"description":"The name of the bank that the customer should send the deposit to","type":"string","uniqueKey":"oneOf.0.source_deposit_instructions.oneOf.0.bank_name","typeLabel":"string"},"bank_address":{"description":"The address of the bank that the customer should send the deposit to. For SEPA, the country in this address should be used for sending the deposit","type":"string","uniqueKey":"oneOf.0.source_deposit_instructions.oneOf.0.bank_address","typeLabel":"string"},"bank_routing_number":{"description":"The routing number of the bank that the customer should send the deposit to","type":"string","uniqueKey":"oneOf.0.source_deposit_instructions.oneOf.0.bank_routing_number","typeLabel":"string"},"bank_account_number":{"description":"The account number of the bank that the customer should send the deposit to","type":"string","uniqueKey":"oneOf.0.source_deposit_instructions.oneOf.0.bank_account_number","typeLabel":"string"},"bank_beneficiary_name":{"description":"The name of the beneficiary of the bank account that the customer should send the deposit to","type":"string","uniqueKey":"oneOf.0.source_deposit_instructions.oneOf.0.bank_beneficiary_name","typeLabel":"string"},"bank_beneficiary_address":{"description":"The address of the beneficiary of the bank account that the customer should send the deposit to","type":"string","uniqueKey":"oneOf.0.source_deposit_instructions.oneOf.0.bank_beneficiary_address","typeLabel":"string"},"intermediary_bank_name":{"description":"For USD SWIFT, the name of the intermediary correspondent bank that the originating bank should route the payment through.","type":"string","uniqueKey":"oneOf.0.source_deposit_instructions.oneOf.0.intermediary_bank_name","typeLabel":"string"},"intermediary_bank_bic":{"description":"For USD SWIFT, the SWIFT/BIC of the intermediary correspondent bank","type":"string","uniqueKey":"oneOf.0.source_deposit_instructions.oneOf.0.intermediary_bank_bic","typeLabel":"string"},"intermediary_bank_routing_number":{"description":"For USD SWIFT, the ABA routing number of the intermediary correspondent bank","type":"string","uniqueKey":"oneOf.0.source_deposit_instructions.oneOf.0.intermediary_bank_routing_number","typeLabel":"string"},"iban":{"description":"For SEPA and SWIFT, the International Bank Account Number (IBAN) that the customer should use to send the deposit","type":"string","uniqueKey":"oneOf.0.source_deposit_instructions.oneOf.0.iban","typeLabel":"string"},"bic":{"description":"For SEPA and SWIFT, the Bank Identifier Code (BIC) that the customer should use to send the deposit","type":"string","uniqueKey":"oneOf.0.source_deposit_instructions.oneOf.0.bic","typeLabel":"string"},"account_number":{"description":"For Faster Payments (UK), the account number that the customer should use to send the deposit","type":"string","uniqueKey":"oneOf.0.source_deposit_instructions.oneOf.0.account_number","typeLabel":"string"},"sort_code":{"description":"For Faster Payments (UK), the sort code that the customer should use to send the deposit","type":"string","uniqueKey":"oneOf.0.source_deposit_instructions.oneOf.0.sort_code","typeLabel":"string"},"clabe":{"description":"For SPEI, the CLABE (account number) that the customer should use to send the deposit","type":"string","uniqueKey":"oneOf.0.source_deposit_instructions.oneOf.0.clabe","typeLabel":"string"},"br_code":{"description":"For Pix (Brazil), the BR Code that the customer should use to send the deposit","type":"string","uniqueKey":"oneOf.0.source_deposit_instructions.oneOf.0.br_code","typeLabel":"string"},"qr_code":{"description":"For Pix (Brazil), a base64-encoded PNG image of the QR code that the customer can scan to send the deposit","type":"string","uniqueKey":"oneOf.0.source_deposit_instructions.oneOf.0.qr_code","typeLabel":"string"},"account_holder_name":{"description":"For SEPA, SWIFT, SPEI, Pix, Bre-B, and co_bank_transfer, the name of the bank account holder that the customer should use to send the deposit","type":"string","uniqueKey":"oneOf.0.source_deposit_instructions.oneOf.0.account_holder_name","typeLabel":"string"},"bre_b_key":{"description":"For Bre-B (Colombia), the Bre-B key that the customer should use to send the COP deposit","type":"string","uniqueKey":"oneOf.0.source_deposit_instructions.oneOf.0.bre_b_key","typeLabel":"string"},"start_url":{"description":"For co_bank_transfer (Colombia), the URL the customer should be redirected to in order to complete the bank transfer payment","type":"string","uniqueKey":"oneOf.0.source_deposit_instructions.oneOf.0.start_url","typeLabel":"string"},"redirect_url":{"description":"For co_bank_transfer (Colombia), the HTTPS redirect URL you provided when the transfer was created","type":"string","uniqueKey":"oneOf.0.source_deposit_instructions.oneOf.0.redirect_url","typeLabel":"string"},"expires_at":{"description":"For Pix (Brazil) and co_bank_transfer (Colombia), the ISO 8601 timestamp when the payment session expires","type":"string","uniqueKey":"oneOf.0.source_deposit_instructions.oneOf.0.expires_at","typeLabel":"string"}},"uniqueKey":"oneOf.0.source_deposit_instructions.oneOf.0","typeLabel":"Fiat · object"},{"type":"object","title":"Crypto","description":"Instructions for an on-chain deposit to a Bridge deposit address","required":["payment_rail","amount","currency","to_address"],"readOnly":true,"example":{"payment_rail":"ethereum","amount":"75.0","currency":"usdc","from_address":"0x71C7656EC7ab88b098defB751B7401B5f6d8976F","to_address":"0xb794f5ea0ba39494ce839613fffba74279579268"},"properties":{"payment_rail":{"type":"string","enum":["arbitrum","avalanche_c_chain","base","celo","ethereum","linea","optimism","polygon","solana","stellar","tempo","tron","xdc"],"description":"The chain that Bridge is expecting funds to arrive on","isRequired":true,"uniqueKey":"oneOf.0.source_deposit_instructions.oneOf.1.payment_rail","typeLabel":"enum\u003cstring>"},"amount":{"oneOf":[{"description":"Amount of the deposit, expressed as a decimal string denominated in the fiat currency to which the source currency is pegged. Null for flexible amount transfers. Examples include \"100.25\", \"0.1\", \"1.234567\", \"1.01\" etc.","type":"string","isRequired":true,"uniqueKey":"oneOf.0.source_deposit_instructions.oneOf.1.amount.oneOf.0","typeLabel":"string"},{"description":"Amount of the deposit, expressed as a decimal string denominated in the fiat currency to which the source currency is pegged. Null for flexible amount transfers. Examples include \"100.25\", \"0.1\", \"1.234567\", \"1.01\" etc.","type":"null","isRequired":true,"uniqueKey":"oneOf.0.source_deposit_instructions.oneOf.1.amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.source_deposit_instructions.oneOf.1.amount","typeLabel":"string | null"},"currency":{"type":"string","enum":["usdb","usdc","usdt","usdl_linea","pyusd","eurc"],"description":"The source currency","isRequired":true,"uniqueKey":"oneOf.0.source_deposit_instructions.oneOf.1.currency","typeLabel":"enum\u003cstring>"},"to_address":{"description":"The crypto wallet address the customer will send funds to in order to initiate the payment processing","type":"string","isRequired":true,"uniqueKey":"oneOf.0.source_deposit_instructions.oneOf.1.to_address","typeLabel":"string"},"from_address":{"oneOf":[{"description":"The crypto wallet address that the customer must send funds from. Null or absent when any address may be used.","type":"string","uniqueKey":"oneOf.0.source_deposit_instructions.oneOf.1.from_address.oneOf.0","typeLabel":"string"},{"description":"The crypto wallet address that the customer must send funds from. Null or absent when any address may be used.","type":"null","uniqueKey":"oneOf.0.source_deposit_instructions.oneOf.1.from_address.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.source_deposit_instructions.oneOf.1.from_address","typeLabel":"string | null"},"blockchain_memo":{"description":"If present, the message that the customer MUST include in their on chain transfer. Only used for memo-based blockchains such as Stellar and Tron","type":"string","uniqueKey":"oneOf.0.source_deposit_instructions.oneOf.1.blockchain_memo","typeLabel":"string"},"memoless_to_address":{"description":"An alternative crypto wallet address that encodes the memo, allowing the customer to send funds without needing to include a separate memo. Currently only available for Stellar deposits.","type":"string","uniqueKey":"oneOf.0.source_deposit_instructions.oneOf.1.memoless_to_address","typeLabel":"string"}},"uniqueKey":"oneOf.0.source_deposit_instructions.oneOf.1","typeLabel":"Crypto · object"}],"uniqueKey":"oneOf.0.source_deposit_instructions","typeLabel":"Fiat · object | Crypto · object"},"receipt":{"description":"Receipt information of a transfer. Not present on static templates or transfers with a flexible amount.","required":["initial_amount","initial_amount_currency","developer_fee","developer_fee_currency","exchange_fee","exchange_fee_currency","subtotal_amount","subtotal_amount_currency"],"properties":{"initial_amount":{"description":"The initial amount of the transfer from the source, represented as a decimal string. Examples include \"100.25\", \"0.1\", \"1.234567\", \"1.01\" etc.","type":"string","isRequired":true,"uniqueKey":"oneOf.0.receipt.initial_amount","typeLabel":"string"},"initial_amount_currency":{"description":"The currency the `initial_amount` is denominated in.","type":"string","isRequired":true,"uniqueKey":"oneOf.0.receipt.initial_amount_currency","typeLabel":"string"},"developer_fee":{"description":"The fee, expressed as a decimal string, represents the amount of the transfer reserved for your own account. This fee is the final amount deducted from what your customer ultimately receives, rather than a percentage.","type":"string","isRequired":true,"uniqueKey":"oneOf.0.receipt.developer_fee","typeLabel":"string"},"developer_fee_currency":{"description":"The currency the `developer_fee` is denominated in.","type":"string","isRequired":true,"uniqueKey":"oneOf.0.receipt.developer_fee_currency","typeLabel":"string"},"exchange_fee":{"description":"The fee, expressed as a decimal string, represents the amount Bridge charges for facilitating the transfer. This is the final amount deducted from what your customer ultimately receives, rather than a percentage. It can be deducted from the initial amount/currency or the converted amount/currency. ","type":"string","isRequired":true,"uniqueKey":"oneOf.0.receipt.exchange_fee","typeLabel":"string"},"exchange_fee_currency":{"description":"The currency the `exchange_fee` is denominated in.","type":"string","isRequired":true,"uniqueKey":"oneOf.0.receipt.exchange_fee_currency","typeLabel":"string"},"subtotal_amount":{"description":"The amount, expressed as a decimal string, remaining from the converted amount after any remaining non-gas fees have been deducted. ","type":"string","isRequired":true,"uniqueKey":"oneOf.0.receipt.subtotal_amount","typeLabel":"string"},"subtotal_amount_currency":{"description":"The currency the `subtotal_amount` is denominated in.","type":"string","isRequired":true,"uniqueKey":"oneOf.0.receipt.subtotal_amount_currency","typeLabel":"string"},"developer_exchange_fee":{"description":"For FixedOutput trades, the amount, expressed as a decimal string, of the traded money that was not necessary to deliver the fixed output, returned to the developer.","type":"object","properties":{"amount":{"description":"Amount of the fee","type":"string","uniqueKey":"oneOf.0.receipt.developer_exchange_fee.amount","typeLabel":"string"},"currency":{"description":"Currency of the fee","type":"string","uniqueKey":"oneOf.0.receipt.developer_exchange_fee.currency","typeLabel":"string"}},"uniqueKey":"oneOf.0.receipt.developer_exchange_fee","typeLabel":"object"},"pre_conversion_subtotal_amount":{"description":"On transfers with a variable trade, the amount of money, expressed as a decimal string, that is passed into the trade itself. Equal to the initial amount less any fees applied on the input side of the trade","type":"string","uniqueKey":"oneOf.0.receipt.pre_conversion_subtotal_amount","typeLabel":"string"},"pre_conversion_subtotal_amount_currency":{"description":"The currency the `pre_conversion_subtotal_amount` is denominated in.","type":"string","uniqueKey":"oneOf.0.receipt.pre_conversion_subtotal_amount_currency","typeLabel":"string"},"mid_market_rate":{"description":"If the transfer includes a market rate trade, this is the mid-market rate used to calculate the output of the trade. It is expressed as a decimal string.","type":"string","uniqueKey":"oneOf.0.receipt.mid_market_rate","typeLabel":"string"},"converted_amount":{"description":"If the transfer includes a variable trade, the amount of money, expressed as a decimal string, received after the trade, before any final fees are deducted.","type":"string","uniqueKey":"oneOf.0.receipt.converted_amount","typeLabel":"string"},"converted_amount_currency":{"description":"The currency the `converted_amount` is denominated in.","type":"string","uniqueKey":"oneOf.0.receipt.converted_amount_currency","typeLabel":"string"},"remaining_prefunded_balance":{"description":"For Prefunded Accounts, this value will represent the remaining account balance after the transfer.","type":"string","uniqueKey":"oneOf.0.receipt.remaining_prefunded_balance","typeLabel":"string"},"remaining_prefunded_balance_currency":{"description":"The currency the `remaining_prefunded_balance` is denominated in.","type":"string","uniqueKey":"oneOf.0.receipt.remaining_prefunded_balance_currency","typeLabel":"string"},"gas_fee":{"description":"The fee, expressed as a decimal string. It's deducted from the withdrawn amount to pay for gas. Only nonzero to crypto withdrawals that cost gas (e.g. USDT), and only known when the transaction is confirmed on-chain. Will be missing if not yet known.\n\nIt's denominated in the destination currency, given in `gas_fee_currency`.","type":"string","uniqueKey":"oneOf.0.receipt.gas_fee","typeLabel":"string"},"gas_fee_currency":{"description":"The currency the `gas_fee` is denominated in.","type":"string","uniqueKey":"oneOf.0.receipt.gas_fee_currency","typeLabel":"string"},"final_amount":{"description":"The final amount of the transfer, expressed as a decimal string, equal to the subtotal_amount minus any gas fees. If the gas fee is not known, this field will be missing. Examples include \"100.25\", \"0.1\", \"1.234567\", \"1.01\" etc.\n\nIt's denominated in the destination currency, given in `final_amount_currency`.","type":"string","uniqueKey":"oneOf.0.receipt.final_amount","typeLabel":"string"},"final_amount_currency":{"description":"The currency the `final_amount` is denominated in.","type":"string","uniqueKey":"oneOf.0.receipt.final_amount_currency","typeLabel":"string"},"source_tx_hash":{"description":"The hash of the on-chain deposit to the source address, where applicable","uniqueKey":"oneOf.0.receipt.source_tx_hash","typeLabel":"any"},"destination_tx_hash":{"description":"The hash of the on-chain transfer to the destination address, where applicable","uniqueKey":"oneOf.0.receipt.destination_tx_hash","typeLabel":"any"},"exchange_rate":{"description":"The effective exchange rate can be calculated by dividing the converted amount by the amount available for conversion after deducting the developer fee. This rate includes a currency conversion spread and is subject to a rounding precision loss during the calculation. Currently it's populated for SEPA onramp/offramp transfers only.","uniqueKey":"oneOf.0.receipt.exchange_rate","typeLabel":"any"},"url":{"description":"The URL of a user-facing copy of the receipt.","type":"string","uniqueKey":"oneOf.0.receipt.url","typeLabel":"string"},"bank_details":{"description":"Bank-lookup details for fiat offramp receipts, to help the recipient's bank locate the payment. Present for enabled developers once the offramp's bank leg exists; individual fields may be null until they become available (e.g. the ACH trace ID before submission to the Fed).","type":"object","properties":{"sending_routing_number":{"description":"Routing number of the bank Bridge sent the payment from.","type":"string","uniqueKey":"oneOf.0.receipt.bank_details.sending_routing_number","typeLabel":"string"},"ach_description":{"description":"Statement descriptor on the outgoing ACH credit.","type":"string","uniqueKey":"oneOf.0.receipt.bank_details.ach_description","typeLabel":"string"},"ach_trace_id":{"description":"ACH trace number, populated after submission to the Fed.","type":"string","uniqueKey":"oneOf.0.receipt.bank_details.ach_trace_id","typeLabel":"string"},"wire_message":{"description":"Message sent with the outgoing wire (beneficiary, FI-to-FI, or receiving-FI message).","type":"string","uniqueKey":"oneOf.0.receipt.bank_details.wire_message","typeLabel":"string"},"imad":{"description":"IMAD (Input Message Accountability Data) of the outgoing wire, populated after posting.","type":"string","uniqueKey":"oneOf.0.receipt.bank_details.imad","typeLabel":"string"},"recipient_name":{"description":"Name on the receiving external account.","type":"string","uniqueKey":"oneOf.0.receipt.bank_details.recipient_name","typeLabel":"string"},"sending_bic":{"description":"BIC of the bank Bridge sent the SEPA payment from.","type":"string","uniqueKey":"oneOf.0.receipt.bank_details.sending_bic","typeLabel":"string"},"sepa_reference":{"description":"SEPA payment reference.","type":"string","uniqueKey":"oneOf.0.receipt.bank_details.sepa_reference","typeLabel":"string"},"uetr":{"description":"Unique End-to-end Transaction Reference (UETR) of the SEPA payment.","type":"string","uniqueKey":"oneOf.0.receipt.bank_details.uetr","typeLabel":"string"},"receiving_account_last_four":{"description":"Last four digits of the receiving IBAN.","type":"string","uniqueKey":"oneOf.0.receipt.bank_details.receiving_account_last_four","typeLabel":"string"},"receiving_bic":{"description":"BIC of the receiving bank.","type":"string","uniqueKey":"oneOf.0.receipt.bank_details.receiving_bic","typeLabel":"string"}},"uniqueKey":"oneOf.0.receipt.bank_details","typeLabel":"object"}},"type":"object","uniqueKey":"oneOf.0.receipt","typeLabel":"object"},"return_details":{"properties":{"reason":{"description":"The reason for the return, as given by the returning financial institution.","type":"string","uniqueKey":"oneOf.0.return_details.reason","typeLabel":"string"},"refund_reference_id":{"description":"A unique identifier (such as transaction hash) for the refund transaction.","type":"string","uniqueKey":"oneOf.0.return_details.refund_reference_id","typeLabel":"string"},"risk_rejection_reason":{"description":"The risk-related reason the transaction was returned. Present only when Bridge provides a risk-related reason for the return. Possible values include `Exceeds Transaction Limits` and `Exceeds Counterparty Limits`.","type":"string","readOnly":true,"example":"Exceeds Transaction Limits","uniqueKey":"oneOf.0.return_details.risk_rejection_reason","typeLabel":"string"}},"readOnly":true,"description":"Return information, if the transfer has been returned.","type":"object","uniqueKey":"oneOf.0.return_details","typeLabel":"object"},"return_instructions":{"description":"Optional return instructions configured when creating or updating the transfer.","type":"object","required":["address"],"properties":{"address":{"description":"The crypto wallet address to send returned funds to. Must be valid for the source payment rail's chain.","type":"string","isRequired":true,"uniqueKey":"oneOf.0.return_instructions.address","typeLabel":"string"},"memo":{"description":"Memo to include with the return transaction. Required when the source payment rail is Stellar; optional for other memo-capable chains.","type":"string","uniqueKey":"oneOf.0.return_instructions.memo","typeLabel":"string"}},"readOnly":true,"uniqueKey":"oneOf.0.return_instructions","typeLabel":"object"},"exchange_details":{"description":"Exchange details for the associated trade, if applicable.","properties":{"fixed_rate":{"description":"The target exchange rate.","type":"string","uniqueKey":"oneOf.0.exchange_details.fixed_rate","typeLabel":"string"},"estimated_market_rate":{"description":"The estimated achievable rate based on current market conditions.","type":"string","uniqueKey":"oneOf.0.exchange_details.estimated_market_rate","typeLabel":"string"},"traded_market_rate":{"description":"The actual effective exchange rate achieved.","type":"string","uniqueKey":"oneOf.0.exchange_details.traded_market_rate","typeLabel":"string"},"trade_at_market":{"description":"Whether market-rate execution has been applied to this trade.","type":"boolean","uniqueKey":"oneOf.0.exchange_details.trade_at_market","typeLabel":"boolean"},"updated_at":{"description":"Timestamp of the last exchange details update.","type":"string","format":"date-time","uniqueKey":"oneOf.0.exchange_details.updated_at","typeLabel":"string\u003cdate-time>"}},"readOnly":true,"type":"object","uniqueKey":"oneOf.0.exchange_details","typeLabel":"object"},"template_id":{"description":"The ID of the static template transfer from which this transfer was instantiated. Only present for transfers created from a template.","type":"string","pattern":"[a-z0-9]*","minLength":1,"maxLength":42,"readOnly":true,"uniqueKey":"oneOf.0.template_id","typeLabel":"string"},"first_confirmed_at":{"readOnly":true,"type":"string","description":"Time when the withdrawal transaction received its first on-chain confirmation. Only present for crypto withdrawal transfers where this feature is enabled for the developer.","format":"date-time","uniqueKey":"oneOf.0.first_confirmed_at","typeLabel":"string\u003cdate-time>"},"swift_tracking":{"description":"SWIFT gpi tracking of a payout sent through BNY. Only present for SWIFT destinations where this feature is enabled for the developer.","properties":{"uetr":{"type":"string","description":"The payment's end-to-end reference, constant across the chain.","uniqueKey":"oneOf.0.swift_tracking.uetr","typeLabel":"string"},"tracking_status":{"type":"string","enum":["in_progress","limited_tracking","on_hold","completed","rejected","delivery_unconfirmed"],"description":"`in_progress` from sending until a bank reports otherwise; `tracking_history` is empty until BNY has indexed the payment, usually within minutes. `limited_tracking` when the latest bank forwarded the payment to a bank outside gpi, so further updates may not arrive although the beneficiary's bank can still confirm the credit; `on_hold` when a bank is waiting for documents or funds, for as long as the hold lasts; `completed` when a bank reported the credit, either the beneficiary's bank crediting the account or the cover leg delivering the funds to that bank; `rejected` on a rejection; `delivery_unconfirmed` when no bank has confirmed the credit within 15 days of sending unless the payment is on hold, after which tracking stops.\n","uniqueKey":"oneOf.0.swift_tracking.tracking_status","typeLabel":"enum\u003cstring>"},"value_date":{"oneOf":[{"type":"string","format":"date","description":"The settlement date BNY booked the payment on. Later than the day it was sent when it went out after BNY's cutoff or on a non-business day.\n","uniqueKey":"oneOf.0.swift_tracking.value_date.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","description":"The settlement date BNY booked the payment on. Later than the day it was sent when it went out after BNY's cutoff or on a non-business day.\n","uniqueKey":"oneOf.0.swift_tracking.value_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.swift_tracking.value_date","typeLabel":"string\u003cdate> | null"},"last_updated_at":{"oneOf":[{"type":"string","format":"date-time","description":"Timestamp of the latest report on either leg.","uniqueKey":"oneOf.0.swift_tracking.last_updated_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Timestamp of the latest report on either leg.","uniqueKey":"oneOf.0.swift_tracking.last_updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.swift_tracking.last_updated_at","typeLabel":"string\u003cdate-time> | null"},"instruction":{"oneOf":[{"description":"The payment instruction as BNY recorded it. Present once BNY has indexed the payment.","properties":{"amount":{"oneOf":[{"type":"object","description":"The amount and currency the payment was initiated with.","properties":{"amount":{"type":"string","description":"Decimal string in the currency's precision, for example \"4749.95\".","uniqueKey":"oneOf.0.swift_tracking.instruction.oneOf.0.amount.oneOf.0.amount","typeLabel":"string"},"currency":{"type":"string","description":"Lowercase ISO 4217 code, for example \"gbp\".","uniqueKey":"oneOf.0.swift_tracking.instruction.oneOf.0.amount.oneOf.0.currency","typeLabel":"string"}},"uniqueKey":"oneOf.0.swift_tracking.instruction.oneOf.0.amount.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"oneOf.0.swift_tracking.instruction.oneOf.0.amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.swift_tracking.instruction.oneOf.0.amount","typeLabel":"object | null"},"charge_bearer":{"oneOf":[{"type":"string","description":"Who the instruction makes responsible for charges, in the same vocabulary as the transfer's `charge_bearer`: `sha` splits them between sender and beneficiary, `our` puts them on the sender and `ben` on the beneficiary. Null when the instruction carried `SLEV`, which Bridge never sends, or a code outside the ISO set.\n","enum":["our","sha","ben"],"uniqueKey":"oneOf.0.swift_tracking.instruction.oneOf.0.charge_bearer.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"oneOf.0.swift_tracking.instruction.oneOf.0.charge_bearer.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.swift_tracking.instruction.oneOf.0.charge_bearer","typeLabel":"enum\u003cstring> | null"},"message_definition_identifier":{"oneOf":[{"type":"string","description":"The ISO 20022 message type of the instruction, for example pacs.008.001.08.","uniqueKey":"oneOf.0.swift_tracking.instruction.oneOf.0.message_definition_identifier.oneOf.0","typeLabel":"string"},{"type":"null","description":"The ISO 20022 message type of the instruction, for example pacs.008.001.08.","uniqueKey":"oneOf.0.swift_tracking.instruction.oneOf.0.message_definition_identifier.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.swift_tracking.instruction.oneOf.0.message_definition_identifier","typeLabel":"string | null"},"debtor":{"oneOf":[{"description":"The customer the payout was made for, the sender of the funds on the instruction.","properties":{"name":{"oneOf":[{"type":"string","description":"The customer's name as BNY recorded it.","uniqueKey":"oneOf.0.swift_tracking.instruction.oneOf.0.debtor.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The customer's name as BNY recorded it.","uniqueKey":"oneOf.0.swift_tracking.instruction.oneOf.0.debtor.oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.swift_tracking.instruction.oneOf.0.debtor.oneOf.0.name","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","description":"ISO 3166-1 alpha-3 country of the customer's address, when the instruction carried one.","uniqueKey":"oneOf.0.swift_tracking.instruction.oneOf.0.debtor.oneOf.0.country.oneOf.0","typeLabel":"string"},{"type":"null","description":"ISO 3166-1 alpha-3 country of the customer's address, when the instruction carried one.","uniqueKey":"oneOf.0.swift_tracking.instruction.oneOf.0.debtor.oneOf.0.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.swift_tracking.instruction.oneOf.0.debtor.oneOf.0.country","typeLabel":"string | null"}},"type":"object","uniqueKey":"oneOf.0.swift_tracking.instruction.oneOf.0.debtor.oneOf.0","typeLabel":"object"},{"description":"The customer the payout was made for, the sender of the funds on the instruction.","properties":{"name":{"oneOf":[{"type":"string","description":"The customer's name as BNY recorded it."},{"type":"null","description":"The customer's name as BNY recorded it."}]},"country":{"oneOf":[{"type":"string","description":"ISO 3166-1 alpha-3 country of the customer's address, when the instruction carried one."},{"type":"null","description":"ISO 3166-1 alpha-3 country of the customer's address, when the instruction carried one."}]}},"type":"null","uniqueKey":"oneOf.0.swift_tracking.instruction.oneOf.0.debtor.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.swift_tracking.instruction.oneOf.0.debtor","typeLabel":"object | null"},"debtor_agent":{"oneOf":[{"type":"object","description":"Bridge, the institution the instruction names as holding the customer's funds.","properties":{"name":{"oneOf":[{"type":"string","uniqueKey":"oneOf.0.swift_tracking.instruction.oneOf.0.debtor_agent.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"oneOf.0.swift_tracking.instruction.oneOf.0.debtor_agent.oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.swift_tracking.instruction.oneOf.0.debtor_agent.oneOf.0.name","typeLabel":"string | null"},"bic":{"oneOf":[{"type":"string","description":"The BIC, when reported.","uniqueKey":"oneOf.0.swift_tracking.instruction.oneOf.0.debtor_agent.oneOf.0.bic.oneOf.0","typeLabel":"string"},{"type":"null","description":"The BIC, when reported.","uniqueKey":"oneOf.0.swift_tracking.instruction.oneOf.0.debtor_agent.oneOf.0.bic.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.swift_tracking.instruction.oneOf.0.debtor_agent.oneOf.0.bic","typeLabel":"string | null"}},"uniqueKey":"oneOf.0.swift_tracking.instruction.oneOf.0.debtor_agent.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"oneOf.0.swift_tracking.instruction.oneOf.0.debtor_agent.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.swift_tracking.instruction.oneOf.0.debtor_agent","typeLabel":"object | null"},"creditor":{"oneOf":[{"description":"The beneficiary the payout was sent to, the receiver of the funds on the instruction.","properties":{"country":{"oneOf":[{"type":"string","description":"ISO 3166-1 alpha-3 country where the payment is destined.","uniqueKey":"oneOf.0.swift_tracking.instruction.oneOf.0.creditor.oneOf.0.country.oneOf.0","typeLabel":"string"},{"type":"null","description":"ISO 3166-1 alpha-3 country where the payment is destined.","uniqueKey":"oneOf.0.swift_tracking.instruction.oneOf.0.creditor.oneOf.0.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.swift_tracking.instruction.oneOf.0.creditor.oneOf.0.country","typeLabel":"string | null"}},"type":"object","uniqueKey":"oneOf.0.swift_tracking.instruction.oneOf.0.creditor.oneOf.0","typeLabel":"object"},{"description":"The beneficiary the payout was sent to, the receiver of the funds on the instruction.","properties":{"country":{"oneOf":[{"type":"string","description":"ISO 3166-1 alpha-3 country where the payment is destined."},{"type":"null","description":"ISO 3166-1 alpha-3 country where the payment is destined."}]}},"type":"null","uniqueKey":"oneOf.0.swift_tracking.instruction.oneOf.0.creditor.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.swift_tracking.instruction.oneOf.0.creditor","typeLabel":"object | null"},"creditor_agent":{"oneOf":[{"type":"object","description":"The beneficiary's bank, where the account the payout was sent to is held.","properties":{"name":{"oneOf":[{"type":"string","uniqueKey":"oneOf.0.swift_tracking.instruction.oneOf.0.creditor_agent.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"oneOf.0.swift_tracking.instruction.oneOf.0.creditor_agent.oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.swift_tracking.instruction.oneOf.0.creditor_agent.oneOf.0.name","typeLabel":"string | null"},"bic":{"oneOf":[{"type":"string","description":"The BIC, when reported.","uniqueKey":"oneOf.0.swift_tracking.instruction.oneOf.0.creditor_agent.oneOf.0.bic.oneOf.0","typeLabel":"string"},{"type":"null","description":"The BIC, when reported.","uniqueKey":"oneOf.0.swift_tracking.instruction.oneOf.0.creditor_agent.oneOf.0.bic.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.swift_tracking.instruction.oneOf.0.creditor_agent.oneOf.0.bic","typeLabel":"string | null"}},"uniqueKey":"oneOf.0.swift_tracking.instruction.oneOf.0.creditor_agent.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"oneOf.0.swift_tracking.instruction.oneOf.0.creditor_agent.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.swift_tracking.instruction.oneOf.0.creditor_agent","typeLabel":"object | null"}},"type":"object","uniqueKey":"oneOf.0.swift_tracking.instruction.oneOf.0","typeLabel":"object"},{"description":"The payment instruction as BNY recorded it. Present once BNY has indexed the payment.","properties":{"amount":{"oneOf":[{"type":"object","description":"The amount and currency the payment was initiated with.","properties":{"amount":{"type":"string","description":"Decimal string in the currency's precision, for example \"4749.95\"."},"currency":{"type":"string","description":"Lowercase ISO 4217 code, for example \"gbp\"."}}},{"type":"null"}]},"charge_bearer":{"oneOf":[{"type":"string","description":"Who the instruction makes responsible for charges, in the same vocabulary as the transfer's `charge_bearer`: `sha` splits them between sender and beneficiary, `our` puts them on the sender and `ben` on the beneficiary. Null when the instruction carried `SLEV`, which Bridge never sends, or a code outside the ISO set.\n","enum":["our","sha","ben"]},{"type":"null"}]},"message_definition_identifier":{"oneOf":[{"type":"string","description":"The ISO 20022 message type of the instruction, for example pacs.008.001.08."},{"type":"null","description":"The ISO 20022 message type of the instruction, for example pacs.008.001.08."}]},"debtor":{"oneOf":[{"description":"The customer the payout was made for, the sender of the funds on the instruction.","properties":{"name":{"oneOf":[{"type":"string","description":"The customer's name as BNY recorded it."},{"type":"null","description":"The customer's name as BNY recorded it."}]},"country":{"oneOf":[{"type":"string","description":"ISO 3166-1 alpha-3 country of the customer's address, when the instruction carried one."},{"type":"null","description":"ISO 3166-1 alpha-3 country of the customer's address, when the instruction carried one."}]}},"type":"object"},{"description":"The customer the payout was made for, the sender of the funds on the instruction.","properties":{"name":{"oneOf":[{"type":"string","description":"The customer's name as BNY recorded it."},{"type":"null","description":"The customer's name as BNY recorded it."}]},"country":{"oneOf":[{"type":"string","description":"ISO 3166-1 alpha-3 country of the customer's address, when the instruction carried one."},{"type":"null","description":"ISO 3166-1 alpha-3 country of the customer's address, when the instruction carried one."}]}},"type":"null"}]},"debtor_agent":{"oneOf":[{"type":"object","description":"Bridge, the institution the instruction names as holding the customer's funds.","properties":{"name":{"oneOf":[{"type":"string"},{"type":"null"}]},"bic":{"oneOf":[{"type":"string","description":"The BIC, when reported."},{"type":"null","description":"The BIC, when reported."}]}}},{"type":"null"}]},"creditor":{"oneOf":[{"description":"The beneficiary the payout was sent to, the receiver of the funds on the instruction.","properties":{"country":{"oneOf":[{"type":"string","description":"ISO 3166-1 alpha-3 country where the payment is destined."},{"type":"null","description":"ISO 3166-1 alpha-3 country where the payment is destined."}]}},"type":"object"},{"description":"The beneficiary the payout was sent to, the receiver of the funds on the instruction.","properties":{"country":{"oneOf":[{"type":"string","description":"ISO 3166-1 alpha-3 country where the payment is destined."},{"type":"null","description":"ISO 3166-1 alpha-3 country where the payment is destined."}]}},"type":"null"}]},"creditor_agent":{"oneOf":[{"type":"object","description":"The beneficiary's bank, where the account the payout was sent to is held.","properties":{"name":{"oneOf":[{"type":"string"},{"type":"null"}]},"bic":{"oneOf":[{"type":"string","description":"The BIC, when reported."},{"type":"null","description":"The BIC, when reported."}]}}},{"type":"null"}]}},"type":"null","uniqueKey":"oneOf.0.swift_tracking.instruction.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.swift_tracking.instruction","typeLabel":"object | null"},"originating_bank":{"oneOf":[{"description":"The bank that originated the SWIFT message on Bridge's behalf, with its references and what it applied to the payment on the way out.\n","properties":{"name":{"oneOf":[{"type":"string","uniqueKey":"oneOf.0.swift_tracking.originating_bank.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"oneOf.0.swift_tracking.originating_bank.oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.swift_tracking.originating_bank.oneOf.0.name","typeLabel":"string | null"},"bic":{"oneOf":[{"type":"string","uniqueKey":"oneOf.0.swift_tracking.originating_bank.oneOf.0.bic.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"oneOf.0.swift_tracking.originating_bank.oneOf.0.bic.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.swift_tracking.originating_bank.oneOf.0.bic","typeLabel":"string | null"},"transaction_reference":{"oneOf":[{"type":"string","description":"The originating bank's payment reference number.","uniqueKey":"oneOf.0.swift_tracking.originating_bank.oneOf.0.transaction_reference.oneOf.0","typeLabel":"string"},{"type":"null","description":"The originating bank's payment reference number.","uniqueKey":"oneOf.0.swift_tracking.originating_bank.oneOf.0.transaction_reference.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.swift_tracking.originating_bank.oneOf.0.transaction_reference","typeLabel":"string | null"},"clearing_system":{"oneOf":[{"type":"string","description":"The payment market infrastructure used to clear the payment, for example SWIFT, FEDWIRE or CHIPS.","uniqueKey":"oneOf.0.swift_tracking.originating_bank.oneOf.0.clearing_system.oneOf.0","typeLabel":"string"},{"type":"null","description":"The payment market infrastructure used to clear the payment, for example SWIFT, FEDWIRE or CHIPS.","uniqueKey":"oneOf.0.swift_tracking.originating_bank.oneOf.0.clearing_system.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.swift_tracking.originating_bank.oneOf.0.clearing_system","typeLabel":"string | null"},"clearing_system_identification":{"oneOf":[{"type":"string","description":"The reference in that clearing system, the IMAD or OMAD for Fedwire or the sequence number for CHIPS.","uniqueKey":"oneOf.0.swift_tracking.originating_bank.oneOf.0.clearing_system_identification.oneOf.0","typeLabel":"string"},{"type":"null","description":"The reference in that clearing system, the IMAD or OMAD for Fedwire or the sequence number for CHIPS.","uniqueKey":"oneOf.0.swift_tracking.originating_bank.oneOf.0.clearing_system_identification.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.swift_tracking.originating_bank.oneOf.0.clearing_system_identification","typeLabel":"string | null"},"charges":{"oneOf":[{"type":"object","description":"The amount the originating bank took as charges.","properties":{"amount":{"type":"string","description":"Decimal string in the currency's precision, for example \"4749.95\".","uniqueKey":"oneOf.0.swift_tracking.originating_bank.oneOf.0.charges.oneOf.0.amount","typeLabel":"string"},"currency":{"type":"string","description":"Lowercase ISO 4217 code, for example \"gbp\".","uniqueKey":"oneOf.0.swift_tracking.originating_bank.oneOf.0.charges.oneOf.0.currency","typeLabel":"string"}},"uniqueKey":"oneOf.0.swift_tracking.originating_bank.oneOf.0.charges.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"oneOf.0.swift_tracking.originating_bank.oneOf.0.charges.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.swift_tracking.originating_bank.oneOf.0.charges","typeLabel":"object | null"},"deductions":{"oneOf":[{"description":"Deductions the originating bank applied. It reports them without a currency; the instruction's currency is assumed.\n","properties":{"beneficiary":{"oneOf":[{"type":"object","description":"Bene deduct as applied by the originating bank.","properties":{"amount":{"type":"string","description":"Decimal string in the currency's precision, for example \"4749.95\".","uniqueKey":"oneOf.0.swift_tracking.originating_bank.oneOf.0.deductions.oneOf.0.beneficiary.oneOf.0.amount","typeLabel":"string"},"currency":{"type":"string","description":"Lowercase ISO 4217 code, for example \"gbp\".","uniqueKey":"oneOf.0.swift_tracking.originating_bank.oneOf.0.deductions.oneOf.0.beneficiary.oneOf.0.currency","typeLabel":"string"}},"uniqueKey":"oneOf.0.swift_tracking.originating_bank.oneOf.0.deductions.oneOf.0.beneficiary.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"oneOf.0.swift_tracking.originating_bank.oneOf.0.deductions.oneOf.0.beneficiary.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.swift_tracking.originating_bank.oneOf.0.deductions.oneOf.0.beneficiary","typeLabel":"object | null"},"credit":{"oneOf":[{"type":"object","description":"Credit deduct as applied by the originating bank.","properties":{"amount":{"type":"string","description":"Decimal string in the currency's precision, for example \"4749.95\".","uniqueKey":"oneOf.0.swift_tracking.originating_bank.oneOf.0.deductions.oneOf.0.credit.oneOf.0.amount","typeLabel":"string"},"currency":{"type":"string","description":"Lowercase ISO 4217 code, for example \"gbp\".","uniqueKey":"oneOf.0.swift_tracking.originating_bank.oneOf.0.deductions.oneOf.0.credit.oneOf.0.currency","typeLabel":"string"}},"uniqueKey":"oneOf.0.swift_tracking.originating_bank.oneOf.0.deductions.oneOf.0.credit.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"oneOf.0.swift_tracking.originating_bank.oneOf.0.deductions.oneOf.0.credit.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.swift_tracking.originating_bank.oneOf.0.deductions.oneOf.0.credit","typeLabel":"object | null"},"full_pay_upfront":{"oneOf":[{"type":"object","description":"Full pay upfront deduct as applied by the originating bank.","properties":{"amount":{"type":"string","description":"Decimal string in the currency's precision, for example \"4749.95\".","uniqueKey":"oneOf.0.swift_tracking.originating_bank.oneOf.0.deductions.oneOf.0.full_pay_upfront.oneOf.0.amount","typeLabel":"string"},"currency":{"type":"string","description":"Lowercase ISO 4217 code, for example \"gbp\".","uniqueKey":"oneOf.0.swift_tracking.originating_bank.oneOf.0.deductions.oneOf.0.full_pay_upfront.oneOf.0.currency","typeLabel":"string"}},"uniqueKey":"oneOf.0.swift_tracking.originating_bank.oneOf.0.deductions.oneOf.0.full_pay_upfront.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"oneOf.0.swift_tracking.originating_bank.oneOf.0.deductions.oneOf.0.full_pay_upfront.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.swift_tracking.originating_bank.oneOf.0.deductions.oneOf.0.full_pay_upfront","typeLabel":"object | null"}},"type":"object","uniqueKey":"oneOf.0.swift_tracking.originating_bank.oneOf.0.deductions.oneOf.0","typeLabel":"object"},{"description":"Deductions the originating bank applied. It reports them without a currency; the instruction's currency is assumed.\n","properties":{"beneficiary":{"oneOf":[{"type":"object","description":"Bene deduct as applied by the originating bank.","properties":{"amount":{"type":"string","description":"Decimal string in the currency's precision, for example \"4749.95\"."},"currency":{"type":"string","description":"Lowercase ISO 4217 code, for example \"gbp\"."}}},{"type":"null"}]},"credit":{"oneOf":[{"type":"object","description":"Credit deduct as applied by the originating bank.","properties":{"amount":{"type":"string","description":"Decimal string in the currency's precision, for example \"4749.95\"."},"currency":{"type":"string","description":"Lowercase ISO 4217 code, for example \"gbp\"."}}},{"type":"null"}]},"full_pay_upfront":{"oneOf":[{"type":"object","description":"Full pay upfront deduct as applied by the originating bank.","properties":{"amount":{"type":"string","description":"Decimal string in the currency's precision, for example \"4749.95\"."},"currency":{"type":"string","description":"Lowercase ISO 4217 code, for example \"gbp\"."}}},{"type":"null"}]}},"type":"null","uniqueKey":"oneOf.0.swift_tracking.originating_bank.oneOf.0.deductions.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.swift_tracking.originating_bank.oneOf.0.deductions","typeLabel":"object | null"},"fx":{"oneOf":[{"description":"A conversion the originating bank itself applied, as opposed to one a downstream bank reported on its hop.","properties":{"source_currency":{"type":"string","description":"Lowercase ISO 4217 code of the currency converted from.","uniqueKey":"oneOf.0.swift_tracking.originating_bank.oneOf.0.fx.oneOf.0.source_currency","typeLabel":"string"},"target_currency":{"type":"string","description":"Lowercase ISO 4217 code of the currency converted into.","uniqueKey":"oneOf.0.swift_tracking.originating_bank.oneOf.0.fx.oneOf.0.target_currency","typeLabel":"string"},"exchange_rate":{"type":"string","uniqueKey":"oneOf.0.swift_tracking.originating_bank.oneOf.0.fx.oneOf.0.exchange_rate","typeLabel":"string"},"debit_amount":{"oneOf":[{"type":"string","description":"Decimal string in the source currency.","uniqueKey":"oneOf.0.swift_tracking.originating_bank.oneOf.0.fx.oneOf.0.debit_amount.oneOf.0","typeLabel":"string"},{"type":"null","description":"Decimal string in the source currency.","uniqueKey":"oneOf.0.swift_tracking.originating_bank.oneOf.0.fx.oneOf.0.debit_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.swift_tracking.originating_bank.oneOf.0.fx.oneOf.0.debit_amount","typeLabel":"string | null"},"credit_amount":{"oneOf":[{"type":"string","description":"Decimal string in the target currency.","uniqueKey":"oneOf.0.swift_tracking.originating_bank.oneOf.0.fx.oneOf.0.credit_amount.oneOf.0","typeLabel":"string"},{"type":"null","description":"Decimal string in the target currency.","uniqueKey":"oneOf.0.swift_tracking.originating_bank.oneOf.0.fx.oneOf.0.credit_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.swift_tracking.originating_bank.oneOf.0.fx.oneOf.0.credit_amount","typeLabel":"string | null"}},"type":"object","uniqueKey":"oneOf.0.swift_tracking.originating_bank.oneOf.0.fx.oneOf.0","typeLabel":"object"},{"description":"A conversion the originating bank itself applied, as opposed to one a downstream bank reported on its hop.","properties":{"source_currency":{"type":"string","description":"Lowercase ISO 4217 code of the currency converted from."},"target_currency":{"type":"string","description":"Lowercase ISO 4217 code of the currency converted into."},"exchange_rate":{"type":"string"},"debit_amount":{"oneOf":[{"type":"string","description":"Decimal string in the source currency."},{"type":"null","description":"Decimal string in the source currency."}]},"credit_amount":{"oneOf":[{"type":"string","description":"Decimal string in the target currency."},{"type":"null","description":"Decimal string in the target currency."}]}},"type":"null","uniqueKey":"oneOf.0.swift_tracking.originating_bank.oneOf.0.fx.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.swift_tracking.originating_bank.oneOf.0.fx","typeLabel":"object | null"}},"type":"object","uniqueKey":"oneOf.0.swift_tracking.originating_bank.oneOf.0","typeLabel":"object"},{"description":"The bank that originated the SWIFT message on Bridge's behalf, with its references and what it applied to the payment on the way out.\n","properties":{"name":{"oneOf":[{"type":"string"},{"type":"null"}]},"bic":{"oneOf":[{"type":"string"},{"type":"null"}]},"transaction_reference":{"oneOf":[{"type":"string","description":"The originating bank's payment reference number."},{"type":"null","description":"The originating bank's payment reference number."}]},"clearing_system":{"oneOf":[{"type":"string","description":"The payment market infrastructure used to clear the payment, for example SWIFT, FEDWIRE or CHIPS."},{"type":"null","description":"The payment market infrastructure used to clear the payment, for example SWIFT, FEDWIRE or CHIPS."}]},"clearing_system_identification":{"oneOf":[{"type":"string","description":"The reference in that clearing system, the IMAD or OMAD for Fedwire or the sequence number for CHIPS."},{"type":"null","description":"The reference in that clearing system, the IMAD or OMAD for Fedwire or the sequence number for CHIPS."}]},"charges":{"oneOf":[{"type":"object","description":"The amount the originating bank took as charges.","properties":{"amount":{"type":"string","description":"Decimal string in the currency's precision, for example \"4749.95\"."},"currency":{"type":"string","description":"Lowercase ISO 4217 code, for example \"gbp\"."}}},{"type":"null"}]},"deductions":{"oneOf":[{"description":"Deductions the originating bank applied. It reports them without a currency; the instruction's currency is assumed.\n","properties":{"beneficiary":{"oneOf":[{"type":"object","description":"Bene deduct as applied by the originating bank.","properties":{"amount":{"type":"string","description":"Decimal string in the currency's precision, for example \"4749.95\"."},"currency":{"type":"string","description":"Lowercase ISO 4217 code, for example \"gbp\"."}}},{"type":"null"}]},"credit":{"oneOf":[{"type":"object","description":"Credit deduct as applied by the originating bank.","properties":{"amount":{"type":"string","description":"Decimal string in the currency's precision, for example \"4749.95\"."},"currency":{"type":"string","description":"Lowercase ISO 4217 code, for example \"gbp\"."}}},{"type":"null"}]},"full_pay_upfront":{"oneOf":[{"type":"object","description":"Full pay upfront deduct as applied by the originating bank.","properties":{"amount":{"type":"string","description":"Decimal string in the currency's precision, for example \"4749.95\"."},"currency":{"type":"string","description":"Lowercase ISO 4217 code, for example \"gbp\"."}}},{"type":"null"}]}},"type":"object"},{"description":"Deductions the originating bank applied. It reports them without a currency; the instruction's currency is assumed.\n","properties":{"beneficiary":{"oneOf":[{"type":"object","description":"Bene deduct as applied by the originating bank.","properties":{"amount":{"type":"string","description":"Decimal string in the currency's precision, for example \"4749.95\"."},"currency":{"type":"string","description":"Lowercase ISO 4217 code, for example \"gbp\"."}}},{"type":"null"}]},"credit":{"oneOf":[{"type":"object","description":"Credit deduct as applied by the originating bank.","properties":{"amount":{"type":"string","description":"Decimal string in the currency's precision, for example \"4749.95\"."},"currency":{"type":"string","description":"Lowercase ISO 4217 code, for example \"gbp\"."}}},{"type":"null"}]},"full_pay_upfront":{"oneOf":[{"type":"object","description":"Full pay upfront deduct as applied by the originating bank.","properties":{"amount":{"type":"string","description":"Decimal string in the currency's precision, for example \"4749.95\"."},"currency":{"type":"string","description":"Lowercase ISO 4217 code, for example \"gbp\"."}}},{"type":"null"}]}},"type":"null"}]},"fx":{"oneOf":[{"description":"A conversion the originating bank itself applied, as opposed to one a downstream bank reported on its hop.","properties":{"source_currency":{"type":"string","description":"Lowercase ISO 4217 code of the currency converted from."},"target_currency":{"type":"string","description":"Lowercase ISO 4217 code of the currency converted into."},"exchange_rate":{"type":"string"},"debit_amount":{"oneOf":[{"type":"string","description":"Decimal string in the source currency."},{"type":"null","description":"Decimal string in the source currency."}]},"credit_amount":{"oneOf":[{"type":"string","description":"Decimal string in the target currency."},{"type":"null","description":"Decimal string in the target currency."}]}},"type":"object"},{"description":"A conversion the originating bank itself applied, as opposed to one a downstream bank reported on its hop.","properties":{"source_currency":{"type":"string","description":"Lowercase ISO 4217 code of the currency converted from."},"target_currency":{"type":"string","description":"Lowercase ISO 4217 code of the currency converted into."},"exchange_rate":{"type":"string"},"debit_amount":{"oneOf":[{"type":"string","description":"Decimal string in the source currency."},{"type":"null","description":"Decimal string in the source currency."}]},"credit_amount":{"oneOf":[{"type":"string","description":"Decimal string in the target currency."},{"type":"null","description":"Decimal string in the target currency."}]}},"type":"null"}]}},"type":"null","uniqueKey":"oneOf.0.swift_tracking.originating_bank.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.swift_tracking.originating_bank","typeLabel":"object | null"},"current_tracking":{"oneOf":[{"type":"object","description":"The most recent report from the bank furthest along the chain.","properties":{"leg_type":{"oneOf":[{"type":"string","enum":["serial","cover"],"description":"`serial` for the leg that reaches the beneficiary, `cover` for the correspondent funding leg. A credit on the cover leg means the funds reached the beneficiary's bank.","uniqueKey":"oneOf.0.swift_tracking.current_tracking.oneOf.0.leg_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["serial","cover"],"description":"`serial` for the leg that reaches the beneficiary, `cover` for the correspondent funding leg. A credit on the cover leg means the funds reached the beneficiary's bank.","uniqueKey":"oneOf.0.swift_tracking.current_tracking.oneOf.0.leg_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.swift_tracking.current_tracking.oneOf.0.leg_type","typeLabel":"enum\u003cstring> | null"},"status_code":{"oneOf":[{"type":"string","description":"ISO 20022 payment transaction status as the bank reported it. Known values are `ACSP` (settlement in process), `ACSC` (settled on the sender's side), `ACCC` (beneficiary credited), `RJCT` (rejected) and `PDNG` (pending). The list is open: a bank can report any code from the ISO external code set, so treat unlisted values as a status you do not know rather than as an error.\n","uniqueKey":"oneOf.0.swift_tracking.current_tracking.oneOf.0.status_code.oneOf.0","typeLabel":"string"},{"type":"null","description":"ISO 20022 payment transaction status as the bank reported it. Known values are `ACSP` (settlement in process), `ACSC` (settled on the sender's side), `ACCC` (beneficiary credited), `RJCT` (rejected) and `PDNG` (pending). The list is open: a bank can report any code from the ISO external code set, so treat unlisted values as a status you do not know rather than as an error.\n","uniqueKey":"oneOf.0.swift_tracking.current_tracking.oneOf.0.status_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.swift_tracking.current_tracking.oneOf.0.status_code","typeLabel":"string | null"},"reason_code":{"oneOf":[{"type":"string","description":"Why the status is what it is, as the bank reported it. Known values are the SWIFT gpi codes `G000` (forwarded to a gpi bank), `G001` (forwarded to a non-gpi bank), `G002` (update will follow), `G003` (documents pending), `G004` (funds pending) and `G005` (delivered to the beneficiary's gpi bank), and ISO external status reason codes such as `MS03`. The list is open: a bank can report any code from either set.\n","uniqueKey":"oneOf.0.swift_tracking.current_tracking.oneOf.0.reason_code.oneOf.0","typeLabel":"string"},{"type":"null","description":"Why the status is what it is, as the bank reported it. Known values are the SWIFT gpi codes `G000` (forwarded to a gpi bank), `G001` (forwarded to a non-gpi bank), `G002` (update will follow), `G003` (documents pending), `G004` (funds pending) and `G005` (delivered to the beneficiary's gpi bank), and ISO external status reason codes such as `MS03`. The list is open: a bank can report any code from either set.\n","uniqueKey":"oneOf.0.swift_tracking.current_tracking.oneOf.0.reason_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.swift_tracking.current_tracking.oneOf.0.reason_code","typeLabel":"string | null"},"status_description":{"oneOf":[{"type":"string","uniqueKey":"oneOf.0.swift_tracking.current_tracking.oneOf.0.status_description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"oneOf.0.swift_tracking.current_tracking.oneOf.0.status_description.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.swift_tracking.current_tracking.oneOf.0.status_description","typeLabel":"string | null"},"reason_description":{"oneOf":[{"type":"string","uniqueKey":"oneOf.0.swift_tracking.current_tracking.oneOf.0.reason_description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"oneOf.0.swift_tracking.current_tracking.oneOf.0.reason_description.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.swift_tracking.current_tracking.oneOf.0.reason_description","typeLabel":"string | null"},"reporting_bank":{"description":"A bank or other agent in the payment, as reported.","properties":{"name":{"oneOf":[{"type":"string","uniqueKey":"oneOf.0.swift_tracking.current_tracking.oneOf.0.reporting_bank.name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"oneOf.0.swift_tracking.current_tracking.oneOf.0.reporting_bank.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.swift_tracking.current_tracking.oneOf.0.reporting_bank.name","typeLabel":"string | null"},"bic":{"oneOf":[{"type":"string","description":"The BIC, when reported.","uniqueKey":"oneOf.0.swift_tracking.current_tracking.oneOf.0.reporting_bank.bic.oneOf.0","typeLabel":"string"},{"type":"null","description":"The BIC, when reported.","uniqueKey":"oneOf.0.swift_tracking.current_tracking.oneOf.0.reporting_bank.bic.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.swift_tracking.current_tracking.oneOf.0.reporting_bank.bic","typeLabel":"string | null"}},"type":"object","uniqueKey":"oneOf.0.swift_tracking.current_tracking.oneOf.0.reporting_bank","typeLabel":"object"},"forwarded_agent":{"oneOf":[{"type":"object","description":"The bank this bank passed the payment to, when reported.","properties":{"name":{"oneOf":[{"type":"string","uniqueKey":"oneOf.0.swift_tracking.current_tracking.oneOf.0.forwarded_agent.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"oneOf.0.swift_tracking.current_tracking.oneOf.0.forwarded_agent.oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.swift_tracking.current_tracking.oneOf.0.forwarded_agent.oneOf.0.name","typeLabel":"string | null"},"bic":{"oneOf":[{"type":"string","description":"The BIC, when reported.","uniqueKey":"oneOf.0.swift_tracking.current_tracking.oneOf.0.forwarded_agent.oneOf.0.bic.oneOf.0","typeLabel":"string"},{"type":"null","description":"The BIC, when reported.","uniqueKey":"oneOf.0.swift_tracking.current_tracking.oneOf.0.forwarded_agent.oneOf.0.bic.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.swift_tracking.current_tracking.oneOf.0.forwarded_agent.oneOf.0.bic","typeLabel":"string | null"}},"uniqueKey":"oneOf.0.swift_tracking.current_tracking.oneOf.0.forwarded_agent.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"oneOf.0.swift_tracking.current_tracking.oneOf.0.forwarded_agent.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.swift_tracking.current_tracking.oneOf.0.forwarded_agent","typeLabel":"object | null"},"transaction_reference":{"oneOf":[{"type":"string","description":"The reporting bank's own reference for the payment, useful when asking that bank about it.","uniqueKey":"oneOf.0.swift_tracking.current_tracking.oneOf.0.transaction_reference.oneOf.0","typeLabel":"string"},{"type":"null","description":"The reporting bank's own reference for the payment, useful when asking that bank about it.","uniqueKey":"oneOf.0.swift_tracking.current_tracking.oneOf.0.transaction_reference.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.swift_tracking.current_tracking.oneOf.0.transaction_reference","typeLabel":"string | null"},"settlement_amount":{"oneOf":[{"type":"object","description":"What this bank settled onward.","properties":{"amount":{"type":"string","description":"Decimal string in the currency's precision, for example \"4749.95\".","uniqueKey":"oneOf.0.swift_tracking.current_tracking.oneOf.0.settlement_amount.oneOf.0.amount","typeLabel":"string"},"currency":{"type":"string","description":"Lowercase ISO 4217 code, for example \"gbp\".","uniqueKey":"oneOf.0.swift_tracking.current_tracking.oneOf.0.settlement_amount.oneOf.0.currency","typeLabel":"string"}},"uniqueKey":"oneOf.0.swift_tracking.current_tracking.oneOf.0.settlement_amount.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"oneOf.0.swift_tracking.current_tracking.oneOf.0.settlement_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.swift_tracking.current_tracking.oneOf.0.settlement_amount","typeLabel":"object | null"},"deduct_amount":{"oneOf":[{"type":"object","description":"Charges reported on this row. Carries forward from earlier rows, so it is not additive across the chain.","properties":{"amount":{"type":"string","description":"Decimal string in the currency's precision, for example \"4749.95\".","uniqueKey":"oneOf.0.swift_tracking.current_tracking.oneOf.0.deduct_amount.oneOf.0.amount","typeLabel":"string"},"currency":{"type":"string","description":"Lowercase ISO 4217 code, for example \"gbp\".","uniqueKey":"oneOf.0.swift_tracking.current_tracking.oneOf.0.deduct_amount.oneOf.0.currency","typeLabel":"string"}},"uniqueKey":"oneOf.0.swift_tracking.current_tracking.oneOf.0.deduct_amount.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"oneOf.0.swift_tracking.current_tracking.oneOf.0.deduct_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.swift_tracking.current_tracking.oneOf.0.deduct_amount","typeLabel":"object | null"},"fx":{"oneOf":[{"description":"Present when this bank converted the payment.","properties":{"source_currency":{"type":"string","uniqueKey":"oneOf.0.swift_tracking.current_tracking.oneOf.0.fx.oneOf.0.source_currency","typeLabel":"string"},"target_currency":{"type":"string","uniqueKey":"oneOf.0.swift_tracking.current_tracking.oneOf.0.fx.oneOf.0.target_currency","typeLabel":"string"},"exchange_rate":{"type":"string","uniqueKey":"oneOf.0.swift_tracking.current_tracking.oneOf.0.fx.oneOf.0.exchange_rate","typeLabel":"string"}},"type":"object","uniqueKey":"oneOf.0.swift_tracking.current_tracking.oneOf.0.fx.oneOf.0","typeLabel":"object"},{"description":"Present when this bank converted the payment.","properties":{"source_currency":{"type":"string"},"target_currency":{"type":"string"},"exchange_rate":{"type":"string"}},"type":"null","uniqueKey":"oneOf.0.swift_tracking.current_tracking.oneOf.0.fx.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.swift_tracking.current_tracking.oneOf.0.fx","typeLabel":"object | null"},"status_updated_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"oneOf.0.swift_tracking.current_tracking.oneOf.0.status_updated_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"oneOf.0.swift_tracking.current_tracking.oneOf.0.status_updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.swift_tracking.current_tracking.oneOf.0.status_updated_at","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"oneOf.0.swift_tracking.current_tracking.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"oneOf.0.swift_tracking.current_tracking.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.swift_tracking.current_tracking","typeLabel":"object | null"},"tracking_history":{"type":"array","description":"Every report in the chain, newest first.","items":{"description":"One status that a bank in the payment chain reported through SWIFT gpi.","properties":{"leg_type":{"oneOf":[{"type":"string","enum":["serial","cover"],"description":"`serial` for the leg that reaches the beneficiary, `cover` for the correspondent funding leg. A credit on the cover leg means the funds reached the beneficiary's bank.","uniqueKey":"oneOf.0.swift_tracking.tracking_history.items.[INDEX].leg_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["serial","cover"],"description":"`serial` for the leg that reaches the beneficiary, `cover` for the correspondent funding leg. A credit on the cover leg means the funds reached the beneficiary's bank.","uniqueKey":"oneOf.0.swift_tracking.tracking_history.items.[INDEX].leg_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.swift_tracking.tracking_history.items.[INDEX].leg_type","typeLabel":"enum\u003cstring> | null"},"status_code":{"oneOf":[{"type":"string","description":"ISO 20022 payment transaction status as the bank reported it. Known values are `ACSP` (settlement in process), `ACSC` (settled on the sender's side), `ACCC` (beneficiary credited), `RJCT` (rejected) and `PDNG` (pending). The list is open: a bank can report any code from the ISO external code set, so treat unlisted values as a status you do not know rather than as an error.\n","uniqueKey":"oneOf.0.swift_tracking.tracking_history.items.[INDEX].status_code.oneOf.0","typeLabel":"string"},{"type":"null","description":"ISO 20022 payment transaction status as the bank reported it. Known values are `ACSP` (settlement in process), `ACSC` (settled on the sender's side), `ACCC` (beneficiary credited), `RJCT` (rejected) and `PDNG` (pending). The list is open: a bank can report any code from the ISO external code set, so treat unlisted values as a status you do not know rather than as an error.\n","uniqueKey":"oneOf.0.swift_tracking.tracking_history.items.[INDEX].status_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.swift_tracking.tracking_history.items.[INDEX].status_code","typeLabel":"string | null"},"reason_code":{"oneOf":[{"type":"string","description":"Why the status is what it is, as the bank reported it. Known values are the SWIFT gpi codes `G000` (forwarded to a gpi bank), `G001` (forwarded to a non-gpi bank), `G002` (update will follow), `G003` (documents pending), `G004` (funds pending) and `G005` (delivered to the beneficiary's gpi bank), and ISO external status reason codes such as `MS03`. The list is open: a bank can report any code from either set.\n","uniqueKey":"oneOf.0.swift_tracking.tracking_history.items.[INDEX].reason_code.oneOf.0","typeLabel":"string"},{"type":"null","description":"Why the status is what it is, as the bank reported it. Known values are the SWIFT gpi codes `G000` (forwarded to a gpi bank), `G001` (forwarded to a non-gpi bank), `G002` (update will follow), `G003` (documents pending), `G004` (funds pending) and `G005` (delivered to the beneficiary's gpi bank), and ISO external status reason codes such as `MS03`. The list is open: a bank can report any code from either set.\n","uniqueKey":"oneOf.0.swift_tracking.tracking_history.items.[INDEX].reason_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.swift_tracking.tracking_history.items.[INDEX].reason_code","typeLabel":"string | null"},"status_description":{"oneOf":[{"type":"string","uniqueKey":"oneOf.0.swift_tracking.tracking_history.items.[INDEX].status_description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"oneOf.0.swift_tracking.tracking_history.items.[INDEX].status_description.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.swift_tracking.tracking_history.items.[INDEX].status_description","typeLabel":"string | null"},"reason_description":{"oneOf":[{"type":"string","uniqueKey":"oneOf.0.swift_tracking.tracking_history.items.[INDEX].reason_description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"oneOf.0.swift_tracking.tracking_history.items.[INDEX].reason_description.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.swift_tracking.tracking_history.items.[INDEX].reason_description","typeLabel":"string | null"},"reporting_bank":{"description":"A bank or other agent in the payment, as reported.","properties":{"name":{"oneOf":[{"type":"string","uniqueKey":"oneOf.0.swift_tracking.tracking_history.items.[INDEX].reporting_bank.name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"oneOf.0.swift_tracking.tracking_history.items.[INDEX].reporting_bank.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.swift_tracking.tracking_history.items.[INDEX].reporting_bank.name","typeLabel":"string | null"},"bic":{"oneOf":[{"type":"string","description":"The BIC, when reported.","uniqueKey":"oneOf.0.swift_tracking.tracking_history.items.[INDEX].reporting_bank.bic.oneOf.0","typeLabel":"string"},{"type":"null","description":"The BIC, when reported.","uniqueKey":"oneOf.0.swift_tracking.tracking_history.items.[INDEX].reporting_bank.bic.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.swift_tracking.tracking_history.items.[INDEX].reporting_bank.bic","typeLabel":"string | null"}},"type":"object","uniqueKey":"oneOf.0.swift_tracking.tracking_history.items.[INDEX].reporting_bank","typeLabel":"object"},"forwarded_agent":{"oneOf":[{"type":"object","description":"The bank this bank passed the payment to, when reported.","properties":{"name":{"oneOf":[{"type":"string","uniqueKey":"oneOf.0.swift_tracking.tracking_history.items.[INDEX].forwarded_agent.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"oneOf.0.swift_tracking.tracking_history.items.[INDEX].forwarded_agent.oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.swift_tracking.tracking_history.items.[INDEX].forwarded_agent.oneOf.0.name","typeLabel":"string | null"},"bic":{"oneOf":[{"type":"string","description":"The BIC, when reported.","uniqueKey":"oneOf.0.swift_tracking.tracking_history.items.[INDEX].forwarded_agent.oneOf.0.bic.oneOf.0","typeLabel":"string"},{"type":"null","description":"The BIC, when reported.","uniqueKey":"oneOf.0.swift_tracking.tracking_history.items.[INDEX].forwarded_agent.oneOf.0.bic.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.swift_tracking.tracking_history.items.[INDEX].forwarded_agent.oneOf.0.bic","typeLabel":"string | null"}},"uniqueKey":"oneOf.0.swift_tracking.tracking_history.items.[INDEX].forwarded_agent.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"oneOf.0.swift_tracking.tracking_history.items.[INDEX].forwarded_agent.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.swift_tracking.tracking_history.items.[INDEX].forwarded_agent","typeLabel":"object | null"},"transaction_reference":{"oneOf":[{"type":"string","description":"The reporting bank's own reference for the payment, useful when asking that bank about it.","uniqueKey":"oneOf.0.swift_tracking.tracking_history.items.[INDEX].transaction_reference.oneOf.0","typeLabel":"string"},{"type":"null","description":"The reporting bank's own reference for the payment, useful when asking that bank about it.","uniqueKey":"oneOf.0.swift_tracking.tracking_history.items.[INDEX].transaction_reference.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.swift_tracking.tracking_history.items.[INDEX].transaction_reference","typeLabel":"string | null"},"settlement_amount":{"oneOf":[{"type":"object","description":"What this bank settled onward.","properties":{"amount":{"type":"string","description":"Decimal string in the currency's precision, for example \"4749.95\".","uniqueKey":"oneOf.0.swift_tracking.tracking_history.items.[INDEX].settlement_amount.oneOf.0.amount","typeLabel":"string"},"currency":{"type":"string","description":"Lowercase ISO 4217 code, for example \"gbp\".","uniqueKey":"oneOf.0.swift_tracking.tracking_history.items.[INDEX].settlement_amount.oneOf.0.currency","typeLabel":"string"}},"uniqueKey":"oneOf.0.swift_tracking.tracking_history.items.[INDEX].settlement_amount.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"oneOf.0.swift_tracking.tracking_history.items.[INDEX].settlement_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.swift_tracking.tracking_history.items.[INDEX].settlement_amount","typeLabel":"object | null"},"deduct_amount":{"oneOf":[{"type":"object","description":"Charges reported on this row. Carries forward from earlier rows, so it is not additive across the chain.","properties":{"amount":{"type":"string","description":"Decimal string in the currency's precision, for example \"4749.95\".","uniqueKey":"oneOf.0.swift_tracking.tracking_history.items.[INDEX].deduct_amount.oneOf.0.amount","typeLabel":"string"},"currency":{"type":"string","description":"Lowercase ISO 4217 code, for example \"gbp\".","uniqueKey":"oneOf.0.swift_tracking.tracking_history.items.[INDEX].deduct_amount.oneOf.0.currency","typeLabel":"string"}},"uniqueKey":"oneOf.0.swift_tracking.tracking_history.items.[INDEX].deduct_amount.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"oneOf.0.swift_tracking.tracking_history.items.[INDEX].deduct_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.swift_tracking.tracking_history.items.[INDEX].deduct_amount","typeLabel":"object | null"},"fx":{"oneOf":[{"description":"Present when this bank converted the payment.","properties":{"source_currency":{"type":"string","uniqueKey":"oneOf.0.swift_tracking.tracking_history.items.[INDEX].fx.oneOf.0.source_currency","typeLabel":"string"},"target_currency":{"type":"string","uniqueKey":"oneOf.0.swift_tracking.tracking_history.items.[INDEX].fx.oneOf.0.target_currency","typeLabel":"string"},"exchange_rate":{"type":"string","uniqueKey":"oneOf.0.swift_tracking.tracking_history.items.[INDEX].fx.oneOf.0.exchange_rate","typeLabel":"string"}},"type":"object","uniqueKey":"oneOf.0.swift_tracking.tracking_history.items.[INDEX].fx.oneOf.0","typeLabel":"object"},{"description":"Present when this bank converted the payment.","properties":{"source_currency":{"type":"string"},"target_currency":{"type":"string"},"exchange_rate":{"type":"string"}},"type":"null","uniqueKey":"oneOf.0.swift_tracking.tracking_history.items.[INDEX].fx.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.swift_tracking.tracking_history.items.[INDEX].fx","typeLabel":"object | null"},"status_updated_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"oneOf.0.swift_tracking.tracking_history.items.[INDEX].status_updated_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"oneOf.0.swift_tracking.tracking_history.items.[INDEX].status_updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.swift_tracking.tracking_history.items.[INDEX].status_updated_at","typeLabel":"string\u003cdate-time> | null"}},"type":"object","uniqueKey":"oneOf.0.swift_tracking.tracking_history.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.0.swift_tracking.tracking_history","typeLabel":"object[]"},"amount_delivered":{"oneOf":[{"type":"object","description":"What reached the beneficiary's bank: the last settlement reported along the chain, less charges the chain reported after it. A bank that takes a fee without reporting it leaves it in this figure. Only present once the payment is completed.\n","properties":{"amount":{"type":"string","description":"Decimal string in the currency's precision, for example \"4749.95\".","uniqueKey":"oneOf.0.swift_tracking.amount_delivered.oneOf.0.amount","typeLabel":"string"},"currency":{"type":"string","description":"Lowercase ISO 4217 code, for example \"gbp\".","uniqueKey":"oneOf.0.swift_tracking.amount_delivered.oneOf.0.currency","typeLabel":"string"}},"uniqueKey":"oneOf.0.swift_tracking.amount_delivered.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"oneOf.0.swift_tracking.amount_delivered.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.swift_tracking.amount_delivered","typeLabel":"object | null"},"charges":{"type":"array","description":"Charges taken along the chain, one entry per currency.","items":{"description":"An amount as a bank in the payment chain reported it.","properties":{"amount":{"type":"string","description":"Decimal string in the currency's precision, for example \"4749.95\".","uniqueKey":"oneOf.0.swift_tracking.charges.items.[INDEX].amount","typeLabel":"string"},"currency":{"type":"string","description":"Lowercase ISO 4217 code, for example \"gbp\".","uniqueKey":"oneOf.0.swift_tracking.charges.items.[INDEX].currency","typeLabel":"string"}},"type":"object","uniqueKey":"oneOf.0.swift_tracking.charges.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.0.swift_tracking.charges","typeLabel":"object[]"},"fx":{"oneOf":[{"description":"The conversion applied along the chain, when a bank reported one.","properties":{"source_currency":{"type":"string","uniqueKey":"oneOf.0.swift_tracking.fx.oneOf.0.source_currency","typeLabel":"string"},"target_currency":{"type":"string","uniqueKey":"oneOf.0.swift_tracking.fx.oneOf.0.target_currency","typeLabel":"string"},"exchange_rate":{"type":"string","uniqueKey":"oneOf.0.swift_tracking.fx.oneOf.0.exchange_rate","typeLabel":"string"},"bank":{"description":"A bank or other agent in the payment, as reported.","properties":{"name":{"oneOf":[{"type":"string","uniqueKey":"oneOf.0.swift_tracking.fx.oneOf.0.bank.name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"oneOf.0.swift_tracking.fx.oneOf.0.bank.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.swift_tracking.fx.oneOf.0.bank.name","typeLabel":"string | null"},"bic":{"oneOf":[{"type":"string","description":"The BIC, when reported.","uniqueKey":"oneOf.0.swift_tracking.fx.oneOf.0.bank.bic.oneOf.0","typeLabel":"string"},{"type":"null","description":"The BIC, when reported.","uniqueKey":"oneOf.0.swift_tracking.fx.oneOf.0.bank.bic.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.swift_tracking.fx.oneOf.0.bank.bic","typeLabel":"string | null"}},"type":"object","uniqueKey":"oneOf.0.swift_tracking.fx.oneOf.0.bank","typeLabel":"object"}},"type":"object","uniqueKey":"oneOf.0.swift_tracking.fx.oneOf.0","typeLabel":"object"},{"description":"The conversion applied along the chain, when a bank reported one.","properties":{"source_currency":{"type":"string"},"target_currency":{"type":"string"},"exchange_rate":{"type":"string"},"bank":{"description":"A bank or other agent in the payment, as reported.","properties":{"name":{"oneOf":[{"type":"string"},{"type":"null"}]},"bic":{"oneOf":[{"type":"string","description":"The BIC, when reported."},{"type":"null","description":"The BIC, when reported."}]}},"type":"object"}},"type":"null","uniqueKey":"oneOf.0.swift_tracking.fx.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.swift_tracking.fx","typeLabel":"object | null"}},"readOnly":true,"type":"object","uniqueKey":"oneOf.0.swift_tracking","typeLabel":"object"}},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","required":["state","notes"],"properties":{"state":{"type":"string","enum":["valid","invalid"],"isRequired":true,"uniqueKey":"oneOf.1.state","typeLabel":"enum\u003cstring>"},"notes":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.1.notes.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"oneOf.1.notes","typeLabel":"string[]"}},"uniqueKey":"oneOf.1","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"examples":{"AchOnrampTransferResponse":{"title":"AchOnrampTransferResponse","summary":"A successful ACH onramp transfer (ACH to crypto)","value":{"id":"00000000-0000-0000-0000-000000000003","client_reference_id":"client_transfer_id_123","state":"awaiting_funds","on_behalf_of":"00000000-0000-0000-0000-000000000001","amount":"75.0","developer_fee":"0.0","source":{"payment_rail":"ach_push","currency":"usd","external_account_id":null,"description":"ACH description, if available"},"destination":{"payment_rail":"ethereum","currency":"usdc","to_address":"0x71C7656EC7ab88b098defB751B7401B5f6d8976F"},"source_deposit_instructions":{"payment_rail":"ach_push","amount":"75.0","currency":"usd","deposit_message":"BVI7depositmessage","bank_name":"Bank name","bank_address":"Bank address","bank_routing_number":"123456789","bank_account_number":"1234567890","bank_beneficiary_name":"Bank beneficiary","bank_beneficiary_address":"Bank beneficiary address"},"receipt":{"initial_amount":"75.0","developer_fee":"0.0","exchange_fee":"0.0","subtotal_amount":"75.0","gas_fee":"0.0","final_amount":"75.0","url":"https://dashboard.bridge.xyz/transaction/00000000-0000-0000-0000-000000000000/receipt/00000000-0000-0000-0000-000000000000"},"created_at":"2020-01-01T00:00:00.000Z","updated_at":"2020-01-02T00:00:00.000Z"}},"AchOfframpTransferResponse":{"title":"AchOfframpTransferResponse","summary":"A successful ACH offramp transfer (crypto to ACH)","value":{"id":"00000000-0000-0000-0000-000000000003","client_reference_id":"client_transfer_id_123","state":"awaiting_funds","on_behalf_of":"00000000-0000-0000-0000-000000000001","amount":"75.0","developer_fee":"0.0","source":{"payment_rail":"ethereum","currency":"usdc","from_address":"0x71C7656EC7ab88b098defB751B7401B5f6d8976F"},"destination":{"payment_rail":"ach","currency":"usd","external_account_id":"00000000-0000-0000-0000-000000000002"},"source_deposit_instructions":{"payment_rail":"ethereum","amount":"75.0","currency":"usdc","from_address":"0x71C7656EC7ab88b098defB751B7401B5f6d8976F","to_address":"0xb794f5ea0ba39494ce839613fffba74279579268"},"receipt":{"initial_amount":"75.0","developer_fee":"0.0","exchange_fee":"0.0","subtotal_amount":"75.0","gas_fee":"0.0","final_amount":"75.0","url":"https://dashboard.bridge.xyz/transaction/00000000-0000-0000-0000-000000000000/receipt/00000000-0000-0000-0000-000000000000"},"created_at":"2020-01-01T00:00:00.000Z","updated_at":"2020-01-02T00:00:00.000Z"}},"AchOfframpWithMemoTransferResponse":{"title":"AchOfframpWithMemoTransferResponse","summary":"A successful ACH offramp transfer with memo (Tron/Stellar to ACH)","value":{"id":"00000000-0000-0000-0000-000000000003","client_reference_id":"client_transfer_id_123","state":"awaiting_funds","on_behalf_of":"00000000-0000-0000-0000-000000000001","amount":"75.0","developer_fee":"0.0","source":{"payment_rail":"tron","currency":"usdt","from_address":"TFCVwYhQxMXTeFGmWb45uMk1qsJ4DRMPVS"},"destination":{"payment_rail":"ach","currency":"usd","external_account_id":"00000000-0000-0000-0000-000000000002"},"source_deposit_instructions":{"payment_rail":"tron","amount":"75.0","currency":"usdc","from_address":"TFCVwYhQxMXTeFGmWb45uMk1qsJ4DRMPVS","to_address":"TUEB3vjcMx7mPvc8DmeDLevZU3wEnkZ1zs","blockchain_memo":"BRGEXAMPLEMEMO"},"receipt":{"initial_amount":"75.0","developer_fee":"0.0","exchange_fee":"0.0","subtotal_amount":"75.0","gas_fee":"0.0","final_amount":"75.0","url":"https://dashboard.bridge.xyz/transaction/00000000-0000-0000-0000-000000000000/receipt/00000000-0000-0000-0000-000000000000"},"created_at":"2020-01-01T00:00:00.000Z","updated_at":"2020-01-02T00:00:00.000Z"}},"WireOnrampTransferResponse":{"title":"WireOnrampTransferResponse","summary":"A successful Wire onramp transfer (wire to crypto)","value":{"id":"00000000-0000-0000-0000-000000000003","client_reference_id":"client_transfer_id_123","state":"awaiting_funds","on_behalf_of":"00000000-0000-0000-0000-000000000001","amount":"75.0","developer_fee":"0.0","source":{"payment_rail":"wire","currency":"usd","external_account_id":null,"bank_beneficiary_name":"Sender name, if available","bank_beneficiary_address":"Sender address, if available","bank_routing_number":"Sender routing, if available","bank_name":"Sender bank, if available","imad":"IMAD of incoming wire, if available","omad":"OMAD of incoming wire, if available (deprecated)"},"destination":{"payment_rail":"ethereum","currency":"usdc","to_address":"0x71C7656EC7ab88b098defB751B7401B5f6d8976F"},"source_deposit_instructions":{"payment_rail":"wire","amount":"75.0","currency":"usd","deposit_message":"BVI7depositmessage","bank_name":"Bank name","bank_address":"Bank address","bank_routing_number":"123456789","bank_account_number":"1234567890","bank_beneficiary_name":"Bank beneficiary","bank_beneficiary_address":"Bank beneficiary address"},"receipt":{"initial_amount":"75.0","developer_fee":"0.0","exchange_fee":"0.0","subtotal_amount":"75.0","gas_fee":"0.0","final_amount":"75.0","url":"https://dashboard.bridge.xyz/transaction/00000000-0000-0000-0000-000000000000/receipt/00000000-0000-0000-0000-000000000000"},"created_at":"2020-01-01T00:00:00.000Z","updated_at":"2020-01-02T00:00:00.000Z"}},"WireOfframpTransferResponse":{"title":"WireOfframpTransferResponse","summary":"A successful Wire offramp transfer (crypto to wire)","value":{"id":"00000000-0000-0000-0000-000000000003","client_reference_id":"client_transfer_id_123","state":"awaiting_funds","on_behalf_of":"00000000-0000-0000-0000-000000000001","amount":"500.0","developer_fee":"0.0","source":{"payment_rail":"ethereum","currency":"usdc","from_address":"0x71C7656EC7ab88b098defB751B7401B5f6d8976F"},"destination":{"payment_rail":"wire","currency":"usd","external_account_id":"00000000-0000-0000-0000-000000000002"},"source_deposit_instructions":{"payment_rail":"ethereum","amount":"500.0","currency":"usdc","from_address":"0x71C7656EC7ab88b098defB751B7401B5f6d8976F","to_address":"0xb794f5ea0ba39494ce839613fffba74279579268"},"receipt":{"initial_amount":"500.0","developer_fee":"0.0","exchange_fee":"0.0","subtotal_amount":"500.0","gas_fee":"0.0","final_amount":"500.0","url":"https://dashboard.bridge.xyz/transaction/00000000-0000-0000-0000-000000000000/receipt/00000000-0000-0000-0000-000000000000"},"created_at":"2020-01-01T00:00:00.000Z","updated_at":"2020-01-02T00:00:00.000Z"}},"SepaOnrampTransferResponse":{"title":"SepaOnrampTransferResponse","summary":"A successful SEPA onramp transfer (SEPA to crypto)","value":{"id":"00000000-0000-0000-0000-000000000003","client_reference_id":"client_transfer_id_123","state":"awaiting_funds","on_behalf_of":"00000000-0000-0000-0000-000000000001","amount":"75.0","developer_fee":"0.0","source":{"payment_rail":"sepa","currency":"eur","external_account_id":null},"destination":{"payment_rail":"ethereum","currency":"usdc","to_address":"0x71C7656EC7ab88b098defB751B7401B5f6d8976F"},"source_deposit_instructions":{"payment_rail":"sepa","amount":"75.0","currency":"eur","deposit_message":"BRG7depositmessage","bank_name":"Bank name","bank_address":"Bank address","iban":"123456789","bic":"1234567890","account_holder_name":"Bank account holder name"},"receipt":{"initial_amount":"75.0","developer_fee":"0.0","exchange_fee":"0.0","gas_fee":"0.0","url":"https://dashboard.bridge.xyz/transaction/00000000-0000-0000-0000-000000000000/receipt/00000000-0000-0000-0000-000000000000"},"created_at":"2020-01-01T00:00:00.000Z","updated_at":"2020-01-02T00:00:00.000Z"}},"SepaOfframpTransferResponse":{"title":"SepaOfframpTransferResponse","summary":"A successful SEPA offramp transfer (crypto to SEPA)","value":{"id":"00000000-0000-0000-0000-000000000003","client_reference_id":"client_transfer_id_123","state":"awaiting_funds","on_behalf_of":"00000000-0000-0000-0000-000000000001","amount":"75.0","developer_fee":"0.0","source":{"payment_rail":"ethereum","currency":"usdc","from_address":"0x71C7656EC7ab88b098defB751B7401B5f6d8976F"},"destination":{"payment_rail":"sepa","currency":"eur","external_account_id":"00000000-0000-0000-0000-000000000002","sepa_reference":"SEPA reference"},"source_deposit_instructions":{"payment_rail":"ethereum","amount":"75.0","currency":"usdc","from_address":"0x71C7656EC7ab88b098defB751B7401B5f6d8976F","to_address":"0xb794f5ea0ba39494ce839613fffba74279579268"},"receipt":{"initial_amount":"75.0","developer_fee":"0.0","exchange_fee":"0.0","subtotal_amount":"75.0","gas_fee":"0.0","final_amount":"68.27","url":"https://dashboard.bridge.xyz/transaction/00000000-0000-0000-0000-000000000000/receipt/00000000-0000-0000-0000-000000000000"},"created_at":"2020-01-01T00:00:00.000Z","updated_at":"2020-01-02T00:00:00.000Z"}},"PixOnrampTransferResponse":{"title":"PixOnrampTransferResponse","summary":"A successful Pix onramp transfer (Pix to crypto)","value":{"id":"00000000-0000-0000-0000-000000000003","client_reference_id":"client_transfer_id_123","state":"awaiting_funds","on_behalf_of":"00000000-0000-0000-0000-000000000001","amount":"75.0","developer_fee":"0.0","source":{"payment_rail":"pix","currency":"brl","external_account_id":null,"description":"Pix transfer description, if available","sender_name":"Sender name, if available","account_number":"Sender account number, if available","bank_code":"Sender bank ISPB code, if available","bank_name":"Sender bank name, if available"},"destination":{"payment_rail":"ethereum","currency":"usdc","to_address":"0x71C7656EC7ab88b098defB751B7401B5f6d8976F"},"source_deposit_instructions":{"payment_rail":"pix","amount":"75.0","currency":"brl","br_code":"00020126580014br.gov.bcb.pix0136123e4567-e12b-12d1-a456-4266554400005204000053039865802BR5913Fulano de Tal6008BRASILIA62070503***63041D3D","account_holder_name":"Bridge Developer Name","bank_name":"Woovi Instituição de Pagamento LTDA"},"receipt":{"initial_amount":"75.0","developer_fee":"0.0","exchange_fee":"0.0","subtotal_amount":"75.0","gas_fee":"0.0","final_amount":"68.50","url":"https://dashboard.bridge.xyz/transaction/00000000-0000-0000-0000-000000000000/receipt/00000000-0000-0000-0000-000000000000"},"created_at":"2020-01-01T00:00:00.000Z","updated_at":"2020-01-02T00:00:00.000Z"}},"PixOfframpTransferResponse":{"title":"PixOfframpTransferResponse","summary":"A successful Pix offramp transfer (crypto to Pix)","value":{"id":"00000000-0000-0000-0000-000000000003","client_reference_id":"client_transfer_id_123","state":"awaiting_funds","on_behalf_of":"00000000-0000-0000-0000-000000000001","amount":"75.0","developer_fee":"0.0","source":{"payment_rail":"ethereum","currency":"usdc","from_address":"0x71C7656EC7ab88b098defB751B7401B5f6d8976F"},"destination":{"payment_rail":"pix","currency":"brl","external_account_id":"00000000-0000-0000-0000-000000000002","reference":"Pix payment reference","transaction_id":"E12345678202501011230ABCDEFGHIJK","sending_institution_name":"Woovi Instituição de Pagamento LTDA"},"source_deposit_instructions":{"payment_rail":"ethereum","amount":"75.0","currency":"usdc","from_address":"0x71C7656EC7ab88b098defB751B7401B5f6d8976F","to_address":"0xb794f5ea0ba39494ce839613fffba74279579268"},"receipt":{"initial_amount":"75.0","developer_fee":"0.0","exchange_fee":"0.0","subtotal_amount":"75.0","gas_fee":"0.0","final_amount":"68.50","url":"https://dashboard.bridge.xyz/transaction/00000000-0000-0000-0000-000000000000/receipt/00000000-0000-0000-0000-000000000000"},"created_at":"2020-01-01T00:00:00.000Z","updated_at":"2020-01-02T00:00:00.000Z"}},"SpeiOnrampTransferResponse":{"title":"SpeiOnrampTransferResponse","summary":"A successful SPEI onramp transfer (SPEI to crypto)","value":{"id":"00000000-0000-0000-0000-000000000003","client_reference_id":"client_transfer_id_123","state":"awaiting_funds","on_behalf_of":"00000000-0000-0000-0000-000000000001","amount":"500.0","developer_fee":"0.0","source":{"payment_rail":"spei","currency":"mxn","external_account_id":null,"clabe":"646180546700000164","tracking_number":"1234567890123456789012345678","sender_name":"Sender Business Name","reference":"Payment reference"},"destination":{"payment_rail":"ethereum","currency":"usdc","to_address":"0x71C7656EC7ab88b098defB751B7401B5f6d8976F"},"source_deposit_instructions":{"payment_rail":"spei","amount":"500.0","currency":"mxn","deposit_message":"MXN7depositmessage","clabe":"646180115400000007","account_holder_name":"Bridge Developer Name","bank_name":"STP"},"receipt":{"initial_amount":"500.0","developer_fee":"0.0","exchange_fee":"0.0","subtotal_amount":"500.0","gas_fee":"0.0","final_amount":"24.88","url":"https://dashboard.bridge.xyz/transaction/00000000-0000-0000-0000-000000000000/receipt/00000000-0000-0000-0000-000000000000"},"created_at":"2020-01-01T00:00:00.000Z","updated_at":"2020-01-02T00:00:00.000Z"}},"SpeiOfframpTransferResponse":{"title":"SpeiOfframpTransferResponse","summary":"A successful SPEI offramp transfer (crypto to SPEI)","value":{"id":"00000000-0000-0000-0000-000000000003","client_reference_id":"client_transfer_id_123","state":"awaiting_funds","on_behalf_of":"00000000-0000-0000-0000-000000000001","amount":"75.0","developer_fee":"0.0","source":{"payment_rail":"ethereum","currency":"usdc","from_address":"0x71C7656EC7ab88b098defB751B7401B5f6d8976F"},"destination":{"payment_rail":"spei","currency":"mxn","external_account_id":"00000000-0000-0000-0000-000000000002","spei_reference":"SPEI reference","tracking_number":"1234567890123456789012345678","sending_institution_name":"Sistema de Transferencias y Pagos STP, S.A. de C.V."},"source_deposit_instructions":{"payment_rail":"ethereum","amount":"75.0","currency":"usdc","from_address":"0x71C7656EC7ab88b098defB751B7401B5f6d8976F","to_address":"0xb794f5ea0ba39494ce839613fffba74279579268"},"receipt":{"initial_amount":"75.0","developer_fee":"0.0","exchange_fee":"0.0","subtotal_amount":"75.0","gas_fee":"0.0","final_amount":"1492.50","url":"https://dashboard.bridge.xyz/transaction/00000000-0000-0000-0000-000000000000/receipt/00000000-0000-0000-0000-000000000000"},"created_at":"2020-01-01T00:00:00.000Z","updated_at":"2020-01-02T00:00:00.000Z"}},"BreBOnrampTransferResponse":{"title":"BreBOnrampTransferResponse","summary":"A successful Bre-B onramp transfer (COP to crypto)","value":{"id":"00000000-0000-0000-0000-000000000005","state":"awaiting_funds","on_behalf_of":"00000000-0000-0000-0000-000000000001","amount":"5000000.0","developer_fee":"0.0","source":{"payment_rail":"bre_b","currency":"cop"},"destination":{"payment_rail":"ethereum","currency":"usdc","to_address":"0xdeadbeef"},"source_deposit_instructions":{"payment_rail":"bre_b","amount":"5000000.0","currency":"cop","deposit_message":"COP7depositmessage","bre_b_key":"12345678901234567890","account_holder_name":"Bridge Developer Name"},"created_at":"2020-01-01T00:00:00.000Z","updated_at":"2020-01-02T00:00:00.000Z"}},"BreBOfframpTransferResponse":{"title":"BreBOfframpTransferResponse","summary":"A successful Bre-B offramp transfer (crypto to COP)","value":{"id":"00000000-0000-0000-0000-000000000004","client_reference_id":"client_transfer_id_456","state":"awaiting_funds","on_behalf_of":"00000000-0000-0000-0000-000000000001","amount":"100.0","developer_fee":"0.0","source":{"payment_rail":"ethereum","currency":"usdc","from_address":"0x71C7656EC7ab88b098defB751B7401B5f6d8976F"},"destination":{"payment_rail":"bre_b","currency":"cop","external_account_id":"00000000-0000-0000-0000-000000000002"},"source_deposit_instructions":{"payment_rail":"ethereum","amount":"100.0","currency":"usdc","from_address":"0x71C7656EC7ab88b098defB751B7401B5f6d8976F","to_address":"0xb794f5ea0ba39494ce839613fffba74279579268"},"receipt":{"initial_amount":"100.0","developer_fee":"0.0","exchange_fee":"0.0","subtotal_amount":"100.0","gas_fee":"0.0","final_amount":"420000.0","url":"https://dashboard.bridge.xyz/transaction/00000000-0000-0000-0000-000000000000/receipt/00000000-0000-0000-0000-000000000000"},"created_at":"2020-01-01T00:00:00.000Z","updated_at":"2020-01-02T00:00:00.000Z"}},"CoBankTransferOnrampTransferResponse":{"title":"CoBankTransferOnrampTransferResponse","summary":"A successful Colombian bank transfer onramp (COP to crypto)","value":{"id":"00000000-0000-0000-0000-000000000006","state":"awaiting_funds","on_behalf_of":"00000000-0000-0000-0000-000000000001","amount":"5000000.0","developer_fee":"0.0","source":{"payment_rail":"co_bank_transfer","currency":"cop","co_bank_transfer":{"sender_data":{"full_name":"María López","document_type":"cc","document_number":"***7890","email":"maria@example.com","phone_number":"+573001234567"}}},"destination":{"payment_rail":"ethereum","currency":"usdc","to_address":"0xdeadbeef"},"source_deposit_instructions":{"payment_rail":"co_bank_transfer","amount":"5000000.0","currency":"cop","start_url":"https://example.com/co-bank-transfer/pay/abc123","redirect_url":"https://merchant.example.com/return","expires_at":"2026-05-01T00:30:00.000Z","account_holder_name":"Bridge Developer Name"},"created_at":"2020-01-01T00:00:00.000Z","updated_at":"2020-01-02T00:00:00.000Z"}},"CoBankTransferOfframpTransferResponse":{"title":"CoBankTransferOfframpTransferResponse","summary":"A successful Colombian bank transfer offramp (crypto to COP)","value":{"id":"00000000-0000-0000-0000-000000000007","state":"awaiting_funds","on_behalf_of":"00000000-0000-0000-0000-000000000001","amount":"100.0","developer_fee":"0.0","source":{"payment_rail":"ethereum","currency":"usdc","from_address":"0x71C7656EC7ab88b098defB751B7401B5f6d8976F"},"destination":{"payment_rail":"co_bank_transfer","currency":"cop","external_account_id":"00000000-0000-0000-0000-000000000002"},"source_deposit_instructions":{"payment_rail":"ethereum","amount":"100.0","currency":"usdc","from_address":"0x71C7656EC7ab88b098defB751B7401B5f6d8976F","to_address":"0xb794f5ea0ba39494ce839613fffba74279579268"},"receipt":{"initial_amount":"100.0","developer_fee":"0.0","exchange_fee":"0.0","subtotal_amount":"100.0","gas_fee":"0.0","final_amount":"420000.0","url":"https://dashboard.bridge.xyz/transaction/00000000-0000-0000-0000-000000000000/receipt/00000000-0000-0000-0000-000000000000"},"created_at":"2020-01-01T00:00:00.000Z","updated_at":"2020-01-02T00:00:00.000Z"}},"ValidTransferRouteResponse":{"title":"ValidTransferRouteResponse","summary":"A valid transfer route response","value":{"state":"valid","notes":["This is a valid transfer route"]}}},"exampleType":"examples"}},"exampleType":"examples"},"2d20f6cc-1c70-464b-aecd-6153adc15863":{"description":"Request containing missing or invalid parameters.","content":{"application/json":{"schema":{"required":["code","message"],"properties":{"code":{"type":"string","minLength":1,"maxLength":256,"isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","minLength":1,"maxLength":512,"isRequired":true,"uniqueKey":"message","typeLabel":"string"},"source":{"title":"ErrorSource","required":["location","key"],"properties":{"location":{"type":"string","enum":["path","query","body","header"],"isRequired":true,"uniqueKey":"source.location","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"Comma separated names of the properties or parameters causing the error","isRequired":true,"uniqueKey":"source.key","typeLabel":"string"}},"type":"object","uniqueKey":"source","typeLabel":"ErrorSource · object"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"BadCustomerRequestErrorExample":{"title":"BadCustomerRequestErrorExample","summary":"Bad customer request","value":{"code":"bad_customer_request","message":"fields missing from customer body.","name":"first_name,ssn"}}},"exampleType":"examples"}},"exampleType":"examples"},"579a7f02-cc36-4275-99c6-017dd28f1afe":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"required":["code","message"],"properties":{"code":{"type":"string","minLength":1,"maxLength":256,"isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","minLength":1,"maxLength":512,"isRequired":true,"uniqueKey":"message","typeLabel":"string"},"source":{"title":"ErrorSource","required":["location","key"],"properties":{"location":{"type":"string","enum":["path","query","body","header"],"isRequired":true,"uniqueKey":"source.location","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"Comma separated names of the properties or parameters causing the error","isRequired":true,"uniqueKey":"source.key","typeLabel":"string"}},"type":"object","uniqueKey":"source","typeLabel":"ErrorSource · object"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"MissingTokenError":{"title":"MissingTokenError","summary":"No Api-Key header","description":"The header may be missing or misspelled.","value":{"code":"required","location":"header","name":"Api-Key","message":"Missing Api-Key header"}},"InvalidTokenError":{"title":"InvalidTokenError","summary":"Invalid key in Api-Key header","value":{"code":"invalid","location":"header","name":"Api-Key","message":"Invalid Api-Key header"}}},"exampleType":"examples"}},"exampleType":"examples"},"8f3cd4e3-22e4-4c7d-bb73-0611e6c5fad8":{"description":"The transfer has failed due to an AML violation (anti-money laundering). Reach out to Bridge for more information","content":{"application/json":{"schema":{"required":["code","message"],"properties":{"code":{"type":"string","minLength":1,"maxLength":256,"isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","minLength":1,"maxLength":512,"isRequired":true,"uniqueKey":"message","typeLabel":"string"},"source":{"title":"ErrorSource","required":["location","key"],"properties":{"location":{"type":"string","enum":["path","query","body","header"],"isRequired":true,"uniqueKey":"source.location","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"Comma separated names of the properties or parameters causing the error","isRequired":true,"uniqueKey":"source.key","typeLabel":"string"}},"type":"object","uniqueKey":"source","typeLabel":"ErrorSource · object"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"TransferAmlErrorExample":{"title":"TransferAmlErrorExample","summary":"An AML violation error response","value":{"code":"aml_violation","message":"Failed AML Screening"}}},"exampleType":"examples"}},"exampleType":"examples"},"c4d462b8-082f-4e89-9fc4-be5f221caafe":{"description":"The requested resource is temporarily in a conflicting state. Retry the same request later with the same idempotency key.","content":{"application/json":{"schema":{"required":["code","message"],"properties":{"code":{"type":"string","minLength":1,"maxLength":256,"isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","minLength":1,"maxLength":512,"isRequired":true,"uniqueKey":"message","typeLabel":"string"},"source":{"title":"ErrorSource","required":["location","key"],"properties":{"location":{"type":"string","enum":["path","query","body","header"],"isRequired":true,"uniqueKey":"source.location","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"Comma separated names of the properties or parameters causing the error","isRequired":true,"uniqueKey":"source.key","typeLabel":"string"}},"type":"object","uniqueKey":"source","typeLabel":"ErrorSource · object"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"ResourceStateConflictErrorExample":{"title":"ResourceStateConflictErrorExample","summary":"Balance lock contention while creating a transfer","value":{"code":"resource_state_conflict","message":"Another transfer or balance update is currently in progress for this funding source. Please retry this request."}}},"exampleType":"examples"}},"exampleType":"examples"},"1dea53f9-0791-476e-b79a-bb906035ec52":{"description":"Unexpected error. User may try and send the request again.","content":{"application/json":{"schema":{"required":["code","message"],"properties":{"code":{"type":"string","minLength":1,"maxLength":256,"isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","minLength":1,"maxLength":512,"isRequired":true,"uniqueKey":"message","typeLabel":"string"},"source":{"title":"ErrorSource","required":["location","key"],"properties":{"location":{"type":"string","enum":["path","query","body","header"],"isRequired":true,"uniqueKey":"source.location","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"Comma separated names of the properties or parameters causing the error","isRequired":true,"uniqueKey":"source.key","typeLabel":"string"}},"type":"object","uniqueKey":"source","typeLabel":"ErrorSource · object"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"UnexpectedError":{"title":"UnexpectedError","summary":"An unexpected error","value":{"errors":[{"code":"unexpected","message":"An expected error occurred, you may try again later"}]}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"ab600454-21be-4dfb-bb8b-e5b838e20b79":{"ApiKey":{"type":"apiKey","name":"Api-Key","in":"header","scopes":[],"schemeName":"ApiKey"}}},"servers":{"8cfd91ab-6780-4f17-8205-744d686f1bbb":{"url":"https://api.bridge.xyz/v0","description":"The base path for all resources"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","name":"Api-Key","in":"header","scopes":[],"schemeName":"ApiKey"},"schema":{"title":"Api-Key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKey","name":"Api-Key"}],"title":"ApiKey"}]},"originalFileLocation":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json"},"subdomain":"bridge-727305d3","siteName":"Bridge","title":"Create a transfer - Bridge","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-13T23:37:06.402Z","originalFileLocation":"api-reference/transfers/create-a-transfer.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=\"light\";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=\"light\"}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=\"Create a transfer. If this transfer cannot be created because the funding source is temporarily busy processing another update, this endpoint may return 409 resource_state_conflict. This is a transient, retryable response. You may safely retry the same request with the same Idempotency-Key.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Bridge\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/bridge-727305d3/mooRrVahPwlqVkg3/_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/bridge-727305d3/mooRrVahPwlqVkg3/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/bridge-727305d3/mooRrVahPwlqVkg3/_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/bridge-727305d3/mooRrVahPwlqVkg3/_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/bridge-727305d3/mooRrVahPwlqVkg3/_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/bridge-727305d3/mooRrVahPwlqVkg3/_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/bridge-727305d3/mooRrVahPwlqVkg3/_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/bridge-727305d3/mooRrVahPwlqVkg3/_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/bridge-727305d3/mooRrVahPwlqVkg3/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a transfer - Bridge\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create a transfer. If this transfer cannot be created because the funding source is temporarily busy processing another update, this endpoint may return 409 resource_state_conflict. This is a transient, retryable response. You may safely retry the same request with the same Idempotency-Key.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Bridge\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://apidocs.bridge.xyz/api-reference/transfers/create-a-transfer\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://bridge-727305d3.mintlify.site/_mintlify/api/og/v2?division=Transfers\u0026amp;title=Create+a+transfer\u0026amp;description=Create+a+transfer.%0A%0AIf+this+transfer+cannot+be+created+because+the+funding+source+is+temporarily+busy+processing+another+update%2C+this+endpoint+may+return+%60409+r\u0026amp;theme=7314417c372cd97a946fceed\u0026amp;signature=f6cf7984ca6fad7c54cdc2ace496505a93703807c77f28b03fc1908002a0ff49\">\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=\"Create a transfer - Bridge\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create a transfer. If this transfer cannot be created because the funding source is temporarily busy processing another update, this endpoint may return 409 resource_state_conflict. This is a transient, retryable response. You may safely retry the same request with the same Idempotency-Key.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://bridge-727305d3.mintlify.site/_mintlify/api/og/v2?division=Transfers\u0026amp;title=Create+a+transfer\u0026amp;description=Create+a+transfer.%0A%0AIf+this+transfer+cannot+be+created+because+the+funding+source+is+temporarily+busy+processing+another+update%2C+this+endpoint+may+return+%60409+r\u0026amp;theme=7314417c372cd97a946fceed\u0026amp;signature=f6cf7984ca6fad7c54cdc2ace496505a93703807c77f28b03fc1908002a0ff49\">\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/bridge-727305d3/mooRrVahPwlqVkg3/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Bridge\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#047857\">\u003clink data-mint-head rel=\"canonical\" href=\"https://apidocs.bridge.xyz/api-reference/transfers/create-a-transfer\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/transfers/create-a-transfer.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://apidocs.bridge.xyz/#organization\",\"name\":\"Bridge\",\"url\":\"https://apidocs.bridge.xyz\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/bridge-727305d3/Zr0t-7SjjubLpKla/logo/bridge-logo-wordmark-dark.svg?fit=max\u0026auto=format\u0026n=Zr0t-7SjjubLpKla\u0026q=85\u0026s=c91d77ec31a41686da7d32d0c999b34a\"}},{\"@type\":\"WebSite\",\"@id\":\"https://apidocs.bridge.xyz#website\",\"name\":\"Bridge\",\"url\":\"https://apidocs.bridge.xyz\",\"publisher\":{\"@id\":\"https://apidocs.bridge.xyz/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://apidocs.bridge.xyz/api-reference/transfers/create-a-transfer#webpage\",\"url\":\"https://apidocs.bridge.xyz/api-reference/transfers/create-a-transfer\",\"name\":\"Create a transfer\",\"description\":\"Create a transfer. If this transfer cannot be created because the funding source is temporarily busy processing another update, this endpoint may return 409 resource_state_conflict. This is a transient, retryable response. You may safely retry the same request with the same Idempotency-Key.\",\"dateModified\":\"2026-11-13T23:37:06.402Z\",\"isPartOf\":{\"@id\":\"https://apidocs.bridge.xyz#website\"},\"breadcrumb\":{\"@id\":\"https://apidocs.bridge.xyz/api-reference/transfers/create-a-transfer#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://apidocs.bridge.xyz/api-reference/transfers/create-a-transfer#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://apidocs.bridge.xyz/api-reference/bridge-wallets/get-all-bridge-wallets\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Transfers\",\"item\":\"https://apidocs.bridge.xyz/api-reference/transfers/get-all-transfers\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create a transfer\",\"item\":\"https://apidocs.bridge.xyz/api-reference/transfers/create-a-transfer\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://apidocs.bridge.xyz/api-reference/transfers/create-a-transfer#apireference\",\"headline\":\"Create a transfer\",\"name\":\"Create a transfer\",\"description\":\"Create a transfer. If this transfer cannot be created because the funding source is temporarily busy processing another update, this endpoint may return 409 resource_state_conflict. This is a transient, retryable response. You may safely retry the same request with the same Idempotency-Key.\",\"url\":\"https://apidocs.bridge.xyz/api-reference/transfers/create-a-transfer\",\"mainEntityOfPage\":{\"@id\":\"https://apidocs.bridge.xyz/api-reference/transfers/create-a-transfer#webpage\"},\"dateModified\":\"2026-11-13T23:37:06.402Z\",\"publisher\":{\"@id\":\"https://apidocs.bridge.xyz/#organization\"},\"isPartOf\":{\"@id\":\"https://apidocs.bridge.xyz#website\"}}]}\u003c/script>","agentPointerHref":"/api-reference/transfers/create-a-transfer.md","siteName":"Bridge","nav":{"global":null,"tabs":[{"tab":"Home","icon":"house","pages":[{"title":"Home","href":""}]},{"tab":"Get Started","icon":"play","pages":[{"title":"Get Started","href":"/get-started/introduction/overview"}]},{"tab":"Developer Platform","icon":"layer-group","pages":[{"title":"Developer Platform","href":"/platform/orchestration/overview"}]},{"tab":"API reference","icon":"brackets-curly","pages":[{"title":"Authentication","mode":"wide","href":"/api-reference/introduction/introduction"},{"title":"Idempotency","mode":"wide","href":"/api-reference/introduction/idempotence"},{"title":"Deprecation","mode":"wide","href":"/api-reference/introduction/deprecation"},{"title":"Postman collection","mode":"wide","href":"/api-reference/introduction/postman"},{"title":"Bridge API Pagination Guide","href":"/api-reference/pagination"},{"group":"Endpoints","pages":[{"group":"Bridge Wallets","pages":[{"title":"Get all Bridge Wallets","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /wallets","href":"/api-reference/bridge-wallets/get-all-bridge-wallets"},{"title":"Get total balances of all Bridge Wallets","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /wallets/total_balances","href":"/api-reference/bridge-wallets/get-total-balances-of-all-bridge-wallets"},{"title":"Get a Bridge Wallet","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /wallets/{bridgeWalletID}","href":"/api-reference/bridge-wallets/get-a-bridge-wallet"},{"title":"Get transaction history for a Bridge Wallet","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /wallets/{bridgeWalletID}/history","href":"/api-reference/bridge-wallets/get-transaction-history-for-a-bridge-wallet"},{"title":"Get all Bridge Wallets for a customer","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /customers/{customerID}/wallets","href":"/api-reference/bridge-wallets/get-all-bridge-wallets-for-a-customer"},{"title":"Create a Bridge Wallet","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /customers/{customerID}/wallets","href":"/api-reference/bridge-wallets/create-a-bridge-wallet"},{"title":"Get a Bridge Wallet","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /customers/{customerID}/wallets/{bridgeWalletID}","href":"/api-reference/bridge-wallets/get-a-bridge-wallet-1"}]},{"group":"Customers","pages":[{"title":"Get all customers","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /customers","href":"/api-reference/customers/get-all-customers"},{"title":"Create a customer","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /customers","href":"/api-reference/customers/create-a-customer"},{"title":"Get a single customer object","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /customers/{customerID}","href":"/api-reference/customers/get-a-single-customer-object"},{"title":"Update a single customer object","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json put /customers/{customerID}","href":"/api-reference/customers/update-a-single-customer-object"},{"title":"Delete a single customer object","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json delete /customers/{customerID}","href":"/api-reference/customers/delete-a-single-customer-object"},{"title":"Get associated persons for a business customer","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /customers/{customerID}/associated_persons","href":"/api-reference/customers/get-associated-persons-for-a-business-customer"},{"title":"Create a new associated person for a business customer","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /customers/{customerID}/associated_persons","href":"/api-reference/customers/create-a-new-associated-person-for-a-business-customer"},{"title":"Get a single associated person","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /customers/{customerID}/associated_persons/{associatedPersonID}","href":"/api-reference/customers/get-a-single-associated-person"},{"title":"Update a single associated person","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json put /customers/{customerID}/associated_persons/{associatedPersonID}","href":"/api-reference/customers/update-a-single-associated-person"},{"title":"Delete a single associated person","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json delete /customers/{customerID}/associated_persons/{associatedPersonID}","href":"/api-reference/customers/delete-a-single-associated-person"},{"title":"Retrieve a hosted URL for ToS acceptance for an existing customer","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /customers/{customerID}/tos_acceptance_link","href":"/api-reference/customers/retrieve-a-hosted-url-for-tos-acceptance-for-an-existing-customer"},{"title":"Retrieve a hosted KYC Link for an existing customer","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /customers/{customerID}/kyc_link","href":"/api-reference/customers/retrieve-a-hosted-kyc-link-for-an-existing-customer"},{"title":"Get all transfers","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /customers/{customerID}/transfers","href":"/api-reference/customers/get-all-transfers"},{"title":"Get all static templates for a customer","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /customers/{customerID}/transfers/static_templates","href":"/api-reference/customers/get-all-static-templates-for-a-customer"},{"title":"Request a hosted URL for ToS acceptance for new customer creation","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /customers/tos_links","href":"/api-reference/customers/request-a-hosted-url-for-tos-acceptance-for-new-customer-creation"}]},{"group":"External Accounts","pages":[{"title":"Get all External Accounts","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /customers/{customerID}/external_accounts","href":"/api-reference/external-accounts/get-all-external-accounts"},{"title":"Create a new External Account","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /customers/{customerID}/external_accounts","href":"/api-reference/external-accounts/create-a-new-external-account"},{"title":"Retrieve an External Account object","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /customers/{customerID}/external_accounts/{externalAccountID}","href":"/api-reference/external-accounts/retrieve-an-external-account-object"},{"title":"Update an External Account","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json put /customers/{customerID}/external_accounts/{externalAccountID}","href":"/api-reference/external-accounts/update-an-external-account"},{"title":"Delete a single External Account object","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json delete /customers/{customerID}/external_accounts/{externalAccountID}","href":"/api-reference/external-accounts/delete-a-single-external-account-object"},{"title":"Deactivate an External Account","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /customers/{customerID}/external_accounts/{externalAccountID}/deactivate","href":"/api-reference/external-accounts/deactivate-an-external-account"},{"title":"Verify an External Account","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /customers/{customerID}/external_accounts/{externalAccountID}/verify","href":"/api-reference/external-accounts/verify-an-external-account"},{"title":"Reactivate an External Account","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /customers/{customerID}/external_accounts/{externalAccountID}/reactivate","href":"/api-reference/external-accounts/reactivate-an-external-account"},{"title":"Get all External Accounts","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /external_accounts","href":"/api-reference/external-accounts/get-all-external-accounts-1"}]},{"group":"Fiat Payout Configuration","pages":[{"title":"Get the fiat payout configuration for a customer","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /customers/{customerID}/fiat_payout_configuration","href":"/api-reference/fiat-payout-configuration/get-the-fiat-payout-configuration-for-a-customer"},{"title":"Update the fiat payout configuration for a customer","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json patch /customers/{customerID}/fiat_payout_configuration","href":"/api-reference/fiat-payout-configuration/update-the-fiat-payout-configuration-for-a-customer"}]},{"group":"Plaid","pages":[{"title":"Generate a Plaid Link token for a customer","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /customers/{customerID}/plaid_link_requests","href":"/api-reference/plaid/generate-a-plaid-link-token-for-a-customer"},{"title":"Exchange Plaid public token for an access token","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /plaid_exchange_public_token/{link_token}","href":"/api-reference/plaid/exchange-plaid-public-token-for-an-access-token"}]},{"group":"Transfers","pages":[{"title":"Get all transfers","description":null,"deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /transfers","href":"/api-reference/transfers/get-all-transfers"},{"title":"Create a transfer","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /transfers","href":"/api-reference/transfers/create-a-transfer"},{"title":"List transfers with pending USDT trades","description":"Returns transfers that have a stuck USDT-to-USD trade awaiting execution. Results are sorted by creation time (newest first) and paginated.\n\nUse `POST /transfers/{transferID}/execute` to force-execute a pending trade at the current market rate.\n","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /transfers/pending","href":"/api-reference/transfers/list-transfers-with-pending-usdt-trades"},{"title":"Get a transfer","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /transfers/{transferID}","href":"/api-reference/transfers/get-a-transfer"},{"title":"Update a transfer","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json put /transfers/{transferID}","href":"/api-reference/transfers/update-a-transfer"},{"title":"Delete a transfer","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json delete /transfers/{transferID}","href":"/api-reference/transfers/delete-a-transfer"},{"title":"Execute a pending USDT trade on a transfer","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /transfers/{transferID}/execute","href":"/api-reference/transfers/execute-a-pending-usdt-trade-on-a-transfer"},{"title":"Get all static templates","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /transfers/static_templates","href":"/api-reference/transfers/get-all-static-templates"}]},{"group":"Prefunded Accounts","pages":[{"title":"Get a list of all Prefunded Account","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /prefunded_accounts","href":"/api-reference/prefunded-accounts/get-a-list-of-all-prefunded-account"},{"title":"Get details for a specific Prefunded Account","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /prefunded_accounts/{prefundedAccountID}","href":"/api-reference/prefunded-accounts/get-details-for-a-specific-prefunded-account"},{"title":"Get funding history of a Prefunded Account","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /prefunded_accounts/{prefundedAccountID}/history","href":"/api-reference/prefunded-accounts/get-funding-history-of-a-prefunded-account"}]},{"group":"Liquidation Addresses","pages":[{"title":"Get all Liquidation Addresses for a customer","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /customers/{customerID}/liquidation_addresses","href":"/api-reference/liquidation-addresses/get-all-liquidation-addresses-for-a-customer"},{"title":"Create a Liquidation Address","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /customers/{customerID}/liquidation_addresses","href":"/api-reference/liquidation-addresses/create-a-liquidation-address"},{"title":"Get all Liquidation Addresses","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /liquidation_addresses","href":"/api-reference/liquidation-addresses/get-all-liquidation-addresses"},{"title":"Get a Liquidation Address","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /customers/{customerID}/liquidation_addresses/{liquidationAddressID}","href":"/api-reference/liquidation-addresses/get-a-liquidation-address"},{"title":"Update a Liquidation Address","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json put /customers/{customerID}/liquidation_addresses/{liquidationAddressID}","href":"/api-reference/liquidation-addresses/update-a-liquidation-address"},{"title":"Get drain history of a Liquidation Address","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /customers/{customerID}/liquidation_addresses/{liquidationAddressID}/drains","href":"/api-reference/liquidation-addresses/get-drain-history-of-a-liquidation-address"},{"title":"Execute a pending USDT trade on a drain","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /customers/{customerID}/liquidation_addresses/{liquidationAddressID}/drains/{drainID}/execute","href":"/api-reference/liquidation-addresses/execute-a-pending-usdt-trade-on-a-drain"},{"title":"Get the balance of a Liquidation Address (deprecated)","deprecated":true,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /customers/{customerID}/liquidation_addresses/{liquidationAddressID}/balances","href":"/api-reference/liquidation-addresses/get-the-balance-of-a-liquidation-address-deprecated"},{"title":"Liquidation Address Activity Across All Customers","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /liquidation_addresses/drains","href":"/api-reference/liquidation-addresses/liquidation-address-activity-across-all-customers"},{"title":"List drains with pending USDT trades","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /liquidation_addresses/drains/pending","href":"/api-reference/liquidation-addresses/list-drains-with-pending-usdt-trades"}]},{"group":"Virtual Accounts","pages":[{"title":"List Virtual Accounts by Customer","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /customers/{customerID}/virtual_accounts","href":"/api-reference/virtual-accounts/list-virtual-accounts-by-customer"},{"title":"Create a Virtual Account","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /customers/{customerID}/virtual_accounts","href":"/api-reference/virtual-accounts/create-a-virtual-account"},{"title":"Get a Virtual Account","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /customers/{customerID}/virtual_accounts/{virtualAccountID}","href":"/api-reference/virtual-accounts/get-a-virtual-account"},{"title":"Update a Virtual Account","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json put /customers/{customerID}/virtual_accounts/{virtualAccountID}","href":"/api-reference/virtual-accounts/update-a-virtual-account"},{"title":"Deactivate a Virtual Account","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /customers/{customerID}/virtual_accounts/{virtualAccountID}/deactivate","href":"/api-reference/virtual-accounts/deactivate-a-virtual-account"},{"title":"Reactivate a Virtual Account","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /customers/{customerID}/virtual_accounts/{virtualAccountID}/reactivate","href":"/api-reference/virtual-accounts/reactivate-a-virtual-account"},{"title":"Virtual Account Activity","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /customers/{customerID}/virtual_accounts/{virtualAccountID}/history","href":"/api-reference/virtual-accounts/virtual-account-activity"},{"title":"List Virtual Accounts","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /virtual_accounts","href":"/api-reference/virtual-accounts/list-virtual-accounts"},{"title":"Virtual Account Activity Across All Customers","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /virtual_accounts/history","href":"/api-reference/virtual-accounts/virtual-account-activity-across-all-customers"}]},{"group":"Static Memos","pages":[{"title":"List Static Memos","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /static_memos","href":"/api-reference/static-memos/list-static-memos"},{"title":"List Static Memos for Customer","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /customers/{customerID}/static_memos","href":"/api-reference/static-memos/list-static-memos-for-customer"},{"title":"Create a Static Memo","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /customers/{customerID}/static_memos","href":"/api-reference/static-memos/create-a-static-memo"},{"title":"Get a Static Memo","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /customers/{customerID}/static_memos/{staticMemoID}","href":"/api-reference/static-memos/get-a-static-memo"},{"title":"Update a Static Memo","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json put /customers/{customerID}/static_memos/{staticMemoID}","href":"/api-reference/static-memos/update-a-static-memo"},{"title":"Static Memo Activity","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /customers/{customerID}/static_memos/{staticMemoID}/history","href":"/api-reference/static-memos/static-memo-activity"},{"title":"Static Memo Activity Across All Customers","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /static_memos/history","href":"/api-reference/static-memos/static-memo-activity-across-all-customers"}]},{"group":"Cards","pages":[{"title":"Create Card PIN Update URL","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /customers/{customerID}/card_accounts/{cardAccountID}/pin","href":"/api-reference/cards/create-card-pin-update-url"},{"title":"Generate an Ephemeral Key to Reveal Card Details","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /customers/{customerID}/card_accounts/{cardAccountID}/ephemeral_keys","href":"/api-reference/cards/generate-an-ephemeral-key-to-reveal-card-details"},{"title":"Get a summary of your card program","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /developer/cards/summary","href":"/api-reference/cards/get-a-summary-of-your-card-program"},{"title":"Get a listing of your card program's card designs","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /developer/cards/designs","href":"/api-reference/cards/get-a-listing-of-your-card-programs-card-designs"},{"title":"Retrieve a card account","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /customers/{customerID}/card_accounts/{cardAccountID}","href":"/api-reference/cards/retrieve-a-card-account"},{"title":"Update a card account","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json put /customers/{customerID}/card_accounts/{cardAccountID}","href":"/api-reference/cards/update-a-card-account"},{"title":"Get all card accounts","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /customers/{customerID}/card_accounts","href":"/api-reference/cards/get-all-card-accounts"},{"title":"Provision a card account","deprecated":true,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /customers/{customerID}/card_accounts","href":"/api-reference/cards/provision-a-card-account"},{"title":"Place a freeze on the card account","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /customers/{customerID}/card_accounts/{cardAccountID}/freeze","href":"/api-reference/cards/place-a-freeze-on-the-card-account"},{"title":"Unfreeze the card account","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /customers/{customerID}/card_accounts/{cardAccountID}/unfreeze","href":"/api-reference/cards/unfreeze-the-card-account"},{"title":"Create a mobile wallet push provisioning request","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /customers/{customerID}/card_accounts/{cardAccountID}/create_mobile_wallet_provisioning_request","href":"/api-reference/cards/create-a-mobile-wallet-push-provisioning-request"},{"title":"Retrieve pending card authorizations","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /customers/{customerID}/card_accounts/{cardAccountID}/authorizations","href":"/api-reference/cards/retrieve-pending-card-authorizations"},{"title":"Retrieve card transactions","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /customers/{customerID}/card_accounts/{cardAccountID}/transactions","href":"/api-reference/cards/retrieve-card-transactions"},{"title":"Retrieve a card transaction","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /customers/{customerID}/card_accounts/{cardAccountID}/transactions/{transactionID}","href":"/api-reference/cards/retrieve-a-card-transaction"},{"title":"Retrieve authorization controls","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /customers/{customerID}/card_accounts/{cardAccountID}/auth_controls","href":"/api-reference/cards/retrieve-authorization-controls"},{"title":"Provision an additional top-up deposit address for the card account","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /customers/{customerID}/card_accounts/{cardAccountID}/deposit_addresses","href":"/api-reference/cards/provision-an-additional-top-up-deposit-address-for-the-card-account"},{"title":"Retrieve the withdrawal history of funds","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /customers/{customerID}/card_accounts/{cardAccountID}/withdrawals","href":"/api-reference/cards/retrieve-the-withdrawal-history-of-funds"},{"title":"Create a funds withdrawal request","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /customers/{customerID}/card_accounts/{cardAccountID}/withdrawals","href":"/api-reference/cards/create-a-funds-withdrawal-request"},{"title":"Retrieve a card withdrawal","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /customers/{customerID}/card_accounts/{cardAccountID}/withdrawals/{cardWithdrawalID}","href":"/api-reference/cards/retrieve-a-card-withdrawal"},{"title":"Generate a card account statement","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /customers/{customerID}/card_accounts/{cardAccountID}/statements/{period}.pdf","href":"/api-reference/cards/generate-a-card-account-statement"},{"title":"Generate a card statement using Stripe IDs","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /cardholders/{cardholderID}/cards/{cardID}/statements/{period}.pdf","href":"/api-reference/cards/generate-a-card-statement-using-stripe-ids"}]},{"group":"Batch Settlements","pages":[{"title":"Create a Batch Settlement Schedule","deprecated":true,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /customers/{customerID}/batch_settlement_schedules","href":"/api-reference/batch-settlements/create-a-batch-settlement-schedule"}]},{"group":"Developers","pages":[{"title":"Get the configured fees","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /developer/fees","href":"/api-reference/developers/get-the-configured-fees"},{"title":"Update the configured fees","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /developer/fees","href":"/api-reference/developers/update-the-configured-fees"},{"title":"Get the configured fee External Account","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /developer/fee_external_account","href":"/api-reference/developers/get-the-configured-fee-external-account"},{"title":"Configure a fee External Account","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /developer/fee_external_account","href":"/api-reference/developers/configure-a-fee-external-account"}]},{"group":"API Keys","pages":[{"title":"Create a scoped API key","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /api_keys","href":"/api-reference/api-keys/create-a-scoped-api-key"},{"title":"Describe the calling API key","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /api_keys/whoami","href":"/api-reference/api-keys/describe-the-calling-api-key"}]},{"group":"KYC Links","pages":[{"title":"Get all KYC links.","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /kyc_links","href":"/api-reference/kyc-links/get-all-kyc-links"},{"title":"Generate the Links needs to complete KYC for an individual or business","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /kyc_links","href":"/api-reference/kyc-links/generate-the-links-needs-to-complete-kyc-for-an-individual-or-business"},{"title":"Check the status of a KYC link","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /kyc_links/{kycLinkID}","href":"/api-reference/kyc-links/check-the-status-of-a-kyc-link"}]},{"group":"RFIs","pages":[{"title":"Get all RFIs","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /rfis","href":"/api-reference/rfis/get-all-rfis"},{"title":"Get an RFI","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /rfis/{rfiID}","href":"/api-reference/rfis/get-an-rfi"},{"title":"Submit responses to an RFI","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /rfis/{rfiID}/responses","href":"/api-reference/rfis/submit-responses-to-an-rfi"}]},{"group":"Funds Requests","pages":[{"title":"Get all funds requests","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /funds_requests","href":"/api-reference/funds-requests/get-all-funds-requests"}]},{"group":"Webhooks","pages":[{"title":"Get all webhook endpoints","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /webhooks","href":"/api-reference/webhooks/get-all-webhook-endpoints"},{"title":"Create a webhook endpoint","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /webhooks","href":"/api-reference/webhooks/create-a-webhook-endpoint"},{"title":"Update a webhook","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json put /webhooks/{webhookID}","href":"/api-reference/webhooks/update-a-webhook"},{"title":"Delete a webhook","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json delete /webhooks/{webhookID}","href":"/api-reference/webhooks/delete-a-webhook"},{"title":"List upcoming events","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /webhooks/{webhookID}/events","href":"/api-reference/webhooks/list-upcoming-events"},{"title":"View logs","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /webhooks/{webhookID}/logs","href":"/api-reference/webhooks/view-logs"},{"title":"Send event","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /webhooks/{webhookID}/send","href":"/api-reference/webhooks/send-event"},{"title":"List webhook events","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /webhook_events","href":"/api-reference/webhooks/list-webhook-events"}]},{"group":"Associated Persons","pages":[{"title":"Get a single associated person","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /associated_persons/{associatedPersonID}","href":"/api-reference/associated-persons/get-a-single-associated-person"},{"title":"Update a single associated person","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json put /associated_persons/{associatedPersonID}","href":"/api-reference/associated-persons/update-a-single-associated-person"},{"title":"Delete a single associated person","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json delete /associated_persons/{associatedPersonID}","href":"/api-reference/associated-persons/delete-a-single-associated-person"}]},{"group":"Travel Rule","pages":[{"title":"Submit travel rule data.","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /travel_rule_data/{id}","href":"/api-reference/travel-rule/submit-travel-rule-data"}]},{"group":"Exchange Rates","pages":[{"title":"Get current exchange rate between two currencies.","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /exchange_rates","href":"/api-reference/exchange-rates/get-current-exchange-rate-between-two-currencies"}]},{"group":"Lists","pages":[{"title":"Get occupation codes","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /lists/occupation_codes","href":"/api-reference/lists/get-occupation-codes"},{"title":"Get countries","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /lists/countries","href":"/api-reference/lists/get-countries"}]},{"group":"Crypto Return Policies","pages":[{"title":"Get all crypto return policies","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /crypto_return_policies","href":"/api-reference/crypto-return-policies/get-all-crypto-return-policies"},{"title":"Create a new crypto return policy","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /crypto_return_policies","href":"/api-reference/crypto-return-policies/create-a-new-crypto-return-policy"},{"title":"Update an existing crypto return policy","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json put /crypto_return_policies/{policyID}","href":"/api-reference/crypto-return-policies/update-an-existing-crypto-return-policy"},{"title":"Delete a single crypto return policy object","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json delete /crypto_return_policies/{policyID}","href":"/api-reference/crypto-return-policies/delete-a-single-crypto-return-policy-object"}]},{"group":"Developer Fees","pages":[]},{"group":"Rewards","pages":[{"title":"Get a summary of all rewards for a given stablecoin","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /rewards/{currency}","href":"/api-reference/rewards/get-a-summary-of-all-rewards-for-a-given-stablecoin"},{"title":"Get daily reward history for a stablecoin","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /rewards/{currency}/history","href":"/api-reference/rewards/get-daily-reward-history-for-a-stablecoin"},{"title":"Get a summary of a customer's rewards","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /rewards/{currency}/customer/{customerID}","href":"/api-reference/rewards/get-a-summary-of-a-customers-rewards"},{"title":"Get a history of a customer's rewards","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /rewards/{currency}/customer/{customerID}/history","href":"/api-reference/rewards/get-a-history-of-a-customers-rewards"}]},{"group":"Sandbox","pages":[{"title":"Simulate KYC approval (sandbox only)","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /customers/{customerID}/simulate_kyc_approval","href":"/api-reference/sandbox/simulate-kyc-approval-sandbox-only"}]}]}]},{"tab":"Changelog","icon":"calendar","pages":[{"title":"Changelog","href":"/changelog/changelog"}]}]},"basePath":"","title":"Create a transfer - Bridge","buildId":"dpl_9RFrWkXdFTJCytfx6jAofvAaEXr6","deploymentId":"dpl_9RFrWkXdFTJCytfx6jAofvAaEXr6","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-BgGj2PGS.js","utils-BhNOqRKb.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BAgRNUZo.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CGkb0TPw.js","snippetPresets-ChLkL1a6.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-Ef10Jrbx.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-DlVCnjU8.js","shallow-BA55zJxQ.js","getApiPlaygroundDisplay-DR09dKtp.js","CodeSnippet-BZ8J8Kll.js","CodeSnippets-CcguVheG.js","Page-C7x-eUfk.js","getPastedJson-D5UqeqBp.js","icon-DpD0l99C.js","MethodPill-Wg2NXsp_.js","DuplicateIcon-CCSyX8lh.js","createIcon-C4Ukv9HX.js","DynamicMarkdown-RhjEuCHC.js","SectionHeading-DL1MykRq.js","axios-vUo_bRtp.js","Markdown-BwQ4RMdp.js","dist-CiVXVcSh.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-Dic2Jtb2.js"]}