{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Payward Developer Documentation","colors":{"primary":"#0D0D0D","light":"#FFFFFF","dark":"#0D0D0D"},"logo":{"light":"https://mintcdn.com/mintlify-0e856cf0/MS2nSfkmrBCPqOvg/logo/light.svg?fit=max\u0026auto=format\u0026n=MS2nSfkmrBCPqOvg\u0026q=85\u0026s=38bcfc0cb2a1e7c2a308a1de91e5e778","dark":"https://mintcdn.com/mintlify-0e856cf0/MS2nSfkmrBCPqOvg/logo/dark.svg?fit=max\u0026auto=format\u0026n=MS2nSfkmrBCPqOvg\u0026q=85\u0026s=acbf50d23cd4e13e991f6ef62e72e95d"},"favicon":"https://mintcdn.com/mintlify-0e856cf0/XXxi474nqJjh9ixz/favicon.svg?fit=max\u0026auto=format\u0026n=XXxi474nqJjh9ixz\u0026q=85\u0026s=52a6dac48bb65d2e07aa472407d20f1d","appearance":{"default":"system"},"background":{"color":{"dark":"#0D0D0D"}},"navbar":{"primary":{"type":"button","label":"Book a Demo","href":"https://services.payward.com/?utm_source=docs\u0026utm_medium=referral\u0026utm_campaign=book_a_demo#contact"}},"footer":{"socials":{"x":"https://x.com/PaywardServices","linkedin":"https://www.linkedin.com/company/payward-services"}},"fonts":{"heading":{"family":"Financier","weight":400,"source":"fonts/FinancierDisplayVF-Roman.ttf","format":"woff2"},"body":{"family":"KrakenProduct","weight":400,"source":"https://assets.kraken.com/fonts/Kraken-Product-Regular.87314a06.woff2","format":"woff2"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode",{"title":"Download Production spec","description":"Download the Production OpenAPI specification","icon":"download","href":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json"},{"title":"Download Sandbox spec","description":"Download the Sandbox OpenAPI specification","icon":"download","href":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json"}],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"tabs":[{"tab":"Postman collection","href":"/tabs/developer-documentation/get-started/postman"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"mintlify-0e856cf0","hasAudioNarration":false,"actualSubdomain":"mintlify-0e856cf0","customDomains":["docs.services.payward.com"],"gitSource":{"type":"gitlab","owner":"pws","repo":"docs","hostUrl":"https://roshi-korin.honeycrypt.com","projectId":27964,"deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af2338f6e2ddfdceb36bcf5","clientVersion":"0.0.4094","searchFilterCounts":[{"language":"default","tag":"API reference","count":301},{"language":"default","tag":"Payward Services API","count":300},{"language":"default","tag":"Sandbox","count":153},{"language":"default","tag":"Production","count":148},{"language":"default","tag":"Webhooks","count":101},{"language":"default","tag":"Funding","count":40},{"language":"default","tag":"Get Started","count":27},{"language":"default","tag":"Ramp","count":26},{"language":"default","tag":"Conversions","count":23},{"language":"default","tag":"Bonded Earn","count":22}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"h2,h3,h4,h5,h6{font-family:var(--font-inter), sans-serif!important;font-weight:500!important;letter-spacing:0}h1{font-size:40px!important;font-weight:400!important;letter-spacing:-0.025em!important}h2{font-size:24px!important}h3{font-size:20px!important}.tracking-tight{letter-spacing:0.025em}b,strong,[data-streamdown=\"strong\"]{font-weight:bolder!important}#sidebar-title{font-size:0.875rem;font-weight:650!important}[data-component-part=\"card-title\"]{font-family:'KrakenProduct', sans-serif;font-size:16px!important;font-weight:600!important}[data-component-part=\"card-content\"]{font-size:14px!important;line-height:24px!important}#footer{flex-direction:row-reverse}[data-agent-docs-index]+*{margin-top:0!important}.api-section-heading-title{font-size:20px!important}:is(.dark,[data-theme=\"dark\"]) #topbar-cta-button a>span:first-child{background-color:#ffffff!important}:is(.dark,[data-theme=\"dark\"]) #topbar-cta-button a>div span,:is(.dark,[data-theme=\"dark\"]) #topbar-cta-button a>div svg{color:#0d0d0d!important}.sidebar-group{line-height:1rem!important}.endpoint-reference-table table :is(th,td):first-child{min-width:0;width:1%;white-space:nowrap}[data-radix-menu-content]{max-height:var(--radix-popper-available-height, none)!important}[data-component-part=\"field-name\"]{display:inline-flex;flex-wrap:wrap;min-width:0;max-width:100%;white-space:normal!important;overflow-wrap:anywhere!important;word-break:normal!important;hyphens:none!important}[data-component-part=\"field-name\"]>span:first-child{min-width:0;max-width:100%;white-space:normal!important;overflow-wrap:anywhere!important;word-break:normal!important;hyphens:none!important}.param-head,.param-head>.flex-1{min-width:0;max-width:100%}:not(pre)>code,:not(pre)>code *{overflow-wrap:normal!important;word-break:normal!important;hyphens:none!important}#content-area a:has(>code){border-bottom:0;text-decoration-line:underline;text-underline-offset:0.2em}a[target=\"_blank\"]::after{content:'';display:inline-block;width:0.85em;height:0.85em;margin-inline-start:0.35em;vertical-align:-0.05em;flex-shrink:0;background-color:currentColor;-webkit-mask:url('/images/external-link.svg') center / contain no-repeat;mask:url('/images/external-link.svg') center / contain no-repeat}.nav-tabs-item[target=\"_blank\"]{gap:0}a[target=\"_blank\"]:has(>svg){display:inline-flex;align-items:center}#topbar-cta-button a[target=\"_blank\"] svg{display:none}#topbar-cta-button a[target=\"_blank\"]::after{position:relative;color:white}.docs-screenshot{border:1px solid rgba(0, 0, 0, 0.12);border-radius:20px}:is(.dark,[data-theme=\"dark\"]) .docs-screenshot{border-color:rgba(255, 255, 255, 0.12)}:not(pre)>code{padding-inline:0.25em}"}],"page":{"pagePath":"api-reference/sandbox/conversions/get-conversion-rule","slug":"/api-reference/sandbox/conversions/get-conversion-rule","pageMetadata":{"title":"Get conversion rule","description":"Retrieves the current state of a previously created conversion rule.","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/conversions/{conversion_rule_id}","href":"/api-reference/sandbox/conversions/get-conversion-rule","autogeneratedByOpenApi":true},"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: \"Retrieves the current state of a previously created conversion rule.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={p:`p`,strong:`strong`,..._provideComponents(),...props.components},{Badge}=_components;if(!Badge)_missingMdxReference(`Badge`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:_jsx(_components.strong,{children:`Required API key permission:`})}),`\n`,_jsx(Badge,{icon:`key`,color:`purple`,size:`sm`,shape:`pill`,children:`query-funds`})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get conversion rule","description":"Retrieves the current state of a previously created conversion rule.","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/conversions/{conversion_rule_id}","href":"/api-reference/sandbox/conversions/get-conversion-rule","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Conversions"],"description":"Retrieves the current state of a previously created conversion rule.","operationId":"getConversionRule","parameters":["ab18379d-4807-4252-831a-c60f6ba6be49","c3ed91cf-5a4a-4409-a346-696b6b813092"],"responses":{"200":"d1cc0715-b5e1-4715-bebb-4ee7626f3086","400":"467ffb6c-582b-4223-b1ea-4bc967347bbd","401":"221d362a-927c-459a-a471-4e7b5f0f675d","403":"f299ede1-d806-4369-b572-f19aa546b784","404":"9f5912a3-11a2-4bec-ad92-486ce6f067ad","429":"5c348ea1-6127-4b4f-96ab-19f265cbaa98","500":"f1fd9ca4-fc42-4ff0-9a32-7ec8fb7fe850","501":"3bc6b138-fa50-4cca-8e84-0e9d973c1ad8","503":"45d719c1-ca6a-4c0e-9ebf-fb47871b4316","504":"1cc91238-4aea-49e5-8d70-a974521f0d7b"},"security":["0e360d4d-7ac7-411d-866b-c1625abac094"],"summary":"Get conversion rule","x-mint":{"content":"**Required API key permission:**\n\n\u003cBadge icon=\"key\" color=\"purple\" size=\"sm\" shape=\"pill\">query-funds\u003c/Badge>"},"method":"get","type":"path","servers":["caf8130c-67b7-4adc-8bbf-7f4409636b45"],"path":"/v1/accounts/{account_id}/conversions/{conversion_rule_id}","baseUrlOptions":["https://api.sandbox.services.payward.com"],"title":"Get conversion rule","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"ab18379d-4807-4252-831a-c60f6ba6be49":{"name":"account_id","in":"path","required":true,"example":"WVSD33HRMGSZUBM7","schema":{"description":"Globally unique public identifier for an account.","type":"string","minLength":14,"maxLength":42,"isRequired":true,"uniqueKey":"","typeLabel":"string"}},"c3ed91cf-5a4a-4409-a346-696b6b813092":{"in":"path","name":"conversion_rule_id","required":true,"schema":{"description":"Conversion rule identifier.","type":"string","format":"uuid","isRequired":true,"uniqueKey":"","typeLabel":"string\u003cuuid>"},"style":"simple","example":"550e8400-e29b-41d4-a716-446655440000"}},"responses":{"d1cc0715-b5e1-4715-bebb-4ee7626f3086":{"description":"Successful response","headers":{"X-Trace-Id":{"description":"Trace identifier for the request. Include it when contacting support.","schema":{"type":"string","example":"4bf92f3577b34da6a3ce929d0e0e4736"}},"Strict-Transport-Security":{"description":"Enforces HTTPS for the duration specified by `max-age`.","schema":{"type":"string","example":"max-age=31536000; includeSubDomains; preload"}},"Cache-Control":{"description":"Prevents caching of sensitive financial data. Always `no-store`.","schema":{"type":"string","enum":["no-store"],"example":"no-store"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"description":"The requested conversion rule.","type":"object","properties":{"id":{"description":"Unique identifier for this conversion rule.","type":"string","format":"uuid","isRequired":true,"uniqueKey":"data.id","typeLabel":"string\u003cuuid>"},"from":{"description":"Source side. On reads, `address`/`bank_account` are populated by the service from the autoramp-provisioned inbound (where partner deposits funds). On writes, those fields are ignored. Partners only specify symbol, type, and via on the source side.","type":"object","properties":{"type":{"description":"Kind of endpoint. `wallet` requires `wallet`; `bank` requires `bank_account`; `balance` requires neither.","type":"string","enum":["wallet","bank"],"title":"EndpointType","isRequired":true,"uniqueKey":"data.from.type","typeLabel":"enum\u003cstring>"},"symbol":{"description":"Asset ticker symbol (e.g., \"EUR\", \"USDC\", \"BTC\").","type":"string","minLength":1,"maxLength":16,"uniqueKey":"data.from.symbol","typeLabel":"string"},"wallet":{"description":"Crypto wallet routing. On `to`: partner-supplied destination. On `from`: service-populated when autoramp provisions a crypto inbound. Ignored on the `from` side of requests.","type":"object","properties":{"via":{"description":"Network name from the List deposit methods `network` field.","type":"string","minLength":1,"maxLength":32,"isRequired":true,"uniqueKey":"data.from.wallet.via","typeLabel":"string"},"address":{"description":"On-chain address. Required when `Wallet` is set on a destination endpoint; populated by the service when set on a source endpoint response.","type":"string","minLength":1,"maxLength":256,"uniqueKey":"data.from.wallet.address","typeLabel":"string"},"memo":{"description":"Memo for chains that require one (e.g., XLM, EOS, Cosmos). Passed through to the destination on off-ramp; populated on source responses when upstream provisions a memo'd inbound.","type":"string","minLength":1,"maxLength":64,"uniqueKey":"data.from.wallet.memo","typeLabel":"string"},"tag":{"description":"Destination tag for chains that require one (e.g., XRP). Passed through to the destination on off-ramp; populated on source responses.","type":"string","minLength":1,"maxLength":64,"uniqueKey":"data.from.wallet.tag","typeLabel":"string"}},"required":["via"],"title":"Wallet","uniqueKey":"data.from.wallet","typeLabel":"Wallet · object"},"bank_account":{"description":"Bank account routing. On `to`: partner-supplied destination. On `from`: service-populated when autoramp provisions a fiat inbound. Ignored on the `from` side of requests.","type":"object","properties":{"via":{"description":"Bank rail used to fund the conversion.","type":"string","minLength":1,"maxLength":32,"isRequired":true,"uniqueKey":"data.from.bank_account.via","typeLabel":"string"},"bank":{"description":"Bank / financial institution name for the beneficiary account. Optional; passed through to the destination on off-ramp.","type":"string","maxLength":256,"uniqueKey":"data.from.bank_account.bank","typeLabel":"string"},"iban":{"description":"International Bank Account Number (SEPA, SWIFT).","type":"string","minLength":14,"maxLength":42,"uniqueKey":"data.from.bank_account.iban","typeLabel":"string"},"bic":{"description":"Bank Identifier Code (SEPA, SWIFT).","type":"string","minLength":8,"maxLength":11,"uniqueKey":"data.from.bank_account.bic","typeLabel":"string"},"sort_code":{"description":"UK sort code (FPS).","type":"string","minLength":6,"maxLength":8,"uniqueKey":"data.from.bank_account.sort_code","typeLabel":"string"},"account_number":{"description":"Account number. Required for FPS destinations; may also be populated on source bank accounts.","type":"string","minLength":1,"maxLength":34,"uniqueKey":"data.from.bank_account.account_number","typeLabel":"string"},"routing_number":{"description":"Routing number populated on source bank accounts when supplied by the provider; not accepted on conversion destinations.","type":"string","minLength":1,"maxLength":32,"uniqueKey":"data.from.bank_account.routing_number","typeLabel":"string"},"swift":{"description":"SWIFT code populated on source bank accounts when supplied by the provider; not accepted on conversion destinations.","type":"string","minLength":8,"maxLength":11,"uniqueKey":"data.from.bank_account.swift","typeLabel":"string"},"payee_name":{"description":"Payee / account-holder name on the provisioned inbound (named account). Populated once the virtual account is provisioned. It appears on Get and List for SEPA (not currently returned for FPS); the create response carries it only when the account was already provisioned at creation time. Rejected on a destination.","type":"string","minLength":1,"maxLength":140,"uniqueKey":"data.from.bank_account.payee_name","typeLabel":"string"},"bank_address":{"description":"Bank or EMI (electronic money institution) address on the provisioned inbound. Populated once the virtual account is provisioned. It appears on Get and List for SEPA (not currently returned for FPS); the create response carries it only when the account was already provisioned at creation time. Rejected on a destination.","type":"string","minLength":1,"maxLength":256,"uniqueKey":"data.from.bank_account.bank_address","typeLabel":"string"},"payee_address":{"description":"Payee's registered postal address on the provisioned inbound (on-ramp source only), distinct from `bank_address`, which is the bank or EMI address. Populated once the virtual account is provisioned. It appears on Get and List for SEPA (not currently returned for FPS); the create response carries it only when the account was already provisioned at creation time. Rejected on a destination.","type":"string","minLength":1,"maxLength":256,"uniqueKey":"data.from.bank_account.payee_address","typeLabel":"string"},"account_link_id":{"description":"Public Account Link identifier naming the linked bank account this endpoint routes to, in place of raw routing fields. Mutually exclusive with raw routing fields; `via` still selects the rail.","type":"string","minLength":1,"maxLength":128,"uniqueKey":"data.from.bank_account.account_link_id","typeLabel":"string"}},"required":["via"],"title":"BankAccount","uniqueKey":"data.from.bank_account","typeLabel":"BankAccount · object"}},"required":["type"],"title":"ConversionEndpoint","isRequired":true,"uniqueKey":"data.from","typeLabel":"ConversionEndpoint · object"},"to":{"description":"Destination side. Wallet and bank destinations require their corresponding routing block. Balance destinations use only `symbol` and `type`; omit `wallet` and `bank_account`. Where enabled, balance destinations support GBP bank/FPS to USDC.","type":"object","properties":{"type":{"description":"Kind of endpoint. `wallet` requires `wallet`; `bank` requires `bank_account`; `balance` requires neither.","type":"string","enum":["wallet","bank","balance"],"title":"EndpointType","isRequired":true,"uniqueKey":"data.to.type","typeLabel":"enum\u003cstring>"},"symbol":{"description":"Asset ticker symbol (e.g., \"EUR\", \"USDC\", \"BTC\").","type":"string","minLength":1,"maxLength":16,"uniqueKey":"data.to.symbol","typeLabel":"string"},"wallet":{"description":"Crypto wallet routing. On `to`: partner-supplied destination. On `from`: service-populated when autoramp provisions a crypto inbound. Ignored on the `from` side of requests.","type":"object","properties":{"via":{"description":"Network name from the List deposit methods `network` field.","type":"string","minLength":1,"maxLength":32,"isRequired":true,"uniqueKey":"data.to.wallet.via","typeLabel":"string"},"address":{"description":"On-chain address. Required when `Wallet` is set on a destination endpoint; populated by the service when set on a source endpoint response.","type":"string","minLength":1,"maxLength":256,"uniqueKey":"data.to.wallet.address","typeLabel":"string"},"memo":{"description":"Memo for chains that require one (e.g., XLM, EOS, Cosmos). Passed through to the destination on off-ramp; populated on source responses when upstream provisions a memo'd inbound.","type":"string","minLength":1,"maxLength":64,"uniqueKey":"data.to.wallet.memo","typeLabel":"string"},"tag":{"description":"Destination tag for chains that require one (e.g., XRP). Passed through to the destination on off-ramp; populated on source responses.","type":"string","minLength":1,"maxLength":64,"uniqueKey":"data.to.wallet.tag","typeLabel":"string"}},"required":["via"],"title":"Wallet","uniqueKey":"data.to.wallet","typeLabel":"Wallet · object"},"bank_account":{"description":"Bank account routing. On `to`: partner-supplied destination. On `from`: service-populated when autoramp provisions a fiat inbound. Ignored on the `from` side of requests.","type":"object","properties":{"via":{"description":"Bank rail identifier. Conversion destinations support `sepa`, `fps`, and enabled ACH/RTP rails. ACH accepts bank details or an Account Link ID; RTP requires an Account Link ID.","type":"string","minLength":1,"maxLength":32,"isRequired":true,"uniqueKey":"data.to.bank_account.via","typeLabel":"string"},"bank":{"description":"Bank / financial institution name for the beneficiary account. Optional; passed through to the destination on off-ramp.","type":"string","maxLength":256,"uniqueKey":"data.to.bank_account.bank","typeLabel":"string"},"iban":{"description":"International Bank Account Number (SEPA, SWIFT).","type":"string","minLength":14,"maxLength":42,"uniqueKey":"data.to.bank_account.iban","typeLabel":"string"},"bic":{"description":"Bank Identifier Code (SEPA, SWIFT).","type":"string","minLength":8,"maxLength":11,"uniqueKey":"data.to.bank_account.bic","typeLabel":"string"},"sort_code":{"description":"UK sort code (FPS).","type":"string","minLength":6,"maxLength":8,"uniqueKey":"data.to.bank_account.sort_code","typeLabel":"string"},"account_number":{"description":"Account number. Required for FPS and ACH destinations supplied as bank details; may also be populated on source bank accounts.","type":"string","minLength":1,"maxLength":34,"uniqueKey":"data.to.bank_account.account_number","typeLabel":"string"},"routing_number":{"description":"Routing number. Required for ACH destinations supplied as bank details; may also be populated on source bank accounts.","type":"string","minLength":1,"maxLength":32,"uniqueKey":"data.to.bank_account.routing_number","typeLabel":"string"},"swift":{"description":"SWIFT code populated on source bank accounts when supplied by the provider; not accepted on conversion destinations.","type":"string","minLength":8,"maxLength":11,"uniqueKey":"data.to.bank_account.swift","typeLabel":"string"},"account_link_id":{"description":"Public Account Link identifier naming the linked bank account this endpoint routes to, in place of raw routing fields. Mutually exclusive with raw routing fields; `via` still selects the rail.","type":"string","minLength":1,"maxLength":128,"uniqueKey":"data.to.bank_account.account_link_id","typeLabel":"string"},"account_type":{"description":"Account type for an ACH destination supplied as bank details. The selected Funding withdrawal method determines whether this field is required and which values are allowed.","type":"string","minLength":1,"maxLength":64,"uniqueKey":"data.to.bank_account.account_type","typeLabel":"string"}},"required":["via"],"title":"BankAccount","uniqueKey":"data.to.bank_account","typeLabel":"BankAccount · object"}},"required":["type"],"title":"ConversionEndpoint","isRequired":true,"uniqueKey":"data.to","typeLabel":"ConversionEndpoint · object"},"status":{"description":"Lifecycle status (active | paused).","type":"string","enum":["active","paused","provisioning"],"isRequired":true,"uniqueKey":"data.status","typeLabel":"enum\u003cstring>"},"created_at":{"description":"Time at which the conversion rule was created.","type":"string","format":"date-time","isRequired":true,"uniqueKey":"data.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"description":"Time at which the conversion rule was last updated.","type":"string","format":"date-time","isRequired":true,"uniqueKey":"data.updated_at","typeLabel":"string\u003cdate-time>"},"name":{"description":"Optional partner-facing label for the conversion rule.","type":"string","uniqueKey":"data.name","typeLabel":"string"},"fee":{"description":"Partner fee that applies to the conversions of this conversion rule. Absent when the configured partner fee applies.","type":"object","additionalProperties":false,"properties":{"bps":{"description":"Fee in basis points, where 1 bps is 0.01%.","type":"integer","format":"int32","minimum":0,"maximum":10000,"uniqueKey":"data.fee.bps","typeLabel":"integer\u003cint32>"},"absolute":{"description":"Absolute fee amount in the trading fee currency.","type":"string","maxLength":32,"pattern":"^[0-9]+([.][0-9]+)?$","uniqueKey":"data.fee.absolute","typeLabel":"string"}},"uniqueKey":"data.fee","typeLabel":"object"}},"required":["id","from","to","status","created_at","updated_at"],"title":"ConversionRule","isRequired":true,"uniqueKey":"data","typeLabel":"ConversionRule · object"}},"required":["data"],"uniqueKey":"","typeLabel":"object"},"examples":{"id-get-conversion-rule-ok":{"title":"id-get-conversion-rule-ok","value":{"data":{"id":"550e8400-e29b-41d4-a716-446655440000","name":"EUR autoramp to Polygon vault","from":{"symbol":"EUR","type":"bank","bank_account":{"via":"sepa","iban":"DE89370400440532013000","bic":"COBADEFFXXX","payee_name":"Delta Commerce B.V.","bank_address":"Borschestraat 12, Amsterdam","payee_address":"71 Sir John Rogerson's Quay, Dublin, D02 R296, Ireland"}},"to":{"symbol":"USDC","type":"wallet","wallet":{"via":"polygon","address":"0x1234567890abcdef1234567890abcdef12345678"}},"status":"active","created_at":"2026-05-25T10:30:00Z","updated_at":"2026-05-25T10:30:00Z"}}}},"exampleType":"examples"}},"exampleType":"examples"},"467ffb6c-582b-4223-b1ea-4bc967347bbd":{"description":"Validation error","headers":{"X-Trace-Id":{"description":"Trace identifier for the request. Include it when contacting support.","schema":{"type":"string","example":"4bf92f3577b34da6a3ce929d0e0e4736"}},"Strict-Transport-Security":{"description":"Enforces HTTPS for the duration specified by `max-age`.","schema":{"type":"string","example":"max-age=31536000; includeSubDomains; preload"}},"Cache-Control":{"description":"Prevents caching of sensitive financial data. Always `no-store`.","schema":{"type":"string","enum":["no-store"],"example":"no-store"}}},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Bad Request","description":"Error envelope for request validation failures.","required":["error"],"properties":{"error":{"type":"object","description":"Standard PWS API error object for request validation failures.","required":["status","code","type","instance"],"properties":{"type":{"type":"string","description":"Machine-readable error class.","isRequired":true,"uniqueKey":"oneOf.0.error.type","typeLabel":"string"},"status":{"type":"integer","description":"HTTP status code returned for this error.","format":"int32","const":400,"isRequired":true,"uniqueKey":"oneOf.0.error.status","typeLabel":"integer\u003cint32>"},"instance":{"type":"string","description":"Request identifier for this specific error occurrence.","isRequired":true,"uniqueKey":"oneOf.0.error.instance","typeLabel":"string"},"code":{"type":"string","description":"Stable machine-readable error code.","enum":["bad_request"],"isRequired":true,"uniqueKey":"oneOf.0.error.code","typeLabel":"enum\u003cstring>"},"doc_url":{"type":"string","description":"Optional link to documentation for this error.","format":"uri","uniqueKey":"oneOf.0.error.doc_url","typeLabel":"string\u003curi>"},"causes":{"type":"array","items":{"type":"object","description":"A single request validation failure.","required":["field","message"],"properties":{"field":{"type":"string","description":"Dot-notation path to the offending request field.","isRequired":true,"uniqueKey":"oneOf.0.error.causes.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","description":"Human-readable explanation of the failed validation rule.","isRequired":true,"uniqueKey":"oneOf.0.error.causes.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"oneOf.0.error.causes.items.[INDEX]","typeLabel":"object"},"description":"Validation failures that contributed to the error.","uniqueKey":"oneOf.0.error.causes","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"oneOf.0.error","typeLabel":"object"}},"uniqueKey":"oneOf.0","typeLabel":"Bad Request · object"},{"type":"object","title":"Gateway","description":"Gateway-level validation failure returned before the request reaches the service.","required":["error"],"properties":{"error":{"type":"object","description":"Standard PWS API error object for request validation failures.","required":["status","code","type","instance"],"properties":{"type":{"type":"string","description":"Machine-readable error class.","const":"service_error","isRequired":true,"uniqueKey":"oneOf.1.error.type","typeLabel":"string"},"status":{"type":"integer","description":"HTTP status code returned for this error.","format":"int32","const":400,"isRequired":true,"uniqueKey":"oneOf.1.error.status","typeLabel":"integer\u003cint32>"},"instance":{"type":"string","description":"Request identifier for this specific error occurrence.","isRequired":true,"uniqueKey":"oneOf.1.error.instance","typeLabel":"string"},"code":{"type":"string","description":"Stable machine-readable error code.","const":"gateway","isRequired":true,"uniqueKey":"oneOf.1.error.code","typeLabel":"string"},"doc_url":{"type":"string","description":"Optional link to documentation for this error.","format":"uri","uniqueKey":"oneOf.1.error.doc_url","typeLabel":"string\u003curi>"},"causes":{"type":"array","items":{"type":"object","description":"A single request validation failure.","required":["field","message"],"properties":{"field":{"type":"string","description":"Dot-notation path to the offending request field.","isRequired":true,"uniqueKey":"oneOf.1.error.causes.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","description":"Human-readable explanation of the failed validation rule.","isRequired":true,"uniqueKey":"oneOf.1.error.causes.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"oneOf.1.error.causes.items.[INDEX]","typeLabel":"object"},"description":"Validation failures that contributed to the error.","uniqueKey":"oneOf.1.error.causes","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"oneOf.1.error","typeLabel":"object"}},"uniqueKey":"oneOf.1","typeLabel":"Gateway · object"}],"uniqueKey":"","typeLabel":"Bad Request · object | Gateway · object"},"examples":{"invalid-request":{"title":"invalid-request","value":{"error":{"type":"conversions_error","instance":"5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b","status":400,"code":"bad_request","causes":[{"field":"account_id","message":"must be a valid account identifier"}]}}}},"exampleType":"examples"}},"exampleType":"examples"},"221d362a-927c-459a-a471-4e7b5f0f675d":{"description":"Authentication required","headers":{"X-Trace-Id":{"description":"Trace identifier for the request. Include it when contacting support.","schema":{"type":"string","example":"4bf92f3577b34da6a3ce929d0e0e4736"}},"Strict-Transport-Security":{"description":"Enforces HTTPS for the duration specified by `max-age`.","schema":{"type":"string","example":"max-age=31536000; includeSubDomains; preload"}},"Cache-Control":{"description":"Prevents caching of sensitive financial data. Always `no-store`.","schema":{"type":"string","enum":["no-store"],"example":"no-store"}}},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Unauthenticated","description":"Error envelope for operational or domain failures.","required":["error"],"properties":{"error":{"type":"object","description":"Standard PWS API error object for non-validation failures.","required":["status","code","type","instance"],"properties":{"type":{"type":"string","description":"Machine-readable error class.","isRequired":true,"uniqueKey":"oneOf.0.error.type","typeLabel":"string"},"status":{"type":"integer","description":"HTTP status code returned for this error.","format":"int32","const":401,"isRequired":true,"uniqueKey":"oneOf.0.error.status","typeLabel":"integer\u003cint32>"},"instance":{"type":"string","description":"Request identifier for this specific error occurrence.","isRequired":true,"uniqueKey":"oneOf.0.error.instance","typeLabel":"string"},"code":{"type":"string","description":"Stable machine-readable error code.","enum":["unauthenticated"],"isRequired":true,"uniqueKey":"oneOf.0.error.code","typeLabel":"enum\u003cstring>"},"doc_url":{"type":"string","description":"Optional link to documentation for this error.","format":"uri","uniqueKey":"oneOf.0.error.doc_url","typeLabel":"string\u003curi>"},"causes":{"type":"array","items":{"type":"object","additionalProperties":true,"uniqueKey":"oneOf.0.error.causes.items.[INDEX]","typeLabel":"object"},"description":"Additional error details, when present.","uniqueKey":"oneOf.0.error.causes","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"oneOf.0.error","typeLabel":"object"}},"uniqueKey":"oneOf.0","typeLabel":"Unauthenticated · object"},{"type":"object","title":"Gateway","description":"Authentication failure returned by the API gateway.","required":["error"],"properties":{"error":{"type":"object","description":"Standard PWS API error object for non-validation failures.","required":["status","code","type","instance"],"properties":{"type":{"type":"string","description":"Machine-readable error class.","const":"service_error","isRequired":true,"uniqueKey":"oneOf.1.error.type","typeLabel":"string"},"status":{"type":"integer","description":"HTTP status code returned for this error.","format":"int32","const":401,"isRequired":true,"uniqueKey":"oneOf.1.error.status","typeLabel":"integer\u003cint32>"},"instance":{"type":"string","description":"Request identifier for this specific error occurrence.","isRequired":true,"uniqueKey":"oneOf.1.error.instance","typeLabel":"string"},"code":{"type":"string","description":"Stable machine-readable error code.","const":"gateway","isRequired":true,"uniqueKey":"oneOf.1.error.code","typeLabel":"string"},"doc_url":{"type":"string","description":"Optional link to documentation for this error.","format":"uri","uniqueKey":"oneOf.1.error.doc_url","typeLabel":"string\u003curi>"},"causes":{"type":"array","items":{"type":"object","additionalProperties":true,"uniqueKey":"oneOf.1.error.causes.items.[INDEX]","typeLabel":"object"},"description":"Additional error details, when present.","uniqueKey":"oneOf.1.error.causes","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"oneOf.1.error","typeLabel":"object"}},"uniqueKey":"oneOf.1","typeLabel":"Gateway · object"}],"uniqueKey":"","typeLabel":"Unauthenticated · object | Gateway · object"},"examples":{"authentication-failed":{"title":"authentication-failed","value":{"error":{"type":"conversions_error","instance":"5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b","status":401,"code":"unauthenticated"}}}},"exampleType":"examples"}},"exampleType":"examples"},"f299ede1-d806-4369-b572-f19aa546b784":{"description":"Forbidden","headers":{"X-Trace-Id":{"description":"Trace identifier for the request. Include it when contacting support.","schema":{"type":"string","example":"4bf92f3577b34da6a3ce929d0e0e4736"}},"Strict-Transport-Security":{"description":"Enforces HTTPS for the duration specified by `max-age`.","schema":{"type":"string","example":"max-age=31536000; includeSubDomains; preload"}},"Cache-Control":{"description":"Prevents caching of sensitive financial data. Always `no-store`.","schema":{"type":"string","enum":["no-store"],"example":"no-store"}}},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Forbidden","description":"Error envelope for operational or domain failures.","required":["error"],"properties":{"error":{"type":"object","description":"Standard PWS API error object for non-validation failures.","required":["status","code","type","instance"],"properties":{"type":{"type":"string","description":"Machine-readable error class.","isRequired":true,"uniqueKey":"oneOf.0.error.type","typeLabel":"string"},"status":{"type":"integer","description":"HTTP status code returned for this error.","format":"int32","const":403,"isRequired":true,"uniqueKey":"oneOf.0.error.status","typeLabel":"integer\u003cint32>"},"instance":{"type":"string","description":"Request identifier for this specific error occurrence.","isRequired":true,"uniqueKey":"oneOf.0.error.instance","typeLabel":"string"},"code":{"type":"string","description":"Stable machine-readable error code.","enum":["forbidden"],"isRequired":true,"uniqueKey":"oneOf.0.error.code","typeLabel":"enum\u003cstring>"},"doc_url":{"type":"string","description":"Optional link to documentation for this error.","format":"uri","uniqueKey":"oneOf.0.error.doc_url","typeLabel":"string\u003curi>"},"causes":{"type":"array","items":{"type":"object","additionalProperties":true,"uniqueKey":"oneOf.0.error.causes.items.[INDEX]","typeLabel":"object"},"description":"Additional error details, when present.","uniqueKey":"oneOf.0.error.causes","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"oneOf.0.error","typeLabel":"object"}},"uniqueKey":"oneOf.0","typeLabel":"Forbidden · object"},{"type":"object","title":"Gateway","description":"Authorization failure returned by the API gateway.","required":["error"],"properties":{"error":{"type":"object","description":"Standard PWS API error object for non-validation failures.","required":["status","code","type","instance"],"properties":{"type":{"type":"string","description":"Machine-readable error class.","const":"service_error","isRequired":true,"uniqueKey":"oneOf.1.error.type","typeLabel":"string"},"status":{"type":"integer","description":"HTTP status code returned for this error.","format":"int32","const":403,"isRequired":true,"uniqueKey":"oneOf.1.error.status","typeLabel":"integer\u003cint32>"},"instance":{"type":"string","description":"Request identifier for this specific error occurrence.","isRequired":true,"uniqueKey":"oneOf.1.error.instance","typeLabel":"string"},"code":{"type":"string","description":"Stable machine-readable error code.","const":"gateway","isRequired":true,"uniqueKey":"oneOf.1.error.code","typeLabel":"string"},"doc_url":{"type":"string","description":"Optional link to documentation for this error.","format":"uri","uniqueKey":"oneOf.1.error.doc_url","typeLabel":"string\u003curi>"},"causes":{"type":"array","items":{"type":"object","additionalProperties":true,"uniqueKey":"oneOf.1.error.causes.items.[INDEX]","typeLabel":"object"},"description":"Additional error details, when present.","uniqueKey":"oneOf.1.error.causes","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"oneOf.1.error","typeLabel":"object"}},"uniqueKey":"oneOf.1","typeLabel":"Gateway · object"}],"uniqueKey":"","typeLabel":"Forbidden · object | Gateway · object"},"examples":{"caller-is-not-allowed":{"title":"caller-is-not-allowed","value":{"error":{"type":"conversions_error","instance":"5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b","status":403,"code":"forbidden"}}}},"exampleType":"examples"}},"exampleType":"examples"},"9f5912a3-11a2-4bec-ad92-486ce6f067ad":{"description":"Not found","headers":{"X-Trace-Id":{"description":"Trace identifier for the request. Include it when contacting support.","schema":{"type":"string","example":"4bf92f3577b34da6a3ce929d0e0e4736"}},"Strict-Transport-Security":{"description":"Enforces HTTPS for the duration specified by `max-age`.","schema":{"type":"string","example":"max-age=31536000; includeSubDomains; preload"}},"Cache-Control":{"description":"Prevents caching of sensitive financial data. Always `no-store`.","schema":{"type":"string","enum":["no-store"],"example":"no-store"}}},"content":{"application/json":{"schema":{"type":"object","description":"The requested resource does not exist.","required":["error"],"properties":{"error":{"type":"object","description":"Standard PWS API error object for non-validation failures.","required":["status","code","type","instance"],"properties":{"type":{"type":"string","description":"Machine-readable error class.","isRequired":true,"uniqueKey":"error.type","typeLabel":"string"},"status":{"type":"integer","description":"HTTP status code returned for this error.","format":"int32","const":404,"isRequired":true,"uniqueKey":"error.status","typeLabel":"integer\u003cint32>"},"instance":{"type":"string","description":"Request identifier for this specific error occurrence.","isRequired":true,"uniqueKey":"error.instance","typeLabel":"string"},"code":{"type":"string","description":"Stable machine-readable error code.","enum":["not_found"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"doc_url":{"type":"string","description":"Optional link to documentation for this error.","format":"uri","uniqueKey":"error.doc_url","typeLabel":"string\u003curi>"},"causes":{"type":"array","items":{"type":"object","additionalProperties":true,"uniqueKey":"error.causes.items.[INDEX]","typeLabel":"object"},"description":"Additional error details, when present.","uniqueKey":"error.causes","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"conversion-resource-not-found":{"title":"conversion-resource-not-found","value":{"error":{"type":"conversions_error","instance":"5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b","status":404,"code":"not_found"}}}},"exampleType":"examples"}},"exampleType":"examples"},"5c348ea1-6127-4b4f-96ab-19f265cbaa98":{"description":"Rate limit exceeded","headers":{"X-Trace-Id":{"description":"Trace identifier for the request. Include it when contacting support.","schema":{"type":"string","example":"4bf92f3577b34da6a3ce929d0e0e4736"}},"Strict-Transport-Security":{"description":"Enforces HTTPS for the duration specified by `max-age`.","schema":{"type":"string","example":"max-age=31536000; includeSubDomains; preload"}},"Cache-Control":{"description":"Prevents caching of sensitive financial data. Always `no-store`.","schema":{"type":"string","enum":["no-store"],"example":"no-store"}}},"content":{"application/json":{"schema":{"type":"object","description":"The request was rate limited or a resource quota was exhausted.","required":["error"],"properties":{"error":{"type":"object","description":"Standard PWS API error object for non-validation failures.","required":["status","code","type","instance"],"properties":{"type":{"type":"string","description":"Machine-readable error class.","isRequired":true,"uniqueKey":"error.type","typeLabel":"string"},"status":{"type":"integer","description":"HTTP status code returned for this error.","format":"int32","const":429,"isRequired":true,"uniqueKey":"error.status","typeLabel":"integer\u003cint32>"},"instance":{"type":"string","description":"Request identifier for this specific error occurrence.","isRequired":true,"uniqueKey":"error.instance","typeLabel":"string"},"code":{"type":"string","description":"Stable machine-readable error code.","enum":["resource_exhausted"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"doc_url":{"type":"string","description":"Optional link to documentation for this error.","format":"uri","uniqueKey":"error.doc_url","typeLabel":"string\u003curi>"},"causes":{"type":"array","items":{"type":"object","additionalProperties":true,"uniqueKey":"error.causes.items.[INDEX]","typeLabel":"object"},"description":"Additional error details, when present.","uniqueKey":"error.causes","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"rate-limit-exceeded":{"title":"rate-limit-exceeded","value":{"error":{"type":"conversions_error","instance":"5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b","status":429,"code":"resource_exhausted"}}}},"exampleType":"examples"}},"exampleType":"examples"},"f1fd9ca4-fc42-4ff0-9a32-7ec8fb7fe850":{"description":"Internal server error","headers":{"X-Trace-Id":{"description":"Trace identifier for the request. Include it when contacting support.","schema":{"type":"string","example":"4bf92f3577b34da6a3ce929d0e0e4736"}},"Strict-Transport-Security":{"description":"Enforces HTTPS for the duration specified by `max-age`.","schema":{"type":"string","example":"max-age=31536000; includeSubDomains; preload"}},"Cache-Control":{"description":"Prevents caching of sensitive financial data. Always `no-store`.","schema":{"type":"string","enum":["no-store"],"example":"no-store"}}},"content":{"application/json":{"schema":{"type":"object","description":"An unexpected server-side error occurred.","required":["error"],"properties":{"error":{"type":"object","description":"Standard PWS API error object for non-validation failures.","required":["status","code","type","instance"],"properties":{"type":{"type":"string","description":"Machine-readable error class.","isRequired":true,"uniqueKey":"error.type","typeLabel":"string"},"status":{"type":"integer","description":"HTTP status code returned for this error.","format":"int32","const":500,"isRequired":true,"uniqueKey":"error.status","typeLabel":"integer\u003cint32>"},"instance":{"type":"string","description":"Request identifier for this specific error occurrence.","isRequired":true,"uniqueKey":"error.instance","typeLabel":"string"},"code":{"type":"string","description":"Stable machine-readable error code.","enum":["internal"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"doc_url":{"type":"string","description":"Optional link to documentation for this error.","format":"uri","uniqueKey":"error.doc_url","typeLabel":"string\u003curi>"},"causes":{"type":"array","items":{"type":"object","additionalProperties":true,"uniqueKey":"error.causes.items.[INDEX]","typeLabel":"object"},"description":"Additional error details, when present.","uniqueKey":"error.causes","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"internal-error":{"title":"internal-error","value":{"error":{"type":"conversions_error","instance":"5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b","status":500,"code":"internal"}}}},"exampleType":"examples"}},"exampleType":"examples"},"3bc6b138-fa50-4cca-8e84-0e9d973c1ad8":{"description":"Error response","headers":{"X-Trace-Id":{"description":"Trace identifier for the request. Include it when contacting support.","schema":{"type":"string","example":"4bf92f3577b34da6a3ce929d0e0e4736"}},"Strict-Transport-Security":{"description":"Enforces HTTPS for the duration specified by `max-age`.","schema":{"type":"string","example":"max-age=31536000; includeSubDomains; preload"}},"Cache-Control":{"description":"Prevents caching of sensitive financial data. Always `no-store`.","schema":{"type":"string","enum":["no-store"],"example":"no-store"}}},"content":{"application/json":{"schema":{"type":"object","description":"The requested operation is not implemented.","required":["error"],"properties":{"error":{"type":"object","description":"Standard PWS API error object for non-validation failures.","required":["status","code","type","instance"],"properties":{"type":{"type":"string","description":"Machine-readable error class.","isRequired":true,"uniqueKey":"error.type","typeLabel":"string"},"status":{"type":"integer","description":"HTTP status code returned for this error.","format":"int32","const":501,"isRequired":true,"uniqueKey":"error.status","typeLabel":"integer\u003cint32>"},"instance":{"type":"string","description":"Request identifier for this specific error occurrence.","isRequired":true,"uniqueKey":"error.instance","typeLabel":"string"},"code":{"type":"string","description":"Stable machine-readable error code.","enum":["unimplemented"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"doc_url":{"type":"string","description":"Optional link to documentation for this error.","format":"uri","uniqueKey":"error.doc_url","typeLabel":"string\u003curi>"},"causes":{"type":"array","items":{"type":"object","additionalProperties":true,"uniqueKey":"error.causes.items.[INDEX]","typeLabel":"object"},"description":"Additional error details, when present.","uniqueKey":"error.causes","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"operation-not-implemented":{"title":"operation-not-implemented","value":{"error":{"type":"conversions_error","instance":"5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b","status":501,"code":"unimplemented"}}}},"exampleType":"examples"}},"exampleType":"examples"},"45d719c1-ca6a-4c0e-9ebf-fb47871b4316":{"description":"Service unavailable","headers":{"X-Trace-Id":{"description":"Trace identifier for the request. Include it when contacting support.","schema":{"type":"string","example":"4bf92f3577b34da6a3ce929d0e0e4736"}},"Strict-Transport-Security":{"description":"Enforces HTTPS for the duration specified by `max-age`.","schema":{"type":"string","example":"max-age=31536000; includeSubDomains; preload"}},"Cache-Control":{"description":"Prevents caching of sensitive financial data. Always `no-store`.","schema":{"type":"string","enum":["no-store"],"example":"no-store"}}},"content":{"application/json":{"schema":{"type":"object","description":"The service is temporarily unavailable.","required":["error"],"properties":{"error":{"type":"object","description":"Standard PWS API error object for non-validation failures.","required":["status","code","type","instance"],"properties":{"type":{"type":"string","description":"Machine-readable error class.","isRequired":true,"uniqueKey":"error.type","typeLabel":"string"},"status":{"type":"integer","description":"HTTP status code returned for this error.","format":"int32","const":503,"isRequired":true,"uniqueKey":"error.status","typeLabel":"integer\u003cint32>"},"instance":{"type":"string","description":"Request identifier for this specific error occurrence.","isRequired":true,"uniqueKey":"error.instance","typeLabel":"string"},"code":{"type":"string","description":"Stable machine-readable error code.","enum":["unavailable"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"doc_url":{"type":"string","description":"Optional link to documentation for this error.","format":"uri","uniqueKey":"error.doc_url","typeLabel":"string\u003curi>"},"causes":{"type":"array","items":{"type":"object","additionalProperties":true,"uniqueKey":"error.causes.items.[INDEX]","typeLabel":"object"},"description":"Additional error details, when present.","uniqueKey":"error.causes","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"service-unavailable":{"title":"service-unavailable","value":{"error":{"type":"conversions_error","instance":"5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b","status":503,"code":"unavailable"}}}},"exampleType":"examples"}},"exampleType":"examples"},"1cc91238-4aea-49e5-8d70-a974521f0d7b":{"description":"Deadline exceeded","headers":{"X-Trace-Id":{"description":"Trace identifier for the request. Include it when contacting support.","schema":{"type":"string","example":"4bf92f3577b34da6a3ce929d0e0e4736"}},"Strict-Transport-Security":{"description":"Enforces HTTPS for the duration specified by `max-age`.","schema":{"type":"string","example":"max-age=31536000; includeSubDomains; preload"}},"Cache-Control":{"description":"Prevents caching of sensitive financial data. Always `no-store`.","schema":{"type":"string","enum":["no-store"],"example":"no-store"}}},"content":{"application/json":{"schema":{"type":"object","description":"The request deadline was exceeded before a response could be produced.","required":["error"],"properties":{"error":{"type":"object","description":"Standard PWS API error object for non-validation failures.","required":["status","code","type","instance"],"properties":{"type":{"type":"string","description":"Machine-readable error class.","isRequired":true,"uniqueKey":"error.type","typeLabel":"string"},"status":{"type":"integer","description":"HTTP status code returned for this error.","format":"int32","const":504,"isRequired":true,"uniqueKey":"error.status","typeLabel":"integer\u003cint32>"},"instance":{"type":"string","description":"Request identifier for this specific error occurrence.","isRequired":true,"uniqueKey":"error.instance","typeLabel":"string"},"code":{"type":"string","description":"Stable machine-readable error code.","enum":["deadline_exceeded"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"doc_url":{"type":"string","description":"Optional link to documentation for this error.","format":"uri","uniqueKey":"error.doc_url","typeLabel":"string\u003curi>"},"causes":{"type":"array","items":{"type":"object","additionalProperties":true,"uniqueKey":"error.causes.items.[INDEX]","typeLabel":"object"},"description":"Additional error details, when present.","uniqueKey":"error.causes","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"request-deadline-exceeded":{"title":"request-deadline-exceeded","value":{"error":{"type":"conversions_error","instance":"5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b","status":504,"code":"deadline_exceeded"}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"0e360d4d-7ac7-411d-866b-c1625abac094":{"ApiKey":{"type":"apiKey","in":"header","name":"API-Key","description":"Your public API key. Identifies the partner making the request.","scopes":["query-funds"],"schemeName":"ApiKey"},"ApiSign":{"type":"apiKey","in":"header","name":"API-Sign","description":"HMAC signature over the request, computed with your private key.","scopes":[],"schemeName":"ApiSign"},"ApiTimestamp":{"type":"apiKey","in":"header","name":"API-Timestamp","description":"Time the request was signed, as Unix milliseconds. Included in the request signature. Requests signed too far from the server's time are rejected.","scopes":[],"schemeName":"ApiTimestamp"}}},"servers":{"caf8130c-67b7-4adc-8bbf-7f4409636b45":{"url":"https://api.sandbox.services.payward.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"API-Key","description":"Your public API key. Identifies the partner making the request.","scopes":["query-funds"],"schemeName":"ApiKey"},"schema":{"title":"API-Key","type":"string","description":"Your public API key. Identifies the partner making the request.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKey","name":"API-Key"},{"scheme":{"type":"apiKey","in":"header","name":"API-Sign","description":"HMAC signature over the request, computed with your private key.","scopes":[],"schemeName":"ApiSign"},"schema":{"title":"API-Sign","type":"string","description":"HMAC signature over the request, computed with your private key.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiSign","name":"API-Sign"},{"scheme":{"type":"apiKey","in":"header","name":"API-Timestamp","description":"Time the request was signed, as Unix milliseconds. Included in the request signature. Requests signed too far from the server's time are rejected.","scopes":[],"schemeName":"ApiTimestamp"},"schema":{"title":"API-Timestamp","type":"string","description":"Time the request was signed, as Unix milliseconds. Included in the request signature. Requests signed too far from the server's time are rejected.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiTimestamp","name":"API-Timestamp"}],"title":"ApiKey \u0026 ApiSign \u0026 ApiTimestamp"}]},"originalFileLocation":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json"},"subdomain":"mintlify-0e856cf0","siteName":"Payward Developer Documentation","title":"Get conversion rule - Payward Developer Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-09T18:27:25.897Z","originalFileLocation":"api-reference/sandbox/conversions/get-conversion-rule.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Retrieves the current state of a previously created conversion rule.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Payward Developer Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/mintlify-0e856cf0/qCKiWMQ7t-C00--C/_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/mintlify-0e856cf0/qCKiWMQ7t-C00--C/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/mintlify-0e856cf0/qCKiWMQ7t-C00--C/_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/mintlify-0e856cf0/qCKiWMQ7t-C00--C/_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/mintlify-0e856cf0/qCKiWMQ7t-C00--C/_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/mintlify-0e856cf0/qCKiWMQ7t-C00--C/_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/mintlify-0e856cf0/qCKiWMQ7t-C00--C/_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/mintlify-0e856cf0/qCKiWMQ7t-C00--C/_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/mintlify-0e856cf0/qCKiWMQ7t-C00--C/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get conversion rule - Payward Developer Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieves the current state of a previously created conversion rule.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Payward Developer Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.services.payward.com/api-reference/sandbox/conversions/get-conversion-rule\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://mintlify-0e856cf0.mintlify.site/_mintlify/api/og/v2?division=Conversions\u0026amp;title=Get+conversion+rule\u0026amp;description=Retrieves+the+current+state+of+a+previously+created+conversion+rule.\u0026amp;theme=1e4ff8f14cd3b644cbf830c4\u0026amp;signature=1b747551eccddb6ad16e34b3ef762ce324f0417df340c387f5a18af97b341455\">\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=\"Get conversion rule - Payward Developer Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieves the current state of a previously created conversion rule.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://mintlify-0e856cf0.mintlify.site/_mintlify/api/og/v2?division=Conversions\u0026amp;title=Get+conversion+rule\u0026amp;description=Retrieves+the+current+state+of+a+previously+created+conversion+rule.\u0026amp;theme=1e4ff8f14cd3b644cbf830c4\u0026amp;signature=1b747551eccddb6ad16e34b3ef762ce324f0417df340c387f5a18af97b341455\">\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/mintlify-0e856cf0/qCKiWMQ7t-C00--C/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Payward Developer Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0D0D0D\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.services.payward.com/api-reference/sandbox/conversions/get-conversion-rule\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/sandbox/conversions/get-conversion-rule.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.services.payward.com/#organization\",\"name\":\"Payward Developer Documentation\",\"url\":\"https://docs.services.payward.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/mintlify-0e856cf0/MS2nSfkmrBCPqOvg/logo/light.svg?fit=max\u0026auto=format\u0026n=MS2nSfkmrBCPqOvg\u0026q=85\u0026s=38bcfc0cb2a1e7c2a308a1de91e5e778\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.services.payward.com#website\",\"name\":\"Payward Developer Documentation\",\"url\":\"https://docs.services.payward.com\",\"publisher\":{\"@id\":\"https://docs.services.payward.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.services.payward.com/api-reference/sandbox/conversions/get-conversion-rule#webpage\",\"url\":\"https://docs.services.payward.com/api-reference/sandbox/conversions/get-conversion-rule\",\"name\":\"Get conversion rule\",\"description\":\"Retrieves the current state of a previously created conversion rule.\",\"dateModified\":\"2026-11-09T18:27:25.897Z\",\"isPartOf\":{\"@id\":\"https://docs.services.payward.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.services.payward.com/api-reference/sandbox/conversions/get-conversion-rule#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.services.payward.com/api-reference/sandbox/conversions/get-conversion-rule#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Payward Services API\",\"item\":\"https://docs.services.payward.com/api-reference/sandbox/derivatives-transfers/create-derivatives-transfer\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Conversions\",\"item\":\"https://docs.services.payward.com/api-reference/sandbox/conversions/list-on-demand-conversions\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get conversion rule\",\"item\":\"https://docs.services.payward.com/api-reference/sandbox/conversions/get-conversion-rule\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.services.payward.com/api-reference/sandbox/conversions/get-conversion-rule#apireference\",\"headline\":\"Get conversion rule\",\"name\":\"Get conversion rule\",\"description\":\"Retrieves the current state of a previously created conversion rule.\",\"url\":\"https://docs.services.payward.com/api-reference/sandbox/conversions/get-conversion-rule\",\"mainEntityOfPage\":{\"@id\":\"https://docs.services.payward.com/api-reference/sandbox/conversions/get-conversion-rule#webpage\"},\"dateModified\":\"2026-11-09T18:27:25.897Z\",\"publisher\":{\"@id\":\"https://docs.services.payward.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.services.payward.com#website\"}}]}\u003c/script>","siteName":"Payward Developer Documentation","nav":{"global":{"tabs":[{"tab":"Postman collection","href":"/tabs/developer-documentation/get-started/postman"}]},"tabs":[{"tab":"Get Started","pages":[{"title":"Get Started","href":""}]},{"tab":"Concepts","pages":[{"title":"Concepts","href":"/tabs/concepts/overview"}]},{"tab":"Integration guides","pages":[{"title":"Integration guides","href":"/tabs/guides/overview"}]},{"tab":"API reference","dropdowns":[{"dropdown":"Production","icon":"server","description":"API reference for the production environment","pages":[{"title":"API reference","sidebarTitle":"Overview","href":"/api-reference"},{"group":"Payward Services API","expanded":true,"pages":[{"group":"Derivatives","pages":[]},{"group":"Assets","pages":[{"title":"List assets","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/assets","href":"/api-reference/production-live/assets/list-assets"},{"title":"Get asset","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/assets/{asset_type}/{asset_symbol}","href":"/api-reference/production-live/assets/get-asset"},{"title":"List asset rates","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/assets/{asset_type}/{asset_symbol}/rates","href":"/api-reference/production-live/assets/list-asset-rates"},{"title":"List user assets","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/users/{user_id}/assets","href":"/api-reference/production-live/assets/list-user-assets"},{"title":"Get user asset","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/users/{user_id}/assets/{asset_type}/{asset_symbol}","href":"/api-reference/production-live/assets/get-user-asset"},{"title":"List user asset rates","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/users/{user_id}/assets/{asset_type}/{asset_symbol}/rates","href":"/api-reference/production-live/assets/list-user-asset-rates"}]},{"group":"Conversions","pages":[{"title":"List on-demand conversions","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/accounts/{account_id}/on-demand-conversions","href":"/api-reference/production-live/conversions/list-on-demand-conversions"},{"title":"Execute on-demand conversion","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json post /v1/accounts/{account_id}/on-demand-conversions","href":"/api-reference/production-live/conversions/execute-on-demand-conversion"},{"title":"Get on-demand conversion","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/accounts/{account_id}/on-demand-conversions/{conversion_id}","href":"/api-reference/production-live/conversions/get-on-demand-conversion"},{"title":"List conversion rules","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/accounts/{account_id}/conversions","href":"/api-reference/production-live/conversions/list-conversion-rules"},{"title":"Create conversion rule","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json post /v1/accounts/{account_id}/conversions","href":"/api-reference/production-live/conversions/create-conversion-rule"},{"title":"Get conversion rule","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/accounts/{account_id}/conversions/{conversion_rule_id}","href":"/api-reference/production-live/conversions/get-conversion-rule"},{"title":"Update conversion rule","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json put /v1/accounts/{account_id}/conversions/{conversion_rule_id}","href":"/api-reference/production-live/conversions/update-conversion-rule"},{"title":"Delete conversion rule","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json delete /v1/accounts/{account_id}/conversions/{conversion_rule_id}","href":"/api-reference/production-live/conversions/delete-conversion-rule"},{"title":"List conversion rule transactions","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/accounts/{account_id}/conversions/{conversion_rule_id}/transactions","href":"/api-reference/production-live/conversions/list-conversion-rule-transactions"}]},{"group":"Auto Earn","pages":[{"title":"Get Auto Earn preferences","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/accounts/{account_id}/earn/auto","href":"/api-reference/production-live/auto-earn/get-auto-earn-preferences"},{"title":"Set Auto Earn preferences","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json patch /v1/accounts/{account_id}/earn/auto","href":"/api-reference/production-live/auto-earn/set-auto-earn-preferences"},{"title":"Get Auto Earn allocations","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/accounts/{account_id}/earn/auto/allocations","href":"/api-reference/production-live/auto-earn/get-auto-earn-allocations"},{"title":"Get account Auto Earn assets","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/accounts/{account_id}/earn/auto/assets","href":"/api-reference/production-live/auto-earn/get-account-auto-earn-assets"},{"title":"Get Auto Earn reward summary","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/accounts/{account_id}/earn/auto/rewards/summary","href":"/api-reference/production-live/auto-earn/get-auto-earn-reward-summary"},{"title":"List Auto Earn rewards","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/accounts/{account_id}/earn/auto/rewards","href":"/api-reference/production-live/auto-earn/list-auto-earn-rewards"},{"title":"List upcoming Auto Earn rewards","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/accounts/{account_id}/earn/auto/rewards/upcoming","href":"/api-reference/production-live/auto-earn/list-upcoming-auto-earn-rewards"},{"title":"Get Auto Earn assets","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/earn/auto/assets","href":"/api-reference/production-live/auto-earn/get-auto-earn-assets"}]},{"group":"Bonded Earn","pages":[{"title":"Allocate to a Bonded Earn strategy","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json post /v1/accounts/{account_id}/earn/bonded/strategies/{strategy_id}/allocate","href":"/api-reference/production-live/bonded-earn/allocate-to-a-bonded-earn-strategy"},{"title":"Deallocate from a Bonded Earn strategy","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json post /v1/accounts/{account_id}/earn/bonded/strategies/{strategy_id}/deallocate","href":"/api-reference/production-live/bonded-earn/deallocate-from-a-bonded-earn-strategy"},{"title":"List Bonded Earn allocations","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/accounts/{account_id}/earn/bonded/allocations","href":"/api-reference/production-live/bonded-earn/list-bonded-earn-allocations"},{"title":"List Bonded Earn allocation states","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/accounts/{account_id}/earn/bonded/allocation-states","href":"/api-reference/production-live/bonded-earn/list-bonded-earn-allocation-states"},{"title":"List pending Bonded Earn requests","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/accounts/{account_id}/earn/bonded/requests","href":"/api-reference/production-live/bonded-earn/list-pending-bonded-earn-requests"},{"title":"Get Bonded Earn request status","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/accounts/{account_id}/earn/bonded/requests/{request_id}","href":"/api-reference/production-live/bonded-earn/get-bonded-earn-request-status"},{"title":"List account Bonded Earn strategies","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/accounts/{account_id}/earn/bonded/strategies","href":"/api-reference/production-live/bonded-earn/list-account-bonded-earn-strategies"},{"title":"Get Bonded Earn reward summary","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/accounts/{account_id}/earn/bonded/rewards/summary","href":"/api-reference/production-live/bonded-earn/get-bonded-earn-reward-summary"},{"title":"List Bonded Earn rewards by strategy","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/accounts/{account_id}/earn/bonded/rewards","href":"/api-reference/production-live/bonded-earn/list-bonded-earn-rewards-by-strategy"},{"title":"List upcoming Bonded Earn rewards","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/accounts/{account_id}/earn/bonded/rewards/upcoming","href":"/api-reference/production-live/bonded-earn/list-upcoming-bonded-earn-rewards"},{"title":"List Bonded Earn strategies","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/earn/bonded/strategies","href":"/api-reference/production-live/bonded-earn/list-bonded-earn-strategies"}]},{"group":"Funding","pages":[{"title":"Look up funding method metadata","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/accounts/{account_id}/funds/methods/lookup","href":"/api-reference/production-live/funding/look-up-funding-method-metadata"},{"title":"Create deposit","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json post /v1/accounts/{account_id}/funds/deposits","href":"/api-reference/production-live/funding/create-deposit"},{"title":"List deposit methods","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/accounts/{account_id}/funds/deposits/methods","href":"/api-reference/production-live/funding/list-deposit-methods"},{"title":"Activate deposit method","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json post /v1/accounts/{account_id}/funds/deposits/methods/{method_id}/activation","href":"/api-reference/production-live/funding/activate-deposit-method"},{"title":"List deposit limits","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/accounts/{account_id}/funds/deposits/limits/{asset_symbol}","href":"/api-reference/production-live/funding/list-deposit-limits"},{"title":"List withdrawal methods","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/accounts/{account_id}/funds/withdrawals/methods","href":"/api-reference/production-live/funding/list-withdrawal-methods"},{"title":"List withdrawal limits","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/accounts/{account_id}/funds/withdrawals/limits/{asset_symbol}","href":"/api-reference/production-live/funding/list-withdrawal-limits"},{"title":"List withdrawal holds","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/accounts/{account_id}/funds/withdrawals/holds","href":"/api-reference/production-live/funding/list-withdrawal-holds"},{"title":"Calculate funding fees","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json post /v1/accounts/{account_id}/funds/fees","href":"/api-reference/production-live/funding/calculate-funding-fees"},{"title":"Create withdrawal","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json post /v1/accounts/{account_id}/funds/withdrawals","href":"/api-reference/production-live/funding/create-withdrawal"},{"title":"List deposit addresses","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/accounts/{account_id}/funds/deposits/addresses","href":"/api-reference/production-live/funding/list-deposit-addresses"},{"title":"Claim deposit address","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json post /v1/accounts/{account_id}/funds/deposits/addresses","href":"/api-reference/production-live/funding/claim-deposit-address"},{"title":"List funding addresses","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/accounts/{account_id}/funds/addresses","href":"/api-reference/production-live/funding/list-funding-addresses"},{"title":"Create funding address","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json post /v1/accounts/{account_id}/funds/addresses","href":"/api-reference/production-live/funding/create-funding-address"},{"title":"Create Lightning invoice","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json post /v1/accounts/{account_id}/funds/deposits/lightning-invoices","href":"/api-reference/production-live/funding/create-lightning-invoice"},{"title":"Get funding address","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/accounts/{account_id}/funds/addresses/{address_id}","href":"/api-reference/production-live/funding/get-funding-address"},{"title":"Delete funding address","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json delete /v1/accounts/{account_id}/funds/addresses/{address_id}","href":"/api-reference/production-live/funding/delete-funding-address"},{"title":"Update funding address","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json patch /v1/accounts/{account_id}/funds/addresses/{address_id}","href":"/api-reference/production-live/funding/update-funding-address"},{"title":"Create transfer","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json post /v1/transfers","href":"/api-reference/production-live/funding/create-transfer"},{"title":"Simulate funding deposit","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json post /v1/accounts/{account_id}/funds/testing/deposit","href":"/api-reference/production-live/funding/simulate-funding-deposit"}]},{"group":"Derivative transfers","pages":[{"title":"Create derivatives transfer","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json post /v1/accounts/{account_id}/transfers/derivatives","href":"/api-reference/production-live/derivative-transfers/create-derivatives-transfer"}]},{"group":"Portfolio","pages":[{"title":"Get portfolio","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/accounts/{account_id}/portfolio","href":"/api-reference/production-live/portfolio/get-portfolio"},{"title":"List portfolio history","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/accounts/{account_id}/portfolio/history","href":"/api-reference/production-live/portfolio/list-portfolio-history"},{"title":"List portfolio transactions","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/accounts/{account_id}/portfolio/transactions","href":"/api-reference/production-live/portfolio/list-portfolio-transactions"}]},{"group":"Ramp","pages":[{"title":"List bank links","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/accounts/{account_id}/funds/bank-links","href":"/api-reference/production-live/ramp/list-bank-links"},{"title":"Create bank link","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json post /v1/accounts/{account_id}/funds/bank-links","href":"/api-reference/production-live/ramp/create-bank-link"},{"title":"List Ramp buy cryptocurrency assets","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/ramp/buy/crypto","href":"/api-reference/production-live/ramp/list-ramp-buy-cryptocurrency-assets"},{"title":"Get Ramp checkout URL","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/ramp/checkout","href":"/api-reference/production-live/ramp/get-ramp-checkout-url"},{"title":"List Ramp countries","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/ramp/countries","href":"/api-reference/production-live/ramp/list-ramp-countries"},{"title":"List Ramp fiat currencies","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/ramp/fiat-currencies","href":"/api-reference/production-live/ramp/list-ramp-fiat-currencies"},{"title":"Get Ramp limits","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/ramp/limits","href":"/api-reference/production-live/ramp/get-ramp-limits"},{"title":"List Ramp payment methods","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/ramp/payment-methods","href":"/api-reference/production-live/ramp/list-ramp-payment-methods"},{"title":"Get Ramp prospective quote","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/ramp/quotes/prospective","href":"/api-reference/production-live/ramp/get-ramp-prospective-quote"},{"title":"Create Ramp checkout session","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json post /v1/users/{user_id}/ramp/checkouts","href":"/api-reference/production-live/ramp/create-ramp-checkout-session"},{"title":"Get bank link","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/accounts/{account_id}/funds/bank-links/{bank_link_id}","href":"/api-reference/production-live/ramp/get-bank-link"},{"title":"Unlink bank link","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json delete /v1/accounts/{account_id}/funds/bank-links/{bank_link_id}","href":"/api-reference/production-live/ramp/unlink-bank-link"},{"title":"Reconnect bank link","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json post /v1/accounts/{account_id}/funds/bank-links/{bank_link_id}/reconnect","href":"/api-reference/production-live/ramp/reconnect-bank-link"}]},{"group":"Reports","pages":[{"title":"List settlement reports","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/reports/settlement","href":"/api-reference/production-live/reports/list-settlement-reports"},{"title":"Get settlement report","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/reports/settlement/{id}","href":"/api-reference/production-live/reports/get-settlement-report"}]},{"group":"Swaps","pages":[{"title":"Create quote","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json post /v1/accounts/{account_id}/quotes","href":"/api-reference/production-live/swaps/create-quote"},{"title":"Get quote limits","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/accounts/{account_id}/quotes/limits","href":"/api-reference/production-live/swaps/get-quote-limits"},{"title":"Get quote","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/accounts/{account_id}/quotes/{quote_id}","href":"/api-reference/production-live/swaps/get-quote"},{"title":"Execute quote","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json post /v1/accounts/{account_id}/quotes/{quote_id}/execute","href":"/api-reference/production-live/swaps/execute-quote"}]},{"group":"Onchain quotes","pages":[{"title":"List onchain quotes","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/accounts/{account_id}/onchain-quotes","href":"/api-reference/production-live/onchain-quotes/list-onchain-quotes"},{"title":"Create onchain quote","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json post /v1/accounts/{account_id}/onchain-quotes","href":"/api-reference/production-live/onchain-quotes/create-onchain-quote"},{"title":"Get soft quote","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json post /v1/accounts/{account_id}/onchain-quotes/soft","href":"/api-reference/production-live/onchain-quotes/get-soft-quote"},{"title":"Get onchain quote","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/accounts/{account_id}/onchain-quotes/{quote_id}","href":"/api-reference/production-live/onchain-quotes/get-onchain-quote"}]},{"group":"Price trigger swaps","pages":[{"title":"List price-triggered swaps","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/accounts/{account_id}/price-trigger-swaps","href":"/api-reference/production-live/price-trigger-swaps/list-price-triggered-swaps"},{"title":"Create price-triggered swap","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json post /v1/accounts/{account_id}/price-trigger-swaps","href":"/api-reference/production-live/price-trigger-swaps/create-price-triggered-swap"},{"title":"Get price-triggered swap","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/accounts/{account_id}/price-trigger-swaps/{price_trigger_swap_id}","href":"/api-reference/production-live/price-trigger-swaps/get-price-triggered-swap"},{"title":"Cancel price-triggered swap","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json post /v1/accounts/{account_id}/price-trigger-swaps/{price_trigger_swap_id}/cancel","href":"/api-reference/production-live/price-trigger-swaps/cancel-price-triggered-swap"}]},{"group":"Travel Rule verifications","pages":[{"title":"Create Travel Rule verification","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json post /v1/users/{user_id}/travel-rule/verifications","href":"/api-reference/production-live/travel-rule-verifications/create-travel-rule-verification"},{"title":"Get Travel Rule verification","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/users/{user_id}/travel-rule/verifications/{verification_id}","href":"/api-reference/production-live/travel-rule-verifications/get-travel-rule-verification"}]},{"group":"Users","pages":[{"title":"Create user","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json post /v1/users","href":"/api-reference/production-live/users/create-user"},{"title":"Get user","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/users/{user_id}","href":"/api-reference/production-live/users/get-user"},{"title":"Create user account","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json post /v1/users/{user_id}/accounts","href":"/api-reference/production-live/users/create-user-account"}]},{"group":"Verifications","pages":[{"title":"Get verification","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/users/{user_id}/verifications/{verification_id}","href":"/api-reference/production-live/verifications/get-verification"},{"title":"List verifications","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/users/{user_id}/verifications","href":"/api-reference/production-live/verifications/list-verifications"},{"title":"Get verification requirements","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/users/{user_id}/verifications/requirements","href":"/api-reference/production-live/verifications/get-verification-requirements"},{"title":"Submit verification evidence","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json post /v1/users/{user_id}/verifications/evidence","href":"/api-reference/production-live/verifications/submit-verification-evidence"},{"title":"Create hosted verification","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json post /v1/users/{user_id}/verifications/hosted","href":"/api-reference/production-live/verifications/create-hosted-verification"},{"title":"Update verification profile","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json patch /v1/users/{user_id}/verifications/profile","href":"/api-reference/production-live/verifications/update-verification-profile"},{"title":"Create reusable KYC token","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json post /v1/users/{user_id}/verifications/reusable-kyc-token","href":"/api-reference/production-live/verifications/create-reusable-kyc-token"}]},{"group":"Webhooks","pages":[{"title":"List webhooks","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/webhooks","href":"/api-reference/production-live/webhooks/list-webhooks"},{"title":"Create webhook","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json post /v1/webhooks","href":"/api-reference/production-live/webhooks/create-webhook"},{"title":"Get webhook","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/webhooks/{webhook_id}","href":"/api-reference/production-live/webhooks/get-webhook"},{"title":"Delete webhook","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json delete /v1/webhooks/{webhook_id}","href":"/api-reference/production-live/webhooks/delete-webhook"},{"title":"Update webhook","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json patch /v1/webhooks/{webhook_id}","href":"/api-reference/production-live/webhooks/update-webhook"},{"title":"List webhook attempts","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/webhooks/{webhook_id}/attempts","href":"/api-reference/production-live/webhooks/list-webhook-attempts"},{"title":"Rotate webhook secret","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json post /v1/webhooks/{webhook_id}/secret/rotate","href":"/api-reference/production-live/webhooks/rotate-webhook-secret"},{"title":"Send webhook test event","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json post /v1/webhooks/{webhook_id}/test","href":"/api-reference/production-live/webhooks/send-webhook-test-event"},{"title":"Quote executed","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook quote.executed","href":"/api-reference/production-live/webhooks/quote-executed"},{"title":"Quote canceled","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook quote.cancelled","href":"/api-reference/production-live/webhooks/quote-canceled"},{"title":"Quote execution failed","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook quote.execution_failed","href":"/api-reference/production-live/webhooks/quote-execution-failed"},{"title":"User closed","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook user.closed","href":"/api-reference/production-live/webhooks/user-closed"},{"title":"User disabled","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook user.disabled","href":"/api-reference/production-live/webhooks/user-disabled"},{"title":"Conversion deposit completed","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook conversion.deposit_completed","href":"/api-reference/production-live/webhooks/conversion-deposit-completed"},{"title":"Conversion deposit failed","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook conversion.deposit_failed","href":"/api-reference/production-live/webhooks/conversion-deposit-failed"},{"title":"Conversion deposit held","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook conversion.deposit_held","href":"/api-reference/production-live/webhooks/conversion-deposit-held"},{"title":"Conversion withdrawal completed","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook conversion.withdrawal_completed","href":"/api-reference/production-live/webhooks/conversion-withdrawal-completed"},{"title":"Conversion withdrawal failed","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook conversion.withdrawal_failed","href":"/api-reference/production-live/webhooks/conversion-withdrawal-failed"},{"title":"Conversion quote execution failed","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook conversion.quote_execution_failed","href":"/api-reference/production-live/webhooks/conversion-quote-execution-failed"},{"title":"Conversion blocked by travel rule","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook conversion.travel_rule_blocked","href":"/api-reference/production-live/webhooks/conversion-blocked-by-travel-rule"},{"title":"Conversion quote executed","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook conversion.quote_executed","href":"/api-reference/production-live/webhooks/conversion-quote-executed"},{"title":"Swap transaction changed","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook transaction.swap","href":"/api-reference/production-live/webhooks/swap-transaction-changed"},{"title":"Price trigger swap transaction changed","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook transaction.price_trigger_swap","href":"/api-reference/production-live/webhooks/price-trigger-swap-transaction-changed"},{"title":"Earn reward transaction changed","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook transaction.earn_reward","href":"/api-reference/production-live/webhooks/earn-reward-transaction-changed"},{"title":"Deposit transaction changed","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook transaction.deposit","href":"/api-reference/production-live/webhooks/deposit-transaction-changed"},{"title":"Withdrawal transaction changed","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook transaction.withdrawal","href":"/api-reference/production-live/webhooks/withdrawal-transaction-changed"},{"title":"Transfer transaction changed","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook transaction.transfer","href":"/api-reference/production-live/webhooks/transfer-transaction-changed"},{"title":"Recurring swap transaction changed","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook transaction.recurring_swap","href":"/api-reference/production-live/webhooks/recurring-swap-transaction-changed"},{"title":"Deposit received","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook funds.deposit_received","href":"/api-reference/production-live/webhooks/deposit-received"},{"title":"Deposit held","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook funds.deposit_held","href":"/api-reference/production-live/webhooks/deposit-held"},{"title":"Deposit credited","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook funds.deposit_credited","href":"/api-reference/production-live/webhooks/deposit-credited"},{"title":"Deposit returned","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook funds.deposit_returned","href":"/api-reference/production-live/webhooks/deposit-returned"},{"title":"Deposit failed","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook funds.deposit_failed","href":"/api-reference/production-live/webhooks/deposit-failed"},{"title":"Withdrawal held","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook funds.withdrawal_held","href":"/api-reference/production-live/webhooks/withdrawal-held"},{"title":"Withdrawal complete","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook funds.withdrawal_complete","href":"/api-reference/production-live/webhooks/withdrawal-complete"},{"title":"Withdrawal failed","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook funds.withdrawal_failed","href":"/api-reference/production-live/webhooks/withdrawal-failed"},{"title":"Verification requirements updated","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook verification.requirements_updated","href":"/api-reference/production-live/webhooks/verification-requirements-updated"},{"title":"Verification updated","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook verification.updated","href":"/api-reference/production-live/webhooks/verification-updated"},{"title":"Price trigger swap executed","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook price_trigger_swap.executed","href":"/api-reference/production-live/webhooks/price-trigger-swap-executed"},{"title":"Price trigger swap execution failed","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook price_trigger_swap.execution_failed","href":"/api-reference/production-live/webhooks/price-trigger-swap-execution-failed"},{"title":"Price trigger swap canceled","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook price_trigger_swap.cancelled","href":"/api-reference/production-live/webhooks/price-trigger-swap-canceled"},{"title":"Price trigger swap created","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook price_trigger_swap.created","href":"/api-reference/production-live/webhooks/price-trigger-swap-created"},{"title":"Price trigger swap failed","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook price_trigger_swap.failed","href":"/api-reference/production-live/webhooks/price-trigger-swap-failed"},{"title":"Recurring swap created","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook recurring_swap.created","href":"/api-reference/production-live/webhooks/recurring-swap-created"},{"title":"Recurring swap executed","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook recurring_swap.executed","href":"/api-reference/production-live/webhooks/recurring-swap-executed"},{"title":"Recurring swap execution failed","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook recurring_swap.execution_failed","href":"/api-reference/production-live/webhooks/recurring-swap-execution-failed"},{"title":"Recurring swap canceled","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook recurring_swap.cancelled","href":"/api-reference/production-live/webhooks/recurring-swap-canceled"},{"title":"Recurring swap failed","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook recurring_swap.failed","href":"/api-reference/production-live/webhooks/recurring-swap-failed"},{"title":"Recurring swap paused","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook recurring_swap.paused","href":"/api-reference/production-live/webhooks/recurring-swap-paused"},{"title":"Recurring swap resumed","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook recurring_swap.resumed","href":"/api-reference/production-live/webhooks/recurring-swap-resumed"}]}]}]},{"dropdown":"Sandbox","icon":"flask","description":"API reference for the sandbox environment","groups":[{"group":"Payward Services API","expanded":true,"pages":[{"group":"Derivatives","pages":[{"group":"Derivatives transfers","pages":[{"title":"Create derivatives transfer","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json?mintlify-view=derivatives post /v1/accounts/{account_id}/transfers/derivatives","href":"/api-reference/sandbox/derivatives-transfers/create-derivatives-transfer"}]}]},{"group":"Assets","pages":[{"title":"List assets","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/assets","href":"/api-reference/sandbox/assets/list-assets"},{"title":"Get asset","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/assets/{asset_type}/{asset_symbol}","href":"/api-reference/sandbox/assets/get-asset"},{"title":"List asset rates","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/assets/{asset_type}/{asset_symbol}/rates","href":"/api-reference/sandbox/assets/list-asset-rates"},{"title":"List user assets","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/users/{user_id}/assets","href":"/api-reference/sandbox/assets/list-user-assets"},{"title":"Get user asset","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/users/{user_id}/assets/{asset_type}/{asset_symbol}","href":"/api-reference/sandbox/assets/get-user-asset"},{"title":"List user asset rates","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/users/{user_id}/assets/{asset_type}/{asset_symbol}/rates","href":"/api-reference/sandbox/assets/list-user-asset-rates"}]},{"group":"Conversions","pages":[{"title":"List on-demand conversions","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/on-demand-conversions","href":"/api-reference/sandbox/conversions/list-on-demand-conversions"},{"title":"Execute on-demand conversion","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json post /v1/accounts/{account_id}/on-demand-conversions","href":"/api-reference/sandbox/conversions/execute-on-demand-conversion"},{"title":"Estimate on-demand conversion by account","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json post /v1/accounts/{account_id}/on-demand-conversions/estimate","href":"/api-reference/sandbox/conversions/estimate-on-demand-conversion-by-account"},{"title":"Prepare on-demand conversion","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json post /v1/accounts/{account_id}/on-demand-conversions/prepare","href":"/api-reference/sandbox/conversions/prepare-on-demand-conversion"},{"title":"Get on-demand conversion","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/on-demand-conversions/{conversion_id}","href":"/api-reference/sandbox/conversions/get-on-demand-conversion"},{"title":"Execute prepared on-demand conversion","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json post /v1/accounts/{account_id}/on-demand-conversions/{conversion_id}","href":"/api-reference/sandbox/conversions/execute-prepared-on-demand-conversion"},{"title":"List conversion rules","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/conversions","href":"/api-reference/sandbox/conversions/list-conversion-rules"},{"title":"Create conversion rule","description":"Creates a new conversion rule. Provisions the inbound deposit endpoint (IBAN for fiat-source, crypto address for crypto-source) the caller will fund. Once funded, transactions are produced against this conversion rule and become observable via the transactions surface.","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json post /v1/accounts/{account_id}/conversions","href":"/api-reference/sandbox/conversions/create-conversion-rule"},{"title":"Get conversion rule","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/conversions/{conversion_rule_id}","href":"/api-reference/sandbox/conversions/get-conversion-rule"},{"title":"Update conversion rule","description":"Updates an existing conversion rule. Replaces the destination, name, and status in a single PUT. If you send `fee`, the update replaces the current fee. If you omit `fee`, the update keeps the current fee. If you send `fee` with `bps` set to `0`, the update sets a zero fee. If you send an empty `fee` (`{}`), the update removes the current fee and the configured partner fee applies. The source side is immutable. Re-create the conversion rule if you need to change input asset, rail, or wallet.","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json put /v1/accounts/{account_id}/conversions/{conversion_rule_id}","href":"/api-reference/sandbox/conversions/update-conversion-rule"},{"title":"Delete conversion rule","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json delete /v1/accounts/{account_id}/conversions/{conversion_rule_id}","href":"/api-reference/sandbox/conversions/delete-conversion-rule"},{"title":"List conversion rule transactions","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/conversions/{conversion_rule_id}/transactions","href":"/api-reference/sandbox/conversions/list-conversion-rule-transactions"},{"title":"Estimate conversion rule","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json post /v1/accounts/{account_id}/conversions/{conversion_rule_id}/estimate","href":"/api-reference/sandbox/conversions/estimate-conversion-rule"},{"title":"Estimate new conversion rule by account","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json post /v1/accounts/{account_id}/conversions/estimate","href":"/api-reference/sandbox/conversions/estimate-new-conversion-rule-by-account"}]},{"group":"Auto Earn","pages":[{"title":"Get Auto Earn preferences","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/earn/auto","href":"/api-reference/sandbox/auto-earn/get-auto-earn-preferences"},{"title":"Set Auto Earn preferences","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json patch /v1/accounts/{account_id}/earn/auto","href":"/api-reference/sandbox/auto-earn/set-auto-earn-preferences"},{"title":"Get Auto Earn allocations","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/earn/auto/allocations","href":"/api-reference/sandbox/auto-earn/get-auto-earn-allocations"},{"title":"Get account Auto Earn assets","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/earn/auto/assets","href":"/api-reference/sandbox/auto-earn/get-account-auto-earn-assets"},{"title":"Get Auto Earn reward summary","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/earn/auto/rewards/summary","href":"/api-reference/sandbox/auto-earn/get-auto-earn-reward-summary"},{"title":"List Auto Earn rewards","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/earn/auto/rewards","href":"/api-reference/sandbox/auto-earn/list-auto-earn-rewards"},{"title":"List upcoming Auto Earn rewards","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/earn/auto/rewards/upcoming","href":"/api-reference/sandbox/auto-earn/list-upcoming-auto-earn-rewards"},{"title":"Get Auto Earn assets","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/earn/auto/assets","href":"/api-reference/sandbox/auto-earn/get-auto-earn-assets"}]},{"group":"Bonded Earn","pages":[{"title":"Allocate to a Bonded Earn strategy","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json post /v1/accounts/{account_id}/earn/bonded/strategies/{strategy_id}/allocate","href":"/api-reference/sandbox/bonded-earn/allocate-to-a-bonded-earn-strategy"},{"title":"Deallocate from a Bonded Earn strategy","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json post /v1/accounts/{account_id}/earn/bonded/strategies/{strategy_id}/deallocate","href":"/api-reference/sandbox/bonded-earn/deallocate-from-a-bonded-earn-strategy"},{"title":"List Bonded Earn allocations","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/earn/bonded/allocations","href":"/api-reference/sandbox/bonded-earn/list-bonded-earn-allocations"},{"title":"List Bonded Earn allocation states","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/earn/bonded/allocation-states","href":"/api-reference/sandbox/bonded-earn/list-bonded-earn-allocation-states"},{"title":"List pending Bonded Earn requests","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/earn/bonded/requests","href":"/api-reference/sandbox/bonded-earn/list-pending-bonded-earn-requests"},{"title":"Get Bonded Earn request status","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/earn/bonded/requests/{request_id}","href":"/api-reference/sandbox/bonded-earn/get-bonded-earn-request-status"},{"title":"List account Bonded Earn strategies","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/earn/bonded/strategies","href":"/api-reference/sandbox/bonded-earn/list-account-bonded-earn-strategies"},{"title":"Get Bonded Earn reward summary","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/earn/bonded/rewards/summary","href":"/api-reference/sandbox/bonded-earn/get-bonded-earn-reward-summary"},{"title":"List Bonded Earn rewards by strategy","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/earn/bonded/rewards","href":"/api-reference/sandbox/bonded-earn/list-bonded-earn-rewards-by-strategy"},{"title":"List upcoming Bonded Earn rewards","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/earn/bonded/rewards/upcoming","href":"/api-reference/sandbox/bonded-earn/list-upcoming-bonded-earn-rewards"},{"title":"List Bonded Earn strategies","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/earn/bonded/strategies","href":"/api-reference/sandbox/bonded-earn/list-bonded-earn-strategies"}]},{"group":"Funding","pages":[{"title":"Look up funding method metadata","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/funds/methods/lookup","href":"/api-reference/sandbox/funding/look-up-funding-method-metadata"},{"title":"Create deposit","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json post /v1/accounts/{account_id}/funds/deposits","href":"/api-reference/sandbox/funding/create-deposit"},{"title":"List deposit methods","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/funds/deposits/methods","href":"/api-reference/sandbox/funding/list-deposit-methods"},{"title":"Activate deposit method","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json post /v1/accounts/{account_id}/funds/deposits/methods/{method_id}/activation","href":"/api-reference/sandbox/funding/activate-deposit-method"},{"title":"List deposit limits","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/funds/deposits/limits/{asset_symbol}","href":"/api-reference/sandbox/funding/list-deposit-limits"},{"title":"List withdrawal methods","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/funds/withdrawals/methods","href":"/api-reference/sandbox/funding/list-withdrawal-methods"},{"title":"List withdrawal limits","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/funds/withdrawals/limits/{asset_symbol}","href":"/api-reference/sandbox/funding/list-withdrawal-limits"},{"title":"List withdrawal holds","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/funds/withdrawals/holds","href":"/api-reference/sandbox/funding/list-withdrawal-holds"},{"title":"Calculate funding fees","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json post /v1/accounts/{account_id}/funds/fees","href":"/api-reference/sandbox/funding/calculate-funding-fees"},{"title":"Create withdrawal","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json post /v1/accounts/{account_id}/funds/withdrawals","href":"/api-reference/sandbox/funding/create-withdrawal"},{"title":"List deposit addresses","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/funds/deposits/addresses","href":"/api-reference/sandbox/funding/list-deposit-addresses"},{"title":"Claim deposit address","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json post /v1/accounts/{account_id}/funds/deposits/addresses","href":"/api-reference/sandbox/funding/claim-deposit-address"},{"title":"List funding addresses","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/funds/addresses","href":"/api-reference/sandbox/funding/list-funding-addresses"},{"title":"Create funding address","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json post /v1/accounts/{account_id}/funds/addresses","href":"/api-reference/sandbox/funding/create-funding-address"},{"title":"Create Lightning invoice","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json post /v1/accounts/{account_id}/funds/deposits/lightning-invoices","href":"/api-reference/sandbox/funding/create-lightning-invoice"},{"title":"Get funding address","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/funds/addresses/{address_id}","href":"/api-reference/sandbox/funding/get-funding-address"},{"title":"Delete funding address","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json delete /v1/accounts/{account_id}/funds/addresses/{address_id}","href":"/api-reference/sandbox/funding/delete-funding-address"},{"title":"Update funding address","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json patch /v1/accounts/{account_id}/funds/addresses/{address_id}","href":"/api-reference/sandbox/funding/update-funding-address"},{"title":"Create transfer","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json post /v1/transfers","href":"/api-reference/sandbox/funding/create-transfer"},{"title":"Simulate funding deposit","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json post /v1/accounts/{account_id}/funds/testing/deposit","href":"/api-reference/sandbox/funding/simulate-funding-deposit"}]},{"group":"Portfolio","pages":[{"title":"Get portfolio","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/portfolio","href":"/api-reference/sandbox/portfolio/get-portfolio"},{"title":"List portfolio history","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/portfolio/history","href":"/api-reference/sandbox/portfolio/list-portfolio-history"},{"title":"List portfolio transactions","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/portfolio/transactions","href":"/api-reference/sandbox/portfolio/list-portfolio-transactions"}]},{"group":"Ramp","pages":[{"title":"List bank links","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/funds/bank-links","href":"/api-reference/sandbox/ramp/list-bank-links"},{"title":"Create bank link","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json post /v1/accounts/{account_id}/funds/bank-links","href":"/api-reference/sandbox/ramp/create-bank-link"},{"title":"List Ramp buy cryptocurrency assets","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/ramp/buy/crypto","href":"/api-reference/sandbox/ramp/list-ramp-buy-cryptocurrency-assets"},{"title":"Get Ramp checkout URL","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/ramp/checkout","href":"/api-reference/sandbox/ramp/get-ramp-checkout-url"},{"title":"List Ramp countries","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/ramp/countries","href":"/api-reference/sandbox/ramp/list-ramp-countries"},{"title":"List Ramp fiat currencies","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/ramp/fiat-currencies","href":"/api-reference/sandbox/ramp/list-ramp-fiat-currencies"},{"title":"Get Ramp limits","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/ramp/limits","href":"/api-reference/sandbox/ramp/get-ramp-limits"},{"title":"List Ramp payment methods","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/ramp/payment-methods","href":"/api-reference/sandbox/ramp/list-ramp-payment-methods"},{"title":"Get Ramp prospective quote","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/ramp/quotes/prospective","href":"/api-reference/sandbox/ramp/get-ramp-prospective-quote"},{"title":"Create Ramp checkout session","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json post /v1/users/{user_id}/ramp/checkouts","href":"/api-reference/sandbox/ramp/create-ramp-checkout-session"},{"title":"Get bank link","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/funds/bank-links/{bank_link_id}","href":"/api-reference/sandbox/ramp/get-bank-link"},{"title":"Unlink bank link","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json delete /v1/accounts/{account_id}/funds/bank-links/{bank_link_id}","href":"/api-reference/sandbox/ramp/unlink-bank-link"},{"title":"Reconnect bank link","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json post /v1/accounts/{account_id}/funds/bank-links/{bank_link_id}/reconnect","href":"/api-reference/sandbox/ramp/reconnect-bank-link"}]},{"group":"Reports","pages":[{"title":"List settlement reports","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/reports/settlement","href":"/api-reference/sandbox/reports/list-settlement-reports"},{"title":"Get settlement report","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/reports/settlement/{id}","href":"/api-reference/sandbox/reports/get-settlement-report"}]},{"group":"Swaps","pages":[{"title":"Create quote","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json post /v1/accounts/{account_id}/quotes","href":"/api-reference/sandbox/swaps/create-quote"},{"title":"Get quote limits","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/quotes/limits","href":"/api-reference/sandbox/swaps/get-quote-limits"},{"title":"Get quote","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/quotes/{quote_id}","href":"/api-reference/sandbox/swaps/get-quote"},{"title":"Execute quote","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json post /v1/accounts/{account_id}/quotes/{quote_id}/execute","href":"/api-reference/sandbox/swaps/execute-quote"}]},{"group":"Onchain quotes","pages":[{"title":"List onchain quotes","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/onchain-quotes","href":"/api-reference/sandbox/onchain-quotes/list-onchain-quotes"},{"title":"Create onchain quote","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json post /v1/accounts/{account_id}/onchain-quotes","href":"/api-reference/sandbox/onchain-quotes/create-onchain-quote"},{"title":"Get soft quote","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json post /v1/accounts/{account_id}/onchain-quotes/soft","href":"/api-reference/sandbox/onchain-quotes/get-soft-quote"},{"title":"Get onchain quote","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/onchain-quotes/{quote_id}","href":"/api-reference/sandbox/onchain-quotes/get-onchain-quote"}]},{"group":"Price trigger swaps","pages":[{"title":"List price-triggered swaps","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/price-trigger-swaps","href":"/api-reference/sandbox/price-trigger-swaps/list-price-triggered-swaps"},{"title":"Create price-triggered swap","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json post /v1/accounts/{account_id}/price-trigger-swaps","href":"/api-reference/sandbox/price-trigger-swaps/create-price-triggered-swap"},{"title":"Get price-triggered swap","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/price-trigger-swaps/{price_trigger_swap_id}","href":"/api-reference/sandbox/price-trigger-swaps/get-price-triggered-swap"},{"title":"Cancel price-triggered swap","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json post /v1/accounts/{account_id}/price-trigger-swaps/{price_trigger_swap_id}/cancel","href":"/api-reference/sandbox/price-trigger-swaps/cancel-price-triggered-swap"}]},{"group":"Travel Rule verifications","pages":[{"title":"Create Travel Rule verification","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json post /v1/users/{user_id}/travel-rule/verifications","href":"/api-reference/sandbox/travel-rule-verifications/create-travel-rule-verification"},{"title":"Get Travel Rule verification","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/users/{user_id}/travel-rule/verifications/{verification_id}","href":"/api-reference/sandbox/travel-rule-verifications/get-travel-rule-verification"}]},{"group":"Users","pages":[{"title":"Create user","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json post /v1/users","href":"/api-reference/sandbox/users/create-user"},{"title":"Get user","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/users/{user_id}","href":"/api-reference/sandbox/users/get-user"},{"title":"Create user account","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json post /v1/users/{user_id}/accounts","href":"/api-reference/sandbox/users/create-user-account"}]},{"group":"Verifications","pages":[{"title":"Get verification","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/users/{user_id}/verifications/{verification_id}","href":"/api-reference/sandbox/verifications/get-verification"},{"title":"List verifications","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/users/{user_id}/verifications","href":"/api-reference/sandbox/verifications/list-verifications"},{"title":"Get verification requirements","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/users/{user_id}/verifications/requirements","href":"/api-reference/sandbox/verifications/get-verification-requirements"},{"title":"Submit verification evidence","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json post /v1/users/{user_id}/verifications/evidence","href":"/api-reference/sandbox/verifications/submit-verification-evidence"},{"title":"Create hosted verification","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json post /v1/users/{user_id}/verifications/hosted","href":"/api-reference/sandbox/verifications/create-hosted-verification"},{"title":"Update verification profile","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json patch /v1/users/{user_id}/verifications/profile","href":"/api-reference/sandbox/verifications/update-verification-profile"},{"title":"Create reusable KYC token","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json post /v1/users/{user_id}/verifications/reusable-kyc-token","href":"/api-reference/sandbox/verifications/create-reusable-kyc-token"}]},{"group":"Webhooks","pages":[{"title":"List webhooks","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/webhooks","href":"/api-reference/sandbox/webhooks/list-webhooks"},{"title":"Create webhook","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json post /v1/webhooks","href":"/api-reference/sandbox/webhooks/create-webhook"},{"title":"Get webhook","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/webhooks/{webhook_id}","href":"/api-reference/sandbox/webhooks/get-webhook"},{"title":"Delete webhook","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json delete /v1/webhooks/{webhook_id}","href":"/api-reference/sandbox/webhooks/delete-webhook"},{"title":"Update webhook","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json patch /v1/webhooks/{webhook_id}","href":"/api-reference/sandbox/webhooks/update-webhook"},{"title":"List webhook attempts","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/webhooks/{webhook_id}/attempts","href":"/api-reference/sandbox/webhooks/list-webhook-attempts"},{"title":"Rotate webhook secret","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json post /v1/webhooks/{webhook_id}/secret/rotate","href":"/api-reference/sandbox/webhooks/rotate-webhook-secret"},{"title":"Send webhook test event","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json post /v1/webhooks/{webhook_id}/test","href":"/api-reference/sandbox/webhooks/send-webhook-test-event"},{"title":"Quote executed","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook quote.executed","href":"/api-reference/sandbox/webhooks/quote-executed"},{"title":"Quote canceled","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook quote.cancelled","href":"/api-reference/sandbox/webhooks/quote-canceled"},{"title":"Quote execution failed","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook quote.execution_failed","href":"/api-reference/sandbox/webhooks/quote-execution-failed"},{"title":"User closed","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook user.closed","href":"/api-reference/sandbox/webhooks/user-closed"},{"title":"User disabled","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook user.disabled","href":"/api-reference/sandbox/webhooks/user-disabled"},{"title":"Conversion deposit completed","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook conversion.deposit_completed","href":"/api-reference/sandbox/webhooks/conversion-deposit-completed"},{"title":"Conversion deposit failed","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook conversion.deposit_failed","href":"/api-reference/sandbox/webhooks/conversion-deposit-failed"},{"title":"Conversion deposit held","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook conversion.deposit_held","href":"/api-reference/sandbox/webhooks/conversion-deposit-held"},{"title":"Conversion withdrawal completed","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook conversion.withdrawal_completed","href":"/api-reference/sandbox/webhooks/conversion-withdrawal-completed"},{"title":"Conversion withdrawal failed","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook conversion.withdrawal_failed","href":"/api-reference/sandbox/webhooks/conversion-withdrawal-failed"},{"title":"Conversion quote execution failed","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook conversion.quote_execution_failed","href":"/api-reference/sandbox/webhooks/conversion-quote-execution-failed"},{"title":"Conversion blocked by travel rule","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook conversion.travel_rule_blocked","href":"/api-reference/sandbox/webhooks/conversion-blocked-by-travel-rule"},{"title":"Conversion quote executed","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook conversion.quote_executed","href":"/api-reference/sandbox/webhooks/conversion-quote-executed"},{"title":"Conversion canceled","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook conversion.canceled","href":"/api-reference/sandbox/webhooks/conversion-canceled"},{"title":"Swap transaction changed","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook transaction.swap","href":"/api-reference/sandbox/webhooks/swap-transaction-changed"},{"title":"Price trigger swap transaction changed","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook transaction.price_trigger_swap","href":"/api-reference/sandbox/webhooks/price-trigger-swap-transaction-changed"},{"title":"Earn reward transaction changed","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook transaction.earn_reward","href":"/api-reference/sandbox/webhooks/earn-reward-transaction-changed"},{"title":"Deposit transaction changed","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook transaction.deposit","href":"/api-reference/sandbox/webhooks/deposit-transaction-changed"},{"title":"Withdrawal transaction changed","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook transaction.withdrawal","href":"/api-reference/sandbox/webhooks/withdrawal-transaction-changed"},{"title":"Transfer transaction changed","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook transaction.transfer","href":"/api-reference/sandbox/webhooks/transfer-transaction-changed"},{"title":"Recurring swap transaction changed","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook transaction.recurring_swap","href":"/api-reference/sandbox/webhooks/recurring-swap-transaction-changed"},{"title":"Deposit received","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook funds.deposit_received","href":"/api-reference/sandbox/webhooks/deposit-received"},{"title":"Deposit held","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook funds.deposit_held","href":"/api-reference/sandbox/webhooks/deposit-held"},{"title":"Deposit credited","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook funds.deposit_credited","href":"/api-reference/sandbox/webhooks/deposit-credited"},{"title":"Deposit returned","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook funds.deposit_returned","href":"/api-reference/sandbox/webhooks/deposit-returned"},{"title":"Deposit failed","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook funds.deposit_failed","href":"/api-reference/sandbox/webhooks/deposit-failed"},{"title":"Withdrawal held","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook funds.withdrawal_held","href":"/api-reference/sandbox/webhooks/withdrawal-held"},{"title":"Withdrawal complete","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook funds.withdrawal_complete","href":"/api-reference/sandbox/webhooks/withdrawal-complete"},{"title":"Withdrawal failed","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook funds.withdrawal_failed","href":"/api-reference/sandbox/webhooks/withdrawal-failed"},{"title":"Verification requirements updated","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook verification.requirements_updated","href":"/api-reference/sandbox/webhooks/verification-requirements-updated"},{"title":"Verification updated","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook verification.updated","href":"/api-reference/sandbox/webhooks/verification-updated"},{"title":"Price trigger swap executed","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook price_trigger_swap.executed","href":"/api-reference/sandbox/webhooks/price-trigger-swap-executed"},{"title":"Price trigger swap execution failed","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook price_trigger_swap.execution_failed","href":"/api-reference/sandbox/webhooks/price-trigger-swap-execution-failed"},{"title":"Price trigger swap canceled","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook price_trigger_swap.cancelled","href":"/api-reference/sandbox/webhooks/price-trigger-swap-canceled"},{"title":"Price trigger swap created","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook price_trigger_swap.created","href":"/api-reference/sandbox/webhooks/price-trigger-swap-created"},{"title":"Price trigger swap failed","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook price_trigger_swap.failed","href":"/api-reference/sandbox/webhooks/price-trigger-swap-failed"},{"title":"Recurring swap created","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook recurring_swap.created","href":"/api-reference/sandbox/webhooks/recurring-swap-created"},{"title":"Recurring swap executed","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook recurring_swap.executed","href":"/api-reference/sandbox/webhooks/recurring-swap-executed"},{"title":"Recurring swap execution failed","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook recurring_swap.execution_failed","href":"/api-reference/sandbox/webhooks/recurring-swap-execution-failed"},{"title":"Recurring swap canceled","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook recurring_swap.cancelled","href":"/api-reference/sandbox/webhooks/recurring-swap-canceled"},{"title":"Recurring swap failed","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook recurring_swap.failed","href":"/api-reference/sandbox/webhooks/recurring-swap-failed"},{"title":"Recurring swap paused","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook recurring_swap.paused","href":"/api-reference/sandbox/webhooks/recurring-swap-paused"},{"title":"Recurring swap resumed","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook recurring_swap.resumed","href":"/api-reference/sandbox/webhooks/recurring-swap-resumed"}]}]}]}]},{"tab":"Changelog","hidden":true,"pages":[{"title":"Changelog","href":"/tabs/changelog/overview"}]}]},"basePath":"","title":"Get conversion rule - Payward Developer Documentation","buildId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","deploymentId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C-hEh3I2.js","utils-CnF4QiUD.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C7PVNbel.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-8ytevL2A.js","snippetPresets-BT1alx3v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BLXC0i_W.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CyLIGI9_.js","shallow-DC0lGVIW.js","getApiPlaygroundDisplay-CgDQ85tN.js","CodeSnippet-6-I-Gpv9.js","CodeSnippets-BAk1kDdu.js","Page-C945cI-W.js","getPastedJson-B276RuWN.js","icon-BqP8etTm.js","MethodPill-DM6sbxG1.js","DuplicateIcon-PyJglOaE.js","createIcon-CMeOMAc_.js","DynamicMarkdown-BoyYAA8K.js","SectionHeading-DAYv3gvZ.js","axios-vUo_bRtp.js","Markdown-BhTTmazV.js","clsx-CR-RHrVC.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CBUH0-zX.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BmARFYNC.js"]}