Set source.value_type to USD and omit source.transfer_type. A USD Automation is not tied to a single deposit rail. Its virtual account accepts the inbound rails enabled for it, such as wire, ACH, and FedNow (on accounts with FedNow enabled). Responses may return source.transfer_type: null.The rail used for each deposit appears on the resulting Transfer in source.transfer_type, for example fednow_credit. This is a Transfer response value, not an Automation setting. See Receive FedNow deposits.
You can optionally include a brand object in the request body to select the verified identity (business or individual) that appears as the beneficiary on the automation’s funding instructions.Both custodial and transactional business or individual accounts can be used as brand.account_id, subject to applicable verification and program eligibility. See Branded Automations for the account-type matrix and ownership rules.
Field
Type
Required
Description
brand
object
No
Controls the beneficiary shown on the Automation’s funding instructions.
brand.account_id
string
Yes (if brand is provided)
The account whose verified identity appears as the beneficiary. Can be the caller’s own account or a managed account. If the account is a business, its business name and address are used. If the account is an individual, the individual’s legal name and address are used.
Default behavior is unchanged. If you omit brand, the beneficiary on funding instructions defaults to Brale. If you include brand.account_id, the beneficiary reflects that account’s verified business or individual identity instead.
The automation is still created under the account in the request path (/accounts/{account_id}/automations). brand.account_id does not change which account owns the automation — it only selects the identity shown on the funding instructions.
Testnet branding. With testnet credentials, you can create branded Automations using a business or individual account you have access to, without completing mainnet KYB/KYC or enabling that account for mainnet. Testnet funding instructions contain placeholder banking details and cannot receive real deposits. To fund a testnet Automation, use Simulate an Automation deposit. Mainnet verification requirements are unchanged.
Pass the account_id of an individual account to render that person’s legal name and address as the beneficiary. On mainnet, the individual account must be KYC-verified. See Individual accounts for how to create one.
Excerpt from retrieving the Automation after it becomes active
This partial response shows only the branded fields. It is not the immediate create response, and it does not contain usable banking instructions. Brale populates the full source.funding_instructions once the Automation becomes active.
{ "status": "active", "source": { "funding_instructions": { "beneficiary_name": "Jane Doe", "beneficiary_address": "123 Main St, Des Moines, IA 50309" } }}
Once the Automation becomes active, source.funding_instructions.beneficiary_name and beneficiary_address in the response reflect the branded account’s verified identity (business name and address, or individual legal name and address).For more details on how branded Automations work, see the Automations concept page.
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
The funding source to configure when creating an automation. Set value_type: USD to accept fiat deposits. Do not send funding instructions. Brale populates source.funding_instructions in the Automation response once the automation becomes active.
Optional. Selects the verified identity shown as the beneficiary on the automation's funding instructions. Pass the account_id of your own account or a managed account (business or individual). Both custodial and transactional accounts can be used, subject to applicable verification and program eligibility. The automation is still created under the account in the request path; brand.account_id only controls the identity rendered on the funding instructions. If omitted, Brale is the default beneficiary.
The funding source for the automation. Set value_type: USD to accept fiat deposits. You do not need to select a deposit rail: a USD Automation's virtual account accepts the inbound rails enabled for your account (wire, ACH, and FedNow where enabled). When the automation becomes active, funding_instructions is populated with the virtual account details to share with the payer. This is Automation configuration. The rail of each deposit is reported on the resulting Transfer's source.transfer_type (for example, fednow_credit), not here.
Optional. Selects the verified identity shown as the beneficiary on the automation's funding instructions. Pass the account_id of your own account or a managed account (business or individual). Both custodial and transactional accounts can be used, subject to applicable verification and program eligibility. The automation is still created under the account in the request path; brand.account_id only controls the identity rendered on the funding instructions. If omitted, Brale is the default beneficiary.
Show child attributes
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":""},"chroma":{"liveDeploymentHistoryId":"6ae896ad21b4422fadc7cf7f","collectionId":"13368399-dd75-4972-9007-761442c9bc8e","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae896ad21b4422fadc7cf7f"},"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":"6ae896ad21b4422fadc7cf7f","clientVersion":"0.0.4045","searchFilterCounts":[{"language":"default","tag":"API reference","count":42},{"language":"default","tag":"Guides","count":24},{"language":"default","tag":"API Docs","count":19},{"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":"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":"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":"llms-txt-v2","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":"byok-sep-25","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/brale/create-automations","slug":"/api-reference/brale/create-automations","pageMetadata":{"title":"Create an Automation","description":"Create an automation that mints stablecoins to a destination wallet when fiat deposits are received.","openapi":"POST /accounts/{account_id}/automations","href":"/api-reference/brale/create-automations"},"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: \"Create an automation that mints stablecoins to a destination wallet when fiat deposits are received.\"\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`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{CodeBlock,Heading,Note,Table}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Use the playground below to try this endpoint directly, or review the OpenAPI details in the right panel.`}),`\n`,_jsx(Heading,{level:`2`,id:`source-configuration`,children:`Source configuration`}),`\n`,_jsxs(_components.p,{children:[`Set `,_jsx(_components.code,{children:`source.value_type`}),` to `,_jsx(_components.code,{children:`USD`}),` and omit `,_jsx(_components.code,{children:`source.transfer_type`}),`. A USD Automation is not tied to a single deposit rail. Its virtual account accepts the inbound rails enabled for it, such as wire, ACH, and FedNow (on accounts with FedNow enabled). Responses may return `,_jsx(_components.code,{children:`source.transfer_type: null`}),`.`]}),`\n`,_jsxs(_components.p,{children:[`The rail used for each deposit appears on the resulting Transfer in `,_jsx(_components.code,{children:`source.transfer_type`}),`, for example `,_jsx(_components.code,{children:`fednow_credit`}),`. This is a Transfer response value, not an Automation setting. See `,_jsx(_components.a,{href:`/guides/fednow-inbound`,children:`Receive FedNow deposits`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`branded-automations`,children:`Branded Automations`}),`\n`,_jsxs(_components.p,{children:[`You can optionally include a `,_jsx(_components.code,{children:`brand`}),` object in the request body to select the verified identity (business or individual) that appears as the beneficiary on the automation’s funding instructions.`]}),`\n`,_jsxs(_components.p,{children:[`Both custodial and transactional business or individual accounts can be used as `,_jsx(_components.code,{children:`brand.account_id`}),`, subject to applicable verification and program eligibility. See `,_jsx(_components.a,{href:`/key-concepts/automations#branded-automations`,children:`Branded Automations`}),` for the account-type matrix and ownership rules.`]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{style:{textAlign:`left`},children:`Field`}),_jsx(_components.th,{style:{textAlign:`left`},children:`Type`}),_jsx(_components.th,{style:{textAlign:`left`},children:`Required`}),_jsx(_components.th,{style:{textAlign:`left`},children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:_jsx(_components.code,{children:`brand`})}),_jsx(_components.td,{style:{textAlign:`left`},children:`object`}),_jsx(_components.td,{style:{textAlign:`left`},children:`No`}),_jsx(_components.td,{style:{textAlign:`left`},children:`Controls the beneficiary shown on the Automation’s funding instructions.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:_jsx(_components.code,{children:`brand.account_id`})}),_jsx(_components.td,{style:{textAlign:`left`},children:`string`}),_jsxs(_components.td,{style:{textAlign:`left`},children:[`Yes (if `,_jsx(_components.code,{children:`brand`}),` is provided)`]}),_jsx(_components.td,{style:{textAlign:`left`},children:`The account whose verified identity appears as the beneficiary. Can be the caller’s own account or a managed account. If the account is a business, its business name and address are used. If the account is an individual, the individual’s legal name and address are used.`})]})]})]}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Default behavior is unchanged.`}),` If you omit `,_jsx(_components.code,{children:`brand`}),`, the beneficiary on funding instructions defaults to Brale. If you include `,_jsx(_components.code,{children:`brand.account_id`}),`, the beneficiary reflects that account’s verified business or individual identity instead.`]})}),`\n`,_jsxs(_components.p,{children:[`The automation is still created under the account in the request path (`,_jsx(_components.code,{children:`/accounts/{account_id}/automations`}),`). `,_jsx(_components.code,{children:`brand.account_id`}),` does not change which account owns the automation — it only selects the identity shown on the funding instructions.`]}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Testnet branding.`}),` With testnet credentials, you can create branded Automations using a business or individual account you have access to, without completing mainnet KYB/KYC or enabling that account for mainnet. Testnet funding instructions contain placeholder banking details and cannot receive real deposits. To fund a testnet Automation, use `,_jsx(_components.a,{href:`/api-reference/brale/simulate-automation-deposit`,children:`Simulate an Automation deposit`}),`. Mainnet verification requirements are unchanged.`]})}),`\n`,_jsx(Heading,{level:`3`,id:`example-branded-automation-request-business-account`,children:`Example: branded automation request (business account)`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`12`,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:`12`,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:` \"name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"XYZ Onramp\"`}),_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:` \"source\"`}),_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:` \"value_type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"USD\"`})]}),`\n`,_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:` \"destination\"`}),_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:` \"address_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2VcUIIsgARwVbEGlIYbhg6fGG57\"`}),_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:` \"value_type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"SBC\"`}),_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:` \"transfer_type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"solana\"`})]}),`\n`,_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:` \"brand\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"account_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"34lCJZ2bxbPAzB3ou67Md01veUo\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`3`,id:`example-branded-automation-request-individual-account`,children:`Example: branded automation request (individual account)`}),`\n`,_jsxs(_components.p,{children:[`Pass the `,_jsx(_components.code,{children:`account_id`}),` of an individual account to render that person’s legal name and address as the beneficiary. On mainnet, the individual account must be KYC-verified. See `,_jsx(_components.a,{href:`/guides/individual-accounts`,children:`Individual accounts`}),` for how to create one.`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`12`,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:`12`,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:` \"name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Jane Doe Onramp\"`}),_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:` \"source\"`}),_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:` \"value_type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"USD\"`})]}),`\n`,_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:` \"destination\"`}),_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:` \"address_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2VcUIIsgARwVbEGlIYbhg6fGG57\"`}),_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:` \"value_type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"SBC\"`}),_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:` \"transfer_type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"solana\"`})]}),`\n`,_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:` \"brand\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"account_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"3Ar9BnQCKIrB3SYjKGBzCtFs6XL\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`4`,id:`excerpt-from-retrieving-the-automation-after-it-becomes-active`,children:`Excerpt from retrieving the Automation after it becomes active`}),`\n`,_jsxs(_components.p,{children:[`This partial response shows only the branded fields. It is not the immediate create response, and it does not contain usable banking instructions. Brale populates the full `,_jsx(_components.code,{children:`source.funding_instructions`}),` once the Automation becomes active.`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`9`,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:`9`,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:` \"status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"active\"`}),_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:` \"source\"`}),_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:` \"funding_instructions\"`}),_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:` \"beneficiary_name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Jane Doe\"`}),_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:` \"beneficiary_address\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"123 Main St, Des Moines, IA 50309\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`Once the Automation becomes active, `,_jsx(_components.code,{children:`source.funding_instructions.beneficiary_name`}),` and `,_jsx(_components.code,{children:`beneficiary_address`}),` in the response reflect the branded account’s verified identity (business name and address, or individual legal name and address).`]}),`\n`,_jsxs(_components.p,{children:[`For more details on how branded Automations work, see the `,_jsx(_components.a,{href:`/key-concepts/automations#branded-automations`,children:`Automations concept page`}),`.`]})]})}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 an Automation","description":"Create an automation that mints stablecoins to a destination wallet when fiat deposits are received.","openapi":"POST /accounts/{account_id}/automations","href":"/api-reference/brale/create-automations"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Source configuration","slug":"source-configuration","depth":2,"children":[]},{"title":"Branded Automations","slug":"branded-automations","depth":2,"children":[{"title":"Example: branded automation request (business account)","slug":"example-branded-automation-request-business-account","depth":3,"children":[]},{"title":"Example: branded automation request (individual account)","slug":"example-branded-automation-request-individual-account","depth":3,"children":[]},{"title":"Excerpt from retrieving the Automation after it becomes active","slug":"excerpt-from-retrieving-the-automation-after-it-becomes-active","depth":4,"children":[]}]}],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Automations"],"operationId":"createAutomations","summary":"Create an Automation","description":"Create an automation that mints stablecoins to a destination wallet when fiat deposits are received.","parameters":["958c2d9e-16b9-48b3-855c-d94a6cced5fe","10c10792-20eb-4c8a-b2fb-a6a3b93ac000"],"requestBody":"c87a223e-4e73-4fcc-ae49-84ebb0130f20","responses":{"201":"cddf2fc4-e2fb-4ea6-85a6-3e5949bbab28"},"method":"post","type":"path","servers":["54af4dfe-5427-4f57-94b2-908300102291"],"security":["fc0ff5ec-f334-41e4-911c-9fbe136ca487"],"path":"/accounts/{account_id}/automations","baseUrlOptions":["https://api.brale.xyz"],"title":"Create an Automation","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"958c2d9e-16b9-48b3-855c-d94a6cced5fe":{"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>"}},"10c10792-20eb-4c8a-b2fb-a6a3b93ac000":{"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":{"title":"AutomationCreateRequest","type":"object","properties":{"name":{"type":"string","example":"XYZ Onramp","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"source":{"title":"AutomationCreateSource","type":"object","description":"The funding source to configure when creating an automation. Set `value_type: USD` to accept fiat deposits. Do not send funding instructions. Brale populates `source.funding_instructions` in the Automation response once the automation becomes active.","properties":{"value_type":{"type":"string","description":"The fiat value type accepted by the automation (e.g. `USD`).","example":"USD","isRequired":true,"uniqueKey":"source.value_type","typeLabel":"string"},"transfer_type":{"oneOf":[{"type":"string","description":"Optional. Omit this field to accept every inbound rail enabled for the virtual account.","uniqueKey":"source.transfer_type.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional. Omit this field to accept every inbound rail enabled for the virtual account.","uniqueKey":"source.transfer_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"source.transfer_type","typeLabel":"string | null"}},"required":["value_type"],"isRequired":true,"uniqueKey":"source","typeLabel":"AutomationCreateSource · object"},"destination":{"title":"AutomationDestination","type":"object","description":"The destination wallet that receives minted stablecoins when the automation is funded.","properties":{"address_id":{"title":"Kusid","type":"string","format":"ksuid","pattern":"^[a-zA-Z0-9]{27}$","example":"2VcUIIsgARwVbEGlIYbhg6fGG57","isRequired":true,"uniqueKey":"destination.address_id","typeLabel":"string\u003cksuid>"},"value_type":{"type":"string","description":"The stablecoin value type minted to the destination (e.g. `SBC`).","example":"SBC","isRequired":true,"uniqueKey":"destination.value_type","typeLabel":"string"},"transfer_type":{"type":"string","description":"The destination chain or rail (e.g. `solana`).","example":"solana","isRequired":true,"uniqueKey":"destination.transfer_type","typeLabel":"string"}},"required":["address_id","value_type","transfer_type"],"isRequired":true,"uniqueKey":"destination","typeLabel":"AutomationDestination · object"},"brand":{"title":"AutomationBrand","type":"object","description":"Optional. Selects the verified identity shown as the beneficiary on the automation's funding instructions. Pass the account_id of your own account or a managed account (business or individual). Both custodial and transactional accounts can be used, subject to applicable verification and program eligibility. The automation is still created under the account in the request path; `brand.account_id` only controls the identity rendered on the funding instructions. If omitted, Brale is the default beneficiary.","properties":{"account_id":{"title":"Kusid","type":"string","format":"ksuid","pattern":"^[a-zA-Z0-9]{27}$","example":"2VcUIIsgARwVbEGlIYbhg6fGG57","description":"The account whose verified identity appears as the beneficiary on wire and ACH funding instructions. For a business account, this is the business name and address. For an individual account, this is the individual's legal name and address.","isRequired":true,"uniqueKey":"brand.account_id","typeLabel":"string\u003cksuid>"}},"required":["account_id"],"uniqueKey":"brand","typeLabel":"AutomationBrand · object"}},"required":["name","source","destination"],"uniqueKey":"","typeLabel":"AutomationCreateRequest · object"},"examples":{"branded":{"title":"branded","value":{"name":"Jane Doe Onramp","source":{"value_type":"USD"},"destination":{"address_id":"2MhCCIHulVdXrHiEuQDJvnKbSkl","value_type":"SBC","transfer_type":"solana"},"brand":{"account_id":"3Ar9BnQCKIrB3SYjKGBzCtFs6XL"}}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"cddf2fc4-e2fb-4ea6-85a6-3e5949bbab28":{"description":"Automation successfully created","content":{"*/*":{"schema":{"title":"Automation","type":"object","properties":{"id":{"title":"Kusid","type":"string","format":"ksuid","pattern":"^[a-zA-Z0-9]{27}$","example":"2VcUIIsgARwVbEGlIYbhg6fGG57","uniqueKey":"id","typeLabel":"string\u003cksuid>"},"name":{"type":"string","example":"XYZ Onramp","uniqueKey":"name","typeLabel":"string"},"status":{"type":"string","description":"The current lifecycle state of the automation.","enum":["pending","active","disabled","archived"],"example":"active","uniqueKey":"status","typeLabel":"enum\u003cstring>"},"source":{"title":"AutomationSource","type":"object","description":"The funding source for the automation. Set `value_type: USD` to accept fiat deposits. You do not need to select a deposit rail: a USD Automation's virtual account accepts the inbound rails enabled for your account (wire, ACH, and FedNow where enabled). When the automation becomes active, `funding_instructions` is populated with the virtual account details to share with the payer. This is Automation configuration. The rail of each deposit is reported on the resulting Transfer's `source.transfer_type` (for example, `fednow_credit`), not here.","properties":{"value_type":{"type":"string","description":"The fiat value type accepted by the automation (e.g. `USD`).","example":"USD","isRequired":true,"uniqueKey":"source.value_type","typeLabel":"string"},"transfer_type":{"oneOf":[{"type":"string","description":"Optional. Omit this field to accept every inbound rail enabled for the virtual account. Responses may return `null`. Do not set it to restrict deposits to FedNow. A null value does not mean FedNow is unavailable.","example":null,"uniqueKey":"source.transfer_type.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional. Omit this field to accept every inbound rail enabled for the virtual account. Responses may return `null`. Do not set it to restrict deposits to FedNow. A null value does not mean FedNow is unavailable.","example":null,"uniqueKey":"source.transfer_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"source.transfer_type","typeLabel":"string | null"},"funding_instructions":{"title":"FundingInstructions","type":"object","description":"Bank details for the virtual account that funds the automation. Populated by Brale once the automation becomes active. Share these coordinates with the payer to fund the automation.","properties":{"beneficiary_name":{"type":"string","example":"Jane Business","uniqueKey":"source.funding_instructions.beneficiary_name","typeLabel":"string"},"bank_name":{"type":"string","example":"Example Bank","uniqueKey":"source.funding_instructions.bank_name","typeLabel":"string"},"bank_address":{"type":"string","example":"456 Commerce St., Des Moines, IA 50309","uniqueKey":"source.funding_instructions.bank_address","typeLabel":"string"},"beneficiary_address":{"type":"string","example":"612 Commerce St., Des Moines, IA 50309","uniqueKey":"source.funding_instructions.beneficiary_address","typeLabel":"string"},"account_number":{"type":"string","description":"Bank account number to fund the automation. On testnet, this field contains the automation's alphanumeric ID as a placeholder, not a numeric bank account number. This applies to both branded and unbranded automations.","example":"123456789","uniqueKey":"source.funding_instructions.account_number","typeLabel":"string"},"routing_number":{"type":"string","example":"063108680","uniqueKey":"source.funding_instructions.routing_number","typeLabel":"string"}},"uniqueKey":"source.funding_instructions","typeLabel":"FundingInstructions · object"}},"required":["value_type"],"uniqueKey":"source","typeLabel":"AutomationSource · object"},"destination":{"title":"AutomationDestination","type":"object","description":"The destination wallet that receives minted stablecoins when the automation is funded.","properties":{"address_id":{"title":"Kusid","type":"string","format":"ksuid","pattern":"^[a-zA-Z0-9]{27}$","example":"2VcUIIsgARwVbEGlIYbhg6fGG57","isRequired":true,"uniqueKey":"destination.address_id","typeLabel":"string\u003cksuid>"},"value_type":{"type":"string","description":"The stablecoin value type minted to the destination (e.g. `SBC`).","example":"SBC","isRequired":true,"uniqueKey":"destination.value_type","typeLabel":"string"},"transfer_type":{"type":"string","description":"The destination chain or rail (e.g. `solana`).","example":"solana","isRequired":true,"uniqueKey":"destination.transfer_type","typeLabel":"string"}},"required":["address_id","value_type","transfer_type"],"uniqueKey":"destination","typeLabel":"AutomationDestination · object"},"created_at":{"type":"string","format":"date-time","example":"2024-01-15T12:34:56Z","uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","example":"2024-01-15T12:34:56Z","uniqueKey":"updated_at","typeLabel":"string\u003cdate-time>"},"brand":{"title":"AutomationBrand","type":"object","description":"Optional. Selects the verified identity shown as the beneficiary on the automation's funding instructions. Pass the account_id of your own account or a managed account (business or individual). Both custodial and transactional accounts can be used, subject to applicable verification and program eligibility. The automation is still created under the account in the request path; `brand.account_id` only controls the identity rendered on the funding instructions. If omitted, Brale is the default beneficiary.","properties":{"account_id":{"title":"Kusid","type":"string","format":"ksuid","pattern":"^[a-zA-Z0-9]{27}$","example":"2VcUIIsgARwVbEGlIYbhg6fGG57","description":"The account whose verified identity appears as the beneficiary on wire and ACH funding instructions. For a business account, this is the business name and address. For an individual account, this is the individual's legal name and address.","isRequired":true,"uniqueKey":"brand.account_id","typeLabel":"string\u003cksuid>"}},"required":["account_id"],"uniqueKey":"brand","typeLabel":"AutomationBrand · object"}},"uniqueKey":"","typeLabel":"Automation · object"},"examples":{"Example":{"title":"Example","value":{"id":"2VcUIIsgARwVbEGlIYbhg6fGG57","name":"XYZ Onramp","status":"active","source":{"value_type":"USD","transfer_type":null,"funding_instructions":{"beneficiary_name":"Jane Business","bank_name":"Example Bank","bank_address":"456 Commerce St., Des Moines, IA 50309","beneficiary_address":"612 Commerce St., Des Moines, IA 50309","account_number":"123456789","routing_number":"063108680"}},"destination":{"address_id":"2VcUIIsgARwVbEGlIYbhg6fGG57","value_type":"SBC","transfer_type":"solana"},"created_at":"2024-01-15T12:34:56Z","updated_at":"2024-01-15T12:34:56Z","brand":{"account_id":"2VcUIIsgARwVbEGlIYbhg6fGG57"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"fc0ff5ec-f334-41e4-911c-9fbe136ca487":{"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":{"54af4dfe-5427-4f57-94b2-908300102291":{"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 an Automation - Brale","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-19T21:42:54.248Z","originalFileLocation":"api-reference/brale/create-automations.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=\"Create an automation that mints stablecoins to a destination wallet when fiat deposits are received.\">\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 an Automation - Brale\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create an automation that mints stablecoins to a destination wallet when fiat deposits are received.\">\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-automations\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://brale.mintlify.app/_mintlify/api/og/v2?division=Automations\u0026amp;title=Create+an+Automation\u0026amp;description=Create+an+automation+that+mints+stablecoins+to+a+destination+wallet+when+fiat+deposits+are+received.\u0026amp;theme=f9794a4d42010719ff4d7810\u0026amp;signature=72172e37a957233a43332f7dcb5b319d13178f7583b9aaa65d6b29d3227e516c\">\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 an Automation - Brale\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create an automation that mints stablecoins to a destination wallet when fiat deposits are received.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://brale.mintlify.app/_mintlify/api/og/v2?division=Automations\u0026amp;title=Create+an+Automation\u0026amp;description=Create+an+automation+that+mints+stablecoins+to+a+destination+wallet+when+fiat+deposits+are+received.\u0026amp;theme=f9794a4d42010719ff4d7810\u0026amp;signature=72172e37a957233a43332f7dcb5b319d13178f7583b9aaa65d6b29d3227e516c\">\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-automations\">\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-automations.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-automations#webpage\",\"url\":\"https://docs.brale.xyz/api-reference/brale/create-automations\",\"name\":\"Create an Automation\",\"description\":\"Create an automation that mints stablecoins to a destination wallet when fiat deposits are received.\",\"dateModified\":\"2026-10-19T21:42:54.248Z\",\"isPartOf\":{\"@id\":\"https://docs.brale.xyz#website\"},\"breadcrumb\":{\"@id\":\"https://docs.brale.xyz/api-reference/brale/create-automations#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.brale.xyz/api-reference/brale/create-automations#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Automations\",\"item\":\"https://docs.brale.xyz/api-reference/brale/list-automations\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create an Automation\",\"item\":\"https://docs.brale.xyz/api-reference/brale/create-automations\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.brale.xyz/api-reference/brale/create-automations#apireference\",\"headline\":\"Create an Automation\",\"name\":\"Create an Automation\",\"description\":\"Create an automation that mints stablecoins to a destination wallet when fiat deposits are received.\",\"url\":\"https://docs.brale.xyz/api-reference/brale/create-automations\",\"mainEntityOfPage\":{\"@id\":\"https://docs.brale.xyz/api-reference/brale/create-automations#webpage\"},\"dateModified\":\"2026-10-19T21:42:54.248Z\",\"publisher\":{\"@id\":\"https://docs.brale.xyz/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.brale.xyz#website\"}}]}\u003c/script>","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","pages":[{"title":"Fetch all automations for an account","description":"Retrieves all automations associated with the specified customer 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","description":"Retrieve full details for a single automation on an account, including its status, destination, and configuration.","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","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","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 an Automation - Brale","buildId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","deploymentId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DCDCdBVX.js","utils-ME8dDnLe.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-0e84ACsd.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-wgRBj-ia.js","snippetPresets-C11Sgb-o.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-C0lapOpP.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-ZeRQV8fF.js","shallow-BupWh095.js","getApiPlaygroundDisplay-BnYQO2Ss.js","CodeSnippet-RKKOc8c_.js","CodeSnippets-Drf_m8wS.js","Page-Bevw23-4.js","getPastedJson-u6QiPzNZ.js","icon-Bb-CBSxO.js","MethodPill-F7l5AI7V.js","DuplicateIcon-IiAXkdSg.js","createIcon-FliI8EBc.js","DynamicMarkdown-B62XqCSI.js","SectionHeading-Dj31pT03.js","axios-vUo_bRtp.js","Markdown-BOgQCTwD.js","clsx-BIWXJmsZ.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DKZWslLH.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-UDqbR6xh.js"]}