{
"type": "automation_not_active",
"detail": "Automation must be active to simulate a deposit",
"code": "ValidationError",
"status": 422,
"values": [
"<string>"
]
}
{
"type": "automation_not_active",
"detail": "Automation must be active to simulate a deposit",
"code": "ValidationError",
"status": 422,
"values": [
"<string>"
]
}
{
"type": "automation_not_active",
"detail": "Automation must be active to simulate a deposit",
"code": "ValidationError",
"status": 422,
"values": [
"<string>"
]
}
Transfers
Create a new transfer
Creates a new transfer using the specified source and destination details.
{
"type": "automation_not_active",
"detail": "Automation must be active to simulate a deposit",
"code": "ValidationError",
"status": 422,
"values": [
"<string>"
]
}
{
"type": "automation_not_active",
"detail": "Automation must be active to simulate a deposit",
"code": "ValidationError",
"status": 422,
"values": [
"<string>"
]
}
{
"type": "automation_not_active",
"detail": "Automation must be active to simulate a deposit",
"code": "ValidationError",
"status": 422,
"values": [
"<string>"
]
}
RTP payouts (rtp_credit) ended on October 30, 2026. FedNow (fednow_credit) replaces RTP for instant USD payouts. Requests that still send rtp_credit return 400 invalid_transfer_types on address creation or 400 invalid_transfer_type on transfer creation. To switch, follow Migrate from rtp_credit to fednow_credit. For recipient banks that do not participate in FedNow, use same_day_ach_credit or wire.
rtp_credit errors
A request with destination.transfer_type: "rtp_credit" returns 400:
Brale does not create a Transfer for this request. Add fednow_credit to the destination bank Address, then resend the payout with destination.transfer_type: "fednow_credit" and a new Idempotency-Key. See Migrate from rtp_credit to fednow_credit.Use the playground below to try this endpoint directly, or review the OpenAPI details in the right panel.
Authorizations
Authorization
string
header
required
Use the Bearer token returned from the Auth endpoint via OAuth2 client_credentials flow. Include the token in the "Authorization: Bearer " header.
Headers
Idempotency-Key
string
required
A unique string used to prevent duplicate operations. Each POST request must use a new idempotency key. Use a UUIDv4 string. Example: idemp-123e4567-e89b-12d3-a456-426614174000
Path Parameters
account_id
string<ksuid>
required
The ID of the account
Pattern: ^[a-zA-Z0-9]{27}$
Example:
"2VcUIIsgARwVbEGlIYbhg6fGG57"
Body
application/json
amount
Amount · object
required
Monetary value with explicit currency
Show child attributes
source
PaymentData · object
required
Show child attributes
destination
PaymentData · object
required
Show child attributes
brand
object | null
Optional branding for a transfer. Supported for ACH transfers (ach_debit, ach_credit, same_day_ach_credit), outbound wire payouts (destination.transfer_type: wire), and FedNow payouts (destination.transfer_type: fednow_credit). Not supported for rtp_credit. Branding does not change which Account funds the transfer (the Account in the request path), the source or destination, or destination.wire_memo. Omit brand to send the transfer unbranded. See Branded Transfers.
Show child attributes
note
string
Free-form note stored on the transfer and returned as note. Maximum 255 characters. To set what the recipient sees, use wire_memo or ach_description instead.
Maximum string length: 255
Response
Transfer successfully created. Creation is not settlement. Track status until it reaches complete, canceled, or failed.
A money movement between a source and a destination. Returned by the create, get, and list transfer endpoints. The same shape is used everywhere a Transfer is exposed to API consumers.
id
string<ksuid>
Pattern: ^[a-zA-Z0-9]{27}$
Example:
"2VcUIIsgARwVbEGlIYbhg6fGG57"
status
enum<string>
Lifecycle stage of the transfer. compliance review means Brale holds the transfer for compliance review before sending it, for example when the amount is above a payment partner's transaction limit. From there it moves back to pending or on to processing, or is canceled. The value contains a space, not an underscore.
Available options:
pending,
compliance review,
processing,
complete,
canceled,
failed,
refunding,
refunded
Example:
"pending"
failure
TransferFailure · object | null
Structured failure details for a failed transfer. Usually null. Populated when status is failed and Brale has structured failure details for the transfer — most commonly for ACH returns, outbound wire returns, and other rail/provider failures. Clients should not assume failure is always present for every failed transfer; check for null before reading nested fields.
Show child attributes
Example:
null
source
TransferEndpoint · object
One side (source or destination) of a Transfer. The same shape is used in create requests and in responses. Response-only fields like transaction_id and payment_details are populated by Brale as the underlying leg settles.
Show child attributes
destination
TransferEndpoint · object
One side (source or destination) of a Transfer. The same shape is used in create requests and in responses. Response-only fields like transaction_id and payment_details are populated by Brale as the underlying leg settles.
Show child attributes
amount
Amount · object
Monetary value with explicit currency
Show child attributes
note
string | null
Optional free-form note attached to the transfer.
Example:
null
brand
object | null
The Account the transfer was branded as, or null when the transfer was not branded. Returned on the create, get, and list transfer endpoints. Use it to confirm that the brand you requested was applied. A transfer created with brand can still return null if Brale sent it unbranded.
Show child attributes
Example:
null
created_by
TransferCreatedBy · object | null
Who created the transfer, or null when the creator is not one of the exposed types. Returned on the create, get, and list transfer endpoints, on the simulate Automation deposit response, and in the data object of transfer.completed and transfer.canceled webhooks.
ID of the Automation that created this transfer, when applicable. Omitted for transfers created directly via the API.
Pattern: ^[a-zA-Z0-9]{27}$
Example:
"2VcUIIsgARwVbEGlIYbhg6fGG57"
funding_simulated
boolean
Optional. When returned with a value of true, the source funding for this transfer was simulated in testnet rather than coming from a real payment. Not every simulated transfer is guaranteed to include this field. Not present for production-funded transfers.
created_at
string<date-time>
Example:
"2026-01-01T00:00:00Z"
updated_at
string<date-time>
Example:
"2026-01-01T00:00:00Z"
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Brale","description":"API documentation for issuing, moving, and managing stablecoins on any blockchain with Brale.","colors":{"primary":"#000000","light":"#6938EF","dark":"#18181B"},"logo":{"light":"https://mintcdn.com/brale/8ZhoPWIKA3trPz7_/images/brale/brale-logo-light.svg?fit=max\u0026auto=format\u0026n=8ZhoPWIKA3trPz7_\u0026q=85\u0026s=9d75182cc1a672349f431ab9462b2b14","dark":"https://mintcdn.com/brale/8ZhoPWIKA3trPz7_/images/brale/brale-logo-dark.svg?fit=max\u0026auto=format\u0026n=8ZhoPWIKA3trPz7_\u0026q=85\u0026s=b440c6595e79456e4bec0a5be2bb6b8e"},"favicon":"https://mintcdn.com/brale/8ZhoPWIKA3trPz7_/favicon.svg?fit=max\u0026auto=format\u0026n=8ZhoPWIKA3trPz7_\u0026q=85\u0026s=5ea8e718e80214027ad6dd92fd6a4116","navbar":{"links":[],"primary":{"type":"button","label":"Dashboard","href":"https://app.brale.xyz"}},"footer":{"socials":{"github":"https://github.com/Brale-xyz"}},"seo":{"metatags":{"canonical":"https://docs.brale.xyz","og:site_name":"Brale"},"indexing":"navigable"},"integrations":{"ga4":{"measurementId":"G-ZM1CBNJ9KC"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"API Keys","icon":"key","href":"https://app.brale.xyz"},{"anchor":"API Logs","icon":"database","href":"https://app.brale.xyz/api?tab=activity"},{"anchor":"Changelog","icon":"clock-rotate-left","href":"/changelog"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"brale","hasAudioNarration":false,"actualSubdomain":"brale","customDomains":["docs.brale.xyz"],"gitSource":{"type":"github","owner":"brale-xyz","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"edits":false,"issues":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":"6afdd32e1a1d099aefc612b9","clientVersion":"0.0.4177","searchFilterCounts":[{"language":"default","tag":"API reference","count":42},{"language":"default","tag":"Guides","count":24},{"language":"default","tag":"API Docs","count":20},{"language":"default","tag":"Workflows","count":18},{"language":"default","tag":"Information","count":15},{"language":"default","tag":"Webhooks","count":13},{"language":"default","tag":"Key concepts","count":10},{"language":"default","tag":"Tokenization","count":9},{"language":"default","tag":"Accounts","count":6},{"language":"default","tag":"Addresses","count":6}]},"assistantConfig":{"enableAskAiButton":true,"enableStarterQuestions":false,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"[email protected]","showHelpButton":true}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/brale/create-transfer","slug":"/api-reference/brale/create-transfer","pageMetadata":{"title":"Create a new transfer","description":"Creates a new transfer using the specified source and destination details.","openapi":"POST /accounts/{account_id}/transfers","href":"/api-reference/brale/create-transfer"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Creates a new transfer using the specified source and destination details.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,pre:`pre`,span:`span`,..._provideComponents(),...props.components},{CodeBlock,Heading,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(Warning,{children:_jsxs(_components.p,{children:[`RTP payouts (`,_jsx(_components.code,{children:`rtp_credit`}),`) ended on October 30, 2026. FedNow (`,_jsx(_components.code,{children:`fednow_credit`}),`) replaces RTP for instant USD payouts. Requests that still send `,_jsx(_components.code,{children:`rtp_credit`}),` return `,_jsx(_components.code,{children:`400 invalid_transfer_types`}),` on address creation or `,_jsx(_components.code,{children:`400 invalid_transfer_type`}),` on transfer creation. To switch, follow `,_jsxs(_components.a,{href:`/guides/fednow-outbound#migrate-from-rtp_credit-to-fednow_credit`,children:[`Migrate from `,_jsx(_components.code,{children:`rtp_credit`}),` to `,_jsx(_components.code,{children:`fednow_credit`})]}),`. For recipient banks that do not participate in FedNow, use `,_jsx(_components.code,{children:`same_day_ach_credit`}),` or `,_jsx(_components.code,{children:`wire`}),`.`]})}),`\n`,_jsxs(Heading,{level:`3`,id:`rtp_credit-errors`,children:[_jsx(_components.code,{children:`rtp_credit`}),` errors`]}),`\n`,_jsxs(_components.p,{children:[`A request with `,_jsx(_components.code,{children:`destination.transfer_type: \"rtp_credit\"`}),` returns `,_jsx(_components.code,{children:`400`}),`:`]}),`\n`,_jsx(CodeBlock,{filename:`Response (400)`,numberOfLines:`7`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`7`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"code\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"ValidationError\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`400`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"invalid_transfer_type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"values\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [],`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"detail\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Invalid transfer type\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`Brale does not create a Transfer for this request. Add `,_jsx(_components.code,{children:`fednow_credit`}),` to the destination bank Address, then resend the payout with `,_jsx(_components.code,{children:`destination.transfer_type: \"fednow_credit\"`}),` and a new `,_jsx(_components.code,{children:`Idempotency-Key`}),`. See `,_jsxs(_components.a,{href:`/guides/fednow-outbound#migrate-from-rtp_credit-to-fednow_credit`,children:[`Migrate from `,_jsx(_components.code,{children:`rtp_credit`}),` to `,_jsx(_components.code,{children:`fednow_credit`})]}),`.`]}),`\n`,_jsx(_components.p,{children:`Use the playground below to try this endpoint directly, or review the OpenAPI details in the right panel.`})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create a new transfer","description":"Creates a new transfer using the specified source and destination details.","openapi":"POST /accounts/{account_id}/transfers","href":"/api-reference/brale/create-transfer"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"rtp_credit errors","slug":"rtp_credit-errors","depth":3,"children":[]}],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Transfers","Orders"],"operationId":"createTransfer","summary":"Create a new transfer","description":"Creates a new transfer using the specified source and destination details.","parameters":["02aaba7d-bac5-47c8-8c77-34fae19691c1","d8b1bcab-a9b1-4d89-bffd-06a091cfdf43"],"requestBody":"4747d570-f832-4c29-b068-d3bdd04f06fa","responses":{"201":"73349738-747b-4e7c-9bcf-083ce0903c32","400":"233a9833-856d-41d1-bfdb-0e2c0b133e66","422":"9e7dd032-be34-43e6-a270-d14c8444e6a0","503":"ff044a23-f94d-4405-a46e-23ff658357d3"},"method":"post","type":"path","servers":["8da73adf-e60e-4374-8982-c73a1cf2599d"],"security":["4b324c94-2450-4d2d-a109-b207e1fdd9e4"],"path":"/accounts/{account_id}/transfers","baseUrlOptions":["https://api.brale.xyz"],"title":"Create a new transfer","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"02aaba7d-bac5-47c8-8c77-34fae19691c1":{"name":"account_id","in":"path","required":true,"description":"The ID of the account","schema":{"title":"Kusid","type":"string","format":"ksuid","pattern":"^[a-zA-Z0-9]{27}$","example":"2VcUIIsgARwVbEGlIYbhg6fGG57","isRequired":true,"description":"The ID of the account","uniqueKey":"","typeLabel":"string\u003cksuid>"}},"d8b1bcab-a9b1-4d89-bffd-06a091cfdf43":{"in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string","isRequired":true,"description":"A unique string used to prevent duplicate operations. Each POST request must use a new idempotency key. Use a UUIDv4 string. Example: `idemp-123e4567-e89b-12d3-a456-426614174000`\n","uniqueKey":"","typeLabel":"string"},"example":"idemp-123e4567-e89b-12d3-a456-426614174000","description":"A unique string used to prevent duplicate operations. Each POST request must use a new idempotency key. Use a UUIDv4 string. Example: `idemp-123e4567-e89b-12d3-a456-426614174000`\n"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["amount","source","destination"],"properties":{"amount":{"title":"Amount","type":"object","description":"Monetary value with explicit currency","additionalProperties":false,"properties":{"value":{"type":"string","example":"11234.88","isRequired":true,"uniqueKey":"amount.value","typeLabel":"string"},"currency":{"type":"string","example":"USD","isRequired":true,"uniqueKey":"amount.currency","typeLabel":"string"}},"required":["value","currency"],"isRequired":true,"uniqueKey":"amount","typeLabel":"Amount · object"},"source":{"type":"object","additionalProperties":false,"title":"PaymentData","properties":{"transfer_type":{"type":"string","isRequired":true,"uniqueKey":"source.transfer_type","typeLabel":"string"},"value_type":{"type":"string","isRequired":true,"uniqueKey":"source.value_type","typeLabel":"string"},"address_id":{"type":"string","description":"Preferred Address identifier","uniqueKey":"source.address_id","typeLabel":"string"},"financial_institution_id":{"type":"string","deprecated":true,"description":"Legacy—use address_id","uniqueKey":"source.financial_institution_id","typeLabel":"string"},"wire_memo":{"type":"string","description":"Optional memo or payment reference text sent with outbound wire transfers. Only applies when transfer_type is wire.","uniqueKey":"source.wire_memo","typeLabel":"string"},"ach_description":{"type":"string","maxLength":255,"description":"Optional short description shown after the sender name on the recipient's ACH bank statement. Set it on the ACH leg: `destination.ach_description` for payouts (`ach_credit`, `same_day_ach_credit`) and `source.ach_description` for `ach_debit`. Does not apply to `wire`, `rtp_credit`, or `fednow_credit`. Only the first 10 characters are used. Use letters, numbers, and spaces. Unsupported characters are removed and longer values are cut to 10 characters. If omitted, the description defaults to `PAYOUT` for payouts and `PAYMENT` for ACH debits. Independent of `brand`, which sets the sender name. Not currently returned on GET transfer responses. Exact display varies by receiving bank.","uniqueKey":"source.ach_description","typeLabel":"string"}},"required":["transfer_type","value_type"],"isRequired":true,"uniqueKey":"source","typeLabel":"PaymentData · object"},"destination":{"type":"object","additionalProperties":false,"title":"PaymentData","properties":{"transfer_type":{"type":"string","isRequired":true,"uniqueKey":"destination.transfer_type","typeLabel":"string"},"value_type":{"type":"string","isRequired":true,"uniqueKey":"destination.value_type","typeLabel":"string"},"address_id":{"type":"string","description":"Preferred Address identifier","uniqueKey":"destination.address_id","typeLabel":"string"},"financial_institution_id":{"type":"string","deprecated":true,"description":"Legacy—use address_id","uniqueKey":"destination.financial_institution_id","typeLabel":"string"},"wire_memo":{"type":"string","description":"Optional memo or payment reference text sent with outbound wire transfers. Only applies when transfer_type is wire.","uniqueKey":"destination.wire_memo","typeLabel":"string"},"ach_description":{"type":"string","maxLength":255,"description":"Optional short description shown after the sender name on the recipient's ACH bank statement. Set it on the ACH leg: `destination.ach_description` for payouts (`ach_credit`, `same_day_ach_credit`) and `source.ach_description` for `ach_debit`. Does not apply to `wire`, `rtp_credit`, or `fednow_credit`. Only the first 10 characters are used. Use letters, numbers, and spaces. Unsupported characters are removed and longer values are cut to 10 characters. If omitted, the description defaults to `PAYOUT` for payouts and `PAYMENT` for ACH debits. Independent of `brand`, which sets the sender name. Not currently returned on GET transfer responses. Exact display varies by receiving bank.","uniqueKey":"destination.ach_description","typeLabel":"string"}},"required":["transfer_type","value_type"],"isRequired":true,"uniqueKey":"destination","typeLabel":"PaymentData · object"},"brand":{"oneOf":[{"type":"object","additionalProperties":false,"description":"Optional branding for a transfer. Supported for ACH transfers (`ach_debit`, `ach_credit`, `same_day_ach_credit`), outbound wire payouts (`destination.transfer_type: wire`), and FedNow payouts (`destination.transfer_type: fednow_credit`). Not supported for `rtp_credit`. Branding does not change which Account funds the transfer (the Account in the request path), the source or destination, or `destination.wire_memo`. Omit `brand` to send the transfer unbranded. See [Branded Transfers](/guides/2nd-and-3rd-party-transfers).","required":["account_id"],"properties":{"account_id":{"type":"string","description":"ID of the verified Account whose identity is presented to the counterparty. For ACH, this is the name on bank statement line items. For outbound wires, this Account's verified identity is used as the wire sender (originator). This is an Account ID, not free-form display text.","isRequired":true,"uniqueKey":"brand.oneOf.0.account_id","typeLabel":"string"}},"uniqueKey":"brand.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":false,"description":"Optional branding for a transfer. Supported for ACH transfers (`ach_debit`, `ach_credit`, `same_day_ach_credit`), outbound wire payouts (`destination.transfer_type: wire`), and FedNow payouts (`destination.transfer_type: fednow_credit`). Not supported for `rtp_credit`. Branding does not change which Account funds the transfer (the Account in the request path), the source or destination, or `destination.wire_memo`. Omit `brand` to send the transfer unbranded. See [Branded Transfers](/guides/2nd-and-3rd-party-transfers).","required":["account_id"],"properties":{"account_id":{"type":"string","description":"ID of the verified Account whose identity is presented to the counterparty. For ACH, this is the name on bank statement line items. For outbound wires, this Account's verified identity is used as the wire sender (originator). This is an Account ID, not free-form display text."}},"uniqueKey":"brand.oneOf.1","typeLabel":"null"}],"uniqueKey":"brand","typeLabel":"object | null"},"note":{"type":"string","maxLength":255,"description":"Free-form note stored on the transfer and returned as `note`. Maximum 255 characters. To set what the recipient sees, use `wire_memo` or `ach_description` instead.","uniqueKey":"note","typeLabel":"string"}},"title":"CreateTransfer","uniqueKey":"","typeLabel":"CreateTransfer · object"},"examples":{"ach_debit_to_solana":{"title":"ach_debit_to_solana","summary":"Onramp via ACH debit → Mint on Solana","value":{"amount":{"value":"2500.00","currency":"USD"},"source":{"address_id":"2VcUIonJeVQzFoBuC7LdFT0dRe4","value_type":"USD","transfer_type":"ach_debit"},"destination":{"address_id":"35LWXNTO2jem13nXCLyciFdi162","value_type":"SBC","transfer_type":"solana"}}},"wire_offramp_with_brand":{"title":"wire_offramp_with_brand","summary":"Burn on Polygon → Wire out (brand override)","value":{"amount":{"value":"10000.00","currency":"USD"},"source":{"address_id":"35LWXNTO2jem13nXCLyciFdi162","value_type":"SBC","transfer_type":"polygon"},"destination":{"address_id":"2MhCCIHulVdXrHiEuQDJvnKbSkl","value_type":"USD","transfer_type":"wire","wire_memo":"Invoice 1048"},"brand":{"account_id":"2VcUIIsgARwVbEGlIYbhg6fGG57"}}},"rtp_payout":{"title":"rtp_payout","summary":"Stablecoin payout via RTP","value":{"amount":{"value":"150.00","currency":"USD"},"source":{"address_id":"35LWXNTO2jem13nXCLyciFdi162","value_type":"SBC","transfer_type":"ethereum"},"destination":{"address_id":"2MhCCIHulVdXrHiEuQDJvnKbSkl","value_type":"USD","transfer_type":"rtp_credit"}}},"fednow_payout":{"title":"fednow_payout","summary":"Stablecoin payout via FedNow","description":"Pays out USD over FedNow from a funded Brale internal Address. The source `value_type` and `transfer_type` must match the token and network held by the source Address. The destination bank Address must be `active` and list `fednow_credit` in `transfer_types`.","value":{"amount":{"value":"1.00","currency":"USD"},"source":{"address_id":"2VcUIonJeVQzFoBuC7LdFT0dRe4","value_type":"USDB","transfer_type":"spark"},"destination":{"address_id":"2MhCCIHulVdXrHiEuQDJvnKbSkl","value_type":"USD","transfer_type":"fednow_credit"}}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"73349738-747b-4e7c-9bcf-083ce0903c32":{"description":"Transfer successfully created. Creation is not settlement. Track `status` until it reaches `complete`, `canceled`, or `failed`.","content":{"*/*":{"schema":{"title":"Transfer","type":"object","description":"A money movement between a source and a destination. Returned by the create, get, and list transfer endpoints. The same shape is used everywhere a Transfer is exposed to API consumers.","properties":{"id":{"title":"Kusid","type":"string","format":"ksuid","pattern":"^[a-zA-Z0-9]{27}$","example":"2VcUIIsgARwVbEGlIYbhg6fGG57","uniqueKey":"id","typeLabel":"string\u003cksuid>"},"status":{"type":"string","description":"Lifecycle stage of the transfer. `compliance review` means Brale holds the transfer for compliance review before sending it, for example when the amount is above a payment partner's transaction limit. From there it moves back to `pending` or on to `processing`, or is canceled. The value contains a space, not an underscore.","enum":["pending","compliance review","processing","complete","canceled","failed","refunding","refunded"],"example":"pending","uniqueKey":"status","typeLabel":"enum\u003cstring>"},"failure":{"oneOf":[{"type":"object","title":"TransferFailure","description":"Structured failure details for a failed transfer. Usually `null`. Populated when `status` is `failed` and Brale has structured failure details for the transfer — most commonly for ACH returns, outbound wire returns, and other rail/provider failures. Clients should not assume `failure` is always present for every failed transfer; check for `null` before reading nested fields.","example":null,"properties":{"type":{"type":"string","description":"Error classification for the failure, for example `ach_return`, `wire_return`, or `fednow_return`.","example":"ach_return","uniqueKey":"failure.oneOf.0.type","typeLabel":"string"},"occurred_at":{"type":"string","format":"date-time","description":"When Brale recorded the failure. This is not necessarily the exact time the bank returned the payment.","example":"2026-04-07T00:05:12.102000Z","uniqueKey":"failure.oneOf.0.occurred_at","typeLabel":"string\u003cdate-time>"},"retriable":{"type":"boolean","description":"Whether the failure is considered retriable. When `true`, Brale may automatically retry the underlying operation; when `false`, the failure is permanent.","example":false,"uniqueKey":"failure.oneOf.0.retriable","typeLabel":"boolean"},"ach_return":{"oneOf":[{"type":"object","description":"ACH-only return details. Present for ACH return failures; `null` or not set for wire returns, on-chain failures, and other rail failures.","properties":{"code":{"type":"string","description":"ACH return code (e.g. `R01` — Insufficient Funds).","example":"R01","uniqueKey":"failure.oneOf.0.ach_return.oneOf.0.code","typeLabel":"string"},"reason":{"type":"string","description":"Human-readable description of the ACH return reason.","example":"Insufficient Funds","uniqueKey":"failure.oneOf.0.ach_return.oneOf.0.reason","typeLabel":"string"},"category":{"type":"string","description":"Simplified taxonomy of the ACH return. `administrative` covers bank issues that may be retriable. `unauthorized` covers customer disputes. `general` covers everything else.","enum":["administrative","unauthorized","general"],"example":"administrative","uniqueKey":"failure.oneOf.0.ach_return.oneOf.0.category","typeLabel":"enum\u003cstring>"}},"uniqueKey":"failure.oneOf.0.ach_return.oneOf.0","typeLabel":"object"},{"type":"null","description":"ACH-only return details. Present for ACH return failures; `null` or not set for wire returns, on-chain failures, and other rail failures.","properties":{"code":{"type":"string","description":"ACH return code (e.g. `R01` — Insufficient Funds).","example":"R01"},"reason":{"type":"string","description":"Human-readable description of the ACH return reason.","example":"Insufficient Funds"},"category":{"type":"string","description":"Simplified taxonomy of the ACH return. `administrative` covers bank issues that may be retriable. `unauthorized` covers customer disputes. `general` covers everything else.","enum":["administrative","unauthorized","general"],"example":"administrative"}},"uniqueKey":"failure.oneOf.0.ach_return.oneOf.1","typeLabel":"null"}],"uniqueKey":"failure.oneOf.0.ach_return","typeLabel":"object | null"},"wire_return":{"oneOf":[{"type":"object","description":"Wire-only return details. Present when `type` is `wire_return` for a returned outbound wire; `null` or not set for other failures. Has no `category` field; the ACH return taxonomy does not apply.","properties":{"code":{"type":"string","description":"The provider's wire return reason code when available (for example, `AC04`). When the provider supplies no code, Brale sets `WIRE_RETURN`, a Brale fallback marker that is not an ISO 20022 bank reason code.","example":"AC04","uniqueKey":"failure.oneOf.0.wire_return.oneOf.0.code","typeLabel":"string"},"reason":{"oneOf":[{"type":"string","description":"Human-readable return reason, when available.","example":"Account closed","uniqueKey":"failure.oneOf.0.wire_return.oneOf.0.reason.oneOf.0","typeLabel":"string"},{"type":"null","description":"Human-readable return reason, when available.","example":"Account closed","uniqueKey":"failure.oneOf.0.wire_return.oneOf.0.reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"failure.oneOf.0.wire_return.oneOf.0.reason","typeLabel":"string | null"}},"uniqueKey":"failure.oneOf.0.wire_return.oneOf.0","typeLabel":"object"},{"type":"null","description":"Wire-only return details. Present when `type` is `wire_return` for a returned outbound wire; `null` or not set for other failures. Has no `category` field; the ACH return taxonomy does not apply.","properties":{"code":{"type":"string","description":"The provider's wire return reason code when available (for example, `AC04`). When the provider supplies no code, Brale sets `WIRE_RETURN`, a Brale fallback marker that is not an ISO 20022 bank reason code.","example":"AC04"},"reason":{"oneOf":[{"type":"string","description":"Human-readable return reason, when available.","example":"Account closed"},{"type":"null","description":"Human-readable return reason, when available.","example":"Account closed"}]}},"uniqueKey":"failure.oneOf.0.wire_return.oneOf.1","typeLabel":"null"}],"uniqueKey":"failure.oneOf.0.wire_return","typeLabel":"object | null"},"fednow_return":{"oneOf":[{"type":"object","description":"FedNow-only return details. Present when `type` is `fednow_return`; `null` or not set for other failures. Has no `category` field; the ACH return taxonomy does not apply.","properties":{"code":{"type":"string","description":"ISO 20022 return reason code (for example, `AC01`).","example":"AC01","uniqueKey":"failure.oneOf.0.fednow_return.oneOf.0.code","typeLabel":"string"},"reason":{"oneOf":[{"type":"string","description":"Human-readable return reason, when available.","example":"Incorrect account number","uniqueKey":"failure.oneOf.0.fednow_return.oneOf.0.reason.oneOf.0","typeLabel":"string"},{"type":"null","description":"Human-readable return reason, when available.","example":"Incorrect account number","uniqueKey":"failure.oneOf.0.fednow_return.oneOf.0.reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"failure.oneOf.0.fednow_return.oneOf.0.reason","typeLabel":"string | null"}},"uniqueKey":"failure.oneOf.0.fednow_return.oneOf.0","typeLabel":"object"},{"type":"null","description":"FedNow-only return details. Present when `type` is `fednow_return`; `null` or not set for other failures. Has no `category` field; the ACH return taxonomy does not apply.","properties":{"code":{"type":"string","description":"ISO 20022 return reason code (for example, `AC01`).","example":"AC01"},"reason":{"oneOf":[{"type":"string","description":"Human-readable return reason, when available.","example":"Incorrect account number"},{"type":"null","description":"Human-readable return reason, when available.","example":"Incorrect account number"}]}},"uniqueKey":"failure.oneOf.0.fednow_return.oneOf.1","typeLabel":"null"}],"uniqueKey":"failure.oneOf.0.fednow_return","typeLabel":"object | null"}},"uniqueKey":"failure.oneOf.0","typeLabel":"TransferFailure · object"},{"type":"null","uniqueKey":"failure.oneOf.1","typeLabel":"null"}],"uniqueKey":"failure","typeLabel":"TransferFailure · object | null"},"source":{"title":"TransferEndpoint","description":"One side (source or destination) of a Transfer. The same shape is used in create requests and in responses. Response-only fields like `transaction_id` and `payment_details` are populated by Brale as the underlying leg settles.","type":"object","properties":{"value_type":{"type":"string","example":"USD","isRequired":true,"uniqueKey":"source.value_type","typeLabel":"string"},"transfer_type":{"type":"string","example":"wire","isRequired":true,"uniqueKey":"source.transfer_type","typeLabel":"string"},"requested_transfer_type":{"type":"string","description":"The rail the client requested. Response-only. Appears when an RTP payout falls back to another rail, in which case `transfer_type` is the rail Brale used.","example":"rtp_credit","uniqueKey":"source.requested_transfer_type","typeLabel":"string"},"address_id":{"title":"Kusid","type":"string","format":"ksuid","pattern":"^[a-zA-Z0-9]{27}$","example":"2VcUIIsgARwVbEGlIYbhg6fGG57","uniqueKey":"source.address_id","typeLabel":"string\u003cksuid>"},"financial_institution_id":{"type":"string","deprecated":true,"description":"Legacy — use `address_id`.","uniqueKey":"source.financial_institution_id","typeLabel":"string"},"wire_memo":{"type":"string","description":"Optional memo or payment reference text sent with outbound wire transfers. Only applies when `transfer_type` is `wire` on the destination leg.","uniqueKey":"source.wire_memo","typeLabel":"string"},"transaction_id":{"type":"string","description":"On-chain transaction hash or off-chain payment reference. Present in responses once the leg has been submitted to the network. Not included in create requests.","example":"0xdd5646ea…","uniqueKey":"source.transaction_id","typeLabel":"string"},"payment_details":{"title":"PaymentDetails","type":"object","description":"Underlying payment metadata for a transfer leg. Response-only. Appears on `source.payment_details` for inbound fiat-funded transfers (wire, ACH, and FedNow) and on `destination.payment_details` for outbound wire and ACH transfers. Optional and may be absent depending on the rail and on whether the underlying bank metadata is available yet. Fields are rail-specific. For example, `imad` applies only to wires and `trace_number` only to ACH. Do not expect wire or ACH identifiers on `fednow_credit` legs.","properties":{"received_at":{"oneOf":[{"type":"string","format":"date-time","description":"When the underlying payment was received or posted.","example":"2026-04-07T00:01:24.514000Z","uniqueKey":"source.payment_details.received_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the underlying payment was received or posted.","example":"2026-04-07T00:01:24.514000Z","uniqueKey":"source.payment_details.received_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"source.payment_details.received_at","typeLabel":"string\u003cdate-time> | null"},"sender_name":{"oneOf":[{"type":"string","description":"Name of the originating sender, when available.","example":"Originator Name","uniqueKey":"source.payment_details.sender_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Name of the originating sender, when available.","example":"Originator Name","uniqueKey":"source.payment_details.sender_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"source.payment_details.sender_name","typeLabel":"string | null"},"sender_bank_name":{"oneOf":[{"type":"string","description":"Originating bank name, when available.","example":"JPMorgan Chase Bank","uniqueKey":"source.payment_details.sender_bank_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Originating bank name, when available.","example":"JPMorgan Chase Bank","uniqueKey":"source.payment_details.sender_bank_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"source.payment_details.sender_bank_name","typeLabel":"string | null"},"sender_bank_routing_number":{"oneOf":[{"type":"string","description":"Originating bank routing number, when available.","example":"000000123","uniqueKey":"source.payment_details.sender_bank_routing_number.oneOf.0","typeLabel":"string"},{"type":"null","description":"Originating bank routing number, when available.","example":"000000123","uniqueKey":"source.payment_details.sender_bank_routing_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"source.payment_details.sender_bank_routing_number","typeLabel":"string | null"},"payment_reference":{"oneOf":[{"type":"string","description":"Sender-provided payment reference or memo, when available. For inbound wires, Brale may also populate this field from \"Instruction for Creditor Agent,\" which some banks label \"Message to receiving bank.\" This fallback is used only when no existing memo, Originator-to-Beneficiary Information (OBI), or remittance reference is available. Existing reference precedence is preserved.","example":"Simulated Wire","uniqueKey":"source.payment_details.payment_reference.oneOf.0","typeLabel":"string"},{"type":"null","description":"Sender-provided payment reference or memo, when available. For inbound wires, Brale may also populate this field from \"Instruction for Creditor Agent,\" which some banks label \"Message to receiving bank.\" This fallback is used only when no existing memo, Originator-to-Beneficiary Information (OBI), or remittance reference is available. Existing reference precedence is preserved.","example":"Simulated Wire","uniqueKey":"source.payment_details.payment_reference.oneOf.1","typeLabel":"null"}],"uniqueKey":"source.payment_details.payment_reference","typeLabel":"string | null"},"imad":{"oneOf":[{"type":"string","description":"Wire IMAD / tracking identifier, when available.","example":"20260406XOIZJDPP953495","uniqueKey":"source.payment_details.imad.oneOf.0","typeLabel":"string"},{"type":"null","description":"Wire IMAD / tracking identifier, when available.","example":"20260406XOIZJDPP953495","uniqueKey":"source.payment_details.imad.oneOf.1","typeLabel":"null"}],"uniqueKey":"source.payment_details.imad","typeLabel":"string | null"},"trace_number":{"oneOf":[{"type":"string","description":"ACH trace identifier for the underlying payment, when available. Appears on `source.payment_details` for inbound ACH-funded transfers and on `destination.payment_details` for outbound ACH transfers (`ach_credit` and `same_day_ach_credit`) once the trace number is assigned.","example":"021000029876543","uniqueKey":"source.payment_details.trace_number.oneOf.0","typeLabel":"string"},{"type":"null","description":"ACH trace identifier for the underlying payment, when available. Appears on `source.payment_details` for inbound ACH-funded transfers and on `destination.payment_details` for outbound ACH transfers (`ach_credit` and `same_day_ach_credit`) once the trace number is assigned.","example":"021000029876543","uniqueKey":"source.payment_details.trace_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"source.payment_details.trace_number","typeLabel":"string | null"},"sent_at":{"oneOf":[{"type":"string","format":"date-time","description":"When the outbound payment was sent, when available. Appears on `destination.payment_details` for outbound wire and ACH transfers.","example":"2026-04-07T00:04:58.000000Z","uniqueKey":"source.payment_details.sent_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the outbound payment was sent, when available. Appears on `destination.payment_details` for outbound wire and ACH transfers.","example":"2026-04-07T00:04:58.000000Z","uniqueKey":"source.payment_details.sent_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"source.payment_details.sent_at","typeLabel":"string\u003cdate-time> | null"},"original_transfer_type":{"oneOf":[{"type":"string","description":"The rail originally requested for the payout. Appears when an RTP payout falls back to another rail.","example":"rtp_credit","uniqueKey":"source.payment_details.original_transfer_type.oneOf.0","typeLabel":"string"},{"type":"null","description":"The rail originally requested for the payout. Appears when an RTP payout falls back to another rail.","example":"rtp_credit","uniqueKey":"source.payment_details.original_transfer_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"source.payment_details.original_transfer_type","typeLabel":"string | null"},"fallback_reason_code":{"oneOf":[{"type":"string","description":"Code for why the payout fell back to another rail. Appears when an RTP payout falls back to another rail.","uniqueKey":"source.payment_details.fallback_reason_code.oneOf.0","typeLabel":"string"},{"type":"null","description":"Code for why the payout fell back to another rail. Appears when an RTP payout falls back to another rail.","uniqueKey":"source.payment_details.fallback_reason_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"source.payment_details.fallback_reason_code","typeLabel":"string | null"},"fallback_reason":{"oneOf":[{"type":"string","description":"Human-readable reason the payout fell back to another rail. Appears when an RTP payout falls back to another rail.","uniqueKey":"source.payment_details.fallback_reason.oneOf.0","typeLabel":"string"},{"type":"null","description":"Human-readable reason the payout fell back to another rail. Appears when an RTP payout falls back to another rail.","uniqueKey":"source.payment_details.fallback_reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"source.payment_details.fallback_reason","typeLabel":"string | null"},"fallback_at":{"oneOf":[{"type":"string","format":"date-time","description":"When the payout fell back to another rail. Appears when an RTP payout falls back to another rail.","uniqueKey":"source.payment_details.fallback_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the payout fell back to another rail. Appears when an RTP payout falls back to another rail.","uniqueKey":"source.payment_details.fallback_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"source.payment_details.fallback_at","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"source.payment_details","typeLabel":"PaymentDetails · object"}},"required":["value_type","transfer_type"],"uniqueKey":"source","typeLabel":"TransferEndpoint · object"},"destination":{"title":"TransferEndpoint","description":"One side (source or destination) of a Transfer. The same shape is used in create requests and in responses. Response-only fields like `transaction_id` and `payment_details` are populated by Brale as the underlying leg settles.","type":"object","properties":{"value_type":{"type":"string","example":"USD","isRequired":true,"uniqueKey":"destination.value_type","typeLabel":"string"},"transfer_type":{"type":"string","example":"wire","isRequired":true,"uniqueKey":"destination.transfer_type","typeLabel":"string"},"requested_transfer_type":{"type":"string","description":"The rail the client requested. Response-only. Appears when an RTP payout falls back to another rail, in which case `transfer_type` is the rail Brale used.","example":"rtp_credit","uniqueKey":"destination.requested_transfer_type","typeLabel":"string"},"address_id":{"title":"Kusid","type":"string","format":"ksuid","pattern":"^[a-zA-Z0-9]{27}$","example":"2VcUIIsgARwVbEGlIYbhg6fGG57","uniqueKey":"destination.address_id","typeLabel":"string\u003cksuid>"},"financial_institution_id":{"type":"string","deprecated":true,"description":"Legacy — use `address_id`.","uniqueKey":"destination.financial_institution_id","typeLabel":"string"},"wire_memo":{"type":"string","description":"Optional memo or payment reference text sent with outbound wire transfers. Only applies when `transfer_type` is `wire` on the destination leg.","uniqueKey":"destination.wire_memo","typeLabel":"string"},"transaction_id":{"type":"string","description":"On-chain transaction hash or off-chain payment reference. Present in responses once the leg has been submitted to the network. Not included in create requests.","example":"0xdd5646ea…","uniqueKey":"destination.transaction_id","typeLabel":"string"},"payment_details":{"title":"PaymentDetails","type":"object","description":"Underlying payment metadata for a transfer leg. Response-only. Appears on `source.payment_details` for inbound fiat-funded transfers (wire, ACH, and FedNow) and on `destination.payment_details` for outbound wire and ACH transfers. Optional and may be absent depending on the rail and on whether the underlying bank metadata is available yet. Fields are rail-specific. For example, `imad` applies only to wires and `trace_number` only to ACH. Do not expect wire or ACH identifiers on `fednow_credit` legs.","properties":{"received_at":{"oneOf":[{"type":"string","format":"date-time","description":"When the underlying payment was received or posted.","example":"2026-04-07T00:01:24.514000Z","uniqueKey":"destination.payment_details.received_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the underlying payment was received or posted.","example":"2026-04-07T00:01:24.514000Z","uniqueKey":"destination.payment_details.received_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"destination.payment_details.received_at","typeLabel":"string\u003cdate-time> | null"},"sender_name":{"oneOf":[{"type":"string","description":"Name of the originating sender, when available.","example":"Originator Name","uniqueKey":"destination.payment_details.sender_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Name of the originating sender, when available.","example":"Originator Name","uniqueKey":"destination.payment_details.sender_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"destination.payment_details.sender_name","typeLabel":"string | null"},"sender_bank_name":{"oneOf":[{"type":"string","description":"Originating bank name, when available.","example":"JPMorgan Chase Bank","uniqueKey":"destination.payment_details.sender_bank_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Originating bank name, when available.","example":"JPMorgan Chase Bank","uniqueKey":"destination.payment_details.sender_bank_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"destination.payment_details.sender_bank_name","typeLabel":"string | null"},"sender_bank_routing_number":{"oneOf":[{"type":"string","description":"Originating bank routing number, when available.","example":"000000123","uniqueKey":"destination.payment_details.sender_bank_routing_number.oneOf.0","typeLabel":"string"},{"type":"null","description":"Originating bank routing number, when available.","example":"000000123","uniqueKey":"destination.payment_details.sender_bank_routing_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"destination.payment_details.sender_bank_routing_number","typeLabel":"string | null"},"payment_reference":{"oneOf":[{"type":"string","description":"Sender-provided payment reference or memo, when available. For inbound wires, Brale may also populate this field from \"Instruction for Creditor Agent,\" which some banks label \"Message to receiving bank.\" This fallback is used only when no existing memo, Originator-to-Beneficiary Information (OBI), or remittance reference is available. Existing reference precedence is preserved.","example":"Simulated Wire","uniqueKey":"destination.payment_details.payment_reference.oneOf.0","typeLabel":"string"},{"type":"null","description":"Sender-provided payment reference or memo, when available. For inbound wires, Brale may also populate this field from \"Instruction for Creditor Agent,\" which some banks label \"Message to receiving bank.\" This fallback is used only when no existing memo, Originator-to-Beneficiary Information (OBI), or remittance reference is available. Existing reference precedence is preserved.","example":"Simulated Wire","uniqueKey":"destination.payment_details.payment_reference.oneOf.1","typeLabel":"null"}],"uniqueKey":"destination.payment_details.payment_reference","typeLabel":"string | null"},"imad":{"oneOf":[{"type":"string","description":"Wire IMAD / tracking identifier, when available.","example":"20260406XOIZJDPP953495","uniqueKey":"destination.payment_details.imad.oneOf.0","typeLabel":"string"},{"type":"null","description":"Wire IMAD / tracking identifier, when available.","example":"20260406XOIZJDPP953495","uniqueKey":"destination.payment_details.imad.oneOf.1","typeLabel":"null"}],"uniqueKey":"destination.payment_details.imad","typeLabel":"string | null"},"trace_number":{"oneOf":[{"type":"string","description":"ACH trace identifier for the underlying payment, when available. Appears on `source.payment_details` for inbound ACH-funded transfers and on `destination.payment_details` for outbound ACH transfers (`ach_credit` and `same_day_ach_credit`) once the trace number is assigned.","example":"021000029876543","uniqueKey":"destination.payment_details.trace_number.oneOf.0","typeLabel":"string"},{"type":"null","description":"ACH trace identifier for the underlying payment, when available. Appears on `source.payment_details` for inbound ACH-funded transfers and on `destination.payment_details` for outbound ACH transfers (`ach_credit` and `same_day_ach_credit`) once the trace number is assigned.","example":"021000029876543","uniqueKey":"destination.payment_details.trace_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"destination.payment_details.trace_number","typeLabel":"string | null"},"sent_at":{"oneOf":[{"type":"string","format":"date-time","description":"When the outbound payment was sent, when available. Appears on `destination.payment_details` for outbound wire and ACH transfers.","example":"2026-04-07T00:04:58.000000Z","uniqueKey":"destination.payment_details.sent_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the outbound payment was sent, when available. Appears on `destination.payment_details` for outbound wire and ACH transfers.","example":"2026-04-07T00:04:58.000000Z","uniqueKey":"destination.payment_details.sent_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"destination.payment_details.sent_at","typeLabel":"string\u003cdate-time> | null"},"original_transfer_type":{"oneOf":[{"type":"string","description":"The rail originally requested for the payout. Appears when an RTP payout falls back to another rail.","example":"rtp_credit","uniqueKey":"destination.payment_details.original_transfer_type.oneOf.0","typeLabel":"string"},{"type":"null","description":"The rail originally requested for the payout. Appears when an RTP payout falls back to another rail.","example":"rtp_credit","uniqueKey":"destination.payment_details.original_transfer_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"destination.payment_details.original_transfer_type","typeLabel":"string | null"},"fallback_reason_code":{"oneOf":[{"type":"string","description":"Code for why the payout fell back to another rail. Appears when an RTP payout falls back to another rail.","uniqueKey":"destination.payment_details.fallback_reason_code.oneOf.0","typeLabel":"string"},{"type":"null","description":"Code for why the payout fell back to another rail. Appears when an RTP payout falls back to another rail.","uniqueKey":"destination.payment_details.fallback_reason_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"destination.payment_details.fallback_reason_code","typeLabel":"string | null"},"fallback_reason":{"oneOf":[{"type":"string","description":"Human-readable reason the payout fell back to another rail. Appears when an RTP payout falls back to another rail.","uniqueKey":"destination.payment_details.fallback_reason.oneOf.0","typeLabel":"string"},{"type":"null","description":"Human-readable reason the payout fell back to another rail. Appears when an RTP payout falls back to another rail.","uniqueKey":"destination.payment_details.fallback_reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"destination.payment_details.fallback_reason","typeLabel":"string | null"},"fallback_at":{"oneOf":[{"type":"string","format":"date-time","description":"When the payout fell back to another rail. Appears when an RTP payout falls back to another rail.","uniqueKey":"destination.payment_details.fallback_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the payout fell back to another rail. Appears when an RTP payout falls back to another rail.","uniqueKey":"destination.payment_details.fallback_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"destination.payment_details.fallback_at","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"destination.payment_details","typeLabel":"PaymentDetails · object"}},"required":["value_type","transfer_type"],"uniqueKey":"destination","typeLabel":"TransferEndpoint · object"},"amount":{"title":"Amount","type":"object","description":"Monetary value with explicit currency","additionalProperties":false,"properties":{"value":{"type":"string","example":"11234.88","isRequired":true,"uniqueKey":"amount.value","typeLabel":"string"},"currency":{"type":"string","example":"USD","isRequired":true,"uniqueKey":"amount.currency","typeLabel":"string"}},"required":["value","currency"],"uniqueKey":"amount","typeLabel":"Amount · object"},"note":{"oneOf":[{"type":"string","description":"Optional free-form note attached to the transfer.","example":null,"uniqueKey":"note.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional free-form note attached to the transfer.","example":null,"uniqueKey":"note.oneOf.1","typeLabel":"null"}],"uniqueKey":"note","typeLabel":"string | null"},"brand":{"oneOf":[{"type":"object","additionalProperties":false,"description":"The Account the transfer was branded as, or `null` when the transfer was not branded. Returned on the create, get, and list transfer endpoints. Use it to confirm that the `brand` you requested was applied. A transfer created with `brand` can still return `null` if Brale sent it unbranded.","required":["account_id"],"properties":{"account_id":{"type":"string","description":"ID of the Account whose identity was used as the brand.","isRequired":true,"uniqueKey":"brand.oneOf.0.account_id","typeLabel":"string"}},"example":null,"uniqueKey":"brand.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":false,"description":"The Account the transfer was branded as, or `null` when the transfer was not branded. Returned on the create, get, and list transfer endpoints. Use it to confirm that the `brand` you requested was applied. A transfer created with `brand` can still return `null` if Brale sent it unbranded.","required":["account_id"],"properties":{"account_id":{"type":"string","description":"ID of the Account whose identity was used as the brand."}},"example":null,"uniqueKey":"brand.oneOf.1","typeLabel":"null"}],"uniqueKey":"brand","typeLabel":"object | null"},"created_by":{"oneOf":[{"type":"object","title":"TransferCreatedBy","description":"Who created the transfer, or `null` when the creator is not one of the exposed types. Returned on the create, get, and list transfer endpoints, on the simulate Automation deposit response, and in the `data` object of `transfer.completed` and `transfer.canceled` webhooks.","required":["type","id"],"example":{"type":"automation","id":"3AjRnDClEzwuCKlRioG3OXMS4pH"},"properties":{"type":{"type":"string","description":"The kind of creator. `user`, `application`, and `automation` identify the Brale user, application, or Automation that created the transfer. `transfer` means the transfer is an on-chain deposit. `brale` means Brale created the transfer.","enum":["brale","user","application","automation","transfer"],"example":"automation","isRequired":true,"uniqueKey":"created_by.oneOf.0.type","typeLabel":"enum\u003cstring>"},"id":{"oneOf":[{"type":"string","description":"ID of the creator. `null` when `type` is `brale`. When `type` is `transfer`, this is the chain and the deposit's on-chain transaction hash in the form `\u003cchain>-\u003chash>`, not a Brale ID.","example":"3AjRnDClEzwuCKlRioG3OXMS4pH","isRequired":true,"uniqueKey":"created_by.oneOf.0.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"ID of the creator. `null` when `type` is `brale`. When `type` is `transfer`, this is the chain and the deposit's on-chain transaction hash in the form `\u003cchain>-\u003chash>`, not a Brale ID.","example":"3AjRnDClEzwuCKlRioG3OXMS4pH","isRequired":true,"uniqueKey":"created_by.oneOf.0.id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"created_by.oneOf.0.id","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"created_by.oneOf.0","typeLabel":"TransferCreatedBy · object"},{"type":"null","uniqueKey":"created_by.oneOf.1","typeLabel":"null"}],"uniqueKey":"created_by","typeLabel":"TransferCreatedBy · object | null"},"automation_id":{"oneOf":[{"type":"string","title":"Kusid","description":"ID of the Automation that created this transfer, when applicable. Omitted for transfers created directly via the API.","format":"ksuid","pattern":"^[a-zA-Z0-9]{27}$","example":"2VcUIIsgARwVbEGlIYbhg6fGG57","uniqueKey":"automation_id.oneOf.0","typeLabel":"string\u003cksuid>"},{"type":"null","uniqueKey":"automation_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"automation_id","typeLabel":"string\u003cksuid> | null"},"funding_simulated":{"type":"boolean","description":"Optional. When returned with a value of `true`, the source funding for this transfer was simulated in testnet rather than coming from a real payment. Not every simulated transfer is guaranteed to include this field. Not present for production-funded transfers.","uniqueKey":"funding_simulated","typeLabel":"boolean"},"created_at":{"type":"string","format":"date-time","example":"2026-01-01T00:00:00Z","uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","example":"2026-01-01T00:00:00Z","uniqueKey":"updated_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"","typeLabel":"Transfer · object"},"examples":{"Example":{"title":"Example","value":{"id":"2VcUIIsgARwVbEGlIYbhg6fGG57","status":"pending","failure":null,"source":{"value_type":"USD","transfer_type":"wire","requested_transfer_type":"rtp_credit","address_id":"2VcUIIsgARwVbEGlIYbhg6fGG57","financial_institution_id":"\u003cstring>","wire_memo":"\u003cstring>","transaction_id":"0xdd5646ea…","payment_details":{"received_at":"2026-04-07T00:01:24.514000Z","sender_name":"Originator Name","sender_bank_name":"JPMorgan Chase Bank","sender_bank_routing_number":"000000123","payment_reference":"Simulated Wire","imad":"20260406XOIZJDPP953495","trace_number":"021000029876543","sent_at":"2026-04-07T00:04:58.000000Z","original_transfer_type":"rtp_credit","fallback_reason_code":"\u003cstring>","fallback_reason":"\u003cstring>","fallback_at":"2023-11-07T05:31:56Z"}},"destination":{"value_type":"USD","transfer_type":"wire","requested_transfer_type":"rtp_credit","address_id":"2VcUIIsgARwVbEGlIYbhg6fGG57","financial_institution_id":"\u003cstring>","wire_memo":"\u003cstring>","transaction_id":"0xdd5646ea…","payment_details":{"received_at":"2026-04-07T00:01:24.514000Z","sender_name":"Originator Name","sender_bank_name":"JPMorgan Chase Bank","sender_bank_routing_number":"000000123","payment_reference":"Simulated Wire","imad":"20260406XOIZJDPP953495","trace_number":"021000029876543","sent_at":"2026-04-07T00:04:58.000000Z","original_transfer_type":"rtp_credit","fallback_reason_code":"\u003cstring>","fallback_reason":"\u003cstring>","fallback_at":"2023-11-07T05:31:56Z"}},"amount":{"value":"11234.88","currency":"USD"},"note":null,"brand":null,"created_by":{"type":"automation","id":"3AjRnDClEzwuCKlRioG3OXMS4pH"},"automation_id":"2VcUIIsgARwVbEGlIYbhg6fGG57","funding_simulated":true,"created_at":"2026-01-01T00:00:00Z","updated_at":"2026-01-01T00:00:00Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"233a9833-856d-41d1-bfdb-0e2c0b133e66":{"description":"The transfer amount is invalid. Known cases include:\n\n- `invalid_amount` with `detail` `Invalid transfer amount`: `amount.value` is not a number (for example, `\"abc\"`).\n- `invalid_amount` with `detail` `Amount must be greater than zero`: `amount.value` is zero or negative.\n- `invalid_amount_currency`: `amount.currency` is not supported for the account (for example, `BTC`).\n","content":{"application/json":{"schema":{"title":"ApiErrorV2","type":"object","description":"Error envelope returned by newer Brale endpoints.","required":["type"],"properties":{"type":{"type":"string","description":"Machine-readable error type identifier.","example":"automation_not_active","isRequired":true,"uniqueKey":"type","typeLabel":"string"},"detail":{"type":"string","description":"Human-readable explanation of the error.","example":"Automation must be active to simulate a deposit","uniqueKey":"detail","typeLabel":"string"},"code":{"type":"string","example":"ValidationError","uniqueKey":"code","typeLabel":"string"},"status":{"type":"integer","example":422,"uniqueKey":"status","typeLabel":"integer"},"values":{"type":"array","items":{"type":"string","uniqueKey":"values.items.[INDEX]","typeLabel":"string"},"uniqueKey":"values","typeLabel":"string[]"}},"uniqueKey":"","typeLabel":"ApiErrorV2 · object"},"examples":{"Example":{"title":"Example","value":{"type":"automation_not_active","detail":"Automation must be active to simulate a deposit","code":"ValidationError","status":422,"values":["\u003cstring>"]}}},"exampleType":"generated"}},"exampleType":"generated"},"9e7dd032-be34-43e6-a270-d14c8444e6a0":{"description":"The request is valid but cannot be processed. Known cases include `insufficient_balance` (the source Address does not hold enough of the source `value_type`) and reuse of an `Idempotency-Key` with a different body or URI. After funding the source Address, retry `insufficient_balance` with the same `Idempotency-Key` and body.\n\nFor an `ach_debit` transfer, Brale can also reject the request when the source bank Address cannot be debited:\n\n- `bank_account_not_linked`: the bank account is not linked through Plaid. Link the bank account before using it for an ACH debit.\n- `bank_account_relink_required`: the bank account's Plaid link has expired. Have the user relink the bank account, then retry.\n- `bank_balance_unavailable`: Brale could not verify the bank account's balance. Retry, or relink the bank account if the error continues.\n- `insufficient_balance`: the transfer amount exceeds the bank account's available balance.\n\nFor a branded transfer, Brale can also reject the request when the Account in `brand.account_id` can't be used as a brand:\n\n- `brand_account_not_verified`: the brand Account is not ready to be used as a brand. Contact support to resolve this, then retry.\n- `brand_account_update_required`: the brand Account can't be used for branded transfers yet. Contact support to resolve this, then retry with the same `Idempotency-Key` and body. Brale does not store this response for the key, so the same request succeeds once support has fixed the brand Account.\n","content":{"application/json":{"schema":{"title":"ApiErrorV2","type":"object","description":"Error envelope returned by newer Brale endpoints.","required":["type"],"properties":{"type":{"type":"string","description":"Machine-readable error type identifier.","example":"automation_not_active","isRequired":true,"uniqueKey":"type","typeLabel":"string"},"detail":{"type":"string","description":"Human-readable explanation of the error.","example":"Automation must be active to simulate a deposit","uniqueKey":"detail","typeLabel":"string"},"code":{"type":"string","example":"ValidationError","uniqueKey":"code","typeLabel":"string"},"status":{"type":"integer","example":422,"uniqueKey":"status","typeLabel":"integer"},"values":{"type":"array","items":{"type":"string","uniqueKey":"values.items.[INDEX]","typeLabel":"string"},"uniqueKey":"values","typeLabel":"string[]"}},"uniqueKey":"","typeLabel":"ApiErrorV2 · object"},"examples":{"Example":{"title":"Example","value":{"type":"automation_not_active","detail":"Automation must be active to simulate a deposit","code":"ValidationError","status":422,"values":["\u003cstring>"]}}},"exampleType":"generated"}},"exampleType":"generated"},"ff044a23-f94d-4405-a46e-23ff658357d3":{"description":"`brand_identity_unavailable`: Brale can't process branded transfers right now. Retry the same request with the same `Idempotency-Key` after a few minutes, and contact support if the error continues. Brale does not store this response for the key.\n","content":{"application/json":{"schema":{"title":"ApiErrorV2","type":"object","description":"Error envelope returned by newer Brale endpoints.","required":["type"],"properties":{"type":{"type":"string","description":"Machine-readable error type identifier.","example":"automation_not_active","isRequired":true,"uniqueKey":"type","typeLabel":"string"},"detail":{"type":"string","description":"Human-readable explanation of the error.","example":"Automation must be active to simulate a deposit","uniqueKey":"detail","typeLabel":"string"},"code":{"type":"string","example":"ValidationError","uniqueKey":"code","typeLabel":"string"},"status":{"type":"integer","example":422,"uniqueKey":"status","typeLabel":"integer"},"values":{"type":"array","items":{"type":"string","uniqueKey":"values.items.[INDEX]","typeLabel":"string"},"uniqueKey":"values","typeLabel":"string[]"}},"uniqueKey":"","typeLabel":"ApiErrorV2 · object"},"examples":{"Example":{"title":"Example","value":{"type":"automation_not_active","detail":"Automation must be active to simulate a deposit","code":"ValidationError","status":422,"values":["\u003cstring>"]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"4b324c94-2450-4d2d-a109-b207e1fdd9e4":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Use the Bearer token returned from the Auth endpoint via OAuth2 client_credentials flow. Include the token in the \"Authorization: Bearer \u003ctoken>\" header.\n","scopes":[],"schemeName":"BearerAuth"}}},"servers":{"8da73adf-e60e-4374-8982-c73a1cf2599d":{"url":"https://api.brale.xyz","description":"Production server"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Use the Bearer token returned from the Auth endpoint via OAuth2 client_credentials flow. Include the token in the \"Authorization: Bearer \u003ctoken>\" header.\n","scopes":[],"schemeName":"BearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Use the Bearer token returned from the Auth endpoint via OAuth2 client_credentials flow. Include the token in the \"Authorization: Bearer \u003ctoken>\" header.\n","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerAuth","name":"Authorization"}],"title":"BearerAuth"}]},"originalFileLocation":"api-reference/brale-openapi.yaml"},"subdomain":"brale","siteName":"Brale","title":"Create a new transfer - Brale","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-09T00:14:04.889Z","originalFileLocation":"api-reference/brale/create-transfer.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Creates a new transfer using the specified source and destination details.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Brale\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/brale/fNz744YuLs689rFY/_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/brale/fNz744YuLs689rFY/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/brale/fNz744YuLs689rFY/_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/brale/fNz744YuLs689rFY/_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/brale/fNz744YuLs689rFY/_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/brale/fNz744YuLs689rFY/_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/brale/fNz744YuLs689rFY/_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/brale/fNz744YuLs689rFY/_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/brale/fNz744YuLs689rFY/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a new transfer - Brale\">\u003cmeta data-mint-head property=\"og:description\" content=\"Creates a new transfer using the specified source and destination details.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Brale\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.brale.xyz/api-reference/brale/create-transfer\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://brale.mintlify.site/_mintlify/api/og/v2?division=Transfers\u0026amp;title=Create+a+new+transfer\u0026amp;description=Creates+a+new+transfer+using+the+specified+source+and+destination+details.\u0026amp;theme=b2b665b22cc0ea8a2264b9db\u0026amp;signature=f5f5cc80c056ccf7146480a658778a4b2c6cc163664e8b19b9994f17d6aaea24\">\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 new transfer - Brale\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Creates a new transfer using the specified source and destination details.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://brale.mintlify.site/_mintlify/api/og/v2?division=Transfers\u0026amp;title=Create+a+new+transfer\u0026amp;description=Creates+a+new+transfer+using+the+specified+source+and+destination+details.\u0026amp;theme=b2b665b22cc0ea8a2264b9db\u0026amp;signature=f5f5cc80c056ccf7146480a658778a4b2c6cc163664e8b19b9994f17d6aaea24\">\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/brale/fNz744YuLs689rFY/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Brale\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#000000\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.brale.xyz/api-reference/brale/create-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/brale/create-transfer.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.brale.xyz/#organization\",\"name\":\"Brale\",\"url\":\"https://docs.brale.xyz\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/brale/8ZhoPWIKA3trPz7_/images/brale/brale-logo-light.svg?fit=max\u0026auto=format\u0026n=8ZhoPWIKA3trPz7_\u0026q=85\u0026s=9d75182cc1a672349f431ab9462b2b14\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.brale.xyz#website\",\"name\":\"Brale\",\"url\":\"https://docs.brale.xyz\",\"publisher\":{\"@id\":\"https://docs.brale.xyz/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.brale.xyz/api-reference/brale/create-transfer#webpage\",\"url\":\"https://docs.brale.xyz/api-reference/brale/create-transfer\",\"name\":\"Create a new transfer\",\"description\":\"Creates a new transfer using the specified source and destination details.\",\"dateModified\":\"2026-11-09T00:14:04.889Z\",\"isPartOf\":{\"@id\":\"https://docs.brale.xyz#website\"},\"breadcrumb\":{\"@id\":\"https://docs.brale.xyz/api-reference/brale/create-transfer#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.brale.xyz/api-reference/brale/create-transfer#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Transfers\",\"item\":\"https://docs.brale.xyz/api-reference/brale/list-transfers\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create a new transfer\",\"item\":\"https://docs.brale.xyz/api-reference/brale/create-transfer\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.brale.xyz/api-reference/brale/create-transfer#apireference\",\"headline\":\"Create a new transfer\",\"name\":\"Create a new transfer\",\"description\":\"Creates a new transfer using the specified source and destination details.\",\"url\":\"https://docs.brale.xyz/api-reference/brale/create-transfer\",\"mainEntityOfPage\":{\"@id\":\"https://docs.brale.xyz/api-reference/brale/create-transfer#webpage\"},\"dateModified\":\"2026-11-09T00:14:04.889Z\",\"publisher\":{\"@id\":\"https://docs.brale.xyz/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.brale.xyz#website\"}}]}\u003c/script>","agentPointerHref":"/api-reference/brale/create-transfer.md","siteName":"Brale","nav":{"global":{"anchors":[{"anchor":"API Keys","icon":"key","href":"https://app.brale.xyz"},{"anchor":"API Logs","icon":"database","href":"https://app.brale.xyz/api?tab=activity"},{"anchor":"Changelog","icon":"clock-rotate-left","href":"/changelog"}]},"tabs":[{"tab":"Information","pages":[{"title":"Information","href":"/documentation/introduction"}]},{"tab":"Tools","pages":[{"title":"Tools","href":"/documentation/commons-stablecoin-format"}]},{"tab":"API Docs","pages":[{"title":"API Docs","href":"/overview/introduction"}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/guides/how-to/get-your-account-id"}]},{"tab":"API reference","groups":[{"group":"API overview","pages":[{"title":"Brale Issuance and Orchestration API","href":"/api-reference/brale-introduction"}]},{"group":"Accounts","pages":[{"title":"Retrieve all accounts","openapi":"GET /accounts","href":"/api-reference/brale/list-accounts"},{"title":"Create a customer account","openapi":"POST /accounts","href":"/api-reference/brale/create-account"},{"title":"Retrieve a customer account","openapi":"GET /accounts/{account_id}","href":"/api-reference/brale/get-account"},{"title":"Stage a Verification Document","openapi":"POST /documents","href":"/api-reference/brale/stage-verification-document"},{"title":"List Verification Documents","openapi":"GET /accounts/{account_id}/verification/documents","href":"/api-reference/brale/list-verification-documents"},{"title":"Link Verification Documents","openapi":"PATCH /accounts/{account_id}","href":"/api-reference/brale/link-verification-documents"}]},{"group":"Addresses","pages":[{"title":"Fetch all addresses","openapi":"GET /accounts/{account_id}/addresses","href":"/api-reference/brale/list-addresses"},{"title":"Retrieve an address","openapi":"GET /accounts/{account_id}/addresses/{address_id}","href":"/api-reference/brale/get-address"},{"title":"Create a new external address","openapi":"POST /accounts/{account_id}/addresses/external","href":"/api-reference/brale/create-address"},{"title":"Create a new internal address","openapi":"POST /accounts/{account_id}/addresses/internal","href":"/api-reference/brale/create-internal-address"},{"title":"Update an Address","openapi":"PATCH /accounts/{account_id}/addresses/{address_id}","href":"/api-reference/brale/update-address"},{"title":"Get an address balance","openapi":"GET /accounts/{account_id}/addresses/{address_id}/balance","href":"/api-reference/brale/get-address-balance"}]},{"group":"Automations (virtual accounts)","pages":[{"title":"Fetch all automations for an account","openapi":"GET /accounts/{account_id}/automations","href":"/api-reference/brale/list-automations"},{"title":"Create an Automation","openapi":"POST /accounts/{account_id}/automations","href":"/api-reference/brale/create-automations"},{"title":"Retrieve a single automation","openapi":"GET /accounts/{account_id}/automations/{id}","href":"/api-reference/brale/get-automations"},{"title":"Archive an Automation","openapi":"PATCH /accounts/{account_id}/automations/{automation_id}","href":"/api-reference/brale/archive-automation"},{"title":"Simulate an Automation deposit","openapi":"api-reference/brale-openapi.yaml POST /accounts/{account_id}/automations/{automation_id}/simulations/deposits","href":"/api-reference/brale/simulate-automation-deposit"}]},{"group":"Transfers","pages":[{"title":"List transfers","sidebarTitle":"List transfers","description":"Returns a paginated list of transfers for a given account, with optional filters.","openapi":"GET /accounts/{account_id}/transfers","href":"/api-reference/brale/list-transfers"},{"title":"Create a new transfer","openapi":"POST /accounts/{account_id}/transfers","href":"/api-reference/brale/create-transfer"},{"title":"Retrieve a single transfer","description":"Retrieve full details for a specific transfer, including source and destination payment details, amount, and status.","openapi":"GET /accounts/{account_id}/transfers/{id}","href":"/api-reference/brale/get-transfer"}]},{"group":"Financial institutions","pages":[{"title":"Fetch all financial institutions","openapi":"GET /accounts/{account_id}/financial-institutions","href":"/api-reference/brale/list-financial-institutions"},{"title":"Create a new external financial institution","openapi":"POST /accounts/{account_id}/financial-institutions/external","href":"/api-reference/brale/create-financial-institution"},{"title":"Fetch a specific financial institution","openapi":"GET /accounts/{account_id}/financial-institutions/{id}","href":"/api-reference/brale/get-financial-institution"},{"title":"Create Plaid link token","openapi":"POST /accounts/{account_id}/plaid/link_token","href":"/api-reference/brale/create-plaid-link-token"},{"title":"Register financial institution account via Plaid and return address ID","openapi":"POST /accounts/{account_id}/plaid/register-account","href":"/api-reference/brale/register-financial-institution-account-via-plaid-and-return-address-id"}]},{"group":"Webhooks","pages":[{"title":"List Webhook Event Types","openapi":"GET /accounts/{account_id}/webhooks/event_types","href":"/api-reference/brale/list-webhook-event-types"},{"title":"Create Webhook Subscription","openapi":"POST /accounts/{account_id}/webhooks","href":"/api-reference/brale/create-webhook-subscription"},{"title":"List Webhook Subscriptions","openapi":"GET /accounts/{account_id}/webhooks","href":"/api-reference/brale/list-webhook-subscriptions"},{"title":"Get Webhook Subscription","openapi":"GET /accounts/{account_id}/webhooks/{subscription_id}","href":"/api-reference/brale/get-webhook-subscription"},{"title":"Update Webhook Subscription","openapi":"PATCH /accounts/{account_id}/webhooks/subscriptions/{subscription_id}","href":"/api-reference/brale/update-webhook-subscription"},{"title":"Archive Webhook Subscription","openapi":"DELETE /accounts/{account_id}/webhooks/subscriptions/{subscription_id}","href":"/api-reference/brale/archive-webhook-subscription"},{"title":"List Webhook Delivery Attempts","openapi":"GET /accounts/{account_id}/webhooks/deliveries","href":"/api-reference/brale/list-webhook-delivery-attempts"}]},{"group":"Tokenization","pages":[{"title":"Create Token Mint","openapi":"POST /accounts/{account_id}/tokens/mints","href":"/api-reference/brale/create-token-mint"},{"title":"List Token Mints","openapi":"GET /accounts/{account_id}/tokens/mints","href":"/api-reference/brale/list-token-mints"},{"title":"Get Token Mint","openapi":"GET /accounts/{account_id}/tokens/mints/{mint_id}","href":"/api-reference/brale/get-token-mint"},{"title":"Create Token Burn","openapi":"POST /accounts/{account_id}/tokens/burns","href":"/api-reference/brale/create-token-burn"},{"title":"List Token Burns","openapi":"GET /accounts/{account_id}/tokens/burns","href":"/api-reference/brale/list-token-burns"},{"title":"Get Token Burn","openapi":"GET /accounts/{account_id}/tokens/burns/{burn_id}","href":"/api-reference/brale/get-token-burn"},{"title":"Create Token Transfer","openapi":"POST /accounts/{account_id}/tokens/transfers","href":"/api-reference/brale/create-token-transfer"},{"title":"List Token Transfers","openapi":"GET /accounts/{account_id}/tokens/transfers","href":"/api-reference/brale/list-token-transfers"},{"title":"Get Token Transfer","openapi":"GET /accounts/{account_id}/tokens/transfers/{transfer_id}","href":"/api-reference/brale/get-token-transfer"}]}]},{"tab":"Brale Status","href":"https://status.brale.xyz"}]},"basePath":"","title":"Create a new transfer - Brale","deploymentId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","buildId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-jJHA3WSo.js","utils-DbZn3Mjn.js","cloneDeep-CnBnaSyy.js","_Uint8Array-CMQtTgBR.js","isObject-FP1Yky1u.js","utils-Bl2DvzOJ.js","addUniqueKeysToSchema-BwOLo9p1.js","snippetPresets-BBiPpKa-.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-C0px4Tml.js","isEqual-zAyttAAO.js","usePlaygroundInputsStore-Dell6dGw.js","shallow-0VKqkSqN.js","getApiPlaygroundDisplay-CP_ctPEB.js","CodeSnippet-5L35ic0s.js","CodeSnippets-DOXbNhJw.js","Page-DRLI_2Ue.js","getPastedJson-VhzT9m2P.js","icon-CD8_AtCO.js","MethodPill-DGgOMftG.js","DuplicateIcon-DZ6A_EtN.js","createIcon-DUl4oM5f.js","DynamicMarkdown-BGHukeRM.js","SectionHeading-ChrEUs8u.js","axios-vUo_bRtp.js","Markdown-Dj-na-_-.js","dist-C5gjFYHe.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-DEBW87tT.js"]}