Delivers an example message of the requested event type to this webhook’s destination URL, and only to this webhook, regardless of which other webhooks are subscribed to the same event type. The payload carries representative placeholder values in the exact shape of a real delivery (including the type discriminator), and the request is signed with the webhook’s signing secret like any other delivery, so partners can exercise their receiving endpoint and signature verification end to end before going live.
The webhook must be subscribed to event (it must appear in the webhook’s events list); requesting a test for an event the webhook does not subscribe to fails with 400 Bad Request rather than delivering nothing.
Event type to send an example of. The test delivery's payload uses representative placeholder values in the shape of a real event of this type. The funds.deposit_*, funds.withdrawal_held, funds.withdrawal_complete, and funds.withdrawal_failed test events include example amount and fee objects with asset and decimal-string value fields; the example fee is included when it is zero. In live deliveries, amount is included when resolvable and fee is included only when fee data is available and resolvable.
Available options:
quote.executed,
quote.cancelled,
quote.execution_failed,
user.closed,
user.disabled,
conversion.deposit_completed,
conversion.deposit_failed,
conversion.deposit_held,
conversion.withdrawal_completed,
conversion.withdrawal_failed,
conversion.quote_execution_failed,
conversion.travel_rule_blocked,
transaction.swap,
transaction.price_trigger_swap,
transaction.earn_reward,
transaction.deposit,
transaction.withdrawal,
transaction.transfer,
conversion.quote_executed,
funds.deposit_received,
funds.deposit_held,
funds.deposit_credited,
funds.deposit_returned,
funds.deposit_failed,
verification.requirements_updated,
verification.updated,
price_trigger_swap.executed,
price_trigger_swap.execution_failed,
price_trigger_swap.cancelled,
price_trigger_swap.created,
price_trigger_swap.failed,
funds.withdrawal_held,
funds.withdrawal_complete,
funds.withdrawal_failed,
recurring_swap.created,
recurring_swap.executed,
recurring_swap.execution_failed,
recurring_swap.cancelled,
recurring_swap.failed,
recurring_swap.paused,
recurring_swap.resumed,
transaction.recurring_swap
Response
Successful response
Response from SendWebhookTestEvent.
A successful response means the test message was accepted for delivery, not that the destination URL has already received it; delivery happens asynchronously with the usual retry schedule.
Data envelope returned after a successful SendWebhookTestEvent.
Show child attributes
{"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":"6aee168b42ed63fbbde9698f","clientVersion":"0.0.4087","searchFilterCounts":[{"language":"default","tag":"API reference","count":300},{"language":"default","tag":"Payward Services API","count":299},{"language":"default","tag":"Sandbox","count":152},{"language":"default","tag":"Production","count":148},{"language":"default","tag":"Webhooks","count":100},{"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/webhooks/send-webhook-test-event","slug":"/api-reference/sandbox/webhooks/send-webhook-test-event","pageMetadata":{"title":"Send webhook test event","description":"Sends a test event to the webhook.\n\nDelivers an example message of the requested event type to this webhook's destination URL, and only to this webhook, regardless of which other webhooks are subscribed to the same event type. The payload carries representative placeholder values in the exact shape of a real delivery (including the `type` discriminator), and the request is signed with the webhook's signing secret like any other delivery, so partners can exercise their receiving endpoint and signature verification end to end before going live.\n\nThe webhook must be subscribed to `event` (it must appear in the webhook's `events` list); requesting a test for an event the webhook does not subscribe to fails with `400 Bad Request` rather than delivering nothing.","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","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Sends a test event to the webhook.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Delivers an example message of the requested event type to this webhook’s destination URL, and only to this webhook, regardless of which other webhooks are subscribed to the same event type. The payload carries representative placeholder values in the exact shape of a real delivery (including the \", _jsx(_components.code, {\n children: \"type\"\n }), \" discriminator), and the request is signed with the webhook’s signing secret like any other delivery, so partners can exercise their receiving endpoint and signature verification end to end before going live.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"The webhook must be subscribed to \", _jsx(_components.code, {\n children: \"event\"\n }), \" (it must appear in the webhook’s \", _jsx(_components.code, {\n children: \"events\"\n }), \" list); requesting a test for an event the webhook does not subscribe to fails with \", _jsx(_components.code, {\n children: \"400 Bad Request\"\n }), \" rather than delivering nothing.\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Send webhook test event","description":"Sends a test event to the webhook.\n\nDelivers an example message of the requested event type to this webhook's destination URL, and only to this webhook, regardless of which other webhooks are subscribed to the same event type. The payload carries representative placeholder values in the exact shape of a real delivery (including the `type` discriminator), and the request is signed with the webhook's signing secret like any other delivery, so partners can exercise their receiving endpoint and signature verification end to end before going live.\n\nThe webhook must be subscribed to `event` (it must appear in the webhook's `events` list); requesting a test for an event the webhook does not subscribe to fails with `400 Bad Request` rather than delivering nothing.","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","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Webhooks"],"description":"Sends a test event to the webhook.\n\nDelivers an example message of the requested event type to this webhook's destination URL, and only to this webhook, regardless of which other webhooks are subscribed to the same event type. The payload carries representative placeholder values in the exact shape of a real delivery (including the `type` discriminator), and the request is signed with the webhook's signing secret like any other delivery, so partners can exercise their receiving endpoint and signature verification end to end before going live.\n\nThe webhook must be subscribed to `event` (it must appear in the webhook's `events` list); requesting a test for an event the webhook does not subscribe to fails with `400 Bad Request` rather than delivering nothing.","operationId":"sendWebhookTestEvent","parameters":["6f598c96-ae71-4ea5-9a86-7afb7d442128"],"requestBody":"c9fa2a10-dcc9-49d1-9912-570d6d04fcc8","responses":{"200":"964b2043-d8a8-4ff0-989c-0871b1cbf3ba","400":"7aaa5c57-745e-4f4a-b21a-5c420ef98b46","401":"96ad448d-30c0-4522-b3df-65f6bd80e65d","403":"9c6a75ba-0807-42d1-88ff-1f37d962ff7a","404":"84bc2970-49ef-4039-b52f-854fb57f9f47","429":"7287ea2c-db87-47b9-9cc1-f266bf13fa75","500":"c417ea78-e748-46b6-8292-c5f4e99ab6d5","503":"8c592595-c87c-490f-9e82-f947d0182dbe","504":"48d962b5-d8a8-42b8-966c-ac74cb38f0da"},"security":["f6e19aa0-4405-4118-bd1a-fd9bfe160c9d"],"summary":"Send webhook test event","method":"post","type":"path","servers":["d49d3eb8-8bf3-4280-a75c-4e98110682c1"],"path":"/v1/webhooks/{webhook_id}/test","baseUrlOptions":["https://api.sandbox.services.payward.com"],"title":"Send webhook test event","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"6f598c96-ae71-4ea5-9a86-7afb7d442128":{"in":"path","name":"webhook_id","required":true,"schema":{"description":"Identifier returned by CreateWebhook.","type":"string","minLength":1,"maxLength":64,"isRequired":true,"uniqueKey":"","typeLabel":"string"},"style":"simple","example":"ep_2YuTbBzs6F8XUjWk7p7uA9KNdL5"}},"requestBody":{"content":{"application/json":{"schema":{"description":"Request to send a test event to a webhook.\n\nThe owning tenant is derived from the authenticated caller. Only the webhook id and the event type are supplied.","type":"object","properties":{"event":{"title":"WebhookEventType","description":"Event type to send an example of. The test delivery's payload uses representative placeholder values in the shape of a real event of this type. The `funds.deposit_*`, `funds.withdrawal_held`, `funds.withdrawal_complete`, and `funds.withdrawal_failed` test events include example `amount` and `fee` objects with `asset` and decimal-string `value` fields; the example fee is included when it is zero. In live deliveries, `amount` is included when resolvable and `fee` is included only when fee data is available and resolvable.","type":"string","enum":["quote.executed","quote.cancelled","quote.execution_failed","user.closed","user.disabled","conversion.deposit_completed","conversion.deposit_failed","conversion.deposit_held","conversion.withdrawal_completed","conversion.withdrawal_failed","conversion.quote_execution_failed","conversion.travel_rule_blocked","transaction.swap","transaction.price_trigger_swap","transaction.earn_reward","transaction.deposit","transaction.withdrawal","transaction.transfer","conversion.quote_executed","funds.deposit_received","funds.deposit_held","funds.deposit_credited","funds.deposit_returned","funds.deposit_failed","verification.requirements_updated","verification.updated","price_trigger_swap.executed","price_trigger_swap.execution_failed","price_trigger_swap.cancelled","price_trigger_swap.created","price_trigger_swap.failed","funds.withdrawal_held","funds.withdrawal_complete","funds.withdrawal_failed","recurring_swap.created","recurring_swap.executed","recurring_swap.execution_failed","recurring_swap.cancelled","recurring_swap.failed","recurring_swap.paused","recurring_swap.resumed","transaction.recurring_swap"],"isRequired":true,"uniqueKey":"event","typeLabel":"enum\u003cstring>"}},"required":["event"],"uniqueKey":"","typeLabel":"object"},"examples":{"send-webhook-test-event-request":{"title":"send-webhook-test-event-request","value":{"event":"quote.executed"}}},"exampleType":"examples"}},"required":true,"exampleType":"examples"},"responses":{"964b2043-d8a8-4ff0-989c-0871b1cbf3ba":{"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":{"description":"Response from SendWebhookTestEvent.\n\nA successful response means the test message was accepted for delivery, not that the destination URL has already received it; delivery happens asynchronously with the usual retry schedule.","type":"object","properties":{"data":{"description":"Data envelope returned after a successful SendWebhookTestEvent.","type":"object","properties":{"message_id":{"description":"Identifier of the test message that was dispatched. Useful when contacting support about a test delivery.","type":"string","isRequired":true,"uniqueKey":"data.message_id","typeLabel":"string"},"event":{"title":"WebhookEventType","description":"Event type of the test message. Echoes the request's `event`.","type":"string","enum":["quote.executed","quote.cancelled","quote.execution_failed","user.closed","user.disabled","conversion.deposit_completed","conversion.deposit_failed","conversion.deposit_held","conversion.withdrawal_completed","conversion.withdrawal_failed","conversion.quote_execution_failed","conversion.travel_rule_blocked","transaction.swap","transaction.price_trigger_swap","transaction.earn_reward","transaction.deposit","transaction.withdrawal","transaction.transfer","conversion.quote_executed","funds.deposit_received","funds.deposit_held","funds.deposit_credited","funds.deposit_returned","funds.deposit_failed","verification.requirements_updated","verification.updated","price_trigger_swap.executed","price_trigger_swap.execution_failed","price_trigger_swap.cancelled","price_trigger_swap.created","price_trigger_swap.failed","funds.withdrawal_held","funds.withdrawal_complete","funds.withdrawal_failed","recurring_swap.created","recurring_swap.executed","recurring_swap.execution_failed","recurring_swap.cancelled","recurring_swap.failed","recurring_swap.paused","recurring_swap.resumed","transaction.recurring_swap"],"isRequired":true,"uniqueKey":"data.event","typeLabel":"enum\u003cstring>"}},"required":["message_id","event"],"isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"required":["data"],"uniqueKey":"","typeLabel":"object"},"examples":{"send-webhook-test-event-response":{"title":"send-webhook-test-event-response","value":{"data":{"message_id":"msg_2eZwQqkM3xT5J8vY1bDnA7CfWp0","event":"quote.executed"}}}},"exampleType":"examples"}},"exampleType":"examples"},"7aaa5c57-745e-4f4a-b21a-5c420ef98b46":{"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":"webhooks_error","instance":"req_01H00000000000000000000000","status":400,"code":"bad_request","causes":[{"field":"page_size","message":"must be between 1 and 25"}]}}}},"exampleType":"examples"}},"exampleType":"examples"},"96ad448d-30c0-4522-b3df-65f6bd80e65d":{"description":"Authentication failed","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":"webhooks_error","instance":"req_01H00000000000000000000000","status":401,"code":"unauthenticated"}}}},"exampleType":"examples"}},"exampleType":"examples"},"9c6a75ba-0807-42d1-88ff-1f37d962ff7a":{"description":"Permission denied","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":"webhooks_error","instance":"req_01H00000000000000000000000","status":403,"code":"forbidden"}}}},"exampleType":"examples"}},"exampleType":"examples"},"84bc2970-49ef-4039-b52f-854fb57f9f47":{"description":"Webhook 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 webhook does not exist or is not accessible.","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":["webhook_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":{"webhook-not-found":{"title":"webhook-not-found","value":{"error":{"type":"webhooks_error","status":404,"instance":"req_01H00000000000000000000000","code":"webhook_not_found"}}}},"exampleType":"examples"}},"exampleType":"examples"},"7287ea2c-db87-47b9-9cc1-f266bf13fa75":{"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":"webhooks_error","instance":"req_01H00000000000000000000000","status":429,"code":"resource_exhausted"}}}},"exampleType":"examples"}},"exampleType":"examples"},"c417ea78-e748-46b6-8292-c5f4e99ab6d5":{"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":"webhooks_error","instance":"req_01H00000000000000000000000","status":500,"code":"internal"}}}},"exampleType":"examples"}},"exampleType":"examples"},"8c592595-c87c-490f-9e82-f947d0182dbe":{"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":"webhooks_error","instance":"req_01H00000000000000000000000","status":503,"code":"unavailable"}}}},"exampleType":"examples"}},"exampleType":"examples"},"48d962b5-d8a8-42b8-966c-ac74cb38f0da":{"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":"webhooks_error","instance":"req_01H00000000000000000000000","status":504,"code":"deadline_exceeded"}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"f6e19aa0-4405-4118-bd1a-fd9bfe160c9d":{"ApiKey":{"type":"apiKey","in":"header","name":"API-Key","description":"Your public API key. Identifies the partner making the request.","scopes":[],"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":{"d49d3eb8-8bf3-4280-a75c-4e98110682c1":{"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":[],"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":"Send webhook test event - Payward Developer Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-06T15:41:28.732Z","originalFileLocation":"api-reference/sandbox/webhooks/send-webhook-test-event.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=\"Sends a test event to the webhook. Delivers an example message of the requested event type to this webhook\u0026#x27;s destination URL, and only to this webhook, regardless of which other webhooks are subscribed to the same event type. The payload carries representative placeholder values in the exact shape of a real delivery (including the type discriminator), and the request is signed with the webhook\u0026#x27;s signing secret like any other delivery, so partners can exercise their receiving endpoint and signature verification end to end before going live. The webhook must be subscribed to event (it must appear in the webhook\u0026#x27;s events list); requesting a test for an event the webhook does not subscribe to fails with 400 Bad Request rather than delivering nothing.\">\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=\"Send webhook test event - Payward Developer Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Sends a test event to the webhook. Delivers an example message of the requested event type to this webhook\u0026#x27;s destination URL, and only to this webhook, regardless of which other webhooks are subscribed to the same event type. The payload carries representative placeholder values in the exact shape of a real delivery (including the type discriminator), and the request is signed with the webhook\u0026#x27;s signing secret like any other delivery, so partners can exercise their receiving endpoint and signature verification end to end before going live. The webhook must be subscribed to event (it must appear in the webhook\u0026#x27;s events list); requesting a test for an event the webhook does not subscribe to fails with 400 Bad Request rather than delivering nothing.\">\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/webhooks/send-webhook-test-event\">\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=Webhooks\u0026amp;title=Send+webhook+test+event\u0026amp;description=Sends+a+test+event+to+the+webhook.%0A%0ADelivers+an+example+message+of+the+requested+event+type+to+this+webhook%27s+destination+URL%2C+and+only+to+this+webhook%2C+regardl\u0026amp;theme=5b6df5bc8950a2e4e73d16b5\u0026amp;signature=154f45dc189e597d7bdc7dbb1da4c13604a148ca7a5ccac39aec8ca61ad01654\">\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=\"Send webhook test event - Payward Developer Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Sends a test event to the webhook. Delivers an example message of the requested event type to this webhook\u0026#x27;s destination URL, and only to this webhook, regardless of which other webhooks are subscribed to the same event type. The payload carries representative placeholder values in the exact shape of a real delivery (including the type discriminator), and the request is signed with the webhook\u0026#x27;s signing secret like any other delivery, so partners can exercise their receiving endpoint and signature verification end to end before going live. The webhook must be subscribed to event (it must appear in the webhook\u0026#x27;s events list); requesting a test for an event the webhook does not subscribe to fails with 400 Bad Request rather than delivering nothing.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://mintlify-0e856cf0.mintlify.site/_mintlify/api/og/v2?division=Webhooks\u0026amp;title=Send+webhook+test+event\u0026amp;description=Sends+a+test+event+to+the+webhook.%0A%0ADelivers+an+example+message+of+the+requested+event+type+to+this+webhook%27s+destination+URL%2C+and+only+to+this+webhook%2C+regardl\u0026amp;theme=5b6df5bc8950a2e4e73d16b5\u0026amp;signature=154f45dc189e597d7bdc7dbb1da4c13604a148ca7a5ccac39aec8ca61ad01654\">\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/webhooks/send-webhook-test-event\">\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/webhooks/send-webhook-test-event.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/webhooks/send-webhook-test-event#webpage\",\"url\":\"https://docs.services.payward.com/api-reference/sandbox/webhooks/send-webhook-test-event\",\"name\":\"Send webhook test event\",\"description\":\"Sends a test event to the webhook. Delivers an example message of the requested event type to this webhook's destination URL, and only to this webhook, regardless of which other webhooks are subscribed to the same event type. The payload carries representative placeholder values in the exact shape of a real delivery (including the type discriminator), and the request is signed with the webhook's signing secret like any other delivery, so partners can exercise their receiving endpoint and signature verification end to end before going live. The webhook must be subscribed to event (it must appear in the webhook's events list); requesting a test for an event the webhook does not subscribe to fails with 400 Bad Request rather than delivering nothing.\",\"dateModified\":\"2026-11-06T15:41:28.732Z\",\"isPartOf\":{\"@id\":\"https://docs.services.payward.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.services.payward.com/api-reference/sandbox/webhooks/send-webhook-test-event#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.services.payward.com/api-reference/sandbox/webhooks/send-webhook-test-event#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\":\"Webhooks\",\"item\":\"https://docs.services.payward.com/api-reference/sandbox/webhooks/list-webhooks\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Send webhook test event\",\"item\":\"https://docs.services.payward.com/api-reference/sandbox/webhooks/send-webhook-test-event\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.services.payward.com/api-reference/sandbox/webhooks/send-webhook-test-event#apireference\",\"headline\":\"Send webhook test event\",\"name\":\"Send webhook test event\",\"description\":\"Sends a test event to the webhook. Delivers an example message of the requested event type to this webhook's destination URL, and only to this webhook, regardless of which other webhooks are subscribed to the same event type. The payload carries representative placeholder values in the exact shape of a real delivery (including the type discriminator), and the request is signed with the webhook's signing secret like any other delivery, so partners can exercise their receiving endpoint and signature verification end to end before going live. The webhook must be subscribed to event (it must appear in the webhook's events list); requesting a test for an event the webhook does not subscribe to fails with 400 Bad Request rather than delivering nothing.\",\"url\":\"https://docs.services.payward.com/api-reference/sandbox/webhooks/send-webhook-test-event\",\"mainEntityOfPage\":{\"@id\":\"https://docs.services.payward.com/api-reference/sandbox/webhooks/send-webhook-test-event#webpage\"},\"dateModified\":\"2026-11-06T15:41:28.732Z\",\"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","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","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","description":"Rotates the webhook's signing secret and returns the new value.\n\nThe new secret replaces the previous secret. Deliveries also include a signature made with the old secret during a short grace period so partners can roll the new value out without dropped deliveries. The new signing secret is returned in plaintext exactly once. Partners must persist it and use it to verify the signature on inbound webhook deliveries.","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","description":"Quote successfully executed against the partner account.","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":"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":"Send webhook test event - Payward Developer Documentation","buildId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","deploymentId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CBsVopKK.js","utils-DZAk68jJ.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-D32AYZrP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-D_A5_cny.js","snippetPresets-xNRfS9th.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BIB25-tq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CydJ4w4j.js","shallow-CYPBeQSG.js","getApiPlaygroundDisplay-A5xJVBOu.js","CodeSnippet-BVRTgi3m.js","CodeSnippets-DjD6BSlt.js","Page-Dr40SSJq.js","getPastedJson-D4V4JyrR.js","icon-uhcnG22T.js","MethodPill-CM-ZQdGH.js","DuplicateIcon-B_WnOiNf.js","createIcon-CJsb8utt.js","DynamicMarkdown-D-2HDKEp.js","SectionHeading-KP5xmMgQ.js","axios-vUo_bRtp.js","Markdown-D_k0dg6k.js","clsx-DK3K4Z1S.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DE3EVdvd.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-fN9H9n9g.js"]}