Merchant amount in the project's billing currency, before cardholder fees. Any FX markup or ATM fee that applies to the account is added on top, as in production, so the amount charged to the cardholder can be higher than this value.
Amount in the original transaction currency. Must be provided together with originalCurrency, and is required when the event lands on a transaction whose original currency is not the billing currency.
Conversion rate from the original currency to the card currency
Required range: x >= 0
Examples:
1
0.128205
7.812
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Reap API","description":"Modular fintech infrastructure. Cards, wallets, compliance, and payments via a single API.","colors":{"primary":"#71F7EC","light":"#8FFAF1","dark":"#5BCAC1"},"logo":"https://mintcdn.com/reap-e846d803/qWb4Fwzl8MZcgNPH/images/logo.svg?fit=max\u0026auto=format\u0026n=qWb4Fwzl8MZcgNPH\u0026q=85\u0026s=3b6f4b8d92a46cdc1cbc12bbdab8f23f","favicon":"https://mintcdn.com/reap-e846d803/qWb4Fwzl8MZcgNPH/images/favicon.svg?fit=max\u0026auto=format\u0026n=qWb4Fwzl8MZcgNPH\u0026q=85\u0026s=b5150aaaf3b337b38c7514bf68cb2f30","api":{"playground":{"display":"interactive"},"examples":{"languages":["bash","javascript","python"]}},"appearance":{"default":"dark","strict":true},"background":{"color":{"light":"#FFFFFF","dark":"#0C0E0D"}},"footer":{},"fonts":{"family":"Satoshi","weight":500,"source":"fonts/satoshi-variable.woff2","format":"woff2"},"icons":{"library":"tabler"},"contextual":{"options":["copy","view","cursor","claude"],"display":"header"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"reap-e846d803","hasAudioNarration":false,"actualSubdomain":"reap-e846d803","customDomains":["docs.reap.global"],"gitSource":{"type":"github","owner":"reaphq","repo":"reap-api","deployBranch":"main","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6adfb46ee723af055d460eb4","collectionId":"b20f1934-e4bf-4f3f-807f-0a737e43bc03","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adfb46ee723af055d460eb4"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6adfb46ee723af055d460eb4","clientVersion":"0.0.3971","searchFilterCounts":[{"language":"default","tag":"API Reference","count":140},{"language":"default","tag":"Documentation","count":66},{"language":"default","tag":"Cards","count":31},{"language":"default","tag":"Webhooks","count":27},{"language":"default","tag":"Event Types","count":17},{"language":"default","tag":"Notifications","count":16},{"language":"default","tag":"Agentic","count":16},{"language":"default","tag":"Transactions","count":13},{"language":"default","tag":"Companies","count":13},{"language":"default","tag":"Simulation","count":13}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":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":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"editor-nav-generations","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":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","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":"billing-updated-9-15","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":"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}],"isAtlas":false,"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":":root{--method-get-bg:rgba(0, 202, 127, 0.12);--method-get-fg:#00945c;--method-post-bg:rgba(255, 198, 128, 0.18);--method-post-fg:#9e6e13;--method-put-bg:rgba(79, 70, 229, 0.12);--method-put-fg:#4338ca;--method-patch-bg:rgba(79, 70, 229, 0.12);--method-patch-fg:#4338ca;--method-delete-bg:rgba(248, 113, 113, 0.18);--method-delete-fg:#b91c1c;--method-rare-bg:rgba(99, 112, 106, 0.14);--method-rare-fg:#4b5752;--method-hook-bg:rgba(113, 247, 236, 0.16);--method-hook-fg:#0d9488}.dark,html.dark{--method-get-bg:rgba(138, 255, 191, 0.14);--method-get-fg:#afffd1;--method-post-bg:rgba(254, 210, 163, 0.14);--method-post-fg:#fee0c4;--method-put-bg:rgba(129, 140, 248, 0.14);--method-put-fg:#a5b4fc;--method-patch-bg:rgba(129, 140, 248, 0.14);--method-patch-fg:#a5b4fc;--method-delete-bg:rgba(248, 113, 113, 0.14);--method-delete-fg:#fca5a5;--method-rare-bg:rgba(175, 188, 182, 0.16);--method-rare-fg:#cbd7d2;--method-hook-bg:rgba(113, 247, 236, 0.12);--method-hook-fg:#99f6e4}.method-nav-pill [class*=bg-emerald-],.method-nav-pill [class*=bg-green-],.method-pill[class*=bg-emerald-],.method-pill[class*=bg-green-]{background-color:var(--method-get-bg)!important;color:var(--method-get-fg)!important}.method-nav-pill [class*=bg-blue-],.method-pill[class*=bg-blue-]{background-color:var(--method-post-bg)!important;color:var(--method-post-fg)!important}.method-nav-pill [class*=bg-amber-],.method-nav-pill [class*=bg-yellow-],.method-pill[class*=bg-amber-],.method-pill[class*=bg-yellow-]{background-color:var(--method-put-bg)!important;color:var(--method-put-fg)!important}.method-nav-pill [class*=bg-purple-],.method-nav-pill [class*=bg-violet-],.method-pill[class*=bg-purple-],.method-pill[class*=bg-violet-]{background-color:var(--method-patch-bg)!important;color:var(--method-patch-fg)!important}.method-nav-pill [class*=bg-red-],.method-pill[class*=bg-red-]{background-color:var(--method-delete-bg)!important;color:var(--method-delete-fg)!important}.method-nav-pill [class*=bg-gray-],.method-nav-pill [class*=bg-slate-],.method-pill[class*=bg-gray-],.method-pill[class*=bg-slate-]{background-color:var(--method-rare-bg)!important;color:var(--method-rare-fg)!important}.method-nav-pill [class*='#2AB673'i],.method-pill [class*='#2AB673'i],.method-pill[class*='#2AB673'i]{background-color:var(--method-get-bg)!important;color:var(--method-get-fg)!important;text-shadow:none!important}.method-nav-pill [class*='#C28C30'i],.method-pill [class*='#C28C30'i],.method-pill[class*='#C28C30'i]{background-color:var(--method-put-bg)!important;color:var(--method-put-fg)!important;text-shadow:none!important}.method-nav-pill [class*='#DA622B'i],.method-pill [class*='#DA622B'i],.method-pill[class*='#DA622B'i]{background-color:var(--method-patch-bg)!important;color:var(--method-patch-fg)!important;text-shadow:none!important}.method-nav-pill [class*='#CB3A32'i],.method-pill [class*='#CB3A32'i],.method-pill[class*='#CB3A32'i]{background-color:var(--method-delete-bg)!important;color:var(--method-delete-fg)!important;text-shadow:none!important}.method-nav-pill [data-method],.method-pill [data-method],.method-pill[data-method]{background-color:var(--method-rare-bg)!important;color:var(--method-rare-fg)!important;text-shadow:none!important}.method-nav-pill [data-method=GET],.method-pill [data-method=GET],.method-pill[data-method=GET]{background-color:var(--method-get-bg)!important;color:var(--method-get-fg)!important;text-shadow:none!important}.method-nav-pill [data-method=POST],.method-pill [data-method=POST],.method-pill[data-method=POST]{background-color:var(--method-post-bg)!important;color:var(--method-post-fg)!important;text-shadow:none!important}.method-nav-pill [data-method=PUT],.method-pill [data-method=PUT],.method-pill[data-method=PUT]{background-color:var(--method-put-bg)!important;color:var(--method-put-fg)!important;text-shadow:none!important}.method-nav-pill [data-method=PATCH],.method-pill [data-method=PATCH],.method-pill[data-method=PATCH]{background-color:var(--method-patch-bg)!important;color:var(--method-patch-fg)!important;text-shadow:none!important}.method-nav-pill [data-method=DELETE],.method-pill [data-method=DELETE],.method-pill[data-method=DELETE]{background-color:var(--method-delete-bg)!important;color:var(--method-delete-fg)!important;text-shadow:none!important}.method-nav-pill [data-method=CONNECT],.method-nav-pill [data-method=HEAD],.method-nav-pill [data-method=OPTIONS],.method-nav-pill [data-method=TRACE],.method-pill [data-method=CONNECT],.method-pill [data-method=HEAD],.method-pill [data-method=OPTIONS],.method-pill [data-method=TRACE],.method-pill[data-method=CONNECT],.method-pill[data-method=HEAD],.method-pill[data-method=OPTIONS],.method-pill[data-method=TRACE]{background-color:var(--method-rare-bg)!important;color:var(--method-rare-fg)!important;text-shadow:none!important}.method-nav-pill [data-method=HOOK],.method-pill [data-method=HOOK],.method-pill[data-method=HOOK]{background-color:var(--method-hook-bg)!important;color:var(--method-hook-fg)!important;text-shadow:none!important}:root{--scrollbar-thumb:rgba(15, 23, 42, 0.18);--scrollbar-thumb-hover:rgba(15, 23, 42, 0.32)}.dark,html.dark{--scrollbar-thumb:rgba(255, 255, 255, 0.12);--scrollbar-thumb-hover:rgba(255, 255, 255, 0.24)}@supports (scrollbar-width:thin){#sidebar-content{scrollbar-width:thin;scrollbar-color:var(--scrollbar-thumb) transparent}}@supports selector(::-webkit-scrollbar){#sidebar-content::-webkit-scrollbar{width:6px;height:6px}#sidebar-content::-webkit-scrollbar-corner,#sidebar-content::-webkit-scrollbar-track{background:0 0}#sidebar-content::-webkit-scrollbar-thumb{background-color:var(--scrollbar-thumb);border-radius:9999px;border:1px solid transparent;background-clip:padding-box;min-height:24px}#sidebar-content::-webkit-scrollbar-button{display:none;width:0;height:0}}@media (hover:hover){#sidebar-content::-webkit-scrollbar-thumb:hover{background-color:var(--scrollbar-thumb-hover)}}@media print{#sidebar-content{scrollbar-width:auto;scrollbar-color:auto}}.dark #content,.dark #content-area,html.dark #content,html.dark #content-area{--tw-prose-body:rgb(var(--gray-300));color:rgb(var(--gray-300))}div:has(>[data-component-part=update-label]) a[href^='#']{display:none}[data-component-part=update-label]{cursor:default}[data-component-part=update-content] [data-as=p],[data-component-part=update-content] li,[data-component-part=update-content] li a,[data-component-part=update-content] p{font-size:16px}"}],"page":{"pagePath":"api-reference/simulation/simulate-reversal","slug":"/api-reference/simulation/simulate-reversal","pageMetadata":{"title":"Simulate reversal","description":"Simulates a reversal (partial or full) of an existing `PENDING` authorization. A full reversal transitions the transaction to `VOID`.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /simulation/card-transactions/reversal","href":"/api-reference/simulation/simulate-reversal","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {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(_components.p, {\n children: [\"Simulates a reversal (partial or full) of an existing \", _jsx(_components.code, {\n children: \"PENDING\"\n }), \" authorization. A full reversal transitions the transaction to \", _jsx(_components.code, {\n children: \"VOID\"\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{jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,..._provideComponents(),...props.components},{Badge}=_components;if(!Badge)_missingMdxReference(`Badge`,true);return _jsxs(`div`,{className:`not-prose mint-text-sm mint-text-gray-500 dark:mint-text-gray-400`,children:[`Required scope: `,_jsx(_components.a,{href:`/api-reference/scopes`,children:_jsx(Badge,{color:`blue`,stroke:true,size:`sm`,children:`CARDS_SIMULATE`})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Simulate reversal","description":"Simulates a reversal (partial or full) of an existing `PENDING` authorization. A full reversal transitions the transaction to `VOID`.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /simulation/card-transactions/reversal","href":"/api-reference/simulation/simulate-reversal","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/reap-e846d803/bc4b7e82ee9b6e77/method-pills.js"],"dynamicCss":".mint-text-sm {\n font-size: 0.875rem;\n line-height: 1.25rem\n}\n.mint-text-gray-500 {\n --tw-text-opacity: 1;\n color: rgb(107 114 128 / var(--tw-text-opacity, 1))\n}\n.dark\\:mint-text-gray-400:is(.dark *) {\n --tw-text-opacity: 1;\n color: rgb(156 163 175 / var(--tw-text-opacity, 1))\n}","openApiReferenceData":{"operation":{"tags":["Simulation"],"description":"Simulates a reversal (partial or full) of an existing `PENDING` authorization. A full reversal transitions the transaction to `VOID`.","operationId":"cardTransactionReversal_simulation","summary":"Simulate reversal","x-required-scope":"CARDS_SIMULATE","parameters":["9e46f25d-3d7d-491e-a168-9c4a9a1eac06"],"requestBody":"c4ef3e3d-4105-4507-8a7c-32556fe43545","responses":{"200":"4a7d8365-25f6-4b21-b50e-4ac0469c690b","400":"45fc64d5-37fd-4754-a416-d16c0e845935","404":"5a3d1cb7-bacd-4fc9-9de4-679392e6a148"},"x-mint":{"content":"\u003cdiv className=\"not-prose text-sm text-gray-500 dark:text-gray-400\">Required scope: \u003ca href=\"/api-reference/scopes\">\u003cBadge color=\"blue\" stroke size=\"sm\">CARDS_SIMULATE\u003c/Badge>\u003c/a>\u003c/div>"},"method":"post","type":"path","servers":["de1a2c94-1c62-4954-82a1-16d935609404","3bed5113-8ee4-45fa-9f6a-c24f2baf8936","25066b55-4bc2-46fc-b59f-c8ae060716ba","89b90589-79b1-4461-a44b-a3f71d01e416","3c3a387d-ae3e-40c9-bca5-b6c9c6ace569","b73a3c12-6d12-4183-bc68-cb87abc91e48"],"security":["1e2abbe2-328b-4f9a-81e0-3d484135037d"],"path":"/simulation/card-transactions/reversal","baseUrlOptions":["https://sg.sandbox.api.reap.global","https://sg.prod.api.reap.global","https://mx.sandbox.api.reap.global","https://mx.prod.api.reap.global","https://sandbox.api.reap.global","https://prod.api.reap.global"],"title":"Simulate reversal","codeSamples":[],"requestExampleLanguages":["bash","javascript","python"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"9e46f25d-3d7d-491e-a168-9c4a9a1eac06":{"name":"Reap-Version","in":"header","required":true,"schema":{"type":"string","enum":["2025-02-14"],"description":"API version (YYYY-MM-DD)","example":"2025-02-14","isRequired":true,"uniqueKey":"","typeLabel":"enum\u003cstring>"}}},"requestBody":{"description":"Simulate a reversal event on a card","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"cardId":{"description":"Card ID","type":"string","format":"uuid","isRequired":true,"uniqueKey":"cardId","typeLabel":"string\u003cuuid>"},"transactionId":{"description":"Transaction ID to reverse. Required — reversals always target an existing authorization.","type":"string","format":"uuid","isRequired":true,"uniqueKey":"transactionId","typeLabel":"string\u003cuuid>"},"amount":{"type":"number","minimum":0,"examples":[100.5,0,1234.99],"description":"Merchant amount in the project's billing currency, before cardholder fees. Any FX markup or ATM fee that applies to the account is added on top, as in production, so the amount charged to the cardholder can be higher than this value.","isRequired":true,"uniqueKey":"amount","typeLabel":"number"},"originalAmount":{"description":"Amount in the original transaction currency. Must be provided together with `originalCurrency`, and is required when the event lands on a transaction whose original currency is not the billing currency.","type":"number","minimum":0,"examples":[100.5,0,1234.99],"uniqueKey":"originalAmount","typeLabel":"number"},"originalCurrency":{"description":"Original transaction currency as an ISO 4217 alpha code (e.g. `EUR`). Must be provided together with `originalAmount`.","type":"string","pattern":"^[A-Z]{3}$","uniqueKey":"originalCurrency","typeLabel":"string"}},"required":["cardId","transactionId","amount"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"cardId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","transactionId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","amount":100.5,"originalAmount":100.5,"originalCurrency":"\u003cstring>"}}},"exampleType":"generated"},"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"cardId":{"description":"Card ID","type":"string","format":"uuid","isRequired":true,"uniqueKey":"cardId","typeLabel":"string\u003cuuid>"},"transactionId":{"description":"Transaction ID to reverse. Required — reversals always target an existing authorization.","type":"string","format":"uuid","isRequired":true,"uniqueKey":"transactionId","typeLabel":"string\u003cuuid>"},"amount":{"type":"number","minimum":0,"examples":[100.5,0,1234.99],"description":"Merchant amount in the project's billing currency, before cardholder fees. Any FX markup or ATM fee that applies to the account is added on top, as in production, so the amount charged to the cardholder can be higher than this value.","isRequired":true,"uniqueKey":"amount","typeLabel":"number"},"originalAmount":{"description":"Amount in the original transaction currency. Must be provided together with `originalCurrency`, and is required when the event lands on a transaction whose original currency is not the billing currency.","type":"number","minimum":0,"examples":[100.5,0,1234.99],"uniqueKey":"originalAmount","typeLabel":"number"},"originalCurrency":{"description":"Original transaction currency as an ISO 4217 alpha code (e.g. `EUR`). Must be provided together with `originalAmount`.","type":"string","pattern":"^[A-Z]{3}$","uniqueKey":"originalCurrency","typeLabel":"string"}},"required":["cardId","transactionId","amount"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"cardId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","transactionId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","amount":100.5,"originalAmount":100.5,"originalCurrency":"\u003cstring>"}}},"exampleType":"generated"},"multipart/form-data":{"schema":{"type":"object","properties":{"cardId":{"description":"Card ID","type":"string","format":"uuid","isRequired":true,"uniqueKey":"cardId","typeLabel":"string\u003cuuid>"},"transactionId":{"description":"Transaction ID to reverse. Required — reversals always target an existing authorization.","type":"string","format":"uuid","isRequired":true,"uniqueKey":"transactionId","typeLabel":"string\u003cuuid>"},"amount":{"type":"number","minimum":0,"examples":[100.5,0,1234.99],"description":"Merchant amount in the project's billing currency, before cardholder fees. Any FX markup or ATM fee that applies to the account is added on top, as in production, so the amount charged to the cardholder can be higher than this value.","isRequired":true,"uniqueKey":"amount","typeLabel":"number"},"originalAmount":{"description":"Amount in the original transaction currency. Must be provided together with `originalCurrency`, and is required when the event lands on a transaction whose original currency is not the billing currency.","type":"number","minimum":0,"examples":[100.5,0,1234.99],"uniqueKey":"originalAmount","typeLabel":"number"},"originalCurrency":{"description":"Original transaction currency as an ISO 4217 alpha code (e.g. `EUR`). Must be provided together with `originalAmount`.","type":"string","pattern":"^[A-Z]{3}$","uniqueKey":"originalCurrency","typeLabel":"string"}},"required":["cardId","transactionId","amount"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"cardId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","transactionId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","amount":100.5,"originalAmount":100.5,"originalCurrency":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"4a7d8365-25f6-4b21-b50e-4ac0469c690b":{"description":"Card transaction resource. The response shape varies by transaction status.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Pending","description":"Authorized transaction that hasn't settled yet","required":["id","accountId","cardId","channel","digitalWallet","originalCurrency","currency","merchant","fees","events","occurredAt","createdAt","updatedAt","status","originalAmount","amount","conversionRate"],"properties":{"id":{"type":"string","format":"uuid","description":"Card transaction identifier","isRequired":true,"uniqueKey":"oneOf.0.id","typeLabel":"string\u003cuuid>"},"accountId":{"type":"string","format":"uuid","description":"Account linked to the card","isRequired":true,"uniqueKey":"oneOf.0.accountId","typeLabel":"string\u003cuuid>"},"cardId":{"type":"string","format":"uuid","description":"Card used for this transaction","isRequired":true,"uniqueKey":"oneOf.0.cardId","typeLabel":"string\u003cuuid>"},"channel":{"type":"string","enum":["ATM","POS","ECOMMERCE","VISA_DIRECT"],"description":"Transaction channel","example":"ATM","isRequired":true,"uniqueKey":"oneOf.0.channel","typeLabel":"enum\u003cstring>"},"digitalWallet":{"oneOf":[{"type":"string","description":"Digital wallet used, or null if physical card","enum":["APPLE_PAY","GOOGLE_PAY","MERCHANT_TOKEN"],"example":"APPLE_PAY","isRequired":true,"uniqueKey":"oneOf.0.digitalWallet.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Digital wallet used, or null if physical card","isRequired":true,"uniqueKey":"oneOf.0.digitalWallet.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.digitalWallet","typeLabel":"enum\u003cstring> | null"},"originalCurrency":{"type":"string","examples":["USD","HKD","EUR"],"description":"Original transaction currency (merchant local currency)","isRequired":true,"uniqueKey":"oneOf.0.originalCurrency","typeLabel":"string"},"currency":{"type":"string","examples":["USD","HKD","EUR"],"description":"Card currency","isRequired":true,"uniqueKey":"oneOf.0.currency","typeLabel":"string"},"merchant":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Identifier of the merchant details recorded on this transaction. Not a stable merchant identifier: the same merchant has a different `id` on each transaction, so do not use it to identify or group merchants. Use `cardAcceptorId` instead.","isRequired":true,"uniqueKey":"oneOf.0.merchant.id","typeLabel":"string\u003cuuid>"},"cardAcceptorId":{"oneOf":[{"type":"string","description":"Card acceptor ID (often called the merchant ID or MID), assigned by the merchant's acquirer and passed on by the card network. It is unique only within one acquirer, and one merchant can have several (for example one per terminal). Combine it with `name`, `country`, and `mccCode` when matching merchants. `null` when the network did not provide one.","example":"000123456789012","isRequired":true,"uniqueKey":"oneOf.0.merchant.cardAcceptorId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Card acceptor ID (often called the merchant ID or MID), assigned by the merchant's acquirer and passed on by the card network. It is unique only within one acquirer, and one merchant can have several (for example one per terminal). Combine it with `name`, `country`, and `mccCode` when matching merchants. `null` when the network did not provide one.","example":"000123456789012","isRequired":true,"uniqueKey":"oneOf.0.merchant.cardAcceptorId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.merchant.cardAcceptorId","typeLabel":"string | null"},"name":{"type":"string","description":"Merchant name","isRequired":true,"uniqueKey":"oneOf.0.merchant.name","typeLabel":"string"},"city":{"oneOf":[{"type":"string","description":"Merchant city","isRequired":true,"uniqueKey":"oneOf.0.merchant.city.oneOf.0","typeLabel":"string"},{"type":"null","description":"Merchant city","isRequired":true,"uniqueKey":"oneOf.0.merchant.city.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.merchant.city","typeLabel":"string | null"},"postCode":{"oneOf":[{"type":"string","description":"Merchant postal or ZIP code","isRequired":true,"uniqueKey":"oneOf.0.merchant.postCode.oneOf.0","typeLabel":"string"},{"type":"null","description":"Merchant postal or ZIP code","isRequired":true,"uniqueKey":"oneOf.0.merchant.postCode.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.merchant.postCode","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","description":"Merchant state or province","isRequired":true,"uniqueKey":"oneOf.0.merchant.state.oneOf.0","typeLabel":"string"},{"type":"null","description":"Merchant state or province","isRequired":true,"uniqueKey":"oneOf.0.merchant.state.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.merchant.state","typeLabel":"string | null"},"mccCode":{"type":"string","examples":["5411","5812"],"description":"Merchant Category Code","isRequired":true,"uniqueKey":"oneOf.0.merchant.mccCode","typeLabel":"string"},"mccCategory":{"type":"string","examples":["Grocery Stores","Eating Places \u0026 Restaurants"],"description":"MCC category description","isRequired":true,"uniqueKey":"oneOf.0.merchant.mccCategory","typeLabel":"string"},"country":{"type":"string","minLength":2,"maxLength":2,"examples":["US","GB","DE"],"description":"ISO 3166-1 alpha-2 country code","uniqueKey":"oneOf.0.merchant.country","typeLabel":"string"}},"required":["id","cardAcceptorId","name","city","postCode","state","mccCode","mccCategory"],"description":"Merchant details","isRequired":true,"uniqueKey":"oneOf.0.merchant","typeLabel":"object"},"fees":{"type":"object","properties":{"atm":{"type":"number","minimum":0,"examples":[100.5,0,1234.99],"description":"ATM withdrawal markup charged to the cardholder (card currency)","isRequired":true,"uniqueKey":"oneOf.0.fees.atm","typeLabel":"number"},"fx":{"type":"number","minimum":0,"examples":[100.5,0,1234.99],"description":"FX markup charged to the cardholder (card currency)","isRequired":true,"uniqueKey":"oneOf.0.fees.fx","typeLabel":"number"}},"required":["atm","fx"],"description":"Net cardholder fees in the card currency (same aggregation legs as cardholder amount for PENDING/VOID/CLEARED; decline-event fees for DECLINED)","isRequired":true,"uniqueKey":"oneOf.0.fees","typeLabel":"object"},"events":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Event identifier","isRequired":true,"uniqueKey":"oneOf.0.events.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","enum":["AUTHORIZATION","CLEARING","REVERSAL","REFUND","DECLINE","DISPUTE_REFUND"],"description":"Lifecycle event type. DISPUTE_REFUND is the credit from a card dispute resolved in favor of the cardholder; like REFUND it gives cleared value back to the cardholder.","example":"AUTHORIZATION","isRequired":true,"uniqueKey":"oneOf.0.events.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"originalAmount":{"type":"number","minimum":0,"examples":[100.5,0,1234.99],"description":"Event amount in the event-level original currency","isRequired":true,"uniqueKey":"oneOf.0.events.items.[INDEX].originalAmount","typeLabel":"number"},"originalCurrency":{"type":"string","examples":["USD","HKD","EUR"],"description":"Per-event original currency. Usually equals the parent transaction `originalCurrency`, but can differ when the card network reports a presentment (typically a clearing) in the bill currency instead of the merchant local currency.","isRequired":true,"uniqueKey":"oneOf.0.events.items.[INDEX].originalCurrency","typeLabel":"string"},"amount":{"type":"number","minimum":0,"examples":[100.5,0,1234.99],"description":"Event amount charged to the cardholder (card currency)","isRequired":true,"uniqueKey":"oneOf.0.events.items.[INDEX].amount","typeLabel":"number"},"fees":{"type":"object","properties":{"atm":{"type":"number","minimum":0,"examples":[100.5,0,1234.99],"description":"ATM withdrawal markup charged to the cardholder (card currency)","isRequired":true,"uniqueKey":"oneOf.0.events.items.[INDEX].fees.atm","typeLabel":"number"},"fx":{"type":"number","minimum":0,"examples":[100.5,0,1234.99],"description":"FX markup charged to the cardholder (card currency)","isRequired":true,"uniqueKey":"oneOf.0.events.items.[INDEX].fees.fx","typeLabel":"number"}},"required":["atm","fx"],"description":"Cardholder fees charged on this event (card currency)","isRequired":true,"uniqueKey":"oneOf.0.events.items.[INDEX].fees","typeLabel":"object"},"occurredAt":{"type":"string","examples":["2024-01-15T10:30:00Z"],"description":"ISO 8601 timestamp of when the event occurred","isRequired":true,"uniqueKey":"oneOf.0.events.items.[INDEX].occurredAt","typeLabel":"string"},"createdAt":{"type":"string","examples":["2024-01-15T10:30:05Z"],"description":"ISO 8601 timestamp of when the event was recorded","isRequired":true,"uniqueKey":"oneOf.0.events.items.[INDEX].createdAt","typeLabel":"string"}},"required":["id","type","originalAmount","originalCurrency","amount","fees","occurredAt","createdAt"],"description":"A single lifecycle event on the transaction","uniqueKey":"oneOf.0.events.items.[INDEX]","typeLabel":"object"},"description":"Chronologically sorted lifecycle events (oldest first). Provides the full audit trail of what happened to this transaction.","isRequired":true,"uniqueKey":"oneOf.0.events","typeLabel":"object[]"},"occurredAt":{"type":"string","examples":["2024-01-15T10:30:00Z"],"description":"ISO 8601 timestamp of when the transaction was initiated","isRequired":true,"uniqueKey":"oneOf.0.occurredAt","typeLabel":"string"},"createdAt":{"type":"string","examples":["2024-01-15T10:30:00Z"],"description":"ISO 8601 timestamp of creation","isRequired":true,"uniqueKey":"oneOf.0.createdAt","typeLabel":"string"},"updatedAt":{"type":"string","examples":["2024-01-15T10:35:00Z"],"description":"ISO 8601 timestamp of last update","isRequired":true,"uniqueKey":"oneOf.0.updatedAt","typeLabel":"string"},"status":{"type":"string","const":"PENDING","isRequired":true,"uniqueKey":"oneOf.0.status","typeLabel":"string"},"originalAmount":{"type":"object","properties":{"authorized":{"type":"number","minimum":0,"examples":[100.5,0,1234.99],"description":"Original authorized amount before reversals","isRequired":true,"uniqueKey":"oneOf.0.originalAmount.authorized","typeLabel":"number"},"reversed":{"type":"number","minimum":0,"examples":[100.5,0,1234.99],"description":"Total amount reversed (credited back)","isRequired":true,"uniqueKey":"oneOf.0.originalAmount.reversed","typeLabel":"number"},"current":{"type":"number","minimum":0,"examples":[100.5,0,1234.99],"description":"Effective current amount (authorized - reversed, minimum 0)","isRequired":true,"uniqueKey":"oneOf.0.originalAmount.current","typeLabel":"number"}},"required":["authorized","reversed","current"],"description":"Amount in the original transaction currency","isRequired":true,"uniqueKey":"oneOf.0.originalAmount","typeLabel":"object"},"amount":{"type":"object","properties":{"authorized":{"type":"number","minimum":0,"examples":[100.5,0,1234.99],"description":"Original authorized amount before reversals","isRequired":true,"uniqueKey":"oneOf.0.amount.authorized","typeLabel":"number"},"reversed":{"type":"number","minimum":0,"examples":[100.5,0,1234.99],"description":"Total amount reversed (credited back)","isRequired":true,"uniqueKey":"oneOf.0.amount.reversed","typeLabel":"number"},"current":{"type":"number","minimum":0,"examples":[100.5,0,1234.99],"description":"Effective current amount (authorized - reversed, minimum 0)","isRequired":true,"uniqueKey":"oneOf.0.amount.current","typeLabel":"number"}},"required":["authorized","reversed","current"],"description":"Amount charged to the cardholder","isRequired":true,"uniqueKey":"oneOf.0.amount","typeLabel":"object"},"conversionRate":{"type":"number","minimum":0,"examples":[1,0.128205,7.812],"description":"Conversion rate from the original currency to the card currency","isRequired":true,"uniqueKey":"oneOf.0.conversionRate","typeLabel":"number"}},"uniqueKey":"oneOf.0","typeLabel":"Pending · object"},{"type":"object","title":"Cleared","description":"Fully settled transaction","required":["id","accountId","cardId","channel","digitalWallet","originalCurrency","currency","merchant","fees","events","occurredAt","createdAt","updatedAt","status","originalAmount","amount","conversionRate"],"properties":{"id":{"type":"string","format":"uuid","description":"Card transaction identifier","isRequired":true,"uniqueKey":"oneOf.1.id","typeLabel":"string\u003cuuid>"},"accountId":{"type":"string","format":"uuid","description":"Account linked to the card","isRequired":true,"uniqueKey":"oneOf.1.accountId","typeLabel":"string\u003cuuid>"},"cardId":{"type":"string","format":"uuid","description":"Card used for this transaction","isRequired":true,"uniqueKey":"oneOf.1.cardId","typeLabel":"string\u003cuuid>"},"channel":{"type":"string","enum":["ATM","POS","ECOMMERCE","VISA_DIRECT"],"description":"Transaction channel","example":"ATM","isRequired":true,"uniqueKey":"oneOf.1.channel","typeLabel":"enum\u003cstring>"},"digitalWallet":{"oneOf":[{"type":"string","description":"Digital wallet used, or null if physical card","enum":["APPLE_PAY","GOOGLE_PAY","MERCHANT_TOKEN"],"example":"APPLE_PAY","isRequired":true,"uniqueKey":"oneOf.1.digitalWallet.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Digital wallet used, or null if physical card","isRequired":true,"uniqueKey":"oneOf.1.digitalWallet.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.digitalWallet","typeLabel":"enum\u003cstring> | null"},"originalCurrency":{"type":"string","examples":["USD","HKD","EUR"],"description":"Original transaction currency (merchant local currency)","isRequired":true,"uniqueKey":"oneOf.1.originalCurrency","typeLabel":"string"},"currency":{"type":"string","examples":["USD","HKD","EUR"],"description":"Card currency","isRequired":true,"uniqueKey":"oneOf.1.currency","typeLabel":"string"},"merchant":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Identifier of the merchant details recorded on this transaction. Not a stable merchant identifier: the same merchant has a different `id` on each transaction, so do not use it to identify or group merchants. Use `cardAcceptorId` instead.","isRequired":true,"uniqueKey":"oneOf.1.merchant.id","typeLabel":"string\u003cuuid>"},"cardAcceptorId":{"oneOf":[{"type":"string","description":"Card acceptor ID (often called the merchant ID or MID), assigned by the merchant's acquirer and passed on by the card network. It is unique only within one acquirer, and one merchant can have several (for example one per terminal). Combine it with `name`, `country`, and `mccCode` when matching merchants. `null` when the network did not provide one.","example":"000123456789012","isRequired":true,"uniqueKey":"oneOf.1.merchant.cardAcceptorId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Card acceptor ID (often called the merchant ID or MID), assigned by the merchant's acquirer and passed on by the card network. It is unique only within one acquirer, and one merchant can have several (for example one per terminal). Combine it with `name`, `country`, and `mccCode` when matching merchants. `null` when the network did not provide one.","example":"000123456789012","isRequired":true,"uniqueKey":"oneOf.1.merchant.cardAcceptorId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.merchant.cardAcceptorId","typeLabel":"string | null"},"name":{"type":"string","description":"Merchant name","isRequired":true,"uniqueKey":"oneOf.1.merchant.name","typeLabel":"string"},"city":{"oneOf":[{"type":"string","description":"Merchant city","isRequired":true,"uniqueKey":"oneOf.1.merchant.city.oneOf.0","typeLabel":"string"},{"type":"null","description":"Merchant city","isRequired":true,"uniqueKey":"oneOf.1.merchant.city.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.merchant.city","typeLabel":"string | null"},"postCode":{"oneOf":[{"type":"string","description":"Merchant postal or ZIP code","isRequired":true,"uniqueKey":"oneOf.1.merchant.postCode.oneOf.0","typeLabel":"string"},{"type":"null","description":"Merchant postal or ZIP code","isRequired":true,"uniqueKey":"oneOf.1.merchant.postCode.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.merchant.postCode","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","description":"Merchant state or province","isRequired":true,"uniqueKey":"oneOf.1.merchant.state.oneOf.0","typeLabel":"string"},{"type":"null","description":"Merchant state or province","isRequired":true,"uniqueKey":"oneOf.1.merchant.state.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.merchant.state","typeLabel":"string | null"},"mccCode":{"type":"string","examples":["5411","5812"],"description":"Merchant Category Code","isRequired":true,"uniqueKey":"oneOf.1.merchant.mccCode","typeLabel":"string"},"mccCategory":{"type":"string","examples":["Grocery Stores","Eating Places \u0026 Restaurants"],"description":"MCC category description","isRequired":true,"uniqueKey":"oneOf.1.merchant.mccCategory","typeLabel":"string"},"country":{"type":"string","minLength":2,"maxLength":2,"examples":["US","GB","DE"],"description":"ISO 3166-1 alpha-2 country code","uniqueKey":"oneOf.1.merchant.country","typeLabel":"string"}},"required":["id","cardAcceptorId","name","city","postCode","state","mccCode","mccCategory"],"description":"Merchant details","isRequired":true,"uniqueKey":"oneOf.1.merchant","typeLabel":"object"},"fees":{"type":"object","properties":{"atm":{"type":"number","minimum":0,"examples":[100.5,0,1234.99],"description":"ATM withdrawal markup charged to the cardholder (card currency)","isRequired":true,"uniqueKey":"oneOf.1.fees.atm","typeLabel":"number"},"fx":{"type":"number","minimum":0,"examples":[100.5,0,1234.99],"description":"FX markup charged to the cardholder (card currency)","isRequired":true,"uniqueKey":"oneOf.1.fees.fx","typeLabel":"number"}},"required":["atm","fx"],"description":"Net cardholder fees in the card currency (same aggregation legs as cardholder amount for PENDING/VOID/CLEARED; decline-event fees for DECLINED)","isRequired":true,"uniqueKey":"oneOf.1.fees","typeLabel":"object"},"events":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Event identifier","isRequired":true,"uniqueKey":"oneOf.1.events.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","enum":["AUTHORIZATION","CLEARING","REVERSAL","REFUND","DECLINE","DISPUTE_REFUND"],"description":"Lifecycle event type. DISPUTE_REFUND is the credit from a card dispute resolved in favor of the cardholder; like REFUND it gives cleared value back to the cardholder.","example":"AUTHORIZATION","isRequired":true,"uniqueKey":"oneOf.1.events.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"originalAmount":{"type":"number","minimum":0,"examples":[100.5,0,1234.99],"description":"Event amount in the event-level original currency","isRequired":true,"uniqueKey":"oneOf.1.events.items.[INDEX].originalAmount","typeLabel":"number"},"originalCurrency":{"type":"string","examples":["USD","HKD","EUR"],"description":"Per-event original currency. Usually equals the parent transaction `originalCurrency`, but can differ when the card network reports a presentment (typically a clearing) in the bill currency instead of the merchant local currency.","isRequired":true,"uniqueKey":"oneOf.1.events.items.[INDEX].originalCurrency","typeLabel":"string"},"amount":{"type":"number","minimum":0,"examples":[100.5,0,1234.99],"description":"Event amount charged to the cardholder (card currency)","isRequired":true,"uniqueKey":"oneOf.1.events.items.[INDEX].amount","typeLabel":"number"},"fees":{"type":"object","properties":{"atm":{"type":"number","minimum":0,"examples":[100.5,0,1234.99],"description":"ATM withdrawal markup charged to the cardholder (card currency)","isRequired":true,"uniqueKey":"oneOf.1.events.items.[INDEX].fees.atm","typeLabel":"number"},"fx":{"type":"number","minimum":0,"examples":[100.5,0,1234.99],"description":"FX markup charged to the cardholder (card currency)","isRequired":true,"uniqueKey":"oneOf.1.events.items.[INDEX].fees.fx","typeLabel":"number"}},"required":["atm","fx"],"description":"Cardholder fees charged on this event (card currency)","isRequired":true,"uniqueKey":"oneOf.1.events.items.[INDEX].fees","typeLabel":"object"},"occurredAt":{"type":"string","examples":["2024-01-15T10:30:00Z"],"description":"ISO 8601 timestamp of when the event occurred","isRequired":true,"uniqueKey":"oneOf.1.events.items.[INDEX].occurredAt","typeLabel":"string"},"createdAt":{"type":"string","examples":["2024-01-15T10:30:05Z"],"description":"ISO 8601 timestamp of when the event was recorded","isRequired":true,"uniqueKey":"oneOf.1.events.items.[INDEX].createdAt","typeLabel":"string"}},"required":["id","type","originalAmount","originalCurrency","amount","fees","occurredAt","createdAt"],"description":"A single lifecycle event on the transaction","uniqueKey":"oneOf.1.events.items.[INDEX]","typeLabel":"object"},"description":"Chronologically sorted lifecycle events (oldest first). Provides the full audit trail of what happened to this transaction.","isRequired":true,"uniqueKey":"oneOf.1.events","typeLabel":"object[]"},"occurredAt":{"type":"string","examples":["2024-01-15T10:30:00Z"],"description":"ISO 8601 timestamp of when the transaction was initiated","isRequired":true,"uniqueKey":"oneOf.1.occurredAt","typeLabel":"string"},"createdAt":{"type":"string","examples":["2024-01-15T10:30:00Z"],"description":"ISO 8601 timestamp of creation","isRequired":true,"uniqueKey":"oneOf.1.createdAt","typeLabel":"string"},"updatedAt":{"type":"string","examples":["2024-01-15T10:35:00Z"],"description":"ISO 8601 timestamp of last update","isRequired":true,"uniqueKey":"oneOf.1.updatedAt","typeLabel":"string"},"status":{"type":"string","const":"CLEARED","isRequired":true,"uniqueKey":"oneOf.1.status","typeLabel":"string"},"originalAmount":{"type":"object","properties":{"cleared":{"type":"number","minimum":0,"examples":[100.5,0,1234.99],"description":"Total settled amount","isRequired":true,"uniqueKey":"oneOf.1.originalAmount.cleared","typeLabel":"number"},"refunded":{"type":"number","minimum":0,"examples":[100.5,0,1234.99],"description":"Total amount refunded, by the merchant (REFUND events) or through a dispute (DISPUTE_REFUND events)","isRequired":true,"uniqueKey":"oneOf.1.originalAmount.refunded","typeLabel":"number"},"current":{"type":"number","minimum":0,"examples":[100.5,0,1234.99],"description":"Effective current amount (cleared - refunded, minimum 0)","isRequired":true,"uniqueKey":"oneOf.1.originalAmount.current","typeLabel":"number"}},"required":["cleared","refunded","current"],"description":"Amount in the original transaction currency","isRequired":true,"uniqueKey":"oneOf.1.originalAmount","typeLabel":"object"},"amount":{"type":"object","properties":{"cleared":{"type":"number","minimum":0,"examples":[100.5,0,1234.99],"description":"Total settled amount","isRequired":true,"uniqueKey":"oneOf.1.amount.cleared","typeLabel":"number"},"refunded":{"type":"number","minimum":0,"examples":[100.5,0,1234.99],"description":"Total amount refunded, by the merchant (REFUND events) or through a dispute (DISPUTE_REFUND events)","isRequired":true,"uniqueKey":"oneOf.1.amount.refunded","typeLabel":"number"},"current":{"type":"number","minimum":0,"examples":[100.5,0,1234.99],"description":"Effective current amount (cleared - refunded, minimum 0)","isRequired":true,"uniqueKey":"oneOf.1.amount.current","typeLabel":"number"}},"required":["cleared","refunded","current"],"description":"Amount charged to the cardholder","isRequired":true,"uniqueKey":"oneOf.1.amount","typeLabel":"object"},"conversionRate":{"type":"number","minimum":0,"examples":[1,0.128205,7.812],"description":"Conversion rate from the original currency to the card currency","isRequired":true,"uniqueKey":"oneOf.1.conversionRate","typeLabel":"number"}},"uniqueKey":"oneOf.1","typeLabel":"Cleared · object"},{"type":"object","title":"Declined","description":"Transaction that was declined during authorization","required":["id","accountId","cardId","channel","digitalWallet","originalCurrency","currency","merchant","fees","events","occurredAt","createdAt","updatedAt","status","originalAmount","declineReason","policy"],"properties":{"id":{"type":"string","format":"uuid","description":"Card transaction identifier","isRequired":true,"uniqueKey":"oneOf.2.id","typeLabel":"string\u003cuuid>"},"accountId":{"type":"string","format":"uuid","description":"Account linked to the card","isRequired":true,"uniqueKey":"oneOf.2.accountId","typeLabel":"string\u003cuuid>"},"cardId":{"type":"string","format":"uuid","description":"Card used for this transaction","isRequired":true,"uniqueKey":"oneOf.2.cardId","typeLabel":"string\u003cuuid>"},"channel":{"type":"string","enum":["ATM","POS","ECOMMERCE","VISA_DIRECT"],"description":"Transaction channel","example":"ATM","isRequired":true,"uniqueKey":"oneOf.2.channel","typeLabel":"enum\u003cstring>"},"digitalWallet":{"oneOf":[{"type":"string","description":"Digital wallet used, or null if physical card","enum":["APPLE_PAY","GOOGLE_PAY","MERCHANT_TOKEN"],"example":"APPLE_PAY","isRequired":true,"uniqueKey":"oneOf.2.digitalWallet.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Digital wallet used, or null if physical card","isRequired":true,"uniqueKey":"oneOf.2.digitalWallet.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.digitalWallet","typeLabel":"enum\u003cstring> | null"},"originalCurrency":{"type":"string","examples":["USD","HKD","EUR"],"description":"Original transaction currency (merchant local currency)","isRequired":true,"uniqueKey":"oneOf.2.originalCurrency","typeLabel":"string"},"currency":{"type":"string","examples":["USD","HKD","EUR"],"description":"Card currency","isRequired":true,"uniqueKey":"oneOf.2.currency","typeLabel":"string"},"merchant":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Identifier of the merchant details recorded on this transaction. Not a stable merchant identifier: the same merchant has a different `id` on each transaction, so do not use it to identify or group merchants. Use `cardAcceptorId` instead.","isRequired":true,"uniqueKey":"oneOf.2.merchant.id","typeLabel":"string\u003cuuid>"},"cardAcceptorId":{"oneOf":[{"type":"string","description":"Card acceptor ID (often called the merchant ID or MID), assigned by the merchant's acquirer and passed on by the card network. It is unique only within one acquirer, and one merchant can have several (for example one per terminal). Combine it with `name`, `country`, and `mccCode` when matching merchants. `null` when the network did not provide one.","example":"000123456789012","isRequired":true,"uniqueKey":"oneOf.2.merchant.cardAcceptorId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Card acceptor ID (often called the merchant ID or MID), assigned by the merchant's acquirer and passed on by the card network. It is unique only within one acquirer, and one merchant can have several (for example one per terminal). Combine it with `name`, `country`, and `mccCode` when matching merchants. `null` when the network did not provide one.","example":"000123456789012","isRequired":true,"uniqueKey":"oneOf.2.merchant.cardAcceptorId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.merchant.cardAcceptorId","typeLabel":"string | null"},"name":{"type":"string","description":"Merchant name","isRequired":true,"uniqueKey":"oneOf.2.merchant.name","typeLabel":"string"},"city":{"oneOf":[{"type":"string","description":"Merchant city","isRequired":true,"uniqueKey":"oneOf.2.merchant.city.oneOf.0","typeLabel":"string"},{"type":"null","description":"Merchant city","isRequired":true,"uniqueKey":"oneOf.2.merchant.city.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.merchant.city","typeLabel":"string | null"},"postCode":{"oneOf":[{"type":"string","description":"Merchant postal or ZIP code","isRequired":true,"uniqueKey":"oneOf.2.merchant.postCode.oneOf.0","typeLabel":"string"},{"type":"null","description":"Merchant postal or ZIP code","isRequired":true,"uniqueKey":"oneOf.2.merchant.postCode.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.merchant.postCode","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","description":"Merchant state or province","isRequired":true,"uniqueKey":"oneOf.2.merchant.state.oneOf.0","typeLabel":"string"},{"type":"null","description":"Merchant state or province","isRequired":true,"uniqueKey":"oneOf.2.merchant.state.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.merchant.state","typeLabel":"string | null"},"mccCode":{"type":"string","examples":["5411","5812"],"description":"Merchant Category Code","isRequired":true,"uniqueKey":"oneOf.2.merchant.mccCode","typeLabel":"string"},"mccCategory":{"type":"string","examples":["Grocery Stores","Eating Places \u0026 Restaurants"],"description":"MCC category description","isRequired":true,"uniqueKey":"oneOf.2.merchant.mccCategory","typeLabel":"string"},"country":{"type":"string","minLength":2,"maxLength":2,"examples":["US","GB","DE"],"description":"ISO 3166-1 alpha-2 country code","uniqueKey":"oneOf.2.merchant.country","typeLabel":"string"}},"required":["id","cardAcceptorId","name","city","postCode","state","mccCode","mccCategory"],"description":"Merchant details","isRequired":true,"uniqueKey":"oneOf.2.merchant","typeLabel":"object"},"fees":{"type":"object","properties":{"atm":{"type":"number","minimum":0,"examples":[100.5,0,1234.99],"description":"ATM withdrawal markup charged to the cardholder (card currency)","isRequired":true,"uniqueKey":"oneOf.2.fees.atm","typeLabel":"number"},"fx":{"type":"number","minimum":0,"examples":[100.5,0,1234.99],"description":"FX markup charged to the cardholder (card currency)","isRequired":true,"uniqueKey":"oneOf.2.fees.fx","typeLabel":"number"}},"required":["atm","fx"],"description":"Net cardholder fees in the card currency (same aggregation legs as cardholder amount for PENDING/VOID/CLEARED; decline-event fees for DECLINED)","isRequired":true,"uniqueKey":"oneOf.2.fees","typeLabel":"object"},"events":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Event identifier","isRequired":true,"uniqueKey":"oneOf.2.events.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","enum":["AUTHORIZATION","CLEARING","REVERSAL","REFUND","DECLINE","DISPUTE_REFUND"],"description":"Lifecycle event type. DISPUTE_REFUND is the credit from a card dispute resolved in favor of the cardholder; like REFUND it gives cleared value back to the cardholder.","example":"AUTHORIZATION","isRequired":true,"uniqueKey":"oneOf.2.events.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"originalAmount":{"type":"number","minimum":0,"examples":[100.5,0,1234.99],"description":"Event amount in the event-level original currency","isRequired":true,"uniqueKey":"oneOf.2.events.items.[INDEX].originalAmount","typeLabel":"number"},"originalCurrency":{"type":"string","examples":["USD","HKD","EUR"],"description":"Per-event original currency. Usually equals the parent transaction `originalCurrency`, but can differ when the card network reports a presentment (typically a clearing) in the bill currency instead of the merchant local currency.","isRequired":true,"uniqueKey":"oneOf.2.events.items.[INDEX].originalCurrency","typeLabel":"string"},"amount":{"type":"number","minimum":0,"examples":[100.5,0,1234.99],"description":"Event amount charged to the cardholder (card currency)","isRequired":true,"uniqueKey":"oneOf.2.events.items.[INDEX].amount","typeLabel":"number"},"fees":{"type":"object","properties":{"atm":{"type":"number","minimum":0,"examples":[100.5,0,1234.99],"description":"ATM withdrawal markup charged to the cardholder (card currency)","isRequired":true,"uniqueKey":"oneOf.2.events.items.[INDEX].fees.atm","typeLabel":"number"},"fx":{"type":"number","minimum":0,"examples":[100.5,0,1234.99],"description":"FX markup charged to the cardholder (card currency)","isRequired":true,"uniqueKey":"oneOf.2.events.items.[INDEX].fees.fx","typeLabel":"number"}},"required":["atm","fx"],"description":"Cardholder fees charged on this event (card currency)","isRequired":true,"uniqueKey":"oneOf.2.events.items.[INDEX].fees","typeLabel":"object"},"occurredAt":{"type":"string","examples":["2024-01-15T10:30:00Z"],"description":"ISO 8601 timestamp of when the event occurred","isRequired":true,"uniqueKey":"oneOf.2.events.items.[INDEX].occurredAt","typeLabel":"string"},"createdAt":{"type":"string","examples":["2024-01-15T10:30:05Z"],"description":"ISO 8601 timestamp of when the event was recorded","isRequired":true,"uniqueKey":"oneOf.2.events.items.[INDEX].createdAt","typeLabel":"string"}},"required":["id","type","originalAmount","originalCurrency","amount","fees","occurredAt","createdAt"],"description":"A single lifecycle event on the transaction","uniqueKey":"oneOf.2.events.items.[INDEX]","typeLabel":"object"},"description":"Chronologically sorted lifecycle events (oldest first). Provides the full audit trail of what happened to this transaction.","isRequired":true,"uniqueKey":"oneOf.2.events","typeLabel":"object[]"},"occurredAt":{"type":"string","examples":["2024-01-15T10:30:00Z"],"description":"ISO 8601 timestamp of when the transaction was initiated","isRequired":true,"uniqueKey":"oneOf.2.occurredAt","typeLabel":"string"},"createdAt":{"type":"string","examples":["2024-01-15T10:30:00Z"],"description":"ISO 8601 timestamp of creation","isRequired":true,"uniqueKey":"oneOf.2.createdAt","typeLabel":"string"},"updatedAt":{"type":"string","examples":["2024-01-15T10:35:00Z"],"description":"ISO 8601 timestamp of last update","isRequired":true,"uniqueKey":"oneOf.2.updatedAt","typeLabel":"string"},"status":{"type":"string","const":"DECLINED","isRequired":true,"uniqueKey":"oneOf.2.status","typeLabel":"string"},"originalAmount":{"type":"number","minimum":0,"examples":[100.5,0,1234.99],"description":"Attempted transaction amount in the original currency","isRequired":true,"uniqueKey":"oneOf.2.originalAmount","typeLabel":"number"},"declineReason":{"type":"object","properties":{"code":{"type":"string","enum":["INSUFFICIENT_BALANCE","INSUFFICIENT_MASTER_BALANCE","CARD_NOT_ACTIVE","CARD_NOT_ACTIVATED","CARD_EXPIRED","CARD_FROZEN","CARD_BLOCKED","CARD_REPORTED_LOST","CARD_REPORTED_STOLEN","ACCOUNT_NOT_ACTIVE","INCORRECT_PIN","INCORRECT_CVV","INVALID_CARD_DETAILS","CONTACTLESS_NOT_SUPPORTED","TERMINAL_ERROR","CASH_SERVICE_NOT_AVAILABLE","WITHDRAWALS_NOT_ALLOWED","ATM_WITHDRAWAL_LIMIT_EXCEEDED","ATM_WITHDRAWAL_FREQUENCY_EXCEEDED","MERCHANT_CARD_TYPE_MISMATCH","MERCHANT_CATEGORY_CODE_NOT_ALLOWED","TRANSACTION_TYPE_NOT_ALLOWED","MERCHANT_NOT_ALLOWED","CHANNEL_NOT_ALLOWED","TRANSACTION_AMOUNT_LIMIT_EXCEEDED","SPEND_LIMIT_EXCEEDED","AUTHORIZATION_COUNT_LIMIT_EXCEEDED","TRANSACTION_NOT_ALLOWED","AUTHORIZATION_ENDPOINT_TIMEOUT","AUTHORIZATION_ENDPOINT_ERROR","NETWORK_DECLINE","SUSPECTED_FRAUD","INTERNAL_ERROR"],"description":"Machine-readable decline reason code. Intended for client application logic and monitoring (routing the cardholder to a top-up screen, prompting for PIN re-entry, alerting on your own authorization endpoint failures, ...). Do not display this string, or a label derived from it, to cardholders: some codes describe your own systems. Use `message` instead, or render your own copy keyed off `code`.","example":"INSUFFICIENT_BALANCE","isRequired":true,"uniqueKey":"oneOf.2.declineReason.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Cardholder-facing description of the decline reason, and the only field here meant for end users. Safe to render directly in your UI as a sensible default.","isRequired":true,"uniqueKey":"oneOf.2.declineReason.message","typeLabel":"string"}},"required":["code","message"],"description":"Reason the transaction was declined","isRequired":true,"uniqueKey":"oneOf.2.declineReason","typeLabel":"object"},"policy":{"oneOf":[{"type":"object","title":"DeclinedPolicy","description":"The policy that caused the decline, or null if the transaction was declined for another reason (e.g. insufficient funds).","required":["id","type","scopeType","name"],"properties":{"id":{"type":"string","description":"ID of the policy that declined the transaction. A UUID for your policies; a stable identifier for platform policies.","isRequired":true,"uniqueKey":"oneOf.2.policy.oneOf.0.id","typeLabel":"string"},"type":{"type":"string","enum":["MERCHANT_RESTRICTION","CHANNEL_RESTRICTION","TRANSACTION_AMOUNT_LIMIT","SPEND_LIMIT","AUTHORIZATION_COUNT_LIMIT"],"example":"MERCHANT_RESTRICTION","isRequired":true,"uniqueKey":"oneOf.2.policy.oneOf.0.type","typeLabel":"enum\u003cstring>"},"scopeType":{"type":"string","enum":["PROJECT","USER","CARD"],"description":"The level the policy was attached to.","example":"PROJECT","isRequired":true,"uniqueKey":"oneOf.2.policy.oneOf.0.scopeType","typeLabel":"enum\u003cstring>"},"name":{"type":"string","minLength":1,"maxLength":128,"description":"Human-readable label.","isRequired":true,"uniqueKey":"oneOf.2.policy.oneOf.0.name","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.2.policy.oneOf.0","typeLabel":"DeclinedPolicy · object"},{"type":"null","description":"The policy that caused the decline, or null if the transaction was declined for another reason (e.g. insufficient funds).","isRequired":true,"uniqueKey":"oneOf.2.policy.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.policy","typeLabel":"DeclinedPolicy · object | null"}},"uniqueKey":"oneOf.2","typeLabel":"Declined · object"},{"type":"object","title":"Void","description":"Fully reversed authorization or zero-amount verification","required":["id","accountId","cardId","channel","digitalWallet","originalCurrency","currency","merchant","fees","events","occurredAt","createdAt","updatedAt","status","originalAmount","amount"],"properties":{"id":{"type":"string","format":"uuid","description":"Card transaction identifier","isRequired":true,"uniqueKey":"oneOf.3.id","typeLabel":"string\u003cuuid>"},"accountId":{"type":"string","format":"uuid","description":"Account linked to the card","isRequired":true,"uniqueKey":"oneOf.3.accountId","typeLabel":"string\u003cuuid>"},"cardId":{"type":"string","format":"uuid","description":"Card used for this transaction","isRequired":true,"uniqueKey":"oneOf.3.cardId","typeLabel":"string\u003cuuid>"},"channel":{"type":"string","enum":["ATM","POS","ECOMMERCE","VISA_DIRECT"],"description":"Transaction channel","example":"ATM","isRequired":true,"uniqueKey":"oneOf.3.channel","typeLabel":"enum\u003cstring>"},"digitalWallet":{"oneOf":[{"type":"string","description":"Digital wallet used, or null if physical card","enum":["APPLE_PAY","GOOGLE_PAY","MERCHANT_TOKEN"],"example":"APPLE_PAY","isRequired":true,"uniqueKey":"oneOf.3.digitalWallet.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Digital wallet used, or null if physical card","isRequired":true,"uniqueKey":"oneOf.3.digitalWallet.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.3.digitalWallet","typeLabel":"enum\u003cstring> | null"},"originalCurrency":{"type":"string","examples":["USD","HKD","EUR"],"description":"Original transaction currency (merchant local currency)","isRequired":true,"uniqueKey":"oneOf.3.originalCurrency","typeLabel":"string"},"currency":{"type":"string","examples":["USD","HKD","EUR"],"description":"Card currency","isRequired":true,"uniqueKey":"oneOf.3.currency","typeLabel":"string"},"merchant":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Identifier of the merchant details recorded on this transaction. Not a stable merchant identifier: the same merchant has a different `id` on each transaction, so do not use it to identify or group merchants. Use `cardAcceptorId` instead.","isRequired":true,"uniqueKey":"oneOf.3.merchant.id","typeLabel":"string\u003cuuid>"},"cardAcceptorId":{"oneOf":[{"type":"string","description":"Card acceptor ID (often called the merchant ID or MID), assigned by the merchant's acquirer and passed on by the card network. It is unique only within one acquirer, and one merchant can have several (for example one per terminal). Combine it with `name`, `country`, and `mccCode` when matching merchants. `null` when the network did not provide one.","example":"000123456789012","isRequired":true,"uniqueKey":"oneOf.3.merchant.cardAcceptorId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Card acceptor ID (often called the merchant ID or MID), assigned by the merchant's acquirer and passed on by the card network. It is unique only within one acquirer, and one merchant can have several (for example one per terminal). Combine it with `name`, `country`, and `mccCode` when matching merchants. `null` when the network did not provide one.","example":"000123456789012","isRequired":true,"uniqueKey":"oneOf.3.merchant.cardAcceptorId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.3.merchant.cardAcceptorId","typeLabel":"string | null"},"name":{"type":"string","description":"Merchant name","isRequired":true,"uniqueKey":"oneOf.3.merchant.name","typeLabel":"string"},"city":{"oneOf":[{"type":"string","description":"Merchant city","isRequired":true,"uniqueKey":"oneOf.3.merchant.city.oneOf.0","typeLabel":"string"},{"type":"null","description":"Merchant city","isRequired":true,"uniqueKey":"oneOf.3.merchant.city.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.3.merchant.city","typeLabel":"string | null"},"postCode":{"oneOf":[{"type":"string","description":"Merchant postal or ZIP code","isRequired":true,"uniqueKey":"oneOf.3.merchant.postCode.oneOf.0","typeLabel":"string"},{"type":"null","description":"Merchant postal or ZIP code","isRequired":true,"uniqueKey":"oneOf.3.merchant.postCode.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.3.merchant.postCode","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","description":"Merchant state or province","isRequired":true,"uniqueKey":"oneOf.3.merchant.state.oneOf.0","typeLabel":"string"},{"type":"null","description":"Merchant state or province","isRequired":true,"uniqueKey":"oneOf.3.merchant.state.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.3.merchant.state","typeLabel":"string | null"},"mccCode":{"type":"string","examples":["5411","5812"],"description":"Merchant Category Code","isRequired":true,"uniqueKey":"oneOf.3.merchant.mccCode","typeLabel":"string"},"mccCategory":{"type":"string","examples":["Grocery Stores","Eating Places \u0026 Restaurants"],"description":"MCC category description","isRequired":true,"uniqueKey":"oneOf.3.merchant.mccCategory","typeLabel":"string"},"country":{"type":"string","minLength":2,"maxLength":2,"examples":["US","GB","DE"],"description":"ISO 3166-1 alpha-2 country code","uniqueKey":"oneOf.3.merchant.country","typeLabel":"string"}},"required":["id","cardAcceptorId","name","city","postCode","state","mccCode","mccCategory"],"description":"Merchant details","isRequired":true,"uniqueKey":"oneOf.3.merchant","typeLabel":"object"},"fees":{"type":"object","properties":{"atm":{"type":"number","minimum":0,"examples":[100.5,0,1234.99],"description":"ATM withdrawal markup charged to the cardholder (card currency)","isRequired":true,"uniqueKey":"oneOf.3.fees.atm","typeLabel":"number"},"fx":{"type":"number","minimum":0,"examples":[100.5,0,1234.99],"description":"FX markup charged to the cardholder (card currency)","isRequired":true,"uniqueKey":"oneOf.3.fees.fx","typeLabel":"number"}},"required":["atm","fx"],"description":"Net cardholder fees in the card currency (same aggregation legs as cardholder amount for PENDING/VOID/CLEARED; decline-event fees for DECLINED)","isRequired":true,"uniqueKey":"oneOf.3.fees","typeLabel":"object"},"events":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Event identifier","isRequired":true,"uniqueKey":"oneOf.3.events.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","enum":["AUTHORIZATION","CLEARING","REVERSAL","REFUND","DECLINE","DISPUTE_REFUND"],"description":"Lifecycle event type. DISPUTE_REFUND is the credit from a card dispute resolved in favor of the cardholder; like REFUND it gives cleared value back to the cardholder.","example":"AUTHORIZATION","isRequired":true,"uniqueKey":"oneOf.3.events.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"originalAmount":{"type":"number","minimum":0,"examples":[100.5,0,1234.99],"description":"Event amount in the event-level original currency","isRequired":true,"uniqueKey":"oneOf.3.events.items.[INDEX].originalAmount","typeLabel":"number"},"originalCurrency":{"type":"string","examples":["USD","HKD","EUR"],"description":"Per-event original currency. Usually equals the parent transaction `originalCurrency`, but can differ when the card network reports a presentment (typically a clearing) in the bill currency instead of the merchant local currency.","isRequired":true,"uniqueKey":"oneOf.3.events.items.[INDEX].originalCurrency","typeLabel":"string"},"amount":{"type":"number","minimum":0,"examples":[100.5,0,1234.99],"description":"Event amount charged to the cardholder (card currency)","isRequired":true,"uniqueKey":"oneOf.3.events.items.[INDEX].amount","typeLabel":"number"},"fees":{"type":"object","properties":{"atm":{"type":"number","minimum":0,"examples":[100.5,0,1234.99],"description":"ATM withdrawal markup charged to the cardholder (card currency)","isRequired":true,"uniqueKey":"oneOf.3.events.items.[INDEX].fees.atm","typeLabel":"number"},"fx":{"type":"number","minimum":0,"examples":[100.5,0,1234.99],"description":"FX markup charged to the cardholder (card currency)","isRequired":true,"uniqueKey":"oneOf.3.events.items.[INDEX].fees.fx","typeLabel":"number"}},"required":["atm","fx"],"description":"Cardholder fees charged on this event (card currency)","isRequired":true,"uniqueKey":"oneOf.3.events.items.[INDEX].fees","typeLabel":"object"},"occurredAt":{"type":"string","examples":["2024-01-15T10:30:00Z"],"description":"ISO 8601 timestamp of when the event occurred","isRequired":true,"uniqueKey":"oneOf.3.events.items.[INDEX].occurredAt","typeLabel":"string"},"createdAt":{"type":"string","examples":["2024-01-15T10:30:05Z"],"description":"ISO 8601 timestamp of when the event was recorded","isRequired":true,"uniqueKey":"oneOf.3.events.items.[INDEX].createdAt","typeLabel":"string"}},"required":["id","type","originalAmount","originalCurrency","amount","fees","occurredAt","createdAt"],"description":"A single lifecycle event on the transaction","uniqueKey":"oneOf.3.events.items.[INDEX]","typeLabel":"object"},"description":"Chronologically sorted lifecycle events (oldest first). Provides the full audit trail of what happened to this transaction.","isRequired":true,"uniqueKey":"oneOf.3.events","typeLabel":"object[]"},"occurredAt":{"type":"string","examples":["2024-01-15T10:30:00Z"],"description":"ISO 8601 timestamp of when the transaction was initiated","isRequired":true,"uniqueKey":"oneOf.3.occurredAt","typeLabel":"string"},"createdAt":{"type":"string","examples":["2024-01-15T10:30:00Z"],"description":"ISO 8601 timestamp of creation","isRequired":true,"uniqueKey":"oneOf.3.createdAt","typeLabel":"string"},"updatedAt":{"type":"string","examples":["2024-01-15T10:35:00Z"],"description":"ISO 8601 timestamp of last update","isRequired":true,"uniqueKey":"oneOf.3.updatedAt","typeLabel":"string"},"status":{"type":"string","const":"VOID","isRequired":true,"uniqueKey":"oneOf.3.status","typeLabel":"string"},"originalAmount":{"type":"object","properties":{"authorized":{"type":"number","minimum":0,"examples":[100.5,0,1234.99],"description":"Original authorized amount before reversals","isRequired":true,"uniqueKey":"oneOf.3.originalAmount.authorized","typeLabel":"number"},"reversed":{"type":"number","minimum":0,"examples":[100.5,0,1234.99],"description":"Total amount reversed (credited back)","isRequired":true,"uniqueKey":"oneOf.3.originalAmount.reversed","typeLabel":"number"},"current":{"type":"number","minimum":0,"examples":[100.5,0,1234.99],"description":"Effective current amount (authorized - reversed, minimum 0)","isRequired":true,"uniqueKey":"oneOf.3.originalAmount.current","typeLabel":"number"}},"required":["authorized","reversed","current"],"description":"Amount in the original transaction currency","isRequired":true,"uniqueKey":"oneOf.3.originalAmount","typeLabel":"object"},"amount":{"type":"object","properties":{"authorized":{"type":"number","minimum":0,"examples":[100.5,0,1234.99],"description":"Original authorized amount before reversals","isRequired":true,"uniqueKey":"oneOf.3.amount.authorized","typeLabel":"number"},"reversed":{"type":"number","minimum":0,"examples":[100.5,0,1234.99],"description":"Total amount reversed (credited back)","isRequired":true,"uniqueKey":"oneOf.3.amount.reversed","typeLabel":"number"},"current":{"type":"number","minimum":0,"examples":[100.5,0,1234.99],"description":"Effective current amount (authorized - reversed, minimum 0)","isRequired":true,"uniqueKey":"oneOf.3.amount.current","typeLabel":"number"}},"required":["authorized","reversed","current"],"description":"Amount charged to the cardholder","isRequired":true,"uniqueKey":"oneOf.3.amount","typeLabel":"object"}},"uniqueKey":"oneOf.3","typeLabel":"Void · object"}],"uniqueKey":"","typeLabel":"Pending · object | Cleared · object | Declined · object | Void · object"},"examples":{"Example":{"title":"Example","value":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","accountId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","cardId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","channel":"ATM","digitalWallet":"APPLE_PAY","originalCurrency":"USD","currency":"USD","merchant":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","cardAcceptorId":"000123456789012","name":"\u003cstring>","city":"\u003cstring>","postCode":"\u003cstring>","state":"\u003cstring>","mccCode":"5411","mccCategory":"Grocery Stores","country":"US"},"fees":{"atm":100.5,"fx":100.5},"events":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","type":"AUTHORIZATION","originalAmount":100.5,"originalCurrency":"USD","amount":100.5,"fees":{"atm":100.5,"fx":100.5},"occurredAt":"2024-01-15T10:30:00Z","createdAt":"2024-01-15T10:30:05Z"}],"occurredAt":"2024-01-15T10:30:00Z","createdAt":"2024-01-15T10:30:00Z","updatedAt":"2024-01-15T10:35:00Z","status":"PENDING","originalAmount":{"authorized":100.5,"reversed":100.5,"current":100.5},"amount":{"authorized":100.5,"reversed":100.5,"current":100.5},"conversionRate":1}}},"exampleType":"generated"}},"exampleType":"generated"},"45fc64d5-37fd-4754-a416-d16c0e845935":{"description":"The resource is not in a valid state for the requested simulation","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","const":"SIMULATION_INVALID_STATE","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"detail":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"error.detail.oneOf.0.additionalProperties","typeLabel":"any"},"isRequired":true,"uniqueKey":"error.detail.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"error.detail.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.detail","typeLabel":"object | null"}},"required":["code","message","detail"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"title":"SimulationInvalidStateError","uniqueKey":"","typeLabel":"SimulationInvalidStateError · object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"SIMULATION_INVALID_STATE","message":"\u003cstring>","detail":{}}}}},"exampleType":"generated"}},"exampleType":"generated"},"5a3d1cb7-bacd-4fc9-9de4-679392e6a148":{"description":"Response for status 404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"CardNotFoundError","description":"Card not found","required":["error"],"properties":{"error":{"type":"object","properties":{"code":{"type":"string","const":"CARD_NOT_FOUND","isRequired":true,"uniqueKey":"oneOf.0.error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.error.message","typeLabel":"string"},"detail":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"oneOf.0.error.detail.oneOf.0.additionalProperties","typeLabel":"any"},"isRequired":true,"uniqueKey":"oneOf.0.error.detail.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.0.error.detail.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.error.detail","typeLabel":"object | null"}},"required":["code","message","detail"],"isRequired":true,"uniqueKey":"oneOf.0.error","typeLabel":"object"}},"uniqueKey":"oneOf.0","typeLabel":"CardNotFoundError · object"},{"type":"object","title":"CardTransactionNotFoundError","description":"Card transaction not found","required":["error"],"properties":{"error":{"type":"object","properties":{"code":{"type":"string","const":"CARD_TRANSACTION_NOT_FOUND","isRequired":true,"uniqueKey":"oneOf.1.error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.error.message","typeLabel":"string"},"detail":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"oneOf.1.error.detail.oneOf.0.additionalProperties","typeLabel":"any"},"isRequired":true,"uniqueKey":"oneOf.1.error.detail.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.1.error.detail.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.error.detail","typeLabel":"object | null"}},"required":["code","message","detail"],"isRequired":true,"uniqueKey":"oneOf.1.error","typeLabel":"object"}},"uniqueKey":"oneOf.1","typeLabel":"CardTransactionNotFoundError · object"}],"uniqueKey":"","typeLabel":"CardNotFoundError · object | CardTransactionNotFoundError · object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"CARD_NOT_FOUND","message":"\u003cstring>","detail":{}}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"1e2abbe2-328b-4f9a-81e0-3d484135037d":{"bearerAuth":{"type":"http","scheme":"bearer","description":"API key as Bearer token","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"de1a2c94-1c62-4954-82a1-16d935609404":{"url":"https://sg.sandbox.api.reap.global","description":"Singapore sandbox"},"3bed5113-8ee4-45fa-9f6a-c24f2baf8936":{"url":"https://sg.prod.api.reap.global","description":"Singapore production"},"25066b55-4bc2-46fc-b59f-c8ae060716ba":{"url":"https://mx.sandbox.api.reap.global","description":"Mexico sandbox"},"89b90589-79b1-4461-a44b-a3f71d01e416":{"url":"https://mx.prod.api.reap.global","description":"Mexico production"},"3c3a387d-ae3e-40c9-bca5-b6c9c6ace569":{"url":"https://sandbox.api.reap.global","description":"Singapore sandbox (alias)"},"b73a3c12-6d12-4183-bc68-cb87abc91e48":{"url":"https://prod.api.reap.global","description":"Singapore production (alias)"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"API key as Bearer token","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"API key as Bearer token","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"reap-e846d803","siteName":"Reap API","title":"Simulate reversal - Reap API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-26T18:10:54.535Z","originalFileLocation":"api-reference/simulation/simulate-reversal.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=\"dark\";if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"dark\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Simulates a reversal (partial or full) of an existing PENDING authorization. A full reversal transitions the transaction to VOID.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Reap API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/reap-e846d803/pZr3r14v7CymLz6W/_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/reap-e846d803/pZr3r14v7CymLz6W/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/reap-e846d803/pZr3r14v7CymLz6W/_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/reap-e846d803/pZr3r14v7CymLz6W/_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/reap-e846d803/pZr3r14v7CymLz6W/_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/reap-e846d803/pZr3r14v7CymLz6W/_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/reap-e846d803/pZr3r14v7CymLz6W/_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/reap-e846d803/pZr3r14v7CymLz6W/_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/reap-e846d803/pZr3r14v7CymLz6W/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Simulate reversal - Reap API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Simulates a reversal (partial or full) of an existing PENDING authorization. A full reversal transitions the transaction to VOID.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Reap API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.reap.global/api-reference/simulation/simulate-reversal\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://reap-e846d803.mintlify.app/_mintlify/api/og/v2?division=Simulation\u0026amp;title=Simulate+reversal\u0026amp;description=Simulates+a+reversal+%28partial+or+full%29+of+an+existing+%60PENDING%60+authorization.+A+full+reversal+transitions+the+transaction+to+%60VOID%60.\u0026amp;theme=c390aa48001d23c6cc1c1df8\u0026amp;signature=765215956e67887b43f371f39944d8cf4adc074224614015a29ea7379c7f309a\">\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=\"Simulate reversal - Reap API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Simulates a reversal (partial or full) of an existing PENDING authorization. A full reversal transitions the transaction to VOID.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://reap-e846d803.mintlify.app/_mintlify/api/og/v2?division=Simulation\u0026amp;title=Simulate+reversal\u0026amp;description=Simulates+a+reversal+%28partial+or+full%29+of+an+existing+%60PENDING%60+authorization.+A+full+reversal+transitions+the+transaction+to+%60VOID%60.\u0026amp;theme=c390aa48001d23c6cc1c1df8\u0026amp;signature=765215956e67887b43f371f39944d8cf4adc074224614015a29ea7379c7f309a\">\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/reap-e846d803/pZr3r14v7CymLz6W/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Reap API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#71F7EC\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.reap.global/api-reference/simulation/simulate-reversal\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/simulation/simulate-reversal.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.reap.global/#organization\",\"name\":\"Reap API\",\"url\":\"https://docs.reap.global\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/reap-e846d803/qWb4Fwzl8MZcgNPH/images/logo.svg?fit=max\u0026auto=format\u0026n=qWb4Fwzl8MZcgNPH\u0026q=85\u0026s=3b6f4b8d92a46cdc1cbc12bbdab8f23f\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.reap.global#website\",\"name\":\"Reap API\",\"url\":\"https://docs.reap.global\",\"publisher\":{\"@id\":\"https://docs.reap.global/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.reap.global/api-reference/simulation/simulate-reversal#webpage\",\"url\":\"https://docs.reap.global/api-reference/simulation/simulate-reversal\",\"name\":\"Simulate reversal\",\"description\":\"Simulates a reversal (partial or full) of an existing PENDING authorization. A full reversal transitions the transaction to VOID.\",\"dateModified\":\"2026-10-26T18:10:54.535Z\",\"isPartOf\":{\"@id\":\"https://docs.reap.global#website\"},\"breadcrumb\":{\"@id\":\"https://docs.reap.global/api-reference/simulation/simulate-reversal#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.reap.global/api-reference/simulation/simulate-reversal#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Simulation\",\"item\":\"https://docs.reap.global/api-reference/simulation/simulate-user-application-status\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Simulate reversal\",\"item\":\"https://docs.reap.global/api-reference/simulation/simulate-reversal\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.reap.global/api-reference/simulation/simulate-reversal#apireference\",\"headline\":\"Simulate reversal\",\"name\":\"Simulate reversal\",\"description\":\"Simulates a reversal (partial or full) of an existing PENDING authorization. A full reversal transitions the transaction to VOID.\",\"url\":\"https://docs.reap.global/api-reference/simulation/simulate-reversal\",\"mainEntityOfPage\":{\"@id\":\"https://docs.reap.global/api-reference/simulation/simulate-reversal#webpage\"},\"dateModified\":\"2026-10-26T18:10:54.535Z\",\"publisher\":{\"@id\":\"https://docs.reap.global/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.reap.global#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Reap API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Reap API","nav":{"global":null,"tabs":[{"tab":"Documentation","icon":"book-2","pages":[{"title":"Documentation","href":""}]},{"tab":"API Reference","icon":"terminal-2","groups":[{"group":"Setup","pages":[{"title":"Overview","href":"/api-reference/overview"},{"title":"Authentication","href":"/api-reference/authentication"},{"title":"Scopes","href":"/api-reference/scopes"},{"title":"Versioning \u0026 Compatibility","href":"/api-reference/versioning"},{"title":"Errors","href":"/api-reference/errors"},{"title":"Rate Limiting","href":"/api-reference/rate-limiting"},{"title":"Idempotency","href":"/api-reference/idempotency"}]},{"group":"Users","pages":[{"title":"List users","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /users/","href":"/api-reference/users/list-users"},{"title":"Create user","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /users/","href":"/api-reference/users/create-user"},{"title":"Get user","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /users/{id}","href":"/api-reference/users/get-user"},{"title":"Delete user","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /users/{id}","href":"/api-reference/users/delete-user"},{"title":"Update user phone","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /users/{id}/phone","href":"/api-reference/users/update-user-phone"},{"title":"Update user email","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /users/{id}/email","href":"/api-reference/users/update-user-email"},{"title":"Advance the user application","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /users/{id}/application","href":"/api-reference/users/advance-the-user-application"},{"title":"Upload application documents","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /users/{id}/application/documents","href":"/api-reference/users/upload-application-documents"}]},{"group":"Companies","pages":[{"title":"List companies","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /companies/","href":"/api-reference/companies/list-companies"},{"title":"Create company","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /companies/","href":"/api-reference/companies/create-company"},{"title":"Get company","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /companies/{id}","href":"/api-reference/companies/get-company"},{"title":"List company applications","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /companies/{id}/applications/","href":"/api-reference/companies/list-company-applications"},{"title":"Advance company application","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /companies/{id}/applications/","href":"/api-reference/companies/advance-company-application"},{"title":"Upload application documents","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /companies/{id}/applications/documents","href":"/api-reference/companies/upload-application-documents"},{"title":"Submit company application","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /companies/{id}/applications/submit","href":"/api-reference/companies/submit-company-application"},{"title":"Get company application","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /companies/{id}/applications/{applicationId}","href":"/api-reference/companies/get-company-application"},{"title":"List related persons","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /companies/{id}/related-persons/","href":"/api-reference/companies/list-related-persons"},{"title":"Get related person","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /companies/{id}/related-persons/{personId}","href":"/api-reference/companies/get-related-person"},{"title":"Upload related person documents","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /companies/{id}/related-persons/{personId}/documents","href":"/api-reference/companies/upload-related-person-documents"},{"title":"List related person applications","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /companies/{id}/related-person-applications/","href":"/api-reference/companies/list-related-person-applications"},{"title":"Get related person application","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /companies/{id}/related-person-applications/{applicationId}","href":"/api-reference/companies/get-related-person-application"}]},{"group":"Accounts","pages":[{"title":"List accounts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /accounts/","href":"/api-reference/accounts/list-accounts"},{"title":"Create account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /accounts/","href":"/api-reference/accounts/create-account"},{"title":"Generate signer message","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /accounts/auth-message","href":"/api-reference/accounts/generate-signer-message"},{"title":"Get account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /accounts/{id}","href":"/api-reference/accounts/get-account"},{"title":"Get account balance","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /accounts/{id}/balance","href":"/api-reference/accounts/get-account-balance"},{"title":"Get account assets","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /accounts/{id}/assets","href":"/api-reference/accounts/get-account-assets"}]},{"group":"Virtual Asset Postings","pages":[{"title":"Create posting","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /postings/","href":"/api-reference/virtual-asset-postings/create-posting"},{"title":"Get posting","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /postings/{postingId}","href":"/api-reference/virtual-asset-postings/get-posting"}]},{"group":"Cards","pages":[{"title":"List cards","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /cards/","href":"/api-reference/cards/list-cards"},{"title":"Create card","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /cards/","href":"/api-reference/cards/create-card"},{"title":"Get card","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /cards/{id}","href":"/api-reference/cards/get-card"},{"title":"Delete card","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /cards/{id}","href":"/api-reference/cards/delete-card"},{"title":"Update card PIN","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /cards/{id}/pin","href":"/api-reference/cards/update-card-pin"},{"title":"Freeze card","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /cards/{id}/freeze","href":"/api-reference/cards/freeze-card"},{"title":"Unfreeze card","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /cards/{id}/unfreeze","href":"/api-reference/cards/unfreeze-card"},{"title":"Block card","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /cards/{id}/block","href":"/api-reference/cards/block-card"},{"title":"Unblock card","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /cards/{id}/unblock","href":"/api-reference/cards/unblock-card"},{"title":"Reveal card details","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /cards/{id}/reveal","href":"/api-reference/cards/reveal-card-details"},{"title":"Reveal PAN","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /cards/{id}/reveal-pan","href":"/api-reference/cards/reveal-pan"},{"title":"Update 3DS challenge method","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /cards/{id}/3ds-challenge-method","href":"/api-reference/cards/update-3ds-challenge-method"},{"title":"Activate physical card","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /cards/{id}/activate","href":"/api-reference/cards/activate-physical-card"},{"title":"Get activation code","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /cards/{id}/activation-code","href":"/api-reference/cards/get-activation-code"},{"title":"Push-provision card","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /cards/{id}/push-provisioning","href":"/api-reference/cards/push-provision-card"},{"title":"Respond to 3DS challenge","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /card-3ds-challenges/{challengeId}/respond","href":"/api-reference/cards/respond-to-3ds-challenge"},{"title":"Get 3DS challenge","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /card-3ds-challenges/{challengeId}","href":"/api-reference/cards/get-3ds-challenge"}]},{"group":"Card Shipments","pages":[{"title":"List shipments","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /card-shipments/","href":"/api-reference/card-shipments/list-shipments"},{"title":"Create shipment draft","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /card-shipments/","href":"/api-reference/card-shipments/create-shipment-draft"},{"title":"Get shipment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /card-shipments/{id}","href":"/api-reference/card-shipments/get-shipment"},{"title":"Delete shipment draft","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /card-shipments/{id}","href":"/api-reference/card-shipments/delete-shipment-draft"},{"title":"Update shipping details","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /card-shipments/{id}","href":"/api-reference/card-shipments/update-shipping-details"},{"title":"Add card to draft","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /card-shipments/{id}/cards","href":"/api-reference/card-shipments/add-card-to-draft"},{"title":"Remove card from draft","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /card-shipments/{id}/cards/{memberId}","href":"/api-reference/card-shipments/remove-card-from-draft"},{"title":"Submit shipment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /card-shipments/{id}/submit","href":"/api-reference/card-shipments/submit-shipment"}]},{"group":"Card Designs","pages":[{"title":"List card designs","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /card-designs/","href":"/api-reference/card-designs/list-card-designs"},{"title":"Set default card design","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /card-designs/default","href":"/api-reference/card-designs/set-default-card-design"},{"title":"Get card design","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /card-designs/{id}","href":"/api-reference/card-designs/get-card-design"}]},{"group":"Crypto Deposits","pages":[{"title":"Get crypto deposit","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /crypto-deposits/{id}","href":"/api-reference/crypto-deposits/get-crypto-deposit"}]},{"group":"Crypto Withdrawals","pages":[{"title":"Initiate crypto withdrawal","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /crypto-withdrawals/","href":"/api-reference/crypto-withdrawals/initiate-crypto-withdrawal"},{"title":"Get crypto withdrawal","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /crypto-withdrawals/{id}","href":"/api-reference/crypto-withdrawals/get-crypto-withdrawal"},{"title":"Mint signing payload","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /crypto-withdrawals/{id}/payload","href":"/api-reference/crypto-withdrawals/mint-signing-payload"},{"title":"Submit withdrawal signature","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /crypto-withdrawals/{id}/sign","href":"/api-reference/crypto-withdrawals/submit-withdrawal-signature"},{"title":"Cancel crypto withdrawal","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /crypto-withdrawals/{id}/cancel","href":"/api-reference/crypto-withdrawals/cancel-crypto-withdrawal"}]},{"group":"Fiat Deposits","pages":[{"title":"Get bank details","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /fiat-deposits/bank-details","href":"/api-reference/fiat-deposits/get-bank-details"},{"title":"Get fiat deposit","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /fiat-deposits/{id}","href":"/api-reference/fiat-deposits/get-fiat-deposit"}]},{"group":"Statements","pages":[{"title":"List statements","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /statements/","href":"/api-reference/statements/list-statements"},{"title":"Request statement","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /statements/","href":"/api-reference/statements/request-statement"},{"title":"Get statement","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /statements/{id}","href":"/api-reference/statements/get-statement"},{"title":"Download statement","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /statements/{id}/download","href":"/api-reference/statements/download-statement"}]},{"group":"Card Transactions","pages":[{"title":"Get card transaction","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /card-transactions/{id}","href":"/api-reference/card-transactions/get-card-transaction"}]},{"group":"Fraud Alerts","pages":[{"title":"List alerts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /fraud-alerts/","href":"/api-reference/fraud-alerts/list-alerts"},{"title":"Report fraud","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /fraud-alerts/","href":"/api-reference/fraud-alerts/report-fraud"},{"title":"Get alert","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /fraud-alerts/{id}","href":"/api-reference/fraud-alerts/get-alert"},{"title":"Respond to alert","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /fraud-alerts/{id}/respond","href":"/api-reference/fraud-alerts/respond-to-alert"}]},{"group":"Disputes","pages":[{"title":"List disputes","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /disputes/","href":"/api-reference/disputes/list-disputes"},{"title":"File dispute","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /disputes/","href":"/api-reference/disputes/file-dispute"},{"title":"Get dispute","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /disputes/{id}","href":"/api-reference/disputes/get-dispute"}]},{"group":"Activities","pages":[{"title":"List activities","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /activities/","href":"/api-reference/activities/list-activities"}]},{"group":"Policies","pages":[{"title":"List policies","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /policies/","href":"/api-reference/policies/list-policies"},{"title":"Create policy","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /policies/","href":"/api-reference/policies/create-policy"},{"title":"List effective policies","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /policies/effective","href":"/api-reference/policies/list-effective-policies"},{"title":"Get policy","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /policies/{id}","href":"/api-reference/policies/get-policy"},{"title":"Rename policy","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /policies/{id}","href":"/api-reference/policies/rename-policy"},{"title":"Replace policy configuration","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /policies/{id}/config","href":"/api-reference/policies/replace-policy-configuration"},{"title":"Enable policy","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /policies/{id}/enable","href":"/api-reference/policies/enable-policy"},{"title":"Disable policy","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /policies/{id}/disable","href":"/api-reference/policies/disable-policy"}]},{"group":"Fees","pages":[{"title":"List fees","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /fees/","href":"/api-reference/fees/list-fees"},{"title":"Create fee override","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /fees/","href":"/api-reference/fees/create-fee-override"},{"title":"List effective fees","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /fees/effective","href":"/api-reference/fees/list-effective-fees"},{"title":"Get fee","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /fees/{id}","href":"/api-reference/fees/get-fee"},{"title":"Update fee value","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /fees/{id}","href":"/api-reference/fees/update-fee-value"},{"title":"Delete fee override","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /fees/{id}","href":"/api-reference/fees/delete-fee-override"}]},{"group":"Simulation","pages":[{"title":"Simulate user application status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /simulation/users/{userId}/application","href":"/api-reference/simulation/simulate-user-application-status"},{"title":"Simulate company status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /simulation/companies/{companyId}/status","href":"/api-reference/simulation/simulate-company-status"},{"title":"Reset company application","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /simulation/companies/{companyId}/reset","href":"/api-reference/simulation/reset-company-application"},{"title":"Simulate account status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /simulation/accounts/{id}/status","href":"/api-reference/simulation/simulate-account-status"},{"title":"Simulate card status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /simulation/cards/{id}/status","href":"/api-reference/simulation/simulate-card-status"},{"title":"Simulate shipment status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /simulation/card-shipments/{id}/status","href":"/api-reference/simulation/simulate-shipment-status"},{"title":"Simulate authorization","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /simulation/card-transactions/authorization","href":"/api-reference/simulation/simulate-authorization"},{"title":"Simulate 3DS authorization","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /simulation/card-transactions/authorization-with-3ds","href":"/api-reference/simulation/simulate-3ds-authorization"},{"title":"Simulate decline","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /simulation/card-transactions/decline","href":"/api-reference/simulation/simulate-decline"},{"title":"Simulate clearing","description":"Simulates a clearing (settlement) event. Pass `transactionId` to clear an existing authorization, or omit to simulate offline/direct clearing.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /simulation/card-transactions/clearing","href":"/api-reference/simulation/simulate-clearing"},{"title":"Simulate reversal","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /simulation/card-transactions/reversal","href":"/api-reference/simulation/simulate-reversal"},{"title":"Simulate refund","description":"Simulates a refund event. Pass `transactionId` to refund an existing `CLEARED` transaction, or omit to simulate a standalone refund with no matching purchase (e.g., tax refund).","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /simulation/card-transactions/refund","href":"/api-reference/simulation/simulate-refund"},{"title":"Simulate a fiat deposit","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /simulation/fiat-deposits","href":"/api-reference/simulation/simulate-a-fiat-deposit"}]},{"group":"Virtual Assets","pages":[{"title":"List virtual assets","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /virtual-assets/","href":"/api-reference/virtual-assets/list-virtual-assets"},{"title":"Create virtual asset","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /virtual-assets/","href":"/api-reference/virtual-assets/create-virtual-asset"},{"title":"Get virtual asset","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /virtual-assets/{id}","href":"/api-reference/virtual-assets/get-virtual-asset"},{"title":"Update virtual asset","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /virtual-assets/{id}","href":"/api-reference/virtual-assets/update-virtual-asset"},{"title":"Disable virtual asset","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /virtual-assets/{id}/disable","href":"/api-reference/virtual-assets/disable-virtual-asset"},{"title":"Set rate for virtual asset","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /virtual-assets/{id}/rate","href":"/api-reference/virtual-assets/set-rate-for-virtual-asset"}]},{"group":"Webhooks","pages":[{"title":"List webhook endpoints","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /webhooks/","href":"/api-reference/webhooks/list-webhook-endpoints"},{"title":"Create webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /webhooks/","href":"/api-reference/webhooks/create-webhook-endpoint"},{"title":"Get webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /webhooks/{id}","href":"/api-reference/webhooks/get-webhook-endpoint"},{"title":"Update webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /webhooks/{id}","href":"/api-reference/webhooks/update-webhook-endpoint"},{"title":"Rotate signing secret","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /webhooks/{id}/rotate-secret","href":"/api-reference/webhooks/rotate-signing-secret"},{"title":"Disable webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /webhooks/{id}/disable","href":"/api-reference/webhooks/disable-webhook-endpoint"}]},{"group":"Agentic","pages":[{"title":"List enrollments","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agentic/enrollments","href":"/api-reference/agentic/list-enrollments"},{"title":"Create enrollment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agentic/enrollments","href":"/api-reference/agentic/create-enrollment"},{"title":"Get enrollment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agentic/enrollments/{id}","href":"/api-reference/agentic/get-enrollment"},{"title":"Revoke enrollment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agentic/enrollments/{id}/revoke","href":"/api-reference/agentic/revoke-enrollment"},{"title":"Get mandate","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agentic/mandates/{id}","href":"/api-reference/agentic/get-mandate"},{"title":"Pause mandate","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agentic/mandates/{id}/pause","href":"/api-reference/agentic/pause-mandate"},{"title":"Resume mandate","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agentic/mandates/{id}/resume","href":"/api-reference/agentic/resume-mandate"},{"title":"Cancel mandate","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agentic/mandates/{id}/cancel","href":"/api-reference/agentic/cancel-mandate"},{"title":"Search products","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agentic/products/search","href":"/api-reference/agentic/search-products"},{"title":"Get product details","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agentic/products/details","href":"/api-reference/agentic/get-product-details"},{"title":"Resolve variant","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agentic/products/variant","href":"/api-reference/agentic/resolve-variant"},{"title":"Create quote","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agentic/quotes","href":"/api-reference/agentic/create-quote"},{"title":"Get quote","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agentic/quotes/{id}","href":"/api-reference/agentic/get-quote"},{"title":"Select shipping option","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agentic/quotes/{id}/shipping-option","href":"/api-reference/agentic/select-shipping-option"},{"title":"Create checkout","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agentic/checkouts","href":"/api-reference/agentic/create-checkout"},{"title":"Get checkout","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agentic/checkouts/{id}","href":"/api-reference/agentic/get-checkout"}]}]},{"tab":"Webhooks","icon":"bell","pages":[{"title":"Webhooks","href":"/webhooks/overview"}]},{"tab":"Changelog","icon":"history","pages":[{"title":"Changelog","href":"/changelog"}]}]},"title":"Simulate reversal - Reap API","buildId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","deploymentId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-rfhihCWU.js","utils-BmH1XFxk.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BcNsxPKB.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BAES3tkd.js","snippetPresets-DCMQBKLP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D6l_bzE9.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BOktbnNh.js","shallow-BCs8SgM7.js","getApiPlaygroundDisplay-DEmW5bJB.js","CodeSnippet-CpZOpB9C.js","CodeSnippets-BOBDqibl.js","Page-D5fEM6aW.js","getPastedJson-DH2JBvmr.js","icon-BBJH-kKh.js","MethodPill-D2Sd5NLC.js","DuplicateIcon-CGgfL2qN.js","createIcon-BKudBBzi.js","DynamicMarkdown-85clUA0i.js","SectionHeading-D0JiMgDx.js","axios-vUo_bRtp.js","Markdown-Cfiy0xZO.js","clsx-rL8ZCCw4.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-aeztFa9U.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BywkCr5C.js"]}