The transaction ID will be the same as the quote ID to allow for easy tracking and correlation.You can optionally include custom entity metadata in the metadata field to store your own business data (e.g., reference numbers, categorization, reconciliation data). If not provided during creation, you can add it later using Set metadata.
Some types of transactions require you to pass user context headers, such as X-Uphold-User-Ip and X-Uphold-User-Agent Headers.
Additional contextual errors that occurred while processing the request.
Show child attributes
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Uphold","description":"Documentation for the Uphold Enterprise API Suite: onboard users and move value across banks, cards, and crypto with REST APIs, FIX APIs, and embeddable widgets.","colors":{"primary":"#49CC68","light":"#84FB7F","dark":"#49CC68"},"logo":{"light":"https://mintcdn.com/uphold-d4756e17/7IRkuAa79m7bSPci/_media/logos/uphold-branded-house-horizontal-enterprise-for-light.svg?fit=max\u0026auto=format\u0026n=7IRkuAa79m7bSPci\u0026q=85\u0026s=f60facd63ac72f992db1ece0b4cefaa1","dark":"https://mintcdn.com/uphold-d4756e17/7IRkuAa79m7bSPci/_media/logos/uphold-branded-house-horizontal-enterprise-for-dark.svg?fit=max\u0026auto=format\u0026n=7IRkuAa79m7bSPci\u0026q=85\u0026s=2bef6993603c9b5c473a7eeff0c3bc97"},"favicon":"https://mintcdn.com/uphold-d4756e17/7IRkuAa79m7bSPci/_media/logos/uphold-favicon.svg?fit=max\u0026auto=format\u0026n=7IRkuAa79m7bSPci\u0026q=85\u0026s=fe0c9bdf95c1c4a3ad50ef0dec7b3e97","api":{"examples":{"prefill":true}},"appearance":{"default":"dark"},"background":{"decoration":"gradient"},"navbar":{"links":[],"primary":{"type":"button","label":"Sandbox Access","href":"http://portal.enterprise.uphold.com"}},"footer":{"socials":{"x":"https://x.com/upholdinc","github":"https://github.com/uphold","linkedin":"https://linkedin.com/company/upholdinc"}},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"uphold-d4756e17","hasAudioNarration":false,"actualSubdomain":"uphold-d4756e17","customDomains":["developer.uphold.com"],"gitSource":{"type":"github","owner":"uphold","repo":"enterprise-docs","deployBranch":"master","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6aec6c07802fe9fbb76579c4","collectionId":"04cfd2c1-8ca4-447f-b2e8-0f25e3581d8f","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6aec6c07802fe9fbb76579c4"},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aec6c07802fe9fbb76579c4","clientVersion":"0.0.4071","searchFilterCounts":[{"language":"default","tag":"REST APIs","count":176},{"language":"default","tag":"Core API","count":135},{"language":"default","tag":"Developer Guides","count":69},{"language":"default","tag":"Webhooks","count":40},{"language":"default","tag":"KYC","count":27},{"language":"default","tag":"KYB","count":23},{"language":"default","tag":"Deposit","count":20},{"language":"default","tag":"Withdrawal","count":17},{"language":"default","tag":"Accounts","count":16},{"language":"default","tag":"KYC Connector API","count":15}]},"assistantConfig":{"enableStarterQuestions":false},"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":"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":"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":"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":"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},{"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}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":".card .prose :where(ul>li):not(:where([class~=not-prose],[class~=not-prose] *)){padding-left:1em!important}.card .prose :where(ul>li):not(:where([class~=not-prose],[class~=not-prose] *)):before{left:0em!important}.card-group>.card>img{position:relative;display:inline-block;top:1.25rem;left:1.5rem;margin-bottom:1rem;width:1.5rem;height:1.5rem;object-fit:contain;object-position:left center}.mbs-cap-height-valign,.icon{margin-block-start:calc(1ex - 1cap)}li[data-group-tag]>button{align-items:center}html[data-current-path^=\"/widgets/payment/\"] table td code,html[data-current-path^=\"/widgets/payment/\"] table th code{white-space:nowrap}html[data-current-path^=\"/widgets/payment/\"] table:has(thead th:nth-child(5)){--sticky-col-bg: #ffffff}html.dark[data-current-path^=\"/widgets/payment/\"] table:has(thead th:nth-child(5)){--sticky-col-bg: #0c0d0d}html[data-current-path^=\"/widgets/payment/\"] table:has(thead th:nth-child(5)) th:first-child,html[data-current-path^=\"/widgets/payment/\"] table:has(thead th:nth-child(5)) td:first-child{background-color:var(--sticky-col-bg);left:0;position:sticky;z-index:20}.kyc-connector-errors-table td:first-child{width:35%}html[data-current-path=\"/widgets/payment/introduction\"] #content-container{max-width:unset}html[data-current-path=\"/widgets/kyc/introduction\"] #content-container{max-width:unset}html[data-current-path=\"/get-started/overview\"] [class~=\"@container/page-header\"]{display:none}html[data-current-path=\"/get-started/overview\"] #content-container{max-width:unset}html[data-current-path=\"/get-started/overview\"] [class*=\"max-w-8xl\"]{max-width:unset!important}@media (min-width: 1600px){html[data-current-path=\"/get-started/overview\"] [class*=\"max-w-8xl\"]{max-width:calc(100% - 6cm)!important;margin-left:0!important;margin-right:auto!important}}html[data-current-path=\"/get-started/overview\"] main{margin-top:-10rem}@media (min-width: 1024px){html[data-current-path=\"/get-started/overview\"] main{margin-top:-2.5rem}}@media (max-width: 1023px){html[data-current-path=\"/get-started/overview\"] main{margin-top:-2.5rem}}html[data-current-path=\"/get-started/overview\"] span[style*=\"radial-gradient\"]{display:none!important}.hero-onchain{margin:0 0 0.5rem;font-weight:700;letter-spacing:-0.02em;line-height:1.1;font-size:clamp(1.75rem, 3vw, 2.5rem);text-wrap:balance;color:#0a1f2e}.dark .hero-onchain{color:#ffffff}.hero-onchain .grad{color:#49CC68}.dark .hero-onchain .grad{color:#84FB7F}.hero-onchain-sub{margin:0 0 1.5rem;font-size:1.0625rem;line-height:1.6;color:#4b5563}.dark .hero-onchain-sub{color:#9aa6b2}.hero-onchain-row{display:grid;grid-template-columns:49.2% 36.63%;column-gap:9.09%;align-items:start;padding-right:5.08%;box-sizing:border-box}.hero-onchain-image{max-width:360px}.hero-onchain-image img{width:100%;height:auto;display:block;margin:0}@media (max-width: 768px){.hero-onchain-row{display:block;padding-right:0}.hero-onchain-image{max-width:65%;margin:1.5rem auto 0}}.hero-onchain-eyebrow{margin:0 0 0.5rem;font-size:1rem;line-height:1.5rem;font-weight:600;color:#6b7280}.dark .hero-onchain-eyebrow{color:#9aa6b2}.hero-cta-row{display:flex;align-items:center;flex-wrap:wrap;gap:0.5rem;margin:0 0 1.5rem}.hero-below-image-line{height:1px;margin-top:0.25cm;background:rgba(10, 31, 46, 0.12)}.dark .hero-below-image-line{background:rgba(255, 255, 255, 0.1)}.section-heading{margin:2rem 0 0;font-family:inherit;font-weight:700;font-size:28px;line-height:36px;letter-spacing:-0.2px;color:#0a1f2e}.dark .section-heading{color:#ffffff}.section-subtitle{margin:0 0 2rem;font-size:16px;line-height:20px;font-weight:400;color:#4b5563}.dark .section-subtitle{color:#8494bd}.ov-btn-primary,.ov-btn-secondary{display:inline-flex;align-items:center;gap:0.375rem;padding:0.5rem 0.875rem;border-radius:9999px;font-size:0.875rem;font-weight:600;line-height:1.25rem;white-space:nowrap;border:none;outline:none;box-shadow:none}.ov-btn-primary:hover,.ov-btn-secondary:hover{text-decoration:none;opacity:0.9}.ov-btn-primary{background:#49cc68;color:#0a1f2e}.dark .ov-btn-primary{background:#84fb7f;color:#090d14}.ov-btn-secondary{background:#e5e7eb;color:#1f2937}.dark .ov-btn-secondary{background:#273149;color:#f0f2fa}.ov-btn-icon{display:inline-block;width:0.7rem;height:0.85rem;background-color:currentColor;-webkit-mask:url('/_media/get-started/icon-build-with-ai.svg') center / contain no-repeat;mask:url('/_media/get-started/icon-build-with-ai.svg') center / contain no-repeat}.section-heading.section-heading-gap-lg{margin-top:5rem}.start-building-grid{display:grid;grid-template-columns:repeat(3, 1fr);gap:1.6%}.start-building-card{position:relative;display:block;aspect-ratio:362 / 249;border-radius:16px;overflow:hidden;text-decoration:none!important;background:#141c29}.start-building-card img{position:absolute;inset:0;width:100%;height:100%;object-fit:cover}.start-building-card-content{position:relative;z-index:1;display:flex;flex-direction:column;justify-content:space-between;height:100%;padding:13px 16px 16px;box-sizing:border-box}.start-building-card-title{margin:0 0 4px;font-size:16px;font-weight:600;line-height:20px;color:#84fb7f}.start-building-card-desc{margin:0;max-width:200px;font-size:14px;font-weight:400;line-height:20px;color:#8494bd}.start-building-card-btn{align-self:flex-start;display:inline-flex;align-items:center;padding:0.5rem 0.875rem;border-radius:9999px;font-size:14px;font-weight:600;line-height:20px;white-space:nowrap;background:#273149;color:#f0f2fa}@media (max-width: 768px){.start-building-grid{grid-template-columns:1fr;gap:1rem}}.ready-steps{display:grid;grid-template-columns:repeat(4, 1fr);gap:2rem}.ready-step{position:relative;display:flex;flex-direction:column;gap:1rem}.ready-step:not(:last-child)::after{content:'';position:absolute;top:12px;left:calc(25px + 8px);right:calc(-2rem + 8px);height:4px;border-radius:9999px;background:#141c29}.ready-step-badge{display:flex;align-items:center;justify-content:center;width:25px;height:25px;border-radius:9999px;background:#84fb7f;color:#000e29;font-size:12px;font-weight:600;z-index:1}.ready-step-title{margin:0;font-size:16px;font-weight:600;line-height:20px;color:#84fb7f}.ready-step-desc{margin:0;font-size:14px;font-weight:400;line-height:20px;color:#8494bd}.ready-step-portal-link{color:#8494bd;font-weight:700;text-decoration:underline}@media (max-width: 768px){.ready-steps{grid-template-columns:1fr;gap:2.5rem}.ready-step:not(:last-child)::after{display:none}}html[data-current-path=\"/developer-guides/trade-and-send/trade/interactive-trade-flow\"] #content-container,html[data-current-path=\"/developer-guides/trade-and-send/send/interactive-send-flow\"] #content-container{max-width:unset}html[data-current-path=\"/developer-guides/buy-and-sell/buy/interactive-buy-flow\"] #content-container,html[data-current-path=\"/developer-guides/buy-and-sell/sell/interactive-sell-flow\"] #content-container{max-width:unset}.wizard-step-pane>div>:first-child{margin-top:0!important}@keyframes pulse-ring{0%,100%{box-shadow:0 0 0 0 rgba(53, 177, 61, 0.75),\n 0 0 12px 2px rgba(53, 177, 61, 0.4)}50%{box-shadow:0 0 0 14px rgba(53, 177, 61, 0),\n 0 0 20px 6px rgba(53, 177, 61, 0.15)}}"}],"page":{"pagePath":"rest-apis/core-api/transactions/create-transaction","slug":"/rest-apis/core-api/transactions/create-transaction","pageMetadata":{"openapi":"_media/specs/core-openapi.mintlify.json post /core/transactions","title":"Create transaction","description":"Create transaction from a quote.","href":"/rest-apis/core-api/transactions/create-transaction"},"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 transaction from a quote.\"\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];const RestEndpointSubjects=({subjects=[]})=>{const _components={a:`a`,..._provideComponents()},{Badge}=_components;if(!Badge)_missingMdxReference(`Badge`,true);const subjectToIconMap={\"client\":`browser`,\"user:individual\":`user`,\"user:business\":`briefcase`};if(subjects.length===0){return null}return _jsx(_Fragment,{children:subjects.map(subject=>_jsx(_components.a,{href:`/rest-apis/authentication#subjects`,className:`mint-border-0 mint-opacity-85 hover:mint-opacity-100 mint-transition-opacity`,children:_jsx(Badge,{stroke:true,size:`lg`,icon:subjectToIconMap[subject],color:`gray`,className:`mint-mr-1`,children:subject})},subject))})};function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,..._provideComponents(),...props.components},{Tip,_MdxComponentBoundary}=_components;if(!Tip)_missingMdxReference(`Tip`,true);if(!_MdxComponentBoundary)_missingMdxReference(`_MdxComponentBoundary`,true);return _jsxs(_Fragment,{children:[_jsx(_MdxComponentBoundary,{name:`RestEndpointSubjects`,children:_jsx(RestEndpointSubjects,{subjects:[`user:individual`,`user:business`]})}),`\n`,_jsx(_components.p,{children:`The transaction ID will be the same as the quote ID to allow for easy tracking and correlation.`}),`\n`,_jsxs(_components.p,{children:[`You can optionally include custom `,_jsx(_components.a,{href:`/rest-apis/entity-metadata`,children:`entity metadata`}),` in the `,_jsx(_components.code,{children:`metadata`}),` field to store your own business data (e.g., reference numbers, categorization, reconciliation data). If not provided during creation, you can add it later using `,_jsx(_components.a,{href:`/rest-apis/core-api/metadata/set-metadata`,children:`Set metadata`}),`.`]}),`\n`,_jsxs(Tip,{children:[`Some types of transactions require you to pass `,_jsx(_components.a,{href:`/rest-apis/headers#user-context`,children:`user context`}),` headers, such as `,_jsx(_components.code,{children:`X-Uphold-User-Ip`}),` and `,_jsx(_components.code,{children:`X-Uphold-User-Agent`}),` Headers.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{RestEndpointSubjects,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":{"openapi":"_media/specs/core-openapi.mintlify.json post /core/transactions","title":"Create transaction","description":"Create transaction from a quote.","href":"/rest-apis/core-api/transactions/create-transaction"}}},"mdxSourceWithNoJs":null,"noJsSplices":[[156,780,")=>null;function _cr"]]},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"dynamicCss":".mint-mr-1 {\n margin-right: 0.25rem\n}\n.mint-border-0 {\n border-width: 0px\n}\n.mint-opacity-85 {\n opacity: 0.85\n}\n.mint-transition-opacity {\n transition-property: opacity;\n transition-timing-function: cubic-bezier(0.4, 0, 0.2, 1);\n transition-duration: 150ms\n}\n.hover\\:mint-opacity-100:hover {\n opacity: 1\n}","openApiReferenceData":{"operation":{"operationId":"core.create-transaction","summary":"Create transaction","description":"Create transaction from a quote.","tags":["Transactions"],"x-uphold":{"security":{"OAuth2":{"subjects":["user:business","user:individual"]}}},"security":["d1afceaf-9fda-4fe5-ada6-9a58e5e4fbc4"],"requestBody":"4ce0fc7e-e60d-4af4-9652-b3933a1ad50d","responses":{"201":"db3f41f5-2ce1-4c4b-81ab-10801dd959ad","404":"79f358cc-b55b-4f02-9853-8b8d802daf64","409":"1856546e-9cb5-4f30-a71a-e42f5d5d8b7f"},"method":"post","type":"path","servers":["6fb17518-d629-436e-9656-fdaf251980e5","9c363eda-97e3-4e83-8993-9074e744a002"],"path":"/core/transactions","baseUrlOptions":["https://api.enterprise.sandbox.uphold.com","https://api.enterprise.uphold.com"],"title":"Create transaction","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[{"body.quoteId":"623000c8-9bdf-4a2b-aa3d-6a6b44a7f6a0","body.metadata":{"externalId":123}},{"body.quoteId":"623000c8-9bdf-4a2b-aa3d-6a6b44a7f6a0","body.params.requirements.items.0.oneOf.0.name":"authorize:3ds","body.params.requirements.items.0.oneOf.0.returnUrl":"https://example.com/redirect","body.metadata":{"externalId":123}}]},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"quoteId":{"description":"The quote ID to commit.","type":"string","format":"uuid","isRequired":true,"uniqueKey":"quoteId","typeLabel":"string\u003cuuid>"},"params":{"type":"object","description":"Additional parameters required to create the transaction.","properties":{"requirements":{"description":"The requirements data needed to create the transaction.","type":"array","items":{"oneOf":[{"type":"object","title":"Authorize 3DS","required":["name","returnUrl"],"properties":{"name":{"description":"The name of the requirement.","type":"string","enum":["authorize:3ds"],"isRequired":true,"uniqueKey":"params.requirements.items.[INDEX].oneOf.0.name","typeLabel":"enum\u003cstring>"},"returnUrl":{"description":"The URL to redirect after the 3DS authorization flow.","type":"string","format":"uri","pattern":"^[a-zA-Z][a-zA-Z0-9+\\-.]*:\\/\\/[^\\s]+$","isRequired":true,"uniqueKey":"params.requirements.items.[INDEX].oneOf.0.returnUrl","typeLabel":"string\u003curi>"}},"uniqueKey":"params.requirements.items.[INDEX].oneOf.0","typeLabel":"Authorize 3DS · object"},{"type":"object","title":"Authorize Apple Pay/Google Pay","required":["name","provider","deviceData","tokenizedPayment"],"properties":{"name":{"description":"The name of the requirement.","type":"string","enum":["authorize:apple-pay","authorize:google-pay"],"isRequired":true,"uniqueKey":"params.requirements.items.[INDEX].oneOf.1.name","typeLabel":"enum\u003cstring>"},"provider":{"description":"The provider used for the authorization.","type":"string","enum":["checkout"],"isRequired":true,"uniqueKey":"params.requirements.items.[INDEX].oneOf.1.provider","typeLabel":"enum\u003cstring>"},"deviceData":{"description":"The device data for fraud prevention.","type":"string","isRequired":true,"uniqueKey":"params.requirements.items.[INDEX].oneOf.1.deviceData","typeLabel":"string"},"tokenizedPayment":{"description":"The payload from the payment provider.","type":"object","additionalProperties":true,"isRequired":true,"uniqueKey":"params.requirements.items.[INDEX].oneOf.1.tokenizedPayment","typeLabel":"object"}},"uniqueKey":"params.requirements.items.[INDEX].oneOf.1","typeLabel":"Authorize Apple Pay/Google Pay · object"},{"type":"object","title":"Authorize PayPal/Venmo","required":["name","provider","deviceData"],"properties":{"name":{"description":"The name of the requirement.","type":"string","enum":["authorize:paypal","authorize:venmo"],"isRequired":true,"uniqueKey":"params.requirements.items.[INDEX].oneOf.2.name","typeLabel":"enum\u003cstring>"},"provider":{"description":"The provider used for the authorization.","type":"string","enum":["braintree"],"isRequired":true,"uniqueKey":"params.requirements.items.[INDEX].oneOf.2.provider","typeLabel":"enum\u003cstring>"},"deviceData":{"description":"The device data for fraud prevention.","type":"string","isRequired":true,"uniqueKey":"params.requirements.items.[INDEX].oneOf.2.deviceData","typeLabel":"string"},"tokenizedPayment":{"description":"The payload from the payment provider.","type":"object","properties":{"details":{"description":"The details of the payment provider payload.","type":"object","additionalProperties":true,"uniqueKey":"params.requirements.items.[INDEX].oneOf.2.tokenizedPayment.details","typeLabel":"object"},"nonce":{"description":"The nonce from the payment provider payload.","type":"string","uniqueKey":"params.requirements.items.[INDEX].oneOf.2.tokenizedPayment.nonce","typeLabel":"string"}},"uniqueKey":"params.requirements.items.[INDEX].oneOf.2.tokenizedPayment","typeLabel":"object"}},"uniqueKey":"params.requirements.items.[INDEX].oneOf.2","typeLabel":"Authorize PayPal/Venmo · object"}],"uniqueKey":"params.requirements.items.[INDEX]","typeLabel":"Authorize 3DS · object | Authorize Apple Pay/Google Pay · object | Authorize PayPal/Venmo · object"},"uniqueKey":"params.requirements","typeLabel":"(Authorize 3DS · object | Authorize Apple Pay/Google Pay · object | Authorize PayPal/Venmo · object)[]"},"returnUrl":{"description":"The URL to redirect after the 3DS authorization flow. Deprecated in favor of `requirements`.","deprecated":true,"type":"string","format":"uri","pattern":"^[a-zA-Z][a-zA-Z0-9+\\-.]*:\\/\\/[^\\s]+$","uniqueKey":"params.returnUrl","typeLabel":"string\u003curi>"}},"uniqueKey":"params","typeLabel":"object"},"metadata":{"type":"object","additionalProperties":true,"minProperties":1,"description":"Additional data for the transaction.","uniqueKey":"metadata","typeLabel":"object"}},"required":["quoteId"],"uniqueKey":"","typeLabel":"object"},"examples":{"Create Transaction":{"title":"Create Transaction","value":{"quoteId":"623000c8-9bdf-4a2b-aa3d-6a6b44a7f6a0","metadata":{"externalId":123}}},"Create Card Deposit Transaction":{"title":"Create Card Deposit Transaction","value":{"quoteId":"623000c8-9bdf-4a2b-aa3d-6a6b44a7f6a0","params":{"requirements":[{"name":"authorize:3ds","returnUrl":"https://example.com/redirect"}]},"metadata":{"externalId":123}}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"db3f41f5-2ce1-4c4b-81ab-10801dd959ad":{"description":"Transaction created.","content":{"application/json":{"schema":{"type":"object","properties":{"transaction":{"type":"object","properties":{"id":{"description":"The id of the transaction.","type":"string","format":"uuid","isRequired":true,"uniqueKey":"transaction.id","typeLabel":"string\u003cuuid>"},"origin":{"type":"object","properties":{"asset":{"description":"The asset of the endpoint.","type":"string","isRequired":true,"uniqueKey":"transaction.origin.asset","typeLabel":"string"},"amount":{"description":"The amount of the endpoint.","type":"string","isRequired":true,"uniqueKey":"transaction.origin.amount","typeLabel":"string"},"rate":{"description":"The rate of the endpoint against its counter-part (origin to destination and vice-versa).","type":"string","isRequired":true,"uniqueKey":"transaction.origin.rate","typeLabel":"string"},"node":{"oneOf":[{"type":"object","title":"Account","description":"The node of the endpoint.","required":["type","id","ownerId"],"properties":{"type":{"description":"The type of the node.","type":"string","enum":["account"],"isRequired":true,"uniqueKey":"transaction.origin.node.oneOf.0.type","typeLabel":"enum\u003cstring>"},"id":{"description":"The account id.","type":"string","format":"uuid","isRequired":true,"uniqueKey":"transaction.origin.node.oneOf.0.id","typeLabel":"string\u003cuuid>"},"ownerId":{"description":"The id of the user that owns the account.","type":"string","format":"uuid","isRequired":true,"uniqueKey":"transaction.origin.node.oneOf.0.ownerId","typeLabel":"string\u003cuuid>"}},"isRequired":true,"uniqueKey":"transaction.origin.node.oneOf.0","typeLabel":"Account · object"},{"type":"object","title":"External Account - Bank","description":"The node of the endpoint.","required":["via","network","type","id","ownerId"],"properties":{"type":{"description":"The type of the node.","type":"string","enum":["external-account"],"isRequired":true,"uniqueKey":"transaction.origin.node.oneOf.1.type","typeLabel":"enum\u003cstring>"},"id":{"description":"The external account id.","type":"string","format":"uuid","isRequired":true,"uniqueKey":"transaction.origin.node.oneOf.1.id","typeLabel":"string\u003cuuid>"},"ownerId":{"description":"The id of the user that owns the external account.","type":"string","format":"uuid","isRequired":true,"uniqueKey":"transaction.origin.node.oneOf.1.ownerId","typeLabel":"string\u003cuuid>"},"via":{"type":"string","description":"The rail type through which the transaction is made.","enum":["bank"],"isRequired":true,"uniqueKey":"transaction.origin.node.oneOf.1.via","typeLabel":"enum\u003cstring>"},"network":{"description":"The network used for the transaction with the external account.","type":"string","isRequired":true,"uniqueKey":"transaction.origin.node.oneOf.1.network","typeLabel":"string"}},"isRequired":true,"uniqueKey":"transaction.origin.node.oneOf.1","typeLabel":"External Account - Bank · object"},{"type":"object","title":"External Account - Card","description":"The node of the endpoint.","required":["via","network","type","id","ownerId"],"properties":{"type":{"description":"The type of the node.","type":"string","enum":["external-account"],"isRequired":true,"uniqueKey":"transaction.origin.node.oneOf.2.type","typeLabel":"enum\u003cstring>"},"id":{"description":"The external account id.","type":"string","format":"uuid","isRequired":true,"uniqueKey":"transaction.origin.node.oneOf.2.id","typeLabel":"string\u003cuuid>"},"ownerId":{"description":"The id of the user that owns the external account.","type":"string","format":"uuid","isRequired":true,"uniqueKey":"transaction.origin.node.oneOf.2.ownerId","typeLabel":"string\u003cuuid>"},"via":{"type":"string","description":"The rail type through which the transaction is made.","enum":["card"],"isRequired":true,"uniqueKey":"transaction.origin.node.oneOf.2.via","typeLabel":"enum\u003cstring>"},"network":{"description":"The network used for the transaction with the external account.","type":"string","isRequired":true,"uniqueKey":"transaction.origin.node.oneOf.2.network","typeLabel":"string"},"confirmationUrl":{"description":"The URL to confirm the authorization using the external account (e.g., 3DS).","type":"string","format":"uri","uniqueKey":"transaction.origin.node.oneOf.2.confirmationUrl","typeLabel":"string\u003curi>"}},"isRequired":true,"uniqueKey":"transaction.origin.node.oneOf.2","typeLabel":"External Account - Card · object"},{"type":"object","title":"External Account - APM","description":"The node of the endpoint.","required":["via","type","id","ownerId"],"properties":{"type":{"description":"The type of the node.","type":"string","enum":["external-account"],"isRequired":true,"uniqueKey":"transaction.origin.node.oneOf.3.type","typeLabel":"enum\u003cstring>"},"id":{"description":"The external account id.","type":"string","format":"uuid","isRequired":true,"uniqueKey":"transaction.origin.node.oneOf.3.id","typeLabel":"string\u003cuuid>"},"ownerId":{"description":"The id of the user that owns the external account.","type":"string","format":"uuid","isRequired":true,"uniqueKey":"transaction.origin.node.oneOf.3.ownerId","typeLabel":"string\u003cuuid>"},"via":{"type":"string","description":"The rail type through which the transaction is made.","enum":["apm"],"isRequired":true,"uniqueKey":"transaction.origin.node.oneOf.3.via","typeLabel":"enum\u003cstring>"},"confirmationUrl":{"description":"The URL to confirm the authorization using the external account (e.g., 3DS).","type":"string","format":"uri","uniqueKey":"transaction.origin.node.oneOf.3.confirmationUrl","typeLabel":"string\u003curi>"}},"isRequired":true,"uniqueKey":"transaction.origin.node.oneOf.3","typeLabel":"External Account - APM · object"},{"type":"object","title":"External Account - Crypto","description":"The node of the endpoint.","required":["via","network","type","id","ownerId"],"properties":{"type":{"description":"The type of the node.","type":"string","enum":["external-account"],"isRequired":true,"uniqueKey":"transaction.origin.node.oneOf.4.type","typeLabel":"enum\u003cstring>"},"id":{"description":"The external account id.","type":"string","format":"uuid","isRequired":true,"uniqueKey":"transaction.origin.node.oneOf.4.id","typeLabel":"string\u003cuuid>"},"ownerId":{"description":"The id of the user that owns the external account.","type":"string","format":"uuid","isRequired":true,"uniqueKey":"transaction.origin.node.oneOf.4.ownerId","typeLabel":"string\u003cuuid>"},"via":{"type":"string","description":"The rail type through which the transaction is made.","enum":["crypto"],"isRequired":true,"uniqueKey":"transaction.origin.node.oneOf.4.via","typeLabel":"enum\u003cstring>"},"network":{"description":"The network used for the transaction with the external account.","type":"string","isRequired":true,"uniqueKey":"transaction.origin.node.oneOf.4.network","typeLabel":"string"},"execution":{"oneOf":[{"type":"object","title":"On-chain","description":"The execution details for the transaction.","required":["mode"],"properties":{"mode":{"description":"The mode of execution.","type":"string","enum":["onchain"],"isRequired":true,"uniqueKey":"transaction.origin.node.oneOf.4.execution.oneOf.0.mode","typeLabel":"enum\u003cstring>"},"transactionHash":{"type":"string","pattern":"^\\S.*\\S$|^\\S$","description":"The hash of the transaction in the blockchain.","uniqueKey":"transaction.origin.node.oneOf.4.execution.oneOf.0.transactionHash","typeLabel":"string"}},"uniqueKey":"transaction.origin.node.oneOf.4.execution.oneOf.0","typeLabel":"On-chain · object"},{"type":"object","title":"Off-chain","description":"The execution details for the transaction.","required":["mode"],"properties":{"mode":{"description":"The mode of execution.","type":"string","enum":["offchain"],"isRequired":true,"uniqueKey":"transaction.origin.node.oneOf.4.execution.oneOf.1.mode","typeLabel":"enum\u003cstring>"},"accountId":{"description":"The id of the account on the other side of the off-chain transaction (the recipient's account on a withdrawal, or the sender's account on a deposit).","type":"string","format":"uuid","uniqueKey":"transaction.origin.node.oneOf.4.execution.oneOf.1.accountId","typeLabel":"string\u003cuuid>"},"accountOwnerId":{"description":"The id of the user that owns the account on the other side of the off-chain transaction (the recipient on a withdrawal, or the sender on a deposit).","type":"string","format":"uuid","uniqueKey":"transaction.origin.node.oneOf.4.execution.oneOf.1.accountOwnerId","typeLabel":"string\u003cuuid>"}},"uniqueKey":"transaction.origin.node.oneOf.4.execution.oneOf.1","typeLabel":"Off-chain · object"},{"type":"object","title":"Simulated","description":"The execution details for the transaction.","required":["mode"],"properties":{"mode":{"description":"The mode of execution.","type":"string","enum":["simulated"],"isRequired":true,"uniqueKey":"transaction.origin.node.oneOf.4.execution.oneOf.2.mode","typeLabel":"enum\u003cstring>"},"transactionHash":{"type":"string","pattern":"^\\S.*\\S$|^\\S$","description":"The simulated transaction hash.","uniqueKey":"transaction.origin.node.oneOf.4.execution.oneOf.2.transactionHash","typeLabel":"string"}},"uniqueKey":"transaction.origin.node.oneOf.4.execution.oneOf.2","typeLabel":"Simulated · object"}],"uniqueKey":"transaction.origin.node.oneOf.4.execution","typeLabel":"On-chain · object | Off-chain · object | Simulated · object"}},"isRequired":true,"uniqueKey":"transaction.origin.node.oneOf.4","typeLabel":"External Account - Crypto · object"},{"type":"object","title":"APM","description":"The node of the endpoint.","required":["type","method"],"properties":{"type":{"description":"The type of the node.","type":"string","enum":["apm"],"isRequired":true,"uniqueKey":"transaction.origin.node.oneOf.5.type","typeLabel":"enum\u003cstring>"},"method":{"description":"The alternative payment method to be used in the operation.","enum":["apple-pay","google-pay","paypal","venmo"],"type":"string","isRequired":true,"uniqueKey":"transaction.origin.node.oneOf.5.method","typeLabel":"enum\u003cstring>"},"confirmationUrl":{"description":"The URL to confirm the authorization using the APM (e.g., 3DS).","type":"string","format":"uri","uniqueKey":"transaction.origin.node.oneOf.5.confirmationUrl","typeLabel":"string\u003curi>"}},"isRequired":true,"uniqueKey":"transaction.origin.node.oneOf.5","typeLabel":"APM · object"},{"type":"object","title":"Bank address","description":"The node of the endpoint.","required":["type","network"],"properties":{"type":{"description":"The type of the node.","type":"string","enum":["bank-address"],"isRequired":true,"uniqueKey":"transaction.origin.node.oneOf.6.type","typeLabel":"enum\u003cstring>"},"network":{"description":"The network of the bank transfer.","type":"string","isRequired":true,"uniqueKey":"transaction.origin.node.oneOf.6.network","typeLabel":"string"}},"isRequired":true,"uniqueKey":"transaction.origin.node.oneOf.6","typeLabel":"Bank address · object"},{"type":"object","title":"Crypto address","description":"The node of the endpoint.","required":["type","network"],"properties":{"type":{"description":"The type of the node.","type":"string","enum":["crypto-address"],"isRequired":true,"uniqueKey":"transaction.origin.node.oneOf.7.type","typeLabel":"enum\u003cstring>"},"network":{"type":"string","pattern":"^\\S.*\\S$|^\\S$","description":"The network that the crypto address is on.","isRequired":true,"uniqueKey":"transaction.origin.node.oneOf.7.network","typeLabel":"string"},"address":{"type":"string","pattern":"^\\S.*\\S$|^\\S$","description":"The crypto address (may not be available for deposits).","uniqueKey":"transaction.origin.node.oneOf.7.address","typeLabel":"string"},"reference":{"description":"The additional identifier (e.g., destination tag, memo, or message) for the crypto address.","type":"string","uniqueKey":"transaction.origin.node.oneOf.7.reference","typeLabel":"string"},"execution":{"oneOf":[{"type":"object","title":"On-chain","description":"The execution details for the transaction.","required":["mode"],"properties":{"mode":{"description":"The mode of execution.","type":"string","enum":["onchain"],"isRequired":true,"uniqueKey":"transaction.origin.node.oneOf.7.execution.oneOf.0.mode","typeLabel":"enum\u003cstring>"},"transactionHash":{"type":"string","pattern":"^\\S.*\\S$|^\\S$","description":"The hash of the transaction in the blockchain.","uniqueKey":"transaction.origin.node.oneOf.7.execution.oneOf.0.transactionHash","typeLabel":"string"}},"uniqueKey":"transaction.origin.node.oneOf.7.execution.oneOf.0","typeLabel":"On-chain · object"},{"type":"object","title":"Off-chain","description":"The execution details for the transaction.","required":["mode"],"properties":{"mode":{"description":"The mode of execution.","type":"string","enum":["offchain"],"isRequired":true,"uniqueKey":"transaction.origin.node.oneOf.7.execution.oneOf.1.mode","typeLabel":"enum\u003cstring>"},"accountId":{"description":"The id of the account on the other side of the off-chain transaction (the recipient's account on a withdrawal, or the sender's account on a deposit).","type":"string","format":"uuid","uniqueKey":"transaction.origin.node.oneOf.7.execution.oneOf.1.accountId","typeLabel":"string\u003cuuid>"},"accountOwnerId":{"description":"The id of the user that owns the account on the other side of the off-chain transaction (the recipient on a withdrawal, or the sender on a deposit).","type":"string","format":"uuid","uniqueKey":"transaction.origin.node.oneOf.7.execution.oneOf.1.accountOwnerId","typeLabel":"string\u003cuuid>"}},"uniqueKey":"transaction.origin.node.oneOf.7.execution.oneOf.1","typeLabel":"Off-chain · object"},{"type":"object","title":"Simulated","description":"The execution details for the transaction.","required":["mode"],"properties":{"mode":{"description":"The mode of execution.","type":"string","enum":["simulated"],"isRequired":true,"uniqueKey":"transaction.origin.node.oneOf.7.execution.oneOf.2.mode","typeLabel":"enum\u003cstring>"},"transactionHash":{"type":"string","pattern":"^\\S.*\\S$|^\\S$","description":"The simulated transaction hash.","uniqueKey":"transaction.origin.node.oneOf.7.execution.oneOf.2.transactionHash","typeLabel":"string"}},"uniqueKey":"transaction.origin.node.oneOf.7.execution.oneOf.2","typeLabel":"Simulated · object"}],"uniqueKey":"transaction.origin.node.oneOf.7.execution","typeLabel":"On-chain · object | Off-chain · object | Simulated · object"}},"isRequired":true,"uniqueKey":"transaction.origin.node.oneOf.7","typeLabel":"Crypto address · object"}],"isRequired":true,"uniqueKey":"transaction.origin.node","typeLabel":"Account · object | External Account - Bank · object | External Account - Card · object | External Account - APM · object | External Account - Crypto · object | APM · object | Bank address · object | Crypto address · object"}},"required":["asset","amount","rate","node"],"description":"The origin of the transaction.","isRequired":true,"uniqueKey":"transaction.origin","typeLabel":"object"},"destination":{"type":"object","properties":{"asset":{"description":"The asset of the endpoint.","type":"string","isRequired":true,"uniqueKey":"transaction.destination.asset","typeLabel":"string"},"amount":{"description":"The amount of the endpoint.","type":"string","isRequired":true,"uniqueKey":"transaction.destination.amount","typeLabel":"string"},"rate":{"description":"The rate of the endpoint against its counter-part (origin to destination and vice-versa).","type":"string","isRequired":true,"uniqueKey":"transaction.destination.rate","typeLabel":"string"},"node":{"oneOf":[{"type":"object","title":"Account","description":"The node of the endpoint.","required":["type","id","ownerId"],"properties":{"type":{"description":"The type of the node.","type":"string","enum":["account"],"isRequired":true,"uniqueKey":"transaction.destination.node.oneOf.0.type","typeLabel":"enum\u003cstring>"},"id":{"description":"The account id.","type":"string","format":"uuid","isRequired":true,"uniqueKey":"transaction.destination.node.oneOf.0.id","typeLabel":"string\u003cuuid>"},"ownerId":{"description":"The id of the user that owns the account.","type":"string","format":"uuid","isRequired":true,"uniqueKey":"transaction.destination.node.oneOf.0.ownerId","typeLabel":"string\u003cuuid>"}},"isRequired":true,"uniqueKey":"transaction.destination.node.oneOf.0","typeLabel":"Account · object"},{"type":"object","title":"External Account - Bank","description":"The node of the endpoint.","required":["via","network","type","id","ownerId"],"properties":{"type":{"description":"The type of the node.","type":"string","enum":["external-account"],"isRequired":true,"uniqueKey":"transaction.destination.node.oneOf.1.type","typeLabel":"enum\u003cstring>"},"id":{"description":"The external account id.","type":"string","format":"uuid","isRequired":true,"uniqueKey":"transaction.destination.node.oneOf.1.id","typeLabel":"string\u003cuuid>"},"ownerId":{"description":"The id of the user that owns the external account.","type":"string","format":"uuid","isRequired":true,"uniqueKey":"transaction.destination.node.oneOf.1.ownerId","typeLabel":"string\u003cuuid>"},"via":{"type":"string","description":"The rail type through which the transaction is made.","enum":["bank"],"isRequired":true,"uniqueKey":"transaction.destination.node.oneOf.1.via","typeLabel":"enum\u003cstring>"},"network":{"description":"The network used for the transaction with the external account.","type":"string","isRequired":true,"uniqueKey":"transaction.destination.node.oneOf.1.network","typeLabel":"string"}},"isRequired":true,"uniqueKey":"transaction.destination.node.oneOf.1","typeLabel":"External Account - Bank · object"},{"type":"object","title":"External Account - Card","description":"The node of the endpoint.","required":["via","network","type","id","ownerId"],"properties":{"type":{"description":"The type of the node.","type":"string","enum":["external-account"],"isRequired":true,"uniqueKey":"transaction.destination.node.oneOf.2.type","typeLabel":"enum\u003cstring>"},"id":{"description":"The external account id.","type":"string","format":"uuid","isRequired":true,"uniqueKey":"transaction.destination.node.oneOf.2.id","typeLabel":"string\u003cuuid>"},"ownerId":{"description":"The id of the user that owns the external account.","type":"string","format":"uuid","isRequired":true,"uniqueKey":"transaction.destination.node.oneOf.2.ownerId","typeLabel":"string\u003cuuid>"},"via":{"type":"string","description":"The rail type through which the transaction is made.","enum":["card"],"isRequired":true,"uniqueKey":"transaction.destination.node.oneOf.2.via","typeLabel":"enum\u003cstring>"},"network":{"description":"The network used for the transaction with the external account.","type":"string","isRequired":true,"uniqueKey":"transaction.destination.node.oneOf.2.network","typeLabel":"string"},"confirmationUrl":{"description":"The URL to confirm the authorization using the external account (e.g., 3DS).","type":"string","format":"uri","uniqueKey":"transaction.destination.node.oneOf.2.confirmationUrl","typeLabel":"string\u003curi>"}},"isRequired":true,"uniqueKey":"transaction.destination.node.oneOf.2","typeLabel":"External Account - Card · object"},{"type":"object","title":"External Account - APM","description":"The node of the endpoint.","required":["via","type","id","ownerId"],"properties":{"type":{"description":"The type of the node.","type":"string","enum":["external-account"],"isRequired":true,"uniqueKey":"transaction.destination.node.oneOf.3.type","typeLabel":"enum\u003cstring>"},"id":{"description":"The external account id.","type":"string","format":"uuid","isRequired":true,"uniqueKey":"transaction.destination.node.oneOf.3.id","typeLabel":"string\u003cuuid>"},"ownerId":{"description":"The id of the user that owns the external account.","type":"string","format":"uuid","isRequired":true,"uniqueKey":"transaction.destination.node.oneOf.3.ownerId","typeLabel":"string\u003cuuid>"},"via":{"type":"string","description":"The rail type through which the transaction is made.","enum":["apm"],"isRequired":true,"uniqueKey":"transaction.destination.node.oneOf.3.via","typeLabel":"enum\u003cstring>"},"confirmationUrl":{"description":"The URL to confirm the authorization using the external account (e.g., 3DS).","type":"string","format":"uri","uniqueKey":"transaction.destination.node.oneOf.3.confirmationUrl","typeLabel":"string\u003curi>"}},"isRequired":true,"uniqueKey":"transaction.destination.node.oneOf.3","typeLabel":"External Account - APM · object"},{"type":"object","title":"External Account - Crypto","description":"The node of the endpoint.","required":["via","network","type","id","ownerId"],"properties":{"type":{"description":"The type of the node.","type":"string","enum":["external-account"],"isRequired":true,"uniqueKey":"transaction.destination.node.oneOf.4.type","typeLabel":"enum\u003cstring>"},"id":{"description":"The external account id.","type":"string","format":"uuid","isRequired":true,"uniqueKey":"transaction.destination.node.oneOf.4.id","typeLabel":"string\u003cuuid>"},"ownerId":{"description":"The id of the user that owns the external account.","type":"string","format":"uuid","isRequired":true,"uniqueKey":"transaction.destination.node.oneOf.4.ownerId","typeLabel":"string\u003cuuid>"},"via":{"type":"string","description":"The rail type through which the transaction is made.","enum":["crypto"],"isRequired":true,"uniqueKey":"transaction.destination.node.oneOf.4.via","typeLabel":"enum\u003cstring>"},"network":{"description":"The network used for the transaction with the external account.","type":"string","isRequired":true,"uniqueKey":"transaction.destination.node.oneOf.4.network","typeLabel":"string"},"execution":{"oneOf":[{"type":"object","title":"On-chain","description":"The execution details for the transaction.","required":["mode"],"properties":{"mode":{"description":"The mode of execution.","type":"string","enum":["onchain"],"isRequired":true,"uniqueKey":"transaction.destination.node.oneOf.4.execution.oneOf.0.mode","typeLabel":"enum\u003cstring>"},"transactionHash":{"type":"string","pattern":"^\\S.*\\S$|^\\S$","description":"The hash of the transaction in the blockchain.","uniqueKey":"transaction.destination.node.oneOf.4.execution.oneOf.0.transactionHash","typeLabel":"string"}},"uniqueKey":"transaction.destination.node.oneOf.4.execution.oneOf.0","typeLabel":"On-chain · object"},{"type":"object","title":"Off-chain","description":"The execution details for the transaction.","required":["mode"],"properties":{"mode":{"description":"The mode of execution.","type":"string","enum":["offchain"],"isRequired":true,"uniqueKey":"transaction.destination.node.oneOf.4.execution.oneOf.1.mode","typeLabel":"enum\u003cstring>"},"accountId":{"description":"The id of the account on the other side of the off-chain transaction (the recipient's account on a withdrawal, or the sender's account on a deposit).","type":"string","format":"uuid","uniqueKey":"transaction.destination.node.oneOf.4.execution.oneOf.1.accountId","typeLabel":"string\u003cuuid>"},"accountOwnerId":{"description":"The id of the user that owns the account on the other side of the off-chain transaction (the recipient on a withdrawal, or the sender on a deposit).","type":"string","format":"uuid","uniqueKey":"transaction.destination.node.oneOf.4.execution.oneOf.1.accountOwnerId","typeLabel":"string\u003cuuid>"}},"uniqueKey":"transaction.destination.node.oneOf.4.execution.oneOf.1","typeLabel":"Off-chain · object"},{"type":"object","title":"Simulated","description":"The execution details for the transaction.","required":["mode"],"properties":{"mode":{"description":"The mode of execution.","type":"string","enum":["simulated"],"isRequired":true,"uniqueKey":"transaction.destination.node.oneOf.4.execution.oneOf.2.mode","typeLabel":"enum\u003cstring>"},"transactionHash":{"type":"string","pattern":"^\\S.*\\S$|^\\S$","description":"The simulated transaction hash.","uniqueKey":"transaction.destination.node.oneOf.4.execution.oneOf.2.transactionHash","typeLabel":"string"}},"uniqueKey":"transaction.destination.node.oneOf.4.execution.oneOf.2","typeLabel":"Simulated · object"}],"uniqueKey":"transaction.destination.node.oneOf.4.execution","typeLabel":"On-chain · object | Off-chain · object | Simulated · object"}},"isRequired":true,"uniqueKey":"transaction.destination.node.oneOf.4","typeLabel":"External Account - Crypto · object"},{"type":"object","title":"APM","description":"The node of the endpoint.","required":["type","method"],"properties":{"type":{"description":"The type of the node.","type":"string","enum":["apm"],"isRequired":true,"uniqueKey":"transaction.destination.node.oneOf.5.type","typeLabel":"enum\u003cstring>"},"method":{"description":"The alternative payment method to be used in the operation.","enum":["apple-pay","google-pay","paypal","venmo"],"type":"string","isRequired":true,"uniqueKey":"transaction.destination.node.oneOf.5.method","typeLabel":"enum\u003cstring>"},"confirmationUrl":{"description":"The URL to confirm the authorization using the APM (e.g., 3DS).","type":"string","format":"uri","uniqueKey":"transaction.destination.node.oneOf.5.confirmationUrl","typeLabel":"string\u003curi>"}},"isRequired":true,"uniqueKey":"transaction.destination.node.oneOf.5","typeLabel":"APM · object"},{"type":"object","title":"Bank address","description":"The node of the endpoint.","required":["type","network"],"properties":{"type":{"description":"The type of the node.","type":"string","enum":["bank-address"],"isRequired":true,"uniqueKey":"transaction.destination.node.oneOf.6.type","typeLabel":"enum\u003cstring>"},"network":{"description":"The network of the bank transfer.","type":"string","isRequired":true,"uniqueKey":"transaction.destination.node.oneOf.6.network","typeLabel":"string"}},"isRequired":true,"uniqueKey":"transaction.destination.node.oneOf.6","typeLabel":"Bank address · object"},{"type":"object","title":"Crypto address","description":"The node of the endpoint.","required":["type","network"],"properties":{"type":{"description":"The type of the node.","type":"string","enum":["crypto-address"],"isRequired":true,"uniqueKey":"transaction.destination.node.oneOf.7.type","typeLabel":"enum\u003cstring>"},"network":{"type":"string","pattern":"^\\S.*\\S$|^\\S$","description":"The network that the crypto address is on.","isRequired":true,"uniqueKey":"transaction.destination.node.oneOf.7.network","typeLabel":"string"},"address":{"type":"string","pattern":"^\\S.*\\S$|^\\S$","description":"The crypto address (may not be available for deposits).","uniqueKey":"transaction.destination.node.oneOf.7.address","typeLabel":"string"},"reference":{"description":"The additional identifier (e.g., destination tag, memo, or message) for the crypto address.","type":"string","uniqueKey":"transaction.destination.node.oneOf.7.reference","typeLabel":"string"},"execution":{"oneOf":[{"type":"object","title":"On-chain","description":"The execution details for the transaction.","required":["mode"],"properties":{"mode":{"description":"The mode of execution.","type":"string","enum":["onchain"],"isRequired":true,"uniqueKey":"transaction.destination.node.oneOf.7.execution.oneOf.0.mode","typeLabel":"enum\u003cstring>"},"transactionHash":{"type":"string","pattern":"^\\S.*\\S$|^\\S$","description":"The hash of the transaction in the blockchain.","uniqueKey":"transaction.destination.node.oneOf.7.execution.oneOf.0.transactionHash","typeLabel":"string"}},"uniqueKey":"transaction.destination.node.oneOf.7.execution.oneOf.0","typeLabel":"On-chain · object"},{"type":"object","title":"Off-chain","description":"The execution details for the transaction.","required":["mode"],"properties":{"mode":{"description":"The mode of execution.","type":"string","enum":["offchain"],"isRequired":true,"uniqueKey":"transaction.destination.node.oneOf.7.execution.oneOf.1.mode","typeLabel":"enum\u003cstring>"},"accountId":{"description":"The id of the account on the other side of the off-chain transaction (the recipient's account on a withdrawal, or the sender's account on a deposit).","type":"string","format":"uuid","uniqueKey":"transaction.destination.node.oneOf.7.execution.oneOf.1.accountId","typeLabel":"string\u003cuuid>"},"accountOwnerId":{"description":"The id of the user that owns the account on the other side of the off-chain transaction (the recipient on a withdrawal, or the sender on a deposit).","type":"string","format":"uuid","uniqueKey":"transaction.destination.node.oneOf.7.execution.oneOf.1.accountOwnerId","typeLabel":"string\u003cuuid>"}},"uniqueKey":"transaction.destination.node.oneOf.7.execution.oneOf.1","typeLabel":"Off-chain · object"},{"type":"object","title":"Simulated","description":"The execution details for the transaction.","required":["mode"],"properties":{"mode":{"description":"The mode of execution.","type":"string","enum":["simulated"],"isRequired":true,"uniqueKey":"transaction.destination.node.oneOf.7.execution.oneOf.2.mode","typeLabel":"enum\u003cstring>"},"transactionHash":{"type":"string","pattern":"^\\S.*\\S$|^\\S$","description":"The simulated transaction hash.","uniqueKey":"transaction.destination.node.oneOf.7.execution.oneOf.2.transactionHash","typeLabel":"string"}},"uniqueKey":"transaction.destination.node.oneOf.7.execution.oneOf.2","typeLabel":"Simulated · object"}],"uniqueKey":"transaction.destination.node.oneOf.7.execution","typeLabel":"On-chain · object | Off-chain · object | Simulated · object"}},"isRequired":true,"uniqueKey":"transaction.destination.node.oneOf.7","typeLabel":"Crypto address · object"}],"isRequired":true,"uniqueKey":"transaction.destination.node","typeLabel":"Account · object | External Account - Bank · object | External Account - Card · object | External Account - APM · object | External Account - Crypto · object | APM · object | Bank address · object | Crypto address · object"}},"required":["asset","amount","rate","node"],"description":"The destination of the transaction.","isRequired":true,"uniqueKey":"transaction.destination","typeLabel":"object"},"fees":{"type":"array","items":{"type":"object","properties":{"type":{"description":"The type of the fee.","type":"string","enum":["deposit","exchange","network","withdrawal"],"isRequired":true,"uniqueKey":"transaction.fees.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"code":{"description":"The code of the fee.","type":"string","isRequired":true,"uniqueKey":"transaction.fees.items.[INDEX].code","typeLabel":"string"},"asset":{"description":"The asset in which the fee is denominated.","type":"string","isRequired":true,"uniqueKey":"transaction.fees.items.[INDEX].asset","typeLabel":"string"},"amount":{"description":"The amount of the fee.","type":"string","isRequired":true,"uniqueKey":"transaction.fees.items.[INDEX].amount","typeLabel":"string"},"percentage":{"description":"The percentage of the fee, if the amount was calculated from a percentage.","type":"string","uniqueKey":"transaction.fees.items.[INDEX].percentage","typeLabel":"string"},"beneficiary":{"description":"The entity that receives the fee.","type":"string","enum":["uphold","partner"],"uniqueKey":"transaction.fees.items.[INDEX].beneficiary","typeLabel":"enum\u003cstring>"}},"required":["type","code","asset","amount"],"uniqueKey":"transaction.fees.items.[INDEX]","typeLabel":"object"},"description":"The fees of the transaction.","isRequired":true,"uniqueKey":"transaction.fees","typeLabel":"object[]"},"status":{"description":"Status of the transaction.","type":"string","enum":["processing","on-hold","completed","failed"],"isRequired":true,"uniqueKey":"transaction.status","typeLabel":"enum\u003cstring>"},"quotedAt":{"description":"The time at which the quote was created.","type":"string","format":"date-time","isRequired":true,"uniqueKey":"transaction.quotedAt","typeLabel":"string\u003cdate-time>"},"createdAt":{"description":"The time at which the transaction was created.","type":"string","format":"date-time","isRequired":true,"uniqueKey":"transaction.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"description":"The last time at which the transaction was updated.","type":"string","format":"date-time","isRequired":true,"uniqueKey":"transaction.updatedAt","typeLabel":"string\u003cdate-time>"},"denomination":{"type":"object","properties":{"asset":{"description":"The asset in which the transaction is denominated.","type":"string","isRequired":true,"uniqueKey":"transaction.denomination.asset","typeLabel":"string"},"amount":{"description":"The amount of the transaction.","type":"string","isRequired":true,"uniqueKey":"transaction.denomination.amount","typeLabel":"string"},"rate":{"description":"The rate against the specified target (origin or destination).","type":"string","isRequired":true,"uniqueKey":"transaction.denomination.rate","typeLabel":"string"},"target":{"description":"Whether this exact amount should be paid by the origin or received by the destination.","type":"string","enum":["origin","destination"],"isRequired":true,"uniqueKey":"transaction.denomination.target","typeLabel":"enum\u003cstring>"}},"required":["asset","amount","rate","target"],"description":"The denomination of the transaction.","uniqueKey":"transaction.denomination","typeLabel":"object"},"statusDetails":{"description":"The details of the status of the transaction.","type":"object","properties":{"reason":{"description":"The reason why the transaction failed or is on hold.","type":"string","enum":["apm-account-holder-data-mismatch","apm-authorization-failed","apm-missing-account-holder-data","apm-payment-method-declined","bank-account-holder-name-mismatch","beneficiary-country-restricted","card-declined","card-declined-by-bank","card-expired","card-permanently-declined-by-bank","card-unauthorized","card-unsupported","card-withdrawals-unsupported","insufficient-funds","pending-requests-for-information","provider-maximum-limit-exceeded","screening-verification-failed","travel-rule-verification-failed","unspecified-error","velocity"],"uniqueKey":"transaction.statusDetails.reason","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transaction.statusDetails","typeLabel":"object"},"completedAt":{"description":"The date and time the transaction was completed.","type":"string","format":"date-time","uniqueKey":"transaction.completedAt","typeLabel":"string\u003cdate-time>"}},"required":["id","origin","destination","fees","status","createdAt","updatedAt","quotedAt"],"isRequired":true,"uniqueKey":"transaction","typeLabel":"object"},"errors":{"description":"Additional contextual errors that occurred while processing the request.","type":"object","properties":{"metadata":{"type":"object","description":"Error related to metadata processing.","required":["code","message"],"properties":{"code":{"description":"A short string with a brief explanation about the code reported.","type":"string","isRequired":true,"uniqueKey":"errors.metadata.code","typeLabel":"string"},"message":{"description":"A human-readable message providing more details.","type":"string","isRequired":true,"uniqueKey":"errors.metadata.message","typeLabel":"string"},"details":{"description":"Additional information about the feedback reported.","type":"object","additionalProperties":true,"uniqueKey":"errors.metadata.details","typeLabel":"object"}},"uniqueKey":"errors.metadata","typeLabel":"object"}},"uniqueKey":"errors","typeLabel":"object"}},"required":["transaction"],"uniqueKey":"","typeLabel":"object"},"examples":{"Trade Transaction Created":{"title":"Trade Transaction Created","value":{"transaction":{"id":"623000c8-9bdf-4a2b-aa3d-6a6b44a7f6a0","origin":{"amount":"100.00","asset":"GBP","rate":"47619.04761904762","node":{"type":"account","id":"b98e4f0d-a67d-4126-a99d-666f7e0315d9","ownerId":"e4ce04dc-67b7-4e9f-af91-482cb6f9fc4a"}},"destination":{"amount":"0.0021","asset":"BTC","rate":"0.000021","node":{"type":"account","id":"555a99a1-620d-4431-a0ac-b43e1aad2bdc","ownerId":"e4ce04dc-67b7-4e9f-af91-482cb6f9fc4a"}},"denomination":{"amount":"100.00","asset":"GBP","target":"origin","rate":"1"},"fees":[],"status":"processing","quotedAt":"2024-07-24T15:02:39.000Z","createdAt":"2024-07-24T15:22:39.000Z","updatedAt":"2024-07-24T15:32:39.000Z"}}},"Transaction Created With Metadata Error":{"title":"Transaction Created With Metadata Error","value":{"transaction":{"id":"623000c8-9bdf-4a2b-aa3d-6a6b44a7f6a0","origin":{"amount":"100.00","asset":"GBP","rate":"47619.04761904762","node":{"type":"account","id":"b98e4f0d-a67d-4126-a99d-666f7e0315d9","ownerId":"e4ce04dc-67b7-4e9f-af91-482cb6f9fc4a"}},"destination":{"amount":"0.0021","asset":"BTC","rate":"0.000021","node":{"type":"account","id":"555a99a1-620d-4431-a0ac-b43e1aad2bdc","ownerId":"e4ce04dc-67b7-4e9f-af91-482cb6f9fc4a"}},"denomination":{"amount":"100.00","asset":"GBP","target":"origin","rate":"1"},"fees":[],"status":"processing","quotedAt":"2024-07-24T15:02:39.000Z","createdAt":"2024-07-24T15:22:39.000Z","updatedAt":"2024-07-24T15:32:39.000Z"},"errors":{"metadata":{"code":"content_too_large","message":"The entity metadata size is greater than maximum size limit","details":{"threshold":{"unit":"characters","limit":1024}}}}}},"Deposit From External Account Created (Card)":{"title":"Deposit From External Account Created (Card)","value":{"transaction":{"id":"623000c8-9bdf-4a2b-aa3d-6a6b44a7f6a0","origin":{"amount":"100.00","asset":"GBP","rate":"47619.04761904762","node":{"type":"external-account","via":"card","id":"b98e4f0d-a67d-4126-a99d-666f7e0315d9","confirmationUrl":"https://authentication-devices.sandbox.checkout.com/sessions-interceptor/sid_zrih63pnk6ietkpuerqiyd5zga","ownerId":"e4ce04dc-67b7-4e9f-af91-482cb6f9fc4a","network":"visa"}},"destination":{"amount":"0.0021","asset":"BTC","rate":"0.000021","node":{"type":"account","id":"555a99a1-620d-4431-a0ac-b43e1aad2bdc","ownerId":"e4ce04dc-67b7-4e9f-af91-482cb6f9fc4a"}},"denomination":{"amount":"100.00","asset":"GBP","target":"origin","rate":"1"},"fees":[],"status":"processing","quotedAt":"2024-07-24T15:02:39.000Z","createdAt":"2024-07-24T15:22:39.000Z","updatedAt":"2024-07-24T15:32:39.000Z"}}},"Withdrawal To External Account Created":{"title":"Withdrawal To External Account Created","value":{"transaction":{"id":"623000c8-9bdf-4a2b-aa3d-6a6b44a7f6a0","origin":{"amount":"100.00","asset":"GBP","rate":"47619.04761904762","node":{"type":"account","id":"b98e4f0d-a67d-4126-a99d-666f7e0315d9","ownerId":"e4ce04dc-67b7-4e9f-af91-482cb6f9fc4a"}},"destination":{"amount":"0.0021","asset":"BTC","rate":"0.000021","node":{"type":"external-account","via":"bank","id":"555a99a1-620d-4431-a0ac-b43e1aad2bdc","ownerId":"e4ce04dc-67b7-4e9f-af91-482cb6f9fc4a","network":"fps"}},"denomination":{"amount":"100.00","asset":"GBP","target":"origin","rate":"1"},"fees":[],"status":"processing","quotedAt":"2024-07-24T15:02:39.000Z","createdAt":"2024-07-24T15:22:39.000Z","updatedAt":"2024-07-24T15:32:39.000Z"}}},"Withdrawal to Crypto Address Created (On-chain)":{"title":"Withdrawal to Crypto Address Created (On-chain)","value":{"transaction":{"id":"623000c8-9bdf-4a2b-aa3d-6a6b44a7f6a0","origin":{"amount":"0.00121023","asset":"BTC","rate":"0.00002629253259492961","node":{"type":"account","id":"b98e4f0d-a67d-4126-a99d-666f7e0315d9","ownerId":"e4ce04dc-67b7-4e9f-af91-482cb6f9fc4a"}},"destination":{"amount":"0.00121023","asset":"BTC","rate":"1","node":{"type":"crypto-address","address":"1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa","network":"bitcoin","execution":{"mode":"onchain","transactionHash":"c555dc3f57478014298929b95639b9e5d9b75d4d91e16620c839b47cfefe0c76"}}},"denomination":{"amount":"100.00","asset":"GBP","target":"origin","rate":"0.00001210225938333485"},"fees":[],"status":"processing","quotedAt":"2024-07-24T15:02:39.000Z","createdAt":"2024-07-24T15:22:39.000Z","updatedAt":"2024-07-24T15:32:39.000Z"}}},"Withdrawal to Crypto Address Created (Off-chain)":{"title":"Withdrawal to Crypto Address Created (Off-chain)","value":{"transaction":{"id":"623000c8-9bdf-4a2b-aa3d-6a6b44a7f6a0","origin":{"amount":"0.00121023","asset":"BTC","rate":"0.00002629253259492961","node":{"type":"account","id":"b98e4f0d-a67d-4126-a99d-666f7e0315d9","ownerId":"e4ce04dc-67b7-4e9f-af91-482cb6f9fc4a"}},"destination":{"amount":"0.00121023","asset":"BTC","rate":"1","node":{"type":"crypto-address","address":"1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa","network":"bitcoin","execution":{"mode":"offchain","accountId":"d4c0dabb-79f1-4aec-9850-8bd6981275d5","accountOwnerId":"459762a5-fab0-43d1-9b55-1c92135779f9"}}},"denomination":{"amount":"100.00","asset":"GBP","target":"origin","rate":"0.00001210225938333485"},"fees":[],"status":"processing","quotedAt":"2024-07-24T15:02:39.000Z","createdAt":"2024-07-24T15:22:39.000Z","updatedAt":"2024-07-24T15:32:39.000Z"}}},"Withdrawal to Crypto Address Created (Simulated)":{"title":"Withdrawal to Crypto Address Created (Simulated)","value":{"transaction":{"id":"623000c8-9bdf-4a2b-aa3d-6a6b44a7f6a0","origin":{"amount":"0.00121023","asset":"BTC","rate":"0.00002629253259492961","node":{"type":"account","id":"b98e4f0d-a67d-4126-a99d-666f7e0315d9","ownerId":"e4ce04dc-67b7-4e9f-af91-482cb6f9fc4a"}},"destination":{"amount":"0.00121023","asset":"BTC","rate":"1","node":{"type":"crypto-address","address":"1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa","network":"bitcoin","execution":{"mode":"simulated","transactionHash":"c555dc3f57478014298929b95639b9e5d9b75d4d91e16620c839b47cfefe0c76"}}},"denomination":{"amount":"100.00","asset":"GBP","target":"origin","rate":"0.00001210225938333485"},"fees":[],"status":"processing","quotedAt":"2024-07-24T15:02:39.000Z","createdAt":"2024-07-24T15:22:39.000Z","updatedAt":"2024-07-24T15:32:39.000Z"}}}},"exampleType":"examples"}},"headers":{"x-uphold-request-id":{"description":"A unique identifier for the request that can be shared with Uphold for troubleshooting purposes.","required":true,"schema":{"type":"string"},"examples":{"Request ID":{"value":"a4e390583b3ac581-MRS"}}}},"exampleType":"examples"},"79f358cc-b55b-4f02-9853-8b8d802daf64":{"description":"Resource not found.","content":{"application/json":{"schema":{"type":"object","description":"The error information.","required":["code","message"],"properties":{"code":{"description":"A short string with a brief explanation about the code reported.","type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"description":"A human-readable message providing more details.","type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"details":{"description":"Additional information about the feedback reported.","type":"object","additionalProperties":true,"uniqueKey":"details","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Quote Not Found":{"title":"Quote Not Found","value":{"code":"entity_not_found","message":"The quote cannot be found","details":{"entity":"quote"}}},"Origin Not Found":{"title":"Origin Not Found","value":{"code":"entity_not_found","message":"The origin cannot be found","details":{"entity":"account","context":"body","property":"origin"}}},"Destination Not Found":{"title":"Destination Not Found","value":{"code":"entity_not_found","message":"The destination cannot be found","details":{"entity":"account","context":"body","property":"destination"}}}},"exampleType":"examples"}},"headers":{"x-uphold-request-id":{"description":"A unique identifier for the request that can be shared with Uphold for troubleshooting purposes.","required":true,"schema":{"type":"string"},"examples":{"Request ID":{"value":"a4e390583b3ac581-MRS"}}}},"exampleType":"examples"},"1856546e-9cb5-4f30-a71a-e42f5d5d8b7f":{"description":"Business logic error.","content":{"application/json":{"schema":{"type":"object","description":"The error information.","required":["code","message"],"properties":{"code":{"description":"A short string with a brief explanation about the code reported.","type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"description":"A human-readable message providing more details.","type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"details":{"description":"Additional information about the feedback reported.","type":"object","additionalProperties":true,"uniqueKey":"details","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Insufficient Balance":{"title":"Insufficient Balance","value":{"code":"insufficient_balance","message":"The origin does not have enough balance to perform the transaction","details":{"context":"body","property":"origin"}}},"Missing User Context":{"title":"Missing User Context","value":{"code":"operation_not_allowed","message":"Request not allowed due to missing user context","details":{"reasons":["missing-user-ip-header","missing-user-agent-header"]}}},"Missing Return URL":{"title":"Missing Return URL","value":{"code":"operation_not_allowed","message":"Transaction not allowed due to a missing return URL","details":{"reasons":["missing-return-url"]}}},"Duplicate Withdrawal":{"title":"Duplicate Withdrawal","value":{"code":"operation_not_allowed","message":"Transaction not allowed due to a duplicate withdrawal","details":{"reasons":["duplicate-withdrawal"]}}},"Duplicate Deposit":{"title":"Duplicate Deposit","value":{"code":"operation_not_allowed","message":"Transaction not allowed due to a duplicate deposit","details":{"reasons":["duplicate-deposit"]}}},"Quote Rate Variance Not Allowed":{"title":"Quote Rate Variance Not Allowed","value":{"code":"operation_not_allowed","message":"Transaction not allowed due to high quote rate variance","details":{"reasons":["quote-rate-variance-not-allowed"]}}},"Country Restricted Transaction":{"title":"Country Restricted Transaction","value":{"code":"operation_not_allowed","message":"Transaction not allowed due to a country-restricted violation","details":{"reasons":["country-restricted-transaction"]}}},"Card Declined":{"title":"Card Declined","value":{"code":"operation_not_allowed","message":"Transaction not allowed due to the card being declined","details":{"reasons":["card-declined"]}}},"Processing Failure":{"title":"Processing Failure","value":{"code":"operation_not_allowed","message":"Transaction not allowed due to a processing failure","details":{"reasons":["card-unauthorized"]}}},"User Capability Failure":{"title":"User Capability Failure","value":{"code":"user_capability_failure","message":"The user has capability constraints","details":{"capability":{"code":"trades","requirements":["user-must-submit-identity"],"restrictions":[]}}}},"Amount Exceeds Periodic Limit":{"title":"Amount Exceeds Periodic Limit","value":{"code":"transaction_amount_invalid","message":"The amount exceeds the daily limit","details":{"context":"body","property":"denomination","rule":"amount-exceeds-daily-limit","limit":{"maximumAmount":"100.00","remainingAmount":"80.00"}}}},"Amount Maximum Limit Exceeded":{"title":"Amount Maximum Limit Exceeded","value":{"code":"transaction_amount_invalid","message":"The amount maximum limit was exceeded","details":{"context":"body","property":"denomination","rule":"maximum-limit-exceeded","limit":{"maximumAmount":150}}}},"Amount Minimum Limit Not Met":{"title":"Amount Minimum Limit Not Met","value":{"code":"transaction_amount_invalid","message":"The amount minimum limit was not met","details":{"context":"body","property":"denomination","rule":"minimum-limit-not-met","limit":{"minimumAmount":0.85}}}},"Unspecified Error":{"title":"Unspecified Error","value":{"code":"operation_not_allowed","message":"Transaction not allowed due to an unspecified error","details":{"reasons":["unspecified-error"]}}}},"exampleType":"examples"}},"headers":{"x-uphold-request-id":{"description":"A unique identifier for the request that can be shared with Uphold for troubleshooting purposes.","required":true,"schema":{"type":"string"},"examples":{"Request ID":{"value":"a4e390583b3ac581-MRS"}}}},"exampleType":"examples"}},"security":{"d1afceaf-9fda-4fe5-ada6-9a58e5e4fbc4":{"OAuth2":{"type":"oauth2","description":"OAuth 2.0 authentication.","flows":{"clientCredentials":{"tokenUrl":"/core/oauth2/token","scopes":{"core.users:act-on-behalf-of":"Grants access to act on behalf of a user","core.users:create":"Grants access to create users","core.users:read":"Grants access to view users","core.users:delete":"Grants access to delete users","core.users.metadata:read":"Grants access to view user metadata","core.users.metadata:write":"Grants access to modify user metadata","core.kyc:read":"Grants access to view KYC processes","core.kyc.profile:update":"Grants access to update profile KYC process","core.kyc.address:update":"Grants access to update address KYC process","core.kyc.email:update":"Grants access to update email KYC process","core.kyc.phone:update":"Grants access to update phone KYC process","core.kyc.identity:update":"Grants access to update identity KYC process","core.kyc.proof-of-address:update":"Grants access to update proof-of-address KYC process","core.kyc.customer-due-diligence:update":"Grants access to update customer due diligence KYC process","core.kyc.enhanced-due-diligence:update":"Grants access to update enhanced due diligence KYC process","core.kyc.crypto-risk-assessment:update":"Grants access to update crypto risk assessment KYC process","core.kyc.self-categorization-statement:update":"Grants access to update self-categorization statement KYC process","core.kyc.tax-details:update":"Grants access to update tax details KYC process","core.kyb:read":"Grants access to view KYB processes","core.kyb.profile:update":"Grants access to update profile KYB process","core.kyb.documents:update":"Grants access to update documents KYB process","core.kyb.financial-institution:update":"Grants access to update financial institution KYB process","core.kyb.associated-persons:create":"Grants access to create KYB associated persons","core.kyb.associated-persons:read":"Grants access to view KYB associated persons","core.kyb.associated-persons:delete":"Grants access to delete KYB associated persons","core.kyb.associated-persons.profile:update":"Grants access to update profile KYB associated person process","core.kyb.associated-persons.identity:update":"Grants access to update identity KYB associated person process","core.kyb.associated-persons.proof-of-address:update":"Grants access to update proof-of-address KYB associated person process","core.kyb.attestation:trigger":"Grants access to trigger the attestation process","core.capabilities:read":"Grants access to view user capabilities","core.terms-of-service:read":"Grants access to view terms of service","core.terms-of-service:accept":"Grants access to accept terms of service","core.files:create":"Grants access to create files","core.files:read":"Grants access to view files","core.files.metadata:read":"Grants access to view files metadata","core.files.metadata:write":"Grants access to modify files metadata","core.accounts:create":"Grants access to create accounts","core.accounts:read":"Grants access to view accounts","core.accounts:update":"Grants access to update accounts","core.accounts:archive":"Grants access to archive accounts","core.accounts:deposit-method":"Grants access to deposit method needed for depositing into accounts","core.accounts:use-test-helpers":"Grants access to test helpers of accounts","core.accounts.metadata:read":"Grants access to view accounts metadata","core.accounts.metadata:write":"Grants access to modify accounts metadata","core.assets:use-test-helpers":"Grants access to test helpers of assets","core.external-accounts:create":"Grants access to create external accounts","core.external-accounts:read":"Grants access to view external accounts","core.external-accounts:update":"Grants access to update external accounts","core.external-accounts:delete":"Grants access to delete external accounts","core.external-accounts.metadata:read":"Grants access to view external accounts metadata","core.external-accounts.metadata:write":"Grants access to modify external accounts metadata","core.transactions:create":"Grants access to commit quotes","core.transactions:read":"Grants access to view transactions","core.transactions.metadata:read":"Grants access to view transactions metadata","core.transactions.metadata:write":"Grants access to modify transactions metadata","core.transactions.requests-for-information:read":"Grants access to view transactions requests for information","core.transactions.requests-for-information:update":"Grants access to update transactions requests for information","core.requests-for-information:read":"Grants access to view requests for information","core.requests-for-information:update":"Grants access to update requests for information","core.portfolio:read":"Grants access to view portfolio overview, performance, and historical balance","core.statements:read":"Grants access to read statements","core.webhooks:management-link":"Grants access to create webhook management links"}}},"scopes":["core.transactions:create"],"schemeName":"OAuth2"}}},"servers":{"6fb17518-d629-436e-9656-fdaf251980e5":{"url":"https://api.enterprise.sandbox.uphold.com","description":"Sandbox"},"9c363eda-97e3-4e83-8993-9074e744a002":{"url":"https://api.enterprise.uphold.com","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"oauth2","description":"OAuth 2.0 authentication.","flows":{"clientCredentials":{"tokenUrl":"/core/oauth2/token","scopes":{"core.users:act-on-behalf-of":"Grants access to act on behalf of a user","core.users:create":"Grants access to create users","core.users:read":"Grants access to view users","core.users:delete":"Grants access to delete users","core.users.metadata:read":"Grants access to view user metadata","core.users.metadata:write":"Grants access to modify user metadata","core.kyc:read":"Grants access to view KYC processes","core.kyc.profile:update":"Grants access to update profile KYC process","core.kyc.address:update":"Grants access to update address KYC process","core.kyc.email:update":"Grants access to update email KYC process","core.kyc.phone:update":"Grants access to update phone KYC process","core.kyc.identity:update":"Grants access to update identity KYC process","core.kyc.proof-of-address:update":"Grants access to update proof-of-address KYC process","core.kyc.customer-due-diligence:update":"Grants access to update customer due diligence KYC process","core.kyc.enhanced-due-diligence:update":"Grants access to update enhanced due diligence KYC process","core.kyc.crypto-risk-assessment:update":"Grants access to update crypto risk assessment KYC process","core.kyc.self-categorization-statement:update":"Grants access to update self-categorization statement KYC process","core.kyc.tax-details:update":"Grants access to update tax details KYC process","core.kyb:read":"Grants access to view KYB processes","core.kyb.profile:update":"Grants access to update profile KYB process","core.kyb.documents:update":"Grants access to update documents KYB process","core.kyb.financial-institution:update":"Grants access to update financial institution KYB process","core.kyb.associated-persons:create":"Grants access to create KYB associated persons","core.kyb.associated-persons:read":"Grants access to view KYB associated persons","core.kyb.associated-persons:delete":"Grants access to delete KYB associated persons","core.kyb.associated-persons.profile:update":"Grants access to update profile KYB associated person process","core.kyb.associated-persons.identity:update":"Grants access to update identity KYB associated person process","core.kyb.associated-persons.proof-of-address:update":"Grants access to update proof-of-address KYB associated person process","core.kyb.attestation:trigger":"Grants access to trigger the attestation process","core.capabilities:read":"Grants access to view user capabilities","core.terms-of-service:read":"Grants access to view terms of service","core.terms-of-service:accept":"Grants access to accept terms of service","core.files:create":"Grants access to create files","core.files:read":"Grants access to view files","core.files.metadata:read":"Grants access to view files metadata","core.files.metadata:write":"Grants access to modify files metadata","core.accounts:create":"Grants access to create accounts","core.accounts:read":"Grants access to view accounts","core.accounts:update":"Grants access to update accounts","core.accounts:archive":"Grants access to archive accounts","core.accounts:deposit-method":"Grants access to deposit method needed for depositing into accounts","core.accounts:use-test-helpers":"Grants access to test helpers of accounts","core.accounts.metadata:read":"Grants access to view accounts metadata","core.accounts.metadata:write":"Grants access to modify accounts metadata","core.assets:use-test-helpers":"Grants access to test helpers of assets","core.external-accounts:create":"Grants access to create external accounts","core.external-accounts:read":"Grants access to view external accounts","core.external-accounts:update":"Grants access to update external accounts","core.external-accounts:delete":"Grants access to delete external accounts","core.external-accounts.metadata:read":"Grants access to view external accounts metadata","core.external-accounts.metadata:write":"Grants access to modify external accounts metadata","core.transactions:create":"Grants access to commit quotes","core.transactions:read":"Grants access to view transactions","core.transactions.metadata:read":"Grants access to view transactions metadata","core.transactions.metadata:write":"Grants access to modify transactions metadata","core.transactions.requests-for-information:read":"Grants access to view transactions requests for information","core.transactions.requests-for-information:update":"Grants access to update transactions requests for information","core.requests-for-information:read":"Grants access to view requests for information","core.requests-for-information:update":"Grants access to update requests for information","core.portfolio:read":"Grants access to view portfolio overview, performance, and historical balance","core.statements:read":"Grants access to read statements","core.webhooks:management-link":"Grants access to create webhook management links"}}},"scopes":["core.transactions:create"],"schemeName":"OAuth2"},"schema":{"title":"OAuth2 Auth","type":"string","isRequired":true,"description":"OAuth 2.0 authentication.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"OAuth2","name":"Authorization"}],"title":"OAuth2"}]},"originalFileLocation":"_media/specs/core-openapi.mintlify.json"},"subdomain":"uphold-d4756e17","siteName":"Uphold","title":"Create transaction - Uphold","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-03-24T21:32:04.426Z","originalFileLocation":"rest-apis/core-api/transactions/create-transaction.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=\"dark\"}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 transaction from a quote.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Uphold\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/uphold-d4756e17/TGvshyKbe31xNfhd/_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/uphold-d4756e17/TGvshyKbe31xNfhd/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/uphold-d4756e17/TGvshyKbe31xNfhd/_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/uphold-d4756e17/TGvshyKbe31xNfhd/_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/uphold-d4756e17/TGvshyKbe31xNfhd/_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/uphold-d4756e17/TGvshyKbe31xNfhd/_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/uphold-d4756e17/TGvshyKbe31xNfhd/_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/uphold-d4756e17/TGvshyKbe31xNfhd/_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/uphold-d4756e17/TGvshyKbe31xNfhd/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create transaction - Uphold\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create transaction from a quote.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Uphold\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developer.uphold.com/rest-apis/core-api/transactions/create-transaction\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://uphold-d4756e17.mintlify.app/_mintlify/api/og/v2?division=Transactions\u0026amp;title=Create+transaction\u0026amp;description=Create+transaction+from+a+quote.\u0026amp;theme=56885fc51e154395631c9c6b\u0026amp;signature=222049ce2937cd47b6511f554af5cbb33b5181c54185e8eb70c3bb6179bcddca\">\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 transaction - Uphold\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create transaction from a quote.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://uphold-d4756e17.mintlify.app/_mintlify/api/og/v2?division=Transactions\u0026amp;title=Create+transaction\u0026amp;description=Create+transaction+from+a+quote.\u0026amp;theme=56885fc51e154395631c9c6b\u0026amp;signature=222049ce2937cd47b6511f554af5cbb33b5181c54185e8eb70c3bb6179bcddca\">\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/uphold-d4756e17/TGvshyKbe31xNfhd/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Uphold\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#49CC68\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developer.uphold.com/rest-apis/core-api/transactions/create-transaction\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/rest-apis/core-api/transactions/create-transaction.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developer.uphold.com/#organization\",\"name\":\"Uphold\",\"url\":\"https://developer.uphold.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/uphold-d4756e17/7IRkuAa79m7bSPci/_media/logos/uphold-branded-house-horizontal-enterprise-for-light.svg?fit=max\u0026auto=format\u0026n=7IRkuAa79m7bSPci\u0026q=85\u0026s=f60facd63ac72f992db1ece0b4cefaa1\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developer.uphold.com#website\",\"name\":\"Uphold\",\"url\":\"https://developer.uphold.com\",\"publisher\":{\"@id\":\"https://developer.uphold.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developer.uphold.com/rest-apis/core-api/transactions/create-transaction#webpage\",\"url\":\"https://developer.uphold.com/rest-apis/core-api/transactions/create-transaction\",\"name\":\"Create transaction\",\"description\":\"Create transaction from a quote.\",\"dateModified\":\"2026-03-24T21:32:04.426Z\",\"isPartOf\":{\"@id\":\"https://developer.uphold.com#website\"},\"breadcrumb\":{\"@id\":\"https://developer.uphold.com/rest-apis/core-api/transactions/create-transaction#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developer.uphold.com/rest-apis/core-api/transactions/create-transaction#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Core API\",\"item\":\"https://developer.uphold.com/rest-apis/core-api/concepts\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Transactions\",\"item\":\"https://developer.uphold.com/rest-apis/core-api/transactions/introduction\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create transaction\",\"item\":\"https://developer.uphold.com/rest-apis/core-api/transactions/create-transaction\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developer.uphold.com/rest-apis/core-api/transactions/create-transaction#apireference\",\"headline\":\"Create transaction\",\"name\":\"Create transaction\",\"description\":\"Create transaction from a quote.\",\"url\":\"https://developer.uphold.com/rest-apis/core-api/transactions/create-transaction\",\"mainEntityOfPage\":{\"@id\":\"https://developer.uphold.com/rest-apis/core-api/transactions/create-transaction#webpage\"},\"dateModified\":\"2026-03-24T21:32:04.426Z\",\"publisher\":{\"@id\":\"https://developer.uphold.com/#organization\"},\"isPartOf\":{\"@id\":\"https://developer.uphold.com#website\"}}]}\u003c/script>","siteName":"Uphold","nav":{"global":null,"tabs":[{"tab":"Get started","pages":[{"title":"Get started","href":"/get-started/overview"}]},{"tab":"Developer Guides","pages":[{"title":"Developer Guides","href":"/developer-guides/overview"}]},{"tab":"REST APIs","pages":[{"title":"Introduction to the Uphold Enterprise REST APIs","sidebarTitle":"Introduction","icon":"book-open","href":"/rest-apis/introduction"},{"title":"REST API changelog","sidebarTitle":"Changelog","icon":"rss","href":"/rest-apis/changelog"},{"title":"Authentication","icon":"key","href":"/rest-apis/authentication"},{"title":"API versioning","sidebarTitle":"Versioning","icon":"code-branch","href":"/rest-apis/versioning"},{"title":"Error handling","sidebarTitle":"Errors","icon":"bug","href":"/rest-apis/errors"},{"title":"Rate limits","icon":"gauge","href":"/rest-apis/rate-limits"},{"title":"Common headers","icon":"brackets-curly","href":"/rest-apis/headers"},{"title":"Entity metadata","icon":"tags","href":"/rest-apis/entity-metadata"},{"title":"Pagination","icon":"list","href":"/rest-apis/pagination"},{"title":"Test helpers","icon":"bolt","href":"/rest-apis/test-helpers"},{"title":"Webhooks","icon":"webhook","href":"/rest-apis/webhooks"},{"group":"Core API","pages":[{"title":"Core API concepts and data model","sidebarTitle":"Concepts","icon":"lightbulb","href":"/rest-apis/core-api/concepts"},{"group":"Authentication","pages":[{"openapi":"_media/specs/core-openapi.mintlify.json post /core/oauth2/token","title":"Request OAuth2 token","href":"/rest-apis/core-api/authentication/request-oauth2-token"}]},{"group":"Countries","pages":[{"title":"Countries API introduction","sidebarTitle":"Introduction","icon":"book-open","href":"/rest-apis/core-api/countries/introduction"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/countries","title":"List countries","href":"/rest-apis/core-api/countries/list-countries"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/countries/{country}","title":"Get country","href":"/rest-apis/core-api/countries/get-country"}]},{"group":"Users","pages":[{"openapi":"_media/specs/core-openapi.mintlify.json post /core/users","title":"Create user","href":"/rest-apis/core-api/users/create-user"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/users/me","title":"Get user","href":"/rest-apis/core-api/users/get-user"},{"openapi":"_media/specs/core-openapi.mintlify.json delete /core/users/me","title":"Delete user","href":"/rest-apis/core-api/users/delete-user"},{"group":"Webhooks","icon":"webhook","pages":[{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.user.created","title":"User created","href":"/rest-apis/core-api/users/webhooks/user-created"},{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.user.deleted","title":"User deleted","href":"/rest-apis/core-api/users/webhooks/user-deleted"}]}]},{"group":"KYC","pages":[{"title":"KYC API introduction","sidebarTitle":"Introduction","icon":"book-open","href":"/rest-apis/core-api/kyc/introduction"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/kyc","title":"Get overview","href":"/rest-apis/core-api/kyc/get-overview"},{"openapi":"_media/specs/core-openapi.mintlify.json patch /core/kyc/processes/email","title":"Update email","href":"/rest-apis/core-api/kyc/update-email"},{"openapi":"_media/specs/core-openapi.mintlify.json patch /core/kyc/processes/phone","title":"Update phone","href":"/rest-apis/core-api/kyc/update-phone"},{"openapi":"_media/specs/core-openapi.mintlify.json patch /core/kyc/processes/profile","title":"Update profile","href":"/rest-apis/core-api/kyc/update-profile"},{"openapi":"_media/specs/core-openapi.mintlify.json patch /core/kyc/processes/address","title":"Update address","href":"/rest-apis/core-api/kyc/update-address"},{"openapi":"_media/specs/core-openapi.mintlify.json patch /core/kyc/processes/identity","title":"Update identity","href":"/rest-apis/core-api/kyc/update-identity"},{"openapi":"_media/specs/core-openapi.mintlify.json patch /core/kyc/processes/proof-of-address","title":"Update proof-of-address","href":"/rest-apis/core-api/kyc/update-proof-of-address"},{"openapi":"_media/specs/core-openapi.mintlify.json patch /core/kyc/processes/customer-due-diligence","title":"Update customer due diligence","href":"/rest-apis/core-api/kyc/update-customer-due-diligence"},{"openapi":"_media/specs/core-openapi.mintlify.json patch /core/kyc/processes/enhanced-due-diligence","title":"Update enhanced due diligence","href":"/rest-apis/core-api/kyc/update-enhanced-due-diligence"},{"openapi":"_media/specs/core-openapi.mintlify.json patch /core/kyc/processes/crypto-risk-assessment","title":"Update crypto risk assessment","href":"/rest-apis/core-api/kyc/update-crypto-risk-assessment"},{"openapi":"_media/specs/core-openapi.mintlify.json patch /core/kyc/processes/self-categorization-statement","title":"Update self-categorization statement","href":"/rest-apis/core-api/kyc/update-self-categorization-statement"},{"openapi":"_media/specs/core-openapi.mintlify.json patch /core/kyc/processes/tax-details","title":"Update tax details","href":"/rest-apis/core-api/kyc/update-tax-details"},{"group":"Webhooks","icon":"webhook","pages":[{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.kyc.email.status-changed","title":"Email status changed","href":"/rest-apis/core-api/kyc/webhooks/email-status-changed"},{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.kyc.phone.status-changed","title":"Phone status changed","href":"/rest-apis/core-api/kyc/webhooks/phone-status-changed"},{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.kyc.profile.status-changed","title":"Profile status changed","href":"/rest-apis/core-api/kyc/webhooks/profile-status-changed"},{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.kyc.address.status-changed","title":"Address status Changed","href":"/rest-apis/core-api/kyc/webhooks/address-status-changed"},{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.kyc.identity.status-changed","title":"Identity status changed","href":"/rest-apis/core-api/kyc/webhooks/identity-status-changed"},{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.kyc.proof-of-address.status-changed","title":"Proof-of-address status changed","href":"/rest-apis/core-api/kyc/webhooks/proof-of-address-status-changed"},{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.kyc.customer-due-diligence.status-changed","title":"Customer due diligence status changed","href":"/rest-apis/core-api/kyc/webhooks/customer-due-diligence-status-changed"},{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.kyc.enhanced-due-diligence.status-changed","title":"Enhanced due diligence status changed","href":"/rest-apis/core-api/kyc/webhooks/enhanced-due-diligence-status-changed"},{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.kyc.crypto-risk-assessment.status-changed","title":"Crypto risk assessment status changed","href":"/rest-apis/core-api/kyc/webhooks/crypto-risk-assessment-status-changed"},{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.kyc.self-categorization-statement.status-changed","title":"Self categorization statement status changed","href":"/rest-apis/core-api/kyc/webhooks/self-categorization-statement-status-changed"},{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.kyc.tax-details.status-changed","title":"Tax details status changed","href":"/rest-apis/core-api/kyc/webhooks/tax-details-status-changed"},{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.kyc.screening.status-changed","title":"Screening status changed","href":"/rest-apis/core-api/kyc/webhooks/screening-status-changed"},{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.kyc.risk.status-changed","title":"Risk status changed","href":"/rest-apis/core-api/kyc/webhooks/risk-status-changed"}]}]},{"group":"KYB","pages":[{"title":"KYB API introduction","sidebarTitle":"Introduction","icon":"book-open","href":"/rest-apis/core-api/kyb/introduction"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/kyb","title":"Get overview","href":"/rest-apis/core-api/kyb/get-overview"},{"openapi":"_media/specs/core-openapi.mintlify.json patch /core/kyb/processes/profile","title":"Update profile","href":"/rest-apis/core-api/kyb/update-profile"},{"openapi":"_media/specs/core-openapi.mintlify.json patch /core/kyb/processes/documents","title":"Update documents","href":"/rest-apis/core-api/kyb/update-documents"},{"openapi":"_media/specs/core-openapi.mintlify.json patch /core/kyb/processes/financial-institution","title":"Update financial institution","href":"/rest-apis/core-api/kyb/update-financial-institution"},{"group":"Associated persons","icon":"users","pages":[{"openapi":"_media/specs/core-openapi.mintlify.json get /core/kyb/associated-persons","sidebarTitle":"List persons","title":"List associated persons","href":"/rest-apis/core-api/kyb/associated-persons/list-associated-persons"},{"openapi":"_media/specs/core-openapi.mintlify.json post /core/kyb/associated-persons","sidebarTitle":"Create person","title":"Create associated person","href":"/rest-apis/core-api/kyb/associated-persons/create-associated-person"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/kyb/associated-persons/{personId}","sidebarTitle":"Get person","title":"Get associated person","href":"/rest-apis/core-api/kyb/associated-persons/get-associated-person"},{"openapi":"_media/specs/core-openapi.mintlify.json delete /core/kyb/associated-persons/{personId}","sidebarTitle":"Delete person","title":"Delete associated person","href":"/rest-apis/core-api/kyb/associated-persons/delete-associated-person"},{"openapi":"_media/specs/core-openapi.mintlify.json patch /core/kyb/associated-persons/{personId}/processes/profile","sidebarTitle":"Update person profile","title":"Update associated person profile","href":"/rest-apis/core-api/kyb/associated-persons/update-profile"},{"openapi":"_media/specs/core-openapi.mintlify.json patch /core/kyb/associated-persons/{personId}/processes/identity","sidebarTitle":"Update person identity","title":"Update associated person identity","href":"/rest-apis/core-api/kyb/associated-persons/update-identity"},{"openapi":"_media/specs/core-openapi.mintlify.json patch /core/kyb/associated-persons/{personId}/processes/proof-of-address","sidebarTitle":"Update person proof-of-address","title":"Update associated person proof-of-address","href":"/rest-apis/core-api/kyb/associated-persons/update-proof-of-address"},{"group":"Webhooks","icon":"webhook","pages":[{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.kyb.associated-person.created","sidebarTitle":"Person created","title":"Associated person created","href":"/rest-apis/core-api/kyb/associated-persons/webhooks/associated-person-created"},{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.kyb.associated-person.deleted","sidebarTitle":"Person deleted","title":"Associated person deleted","href":"/rest-apis/core-api/kyb/associated-persons/webhooks/associated-person-deleted"},{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.kyb.associated-person.profile.status-changed","sidebarTitle":"Person profile status changed","title":"Associated person profile status changed","href":"/rest-apis/core-api/kyb/associated-persons/webhooks/profile-status-changed"},{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.kyb.associated-person.identity.status-changed","sidebarTitle":"Person identity status changed","title":"Associated person identity status changed","href":"/rest-apis/core-api/kyb/associated-persons/webhooks/identity-status-changed"},{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.kyb.associated-person.proof-of-address.status-changed","sidebarTitle":"Person proof-of-address status changed","title":"Associated person proof-of-address status changed","href":"/rest-apis/core-api/kyb/associated-persons/webhooks/proof-of-address-status-changed"}]}]},{"openapi":"_media/specs/core-openapi.mintlify.json post /core/kyb/processes/attestation/trigger","title":"Trigger attestation","href":"/rest-apis/core-api/kyb/trigger-attestation"},{"group":"Webhooks","icon":"webhook","pages":[{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.kyb.profile.status-changed","title":"Profile status changed","href":"/rest-apis/core-api/kyb/webhooks/profile-status-changed"},{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.kyb.associated-persons.status-changed","title":"Associated persons status changed","href":"/rest-apis/core-api/kyb/webhooks/associated-persons-status-changed"},{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.kyb.documents.status-changed","title":"Documents status changed","href":"/rest-apis/core-api/kyb/webhooks/documents-status-changed"},{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.kyb.financial-institution.status-changed","title":"Financial institution status changed","href":"/rest-apis/core-api/kyb/webhooks/financial-institution-status-changed"},{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.kyb.attestation.status-changed","title":"Attestation status changed","href":"/rest-apis/core-api/kyb/webhooks/attestation-status-changed"}]}]},{"group":"Capabilities","pages":[{"title":"Capabilities API introduction","sidebarTitle":"Introduction","icon":"book-open","href":"/rest-apis/core-api/capabilities/introduction"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/capabilities","title":"List capabilities","href":"/rest-apis/core-api/capabilities/list-user-capabilities"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/capabilities/{capability}","title":"Get capability","href":"/rest-apis/core-api/capabilities/get-user-capability"}]},{"group":"Terms of service","pages":[{"title":"Terms of Service API introduction","sidebarTitle":"Introduction","icon":"book-open","href":"/rest-apis/core-api/terms-of-service/introduction"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/terms-of-service","title":"List terms of service","href":"/rest-apis/core-api/terms-of-service/list-terms-of-service"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/terms-of-service/{termsOfService}","title":"Get terms of service","href":"/rest-apis/core-api/terms-of-service/get-terms-of-service"},{"openapi":"_media/specs/core-openapi.mintlify.json post /core/terms-of-service/{termsOfService}/accept","title":"Accept terms of service","href":"/rest-apis/core-api/terms-of-service/accept-terms-of-service"}]},{"group":"Files","pages":[{"openapi":"_media/specs/core-openapi.mintlify.json post /core/files","title":"Create file","href":"/rest-apis/core-api/files/create-file"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/files/{fileId}","title":"Get file","href":"/rest-apis/core-api/files/get-file"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/files/settings","title":"List files settings","href":"/rest-apis/core-api/files/list-files-settings"}]},{"group":"Assets","pages":[{"title":"Assets API introduction","sidebarTitle":"Introduction","icon":"book-open","href":"/rest-apis/core-api/assets/introduction"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/assets","title":"List assets","href":"/rest-apis/core-api/assets/list-assets"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/assets/{asset}","title":"Get asset","href":"/rest-apis/core-api/assets/get-asset"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/assets/{asset}/rates","title":"Get asset rates","href":"/rest-apis/core-api/assets/get-asset-rates"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/assets/{asset}/historical-rates","title":"Get asset historical rates","href":"/rest-apis/core-api/assets/get-historical-rates"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/networks","title":"List networks","href":"/rest-apis/core-api/assets/list-networks"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/networks/{network}","title":"Get network","href":"/rest-apis/core-api/assets/get-network"},{"openapi":"_media/specs/core-openapi.mintlify.json post /core/networks/{network}/validate-address","title":"Validate network address","href":"/rest-apis/core-api/assets/validate-network-address"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/rails","title":"List rails","href":"/rest-apis/core-api/assets/list-rails"},{"group":"Test helpers","icon":"bolt","pages":[{"openapi":"_media/specs/core-openapi.mintlify.json put /core/assets/test-helpers/skip-assets-cooldowns","title":"Skip assets cooldowns","href":"/rest-apis/core-api/assets/test-helpers/skip-assets-cooldowns"}]},{"group":"Webhooks","icon":"webhook","pages":[{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.assets.cooldown-ended","title":"Assets cooldown ended","href":"/rest-apis/core-api/assets/webhooks/assets-cooldown-ended"}]}]},{"group":"Accounts","pages":[{"title":"Accounts API introduction","sidebarTitle":"Introduction","icon":"book-open","href":"/rest-apis/core-api/accounts/introduction"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/accounts","title":"List accounts","href":"/rest-apis/core-api/accounts/list-accounts"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/accounts/defaults","title":"List default accounts","href":"/rest-apis/core-api/accounts/list-default-accounts"},{"openapi":"_media/specs/core-openapi.mintlify.json post /core/accounts","title":"Create account","href":"/rest-apis/core-api/accounts/create-account"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/accounts/{accountId}","title":"Get account","href":"/rest-apis/core-api/accounts/get-account"},{"openapi":"_media/specs/core-openapi.mintlify.json delete /core/accounts/{accountId}","title":"Archive account","href":"/rest-apis/core-api/accounts/archive-account"},{"openapi":"_media/specs/core-openapi.mintlify.json patch /core/accounts/{accountId}","title":"Update account","href":"/rest-apis/core-api/accounts/update-account"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/accounts/{accountId}/deposit-method","title":"Get account deposit method","href":"/rest-apis/core-api/accounts/get-account-deposit-method"},{"openapi":"_media/specs/core-openapi.mintlify.json put /core/accounts/{accountId}/deposit-method","title":"Set up account deposit method","href":"/rest-apis/core-api/accounts/set-up-account-deposit-method"},{"group":"Test helpers","icon":"bolt","pages":[{"title":"Fund Sandbox accounts","sidebarTitle":"Fund sandbox accounts","icon":"wallet","href":"/rest-apis/core-api/accounts/test-helpers/fund-sandbox-accounts"},{"openapi":"_media/specs/core-openapi.mintlify.json post /core/accounts/test-helpers/bank-deposits","title":"Simulate bank deposit","href":"/rest-apis/core-api/accounts/test-helpers/simulate-bank-deposit"},{"openapi":"_media/specs/core-openapi.mintlify.json post /core/accounts/test-helpers/crypto-deposits","title":"Simulate crypto deposit","href":"/rest-apis/core-api/accounts/test-helpers/simulate-crypto-deposit"}]},{"group":"Webhooks","icon":"webhook","pages":[{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.account.created","title":"Account Created","href":"/rest-apis/core-api/accounts/webhooks/account-created"},{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.account.balance-changed","title":"Account Balance Changed","href":"/rest-apis/core-api/accounts/webhooks/account-balance-changed"},{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.account.archived","title":"Account archived","href":"/rest-apis/core-api/accounts/webhooks/account-archived"},{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.account.unarchived","title":"Account unarchived","href":"/rest-apis/core-api/accounts/webhooks/account-unarchived"}]}]},{"group":"External accounts","pages":[{"title":"External accounts API introduction","sidebarTitle":"Introduction","icon":"book-open","href":"/rest-apis/core-api/external-accounts/introduction"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/external-accounts","title":"List external accounts","href":"/rest-apis/core-api/external-accounts/list-external-accounts"},{"openapi":"_media/specs/core-openapi.mintlify.json post /core/external-accounts","title":"Create external account","href":"/rest-apis/core-api/external-accounts/create-external-account"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/external-accounts/{externalAccountId}","title":"Get external account","href":"/rest-apis/core-api/external-accounts/get-external-account"},{"openapi":"_media/specs/core-openapi.mintlify.json delete /core/external-accounts/{externalAccountId}","title":"Delete external account","href":"/rest-apis/core-api/external-accounts/delete-external-account"},{"openapi":"_media/specs/core-openapi.mintlify.json patch /core/external-accounts/{externalAccountId}","title":"Update external account","href":"/rest-apis/core-api/external-accounts/update-external-account"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/external-accounts/{externalAccountId}/verifications","title":"List external account verifications","href":"/rest-apis/core-api/external-accounts/list-external-account-verifications"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/external-accounts/{externalAccountId}/verifications/{level}","title":"Get external account verification","href":"/rest-apis/core-api/external-accounts/get-external-account-verification"},{"openapi":"_media/specs/core-openapi.mintlify.json put /core/external-accounts/{externalAccountId}/verifications/{level}","title":"Set up crypto external account verification","href":"/rest-apis/core-api/external-accounts/setup-external-account-verification"},{"group":"Webhooks","icon":"webhook","pages":[{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.external-account.created","title":"External account created","href":"/rest-apis/core-api/external-accounts/webhooks/external-account-created"},{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.external-account.status-changed","title":"External account status changed","href":"/rest-apis/core-api/external-accounts/webhooks/external-account-status-changed"},{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.external-account.deleted","title":"External account deleted","href":"/rest-apis/core-api/external-accounts/webhooks/external-account-deleted"}]}]},{"group":"Transactions","pages":[{"title":"Transactions API introduction","sidebarTitle":"Introduction","icon":"book-open","href":"/rest-apis/core-api/transactions/introduction"},{"openapi":"_media/specs/core-openapi.mintlify.json post /core/transactions/quote","title":"Create quote","href":"/rest-apis/core-api/transactions/create-quote"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/accounts/{accountId}/transactions","title":"List account transactions","href":"/rest-apis/core-api/transactions/list-account-transactions"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/transactions","title":"List transactions","description":"List transactions associated with a user.","href":"/rest-apis/core-api/transactions/list-transactions"},{"openapi":"_media/specs/core-openapi.mintlify.json post /core/transactions","title":"Create transaction","href":"/rest-apis/core-api/transactions/create-transaction"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/transactions/{transactionId}","title":"Get transaction","description":"Retrieve an existing transaction by id.","href":"/rest-apis/core-api/transactions/get-transaction"},{"group":"Webhooks","icon":"webhook","pages":[{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.transaction.created","title":"Transaction created","href":"/rest-apis/core-api/transactions/webhooks/transaction-created"},{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.transaction.status-changed","title":"Transaction status changed","href":"/rest-apis/core-api/transactions/webhooks/transaction-status-changed"}]}]},{"group":"Requests for information","pages":[{"openapi":"_media/specs/core-openapi.mintlify.json get /core/requests-for-information","title":"List requests for information","href":"/rest-apis/core-api/requests-for-information/list-requests-for-information"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/requests-for-information/{requestForInformationId}","title":"Get request for information","href":"/rest-apis/core-api/requests-for-information/get-request-for-information"},{"openapi":"_media/specs/core-openapi.mintlify.json put /core/requests-for-information/{requestForInformationId}","title":"Update request for information","href":"/rest-apis/core-api/requests-for-information/update-request-for-information"}]},{"group":"Portfolio","pages":[{"title":"Portfolio API introduction","sidebarTitle":"Introduction","icon":"book-open","href":"/rest-apis/core-api/portfolio/introduction"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/portfolio","title":"Get overview","href":"/rest-apis/core-api/portfolio/get-portfolio-overview"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/portfolio/performance","title":"Get performance","href":"/rest-apis/core-api/portfolio/get-portfolio-performance"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/portfolio/historical-balance","title":"Get historical balance","href":"/rest-apis/core-api/portfolio/get-portfolio-historical-balance"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/portfolio/accounts/{accountId}/performance","title":"Get account performance","href":"/rest-apis/core-api/portfolio/get-portfolio-account-performance"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/portfolio/accounts/{accountId}/historical-balance","title":"Get account historical balance","href":"/rest-apis/core-api/portfolio/get-portfolio-account-historical-balance"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/portfolio/assets/{asset}/performance","title":"Get asset performance","href":"/rest-apis/core-api/portfolio/get-portfolio-asset-performance"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/portfolio/assets/{asset}/historical-balance","title":"Get asset historical balance","href":"/rest-apis/core-api/portfolio/get-portfolio-asset-historical-balance"}]},{"group":"Statements","pages":[{"title":"Introduction","icon":"book-open","href":"/rest-apis/core-api/statements/introduction"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/statements/portfolio","title":"Get portfolio statement","href":"/rest-apis/core-api/statements/get-portfolio-statement"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/statements/transactions","title":"Get transactions statement","href":"/rest-apis/core-api/statements/get-transactions-statement"}]},{"group":"Metadata","pages":[{"openapi":"_media/specs/core-openapi.mintlify.json put /core/{entity}/{entityId}/metadata","title":"Set metadata","href":"/rest-apis/core-api/metadata/set-metadata"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/{entity}/{entityId}/metadata","title":"Get metadata","href":"/rest-apis/core-api/metadata/get-metadata"},{"openapi":"_media/specs/core-openapi.mintlify.json delete /core/{entity}/{entityId}/metadata","title":"Delete metadata","href":"/rest-apis/core-api/metadata/delete-metadata"},{"openapi":"_media/specs/core-openapi.mintlify.json patch /core/{entity}/{entityId}/metadata","title":"Update metadata","href":"/rest-apis/core-api/metadata/update-metadata"}]},{"group":"Webhooks","pages":[{"openapi":"_media/specs/core-openapi.mintlify.json post /core/webhooks/management-link","title":"Request webhook management link","href":"/rest-apis/core-api/webhooks/request-management-link"}]}]},{"group":"Trading API","tag":"Preview","pages":[{"title":"Trading API introduction","sidebarTitle":"Introduction","icon":"book-open","href":"/rest-apis/trading-api/introduction"},{"group":"Prices","pages":[{"openapi":"_media/specs/trading-openapi.mintlify.json post /trading/prices","title":"Estimate price","href":"/rest-apis/trading-api/prices/estimate-price"}]},{"group":"Orders","pages":[{"openapi":"_media/specs/trading-openapi.mintlify.json post /trading/orders","title":"Create order","href":"/rest-apis/trading-api/orders/create-order"},{"openapi":"_media/specs/trading-openapi.mintlify.json get /trading/orders","title":"List orders","href":"/rest-apis/trading-api/orders/list-orders"},{"openapi":"_media/specs/trading-openapi.mintlify.json get /trading/orders/{orderId}","title":"Get order","href":"/rest-apis/trading-api/orders/get-order"},{"openapi":"_media/specs/trading-openapi.mintlify.json get /trading/orders/{orderId}/trades","title":"List order trades","href":"/rest-apis/trading-api/orders/list-order-trades"}]}]},{"group":"Market Pulse API","pages":[{"group":"General","pages":[{"openapi":"_media/specs/market-pulse-openapi.mintlify.json get /market-pulse/news","title":"List general news","href":"/rest-apis/market-pulse-api/general/list-general-news"}]},{"group":"Assets","pages":[{"openapi":"_media/specs/market-pulse-openapi.mintlify.json get /market-pulse/assets/{assetCode}/news","title":"List asset news","href":"/rest-apis/market-pulse-api/assets/list-asset-news"},{"openapi":"_media/specs/market-pulse-openapi.mintlify.json get /market-pulse/assets/{assetCode}/statistics","title":"Get asset statistics","href":"/rest-apis/market-pulse-api/assets/get-asset-statistics"},{"openapi":"_media/specs/market-pulse-openapi.mintlify.json get /market-pulse/assets/{assetCode}/information","title":"Get asset information","href":"/rest-apis/market-pulse-api/assets/get-asset-information"}]}]},{"group":"KYC Connector API","pages":[{"title":"KYC Connector API introduction","sidebarTitle":"Introduction","icon":"book-open","href":"/rest-apis/kyc-connector-api/introduction"},{"group":"Sumsub","pages":[{"title":"Sumsub KYC Connector overview","sidebarTitle":"Overview","icon":"list-radio","href":"/rest-apis/kyc-connector-api/sumsub/overview"},{"openapi":"_media/specs/kyc-connector-openapi.mintlify.json post /kyc-connector/sumsub/ingestions","title":"Create Sumsub ingestion","href":"/rest-apis/kyc-connector-api/sumsub/create-ingestion"},{"openapi":"_media/specs/kyc-connector-openapi.mintlify.json get /kyc-connector/sumsub/ingestions/{ingestionId}","title":"Get Sumsub ingestion","href":"/rest-apis/kyc-connector-api/sumsub/get-ingestion"},{"openapi":"_media/specs/kyc-connector-openapi.mintlify.json get /kyc-connector/sumsub/ingestions","title":"List Sumsub ingestions","href":"/rest-apis/kyc-connector-api/sumsub/list-ingestions"},{"group":"Webhooks","icon":"webhook","pages":[{"openapi":"_media/specs/kyc-connector-openapi.mintlify.json webhook kyc-connector.sumsub.ingestion.created","title":"Sumsub ingestion created","href":"/rest-apis/kyc-connector-api/sumsub/webhooks/ingestion-created"},{"openapi":"_media/specs/kyc-connector-openapi.mintlify.json webhook kyc-connector.sumsub.ingestion.status-changed","title":"Sumsub ingestion status changed","href":"/rest-apis/kyc-connector-api/sumsub/webhooks/ingestion-status-changed"}]}]},{"group":"Veriff","pages":[{"title":"Veriff KYC Connector overview","sidebarTitle":"Overview","icon":"list-radio","href":"/rest-apis/kyc-connector-api/veriff/overview"},{"openapi":"_media/specs/kyc-connector-openapi.mintlify.json post /kyc-connector/veriff/ingestions","title":"Create Veriff ingestion","href":"/rest-apis/kyc-connector-api/veriff/create-ingestion"},{"openapi":"_media/specs/kyc-connector-openapi.mintlify.json get /kyc-connector/veriff/ingestions/{ingestionId}","title":"Get Veriff ingestion","href":"/rest-apis/kyc-connector-api/veriff/get-ingestion"},{"openapi":"_media/specs/kyc-connector-openapi.mintlify.json get /kyc-connector/veriff/ingestions","title":"List Veriff ingestions","href":"/rest-apis/kyc-connector-api/veriff/list-ingestions"},{"openapi":"_media/specs/kyc-connector-openapi.mintlify.json put /kyc-connector/veriff/config","title":"Set Veriff config","href":"/rest-apis/kyc-connector-api/veriff/set-config"},{"openapi":"_media/specs/kyc-connector-openapi.mintlify.json get /kyc-connector/veriff/config","title":"Get Veriff config","href":"/rest-apis/kyc-connector-api/veriff/get-config"},{"group":"Webhooks","icon":"webhook","pages":[{"openapi":"_media/specs/kyc-connector-openapi.mintlify.json webhook kyc-connector.veriff.ingestion.created","title":"Veriff ingestion created","href":"/rest-apis/kyc-connector-api/veriff/webhooks/ingestion-created"},{"openapi":"_media/specs/kyc-connector-openapi.mintlify.json webhook kyc-connector.veriff.ingestion.status-changed","title":"Veriff ingestion status changed","href":"/rest-apis/kyc-connector-api/veriff/webhooks/ingestion-status-changed"}]}]}]},{"group":"Widgets API","pages":[{"group":"Payment","pages":[{"openapi":"_media/specs/widgets-openapi.mintlify.json post /widgets/payment/sessions","title":"Create session","href":"/rest-apis/widgets-api/payment/create-session"}]},{"group":"KYC","pages":[{"openapi":"_media/specs/widgets-openapi.mintlify.json post /widgets/kyc/sessions","title":"Create session","href":"/rest-apis/widgets-api/kyc/create-session"}]},{"group":"Travel rule","pages":[{"openapi":"_media/specs/widgets-openapi.mintlify.json post /widgets/travel-rule/sessions","title":"Create session","href":"/rest-apis/widgets-api/travel-rule/create-session"}]}]},{"group":"Topper API","pages":[{"group":"KYC sharing","pages":[{"openapi":"_media/specs/topper-openapi.mintlify.json post /topper/kyc-sharing/identify-user","title":"Identify user","href":"/rest-apis/topper-api/kyc-sharing/identify-user"},{"openapi":"_media/specs/topper-openapi.mintlify.json post /topper/kyc-sharing/sessions","title":"Create session","href":"/rest-apis/topper-api/kyc-sharing/create-session"}]}]}]},{"tab":"FIX APIs","pages":[{"title":"FIX APIs","href":"/fix-apis/introduction"}]},{"tab":"Widgets","pages":[{"title":"Widgets","href":"/widgets/introduction"}]}]},"basePath":"","title":"Create transaction - Uphold","buildId":"dpl_GZsjphRpnhWkstV12jxWNcMHFyox","deploymentId":"dpl_GZsjphRpnhWkstV12jxWNcMHFyox","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-B5zPa4Vr.js","utils-CVjrr8Yd.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DTgURWzl.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DxTHtkdZ.js","snippetPresets-Cx47o5Vx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-4Fr6y9N_.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-Dq2ElbEk.js","shallow-BfYl9r69.js","getApiPlaygroundDisplay-Ch3xc7i1.js","CodeSnippet-BsBxuJ1v.js","CodeSnippets-CetzeDL8.js","Page-CYZot51e.js","getPastedJson-BxPKFSJx.js","icon-o0J1Ochb.js","MethodPill-Du3usO5m.js","DuplicateIcon-DJypyMzl.js","createIcon-YMA6N8KJ.js","DynamicMarkdown-CWvhfcZc.js","SectionHeading-BdLVaXCd.js","axios-vUo_bRtp.js","Markdown-C4Ez6OeV.js","clsx-DptzKFCt.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-Dt1IougW.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CZ6Wt2Vb.js"]}