Cancels the transaction. For ucp_checkout, Sapiom cancels the merchant checkout first, then the card payment. For browser_checkout, Sapiom cancels the card payment and the placeholder stops working. Cancelling again does nothing. Returns 409 once it’s too late: card_relayed after your agent pays. It doesn’t refund an order. Requires a buyer key.
POST
/
v1
/
transactions
/
{transactionId}
/
cancel
Cancel a transaction
curl --request POST \ --url https://api.sapiom.ai/v1/transactions/{transactionId}/cancel \ --header 'x-api-key: <api-key>'
The next step in one vocabulary (type + actor: wait, buyer_security_code, approval, payment_ready, closed, …), always present for a purchase. For a transaction that buys nothing, only an approval or security-code step, absent when nobody needs to act. Links are derived at read time.
For a purchase: what is bought, from whom, for how much, and who said so (assertedBy: merchant for the merchant's own checkout answer, agent for the agent's unchecked statement). Read from durable records; absent for a transaction that buys nothing.
For a purchase: the merchant-confirmed order outcome (confirmed, not_confirmed, unknown). With confirmed, the merchant's confirmation from its completed answer, for the platform to show the cardholder: id, label (the order number the buyer sees), permalinkUrl (the order on the merchant's site) and links (its refund, shipping, terms, privacy and contact pages, { type, url, title? }), each null or empty when the merchant sent none. Null for a browser purchase, which has no order confirmation.
Agent information if transaction is associated with an agent
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Sapiom Pay","description":"Let your AI agent buy for each of your users with their own saved card. Sapiom vaults each user's card, authorizes every transaction against real checkout facts, and fills the card into checkout without your agent ever seeing it.","colors":{"primary":"#16A34A","light":"#07C983","dark":"#15803D"},"logo":{"light":"https://mintcdn.com/sapiom-1f975ca2/K4zW5IjQAMJutZvi/logo/light.svg?fit=max\u0026auto=format\u0026n=K4zW5IjQAMJutZvi\u0026q=85\u0026s=37d04ab53c9792ff376364fd56a2799e","dark":"https://mintcdn.com/sapiom-1f975ca2/K4zW5IjQAMJutZvi/logo/dark.svg?fit=max\u0026auto=format\u0026n=K4zW5IjQAMJutZvi\u0026q=85\u0026s=bee7a03b976b9be9e5944daf9ca380ba"},"favicon":"https://mintcdn.com/sapiom-1f975ca2/7k2CTIHfQZNyln5W/favicon.svg?fit=max\u0026auto=format\u0026n=7k2CTIHfQZNyln5W\u0026q=85\u0026s=ffac7db148c05d663b25d3e420b2a24d","api":{"playground":{"display":"simple"}},"navbar":{"primary":{"type":"button","label":"Request access","href":"/request-access"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"markdown":{"instructions":["Sapiom Pay is for platforms whose agent shops for many end users. Each end user is a buyer with their own Sapiom key and saved cards.","Use the buyer's key for every call made on that buyer's behalf. Never use one buyer's key for another user, and never give the agent the platform key.","Backends call the REST API at https://api.sapiom.ai/v1. Agents can also call the hosted MCP tools at https://api.sapiom.ai/v1/mcp/pay. Both take the key in an x-api-key header.","Keys that start with sk_test_ reach the sandbox, a separate test environment with its own buyers and cards, at the same addresses. Use test card numbers only there.","Never ask a buyer for a card number, expiry date or CVV in chat. Buyers enter card details only on Sapiom's hosted pages.","Check the merchant before buying. Use purchase.type ucp_checkout only when the merchant check returns supported. Otherwise use browser_checkout.","Follow the nextAction in each transaction result. Action links are secrets for the intended buyer only.","Use one idempotency key per transaction. Resume an unanswered create with the same request and key. If a UCP update or cancellation is uncertain, stop and hand off to a person. If a browser cancellation is uncertain, read the transaction and resend the same cancellation, with the same key, only if it is not closed. Never start a new transaction to escape an uncertain outcome.","For a ucp_checkout purchase, report an order as placed only when order.outcome is confirmed; if it is unknown, stop and hand off to a person. A browser_checkout purchase has no order confirmation (order is null): confirm the order on the merchant's page."]},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"sapiom-1f975ca2","hasAudioNarration":false,"actualSubdomain":"sapiom-1f975ca2","customDomains":["docs.sapiom.ai"],"gitSource":{"type":"github","owner":"sapiom","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af26bd6ee9917a20ed54bf3","clientVersion":"0.0.4094","searchFilterCounts":[{"language":"default","tag":"API reference","count":26},{"language":"default","tag":"REST API","count":22},{"language":"default","tag":"Docs","count":20},{"language":"default","tag":"Transactions","count":15},{"language":"default","tag":"Cards","count":8},{"language":"default","tag":"Buyers","count":7},{"language":"default","tag":"Get started","count":4},{"language":"default","tag":"Pay in the browser","count":4},{"language":"default","tag":"MCP and SDK","count":2},{"language":"default","tag":"Early access","count":2}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":true,"enableContextualStarterQuestions":true,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/transactions/cancel-a-transaction","slug":"/api-reference/transactions/cancel-a-transaction","pageMetadata":{"title":"Cancel a transaction","description":"Cancels the transaction. For `ucp_checkout`, Sapiom cancels the merchant checkout first, then the card payment. For `browser_checkout`, Sapiom cancels the card payment and the placeholder stops working. Cancelling again does nothing. Returns `409` once it's too late: `card_relayed` after your agent pays. It doesn't refund an order. Requires a [buyer key](/api-reference/overview#authentication).","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/transactions/{transactionId}/cancel","href":"/api-reference/transactions/cancel-a-transaction","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 a: \"a\",\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Cancels the transaction. For \", _jsx(_components.code, {\n children: \"ucp_checkout\"\n }), \", Sapiom cancels the merchant checkout first, then the card payment. For \", _jsx(_components.code, {\n children: \"browser_checkout\"\n }), \", Sapiom cancels the card payment and the placeholder stops working. Cancelling again does nothing. Returns \", _jsx(_components.code, {\n children: \"409\"\n }), \" once it’s too late: \", _jsx(_components.code, {\n children: \"card_relayed\"\n }), \" after your agent pays. It doesn’t refund an order. Requires a \", _jsx(_components.a, {\n href: \"/api-reference/overview#authentication\",\n children: \"buyer key\"\n }), \".\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Cancel a transaction","description":"Cancels the transaction. For `ucp_checkout`, Sapiom cancels the merchant checkout first, then the card payment. For `browser_checkout`, Sapiom cancels the card payment and the placeholder stops working. Cancelling again does nothing. Returns `409` once it's too late: `card_relayed` after your agent pays. It doesn't refund an order. Requires a [buyer key](/api-reference/overview#authentication).","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/transactions/{transactionId}/cancel","href":"/api-reference/transactions/cancel-a-transaction","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"Cancels the transaction. For `ucp_checkout`, Sapiom cancels the merchant checkout first, then the card payment. For `browser_checkout`, Sapiom cancels the card payment and the placeholder stops working. Cancelling again does nothing. Returns `409` once it's too late: `card_relayed` after your agent pays. It doesn't refund an order. Requires a [buyer key](/api-reference/overview#authentication).","operationId":"TransactionController_cancelPurchase","parameters":["9634f445-c1da-4da3-be1b-139cdf41fdf4","fb6dd890-4122-411e-a26a-5a5ba3752c25"],"responses":{"200":"698415c9-fd0f-4faf-9e57-670d183c6acc","404":"ba783406-dcdd-4239-90a7-59111e1e871b","409":"43fa073a-c5fe-4a75-b394-a1324d54ed65"},"security":["a0c1ddfe-f198-4306-a591-cea561bf78a8"],"summary":"Cancel a transaction","tags":["Transactions"],"method":"post","type":"path","servers":["96df3c0a-5b5d-4163-b956-f849b279a52f"],"path":"/v1/transactions/{transactionId}/cancel","baseUrlOptions":["https://api.sapiom.ai"],"title":"Cancel a transaction","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"9634f445-c1da-4da3-be1b-139cdf41fdf4":{"name":"transactionId","required":true,"in":"path","schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}},"fb6dd890-4122-411e-a26a-5a5ba3752c25":{"name":"Idempotency-Key","required":false,"in":"header","schema":{"type":"string","isRequired":false,"description":"Optional. Sapiom sends it with the merchant cancel. Reuse it when you retry.","uniqueKey":"","typeLabel":"string"},"description":"Optional. Sapiom sends it with the merchant cancel. Reuse it when you retry."}},"responses":{"698415c9-fd0f-4faf-9e57-670d183c6acc":{"description":"The cancelled transaction","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Transaction ID","example":"123e4567-e89b-12d3-a456-426614174000","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"tenantId":{"type":"string","description":"Organization ID","example":"123e4567-e89b-12d3-a456-426614174000","isRequired":true,"uniqueKey":"tenantId","typeLabel":"string"},"serviceName":{"type":"string","description":"Service identifier","example":"openai","isRequired":true,"uniqueKey":"serviceName","typeLabel":"string"},"actionName":{"type":"string","description":"Action being performed","example":"completion","isRequired":true,"uniqueKey":"actionName","typeLabel":"string"},"resourceName":{"type":"string","description":"Resource being accessed","example":"gpt-4","isRequired":true,"uniqueKey":"resourceName","typeLabel":"string"},"status":{"enum":["pending","preparing","waiting_approval","authorized","completed","denied","cancelled","needs_revision"],"type":"string","description":"Transaction status","example":"authorized","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"requiresPayment":{"type":"boolean","description":"Whether the transaction requires payment","example":true,"isRequired":true,"uniqueKey":"requiresPayment","typeLabel":"boolean"},"createdAt":{"format":"date-time","type":"string","description":"Creation timestamp","example":"2024-01-01T00:00:00.000Z","isRequired":true,"uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"format":"date-time","type":"string","description":"Last update timestamp","example":"2024-01-01T00:00:00.000Z","isRequired":true,"uniqueKey":"updatedAt","typeLabel":"string\u003cdate-time>"},"returnUrl":{"oneOf":[{"type":"string","description":"Integrator-provided return destination for hosted transaction steps","uniqueKey":"returnUrl.oneOf.0","typeLabel":"string"},{"type":"null","description":"Integrator-provided return destination for hosted transaction steps","uniqueKey":"returnUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"returnUrl","typeLabel":"string | null"},"nextAction":{"type":"object","description":"The next step in one vocabulary (`type` + `actor`: `wait`, `buyer_security_code`, `approval`, `payment_ready`, `closed`, …), always present for a purchase. For a transaction that buys nothing, only an approval or security-code step, absent when nobody needs to act. Links are derived at read time.","uniqueKey":"nextAction","typeLabel":"object"},"purchase":{"type":"object","description":"For a purchase: what is bought, from whom, for how much, and who said so (`assertedBy`: `merchant` for the merchant's own checkout answer, `agent` for the agent's unchecked statement). Read from durable records; absent for a transaction that buys nothing.","example":{"type":"ucp_checkout","assertedBy":"merchant","merchant":{"origin":"https://shop.example"},"total":{"amount":"19.99","currency":"USD"},"lineItems":[{"title":"Mug","itemId":"item_123","quantity":1,"unitAmount":"19.99"}],"revision":1},"uniqueKey":"purchase","typeLabel":"object"},"order":{"oneOf":[{"type":"object","description":"For a purchase: the merchant-confirmed order outcome (`confirmed`, `not_confirmed`, `unknown`). With `confirmed`, the merchant's confirmation from its completed answer, for the platform to show the cardholder: `id`, `label` (the order number the buyer sees), `permalinkUrl` (the order on the merchant's site) and `links` (its refund, shipping, terms, privacy and contact pages, `{ type, url, title? }`), each null or empty when the merchant sent none. Null for a browser purchase, which has no order confirmation.","example":{"outcome":"confirmed","id":"gid://shopify/Order/1","label":"#1008","permalinkUrl":"https://shop.example/orders/1","links":[{"type":"refund_policy","url":"https://shop.example/policies/refund-policy","title":"Refund policy"}]},"uniqueKey":"order.oneOf.0","typeLabel":"object"},{"type":"null","description":"For a purchase: the merchant-confirmed order outcome (`confirmed`, `not_confirmed`, `unknown`). With `confirmed`, the merchant's confirmation from its completed answer, for the platform to show the cardholder: `id`, `label` (the order number the buyer sees), `permalinkUrl` (the order on the merchant's site) and `links` (its refund, shipping, terms, privacy and contact pages, `{ type, url, title? }`), each null or empty when the merchant sent none. Null for a browser purchase, which has no order confirmation.","example":{"outcome":"confirmed","id":"gid://shopify/Order/1","label":"#1008","permalinkUrl":"https://shop.example/orders/1","links":[{"type":"refund_policy","url":"https://shop.example/policies/refund-policy","title":"Refund policy"}]},"uniqueKey":"order.oneOf.1","typeLabel":"null"}],"uniqueKey":"order","typeLabel":"object | null"},"version":{"type":"string","description":"For a purchase: changes whenever anything the caller acts on changes. Pass it back as `since` to wait for the next change.","uniqueKey":"version","typeLabel":"string"},"approvals":{"type":"object","description":"Approval obligations and linked successor attempts; inspect an approval for current authority","uniqueKey":"approvals","typeLabel":"object"},"serviceId":{"oneOf":[{"type":"string","description":"Service entity ID (foreign key reference)","example":"123e4567-e89b-12d3-a456-426614174000","uniqueKey":"serviceId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Service entity ID (foreign key reference)","example":"123e4567-e89b-12d3-a456-426614174000","uniqueKey":"serviceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"serviceId","typeLabel":"string | null"},"qualifiers":{"type":"object","description":"Additional qualifiers for the transaction","example":{"model":"gpt-4","tokens":1000},"uniqueKey":"qualifiers","typeLabel":"object"},"metadata":{"type":"object","description":"Additional metadata for the transaction","uniqueKey":"metadata","typeLabel":"object"},"authorizedAt":{"format":"date-time","type":"string","description":"Authorization timestamp","example":"2024-01-01T00:00:00.000Z","uniqueKey":"authorizedAt","typeLabel":"string\u003cdate-time>"},"completedAt":{"format":"date-time","type":"string","description":"Completion timestamp","example":"2024-01-01T00:00:00.000Z","uniqueKey":"completedAt","typeLabel":"string\u003cdate-time>"},"outcome":{"enum":["success","error"],"type":"string","description":"Transaction outcome (set when completed)","example":"success","uniqueKey":"outcome","typeLabel":"enum\u003cstring>"},"currentPaymentTransactionId":{"oneOf":[{"type":"string","description":"Current payment transaction ID if transaction requires payment","example":"123e4567-e89b-12d3-a456-426614174000","uniqueKey":"currentPaymentTransactionId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Current payment transaction ID if transaction requires payment","example":"123e4567-e89b-12d3-a456-426614174000","uniqueKey":"currentPaymentTransactionId.oneOf.1","typeLabel":"null"}],"uniqueKey":"currentPaymentTransactionId","typeLabel":"string | null"},"payment":{"type":"object","description":"Payment transaction details when transaction requires payment","required":["id","transactionId","fiatAmount","status","createdAt","updatedAt"],"properties":{"id":{"type":"string","description":"Payment transaction ID","example":"123e4567-e89b-12d3-a456-426614174000","isRequired":true,"uniqueKey":"payment.id","typeLabel":"string"},"transactionId":{"type":"string","description":"Transaction ID this payment belongs to","example":"123e4567-e89b-12d3-a456-426614174000","isRequired":true,"uniqueKey":"payment.transactionId","typeLabel":"string"},"fiatAmount":{"type":"string","description":"The payment amount in USD, as a decimal string.","isRequired":true,"uniqueKey":"payment.fiatAmount","typeLabel":"string"},"status":{"enum":["pending","preparing","authorized","settling","completed","failed","cancelled"],"type":"string","description":"Payment status","example":"authorized","isRequired":true,"uniqueKey":"payment.status","typeLabel":"enum\u003cstring>"},"createdAt":{"format":"date-time","type":"string","description":"Creation timestamp","example":"2024-01-01T00:00:00.000Z","isRequired":true,"uniqueKey":"payment.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"format":"date-time","type":"string","description":"Last update timestamp","example":"2024-01-01T00:00:00.000Z","isRequired":true,"uniqueKey":"payment.updatedAt","typeLabel":"string\u003cdate-time>"},"fundingSource":{"type":"string","description":"`external_card`: the buyer's saved card pays.","enum":["external_card"],"uniqueKey":"payment.fundingSource","typeLabel":"enum\u003cstring>"},"paymentCardId":{"oneOf":[{"type":"string","description":"The card paying a card-funded payment","format":"uuid","uniqueKey":"payment.paymentCardId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","description":"The card paying a card-funded payment","format":"uuid","uniqueKey":"payment.paymentCardId.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment.paymentCardId","typeLabel":"string\u003cuuid> | null"},"credentialRoute":{"oneOf":[{"type":"string","description":"`real_card_number`: the relay puts the real card into the merchant's payment request.","enum":["real_card_number"],"uniqueKey":"payment.credentialRoute.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"`real_card_number`: the relay puts the real card into the merchant's payment request.","enum":["real_card_number"],"uniqueKey":"payment.credentialRoute.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment.credentialRoute","typeLabel":"enum\u003cstring> | null"},"placeholder":{"type":"object","description":"An authorized card payment's placeholder card, while it can still be relayed. Submit it in the merchant's card form; the relay swaps it for the real credential once.","required":["number","expMonth","expYear","cvc","brand","expiresAt","injectionRef","transactionId"],"properties":{"number":{"type":"string","description":"Card number shaped like the real card's brand; not a real card","example":"4000123412341234","isRequired":true,"uniqueKey":"payment.placeholder.number","typeLabel":"string"},"expMonth":{"type":"number","example":7,"isRequired":true,"uniqueKey":"payment.placeholder.expMonth","typeLabel":"number"},"expYear":{"type":"number","example":2029,"isRequired":true,"uniqueKey":"payment.placeholder.expYear","typeLabel":"number"},"cvc":{"type":"string","example":"123","isRequired":true,"uniqueKey":"payment.placeholder.cvc","typeLabel":"string"},"brand":{"type":"string","example":"visa","isRequired":true,"uniqueKey":"payment.placeholder.brand","typeLabel":"string"},"expiresAt":{"type":"string","description":"After this the placeholder no longer relays","example":"2026-10-13T13:00:00.000Z","isRequired":true,"uniqueKey":"payment.placeholder.expiresAt","typeLabel":"string"},"injectionRef":{"type":"string","description":"The armed injection the relay looks the placeholder up by","isRequired":true,"uniqueKey":"payment.placeholder.injectionRef","typeLabel":"string"},"transactionId":{"type":"string","description":"The transaction the placeholder is relayed through","isRequired":true,"uniqueKey":"payment.placeholder.transactionId","typeLabel":"string"}},"uniqueKey":"payment.placeholder","typeLabel":"object"},"reason":{"oneOf":[{"type":"string","description":"Why the payment failed, when it is a public code: `sapiom_error` (a fault on Sapiom's side; report the transaction's requestId). Absent otherwise; a transaction's checkout `nextAction` says why it ended.","enum":["sapiom_error"],"example":"sapiom_error","uniqueKey":"payment.reason.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Why the payment failed, when it is a public code: `sapiom_error` (a fault on Sapiom's side; report the transaction's requestId). Absent otherwise; a transaction's checkout `nextAction` says why it ended.","enum":["sapiom_error"],"example":"sapiom_error","uniqueKey":"payment.reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment.reason","typeLabel":"enum\u003cstring> | null"},"authorizedAt":{"oneOf":[{"format":"date-time","type":"string","description":"Authorization timestamp","example":"2024-01-01T00:00:00.000Z","uniqueKey":"payment.authorizedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"format":"date-time","type":"null","description":"Authorization timestamp","example":"2024-01-01T00:00:00.000Z","uniqueKey":"payment.authorizedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment.authorizedAt","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"payment","typeLabel":"object"},"trace":{"type":"object","description":"Trace information for workflow grouping","required":["id"],"properties":{"id":{"type":"string","description":"Trace ID","example":"123e4567-e89b-12d3-a456-426614174000","isRequired":true,"uniqueKey":"trace.id","typeLabel":"string"},"externalId":{"oneOf":[{"type":"string","description":"Optional user-supplied external ID for trace correlation","example":"checkout-session-abc123","uniqueKey":"trace.externalId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional user-supplied external ID for trace correlation","example":"checkout-session-abc123","uniqueKey":"trace.externalId.oneOf.1","typeLabel":"null"}],"uniqueKey":"trace.externalId","typeLabel":"string | null"}},"uniqueKey":"trace","typeLabel":"object"},"agentId":{"oneOf":[{"type":"string","description":"Agent ID if transaction is associated with an agent","example":"123e4567-e89b-12d3-a456-426614174000","uniqueKey":"agentId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Agent ID if transaction is associated with an agent","example":"123e4567-e89b-12d3-a456-426614174000","uniqueKey":"agentId.oneOf.1","typeLabel":"null"}],"uniqueKey":"agentId","typeLabel":"string | null"},"agent":{"type":"object","description":"Agent information if transaction is associated with an agent","required":["id","tenantId","label","name","status","createdAt","updatedAt"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"agent.id","typeLabel":"string"},"tenantId":{"type":"string","isRequired":true,"uniqueKey":"agent.tenantId","typeLabel":"string"},"label":{"type":"string","isRequired":true,"uniqueKey":"agent.label","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"agent.name","typeLabel":"string"},"status":{"type":"string","isRequired":true,"uniqueKey":"agent.status","typeLabel":"string"},"createdAt":{"format":"date-time","type":"string","isRequired":true,"uniqueKey":"agent.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"format":"date-time","type":"string","isRequired":true,"uniqueKey":"agent.updatedAt","typeLabel":"string\u003cdate-time>"},"description":{"oneOf":[{"type":"string","uniqueKey":"agent.description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"agent.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"agent.description","typeLabel":"string | null"}},"uniqueKey":"agent","typeLabel":"object"}},"required":["id","tenantId","serviceName","actionName","resourceName","status","requiresPayment","createdAt","updatedAt"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"123e4567-e89b-12d3-a456-426614174000","tenantId":"123e4567-e89b-12d3-a456-426614174000","serviceName":"openai","actionName":"completion","resourceName":"gpt-4","status":"authorized","requiresPayment":true,"createdAt":"2024-01-01T00:00:00.000Z","updatedAt":"2024-01-01T00:00:00.000Z","returnUrl":"\u003cstring>","nextAction":{},"purchase":{"type":"ucp_checkout","assertedBy":"merchant","merchant":{"origin":"https://shop.example"},"total":{"amount":"19.99","currency":"USD"},"lineItems":[{"title":"Mug","itemId":"item_123","quantity":1,"unitAmount":"19.99"}],"revision":1},"order":{"outcome":"confirmed","id":"gid://shopify/Order/1","label":"#1008","permalinkUrl":"https://shop.example/orders/1","links":[{"type":"refund_policy","url":"https://shop.example/policies/refund-policy","title":"Refund policy"}]},"version":"\u003cstring>","approvals":{},"serviceId":"123e4567-e89b-12d3-a456-426614174000","qualifiers":{"model":"gpt-4","tokens":1000},"metadata":{},"authorizedAt":"2024-01-01T00:00:00.000Z","completedAt":"2024-01-01T00:00:00.000Z","outcome":"success","currentPaymentTransactionId":"123e4567-e89b-12d3-a456-426614174000","payment":{"id":"123e4567-e89b-12d3-a456-426614174000","transactionId":"123e4567-e89b-12d3-a456-426614174000","fiatAmount":"\u003cstring>","status":"authorized","createdAt":"2024-01-01T00:00:00.000Z","updatedAt":"2024-01-01T00:00:00.000Z","fundingSource":"external_card","paymentCardId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","credentialRoute":"real_card_number","placeholder":{"number":"4000123412341234","expMonth":7,"expYear":2029,"cvc":"123","brand":"visa","expiresAt":"2026-10-13T13:00:00.000Z","injectionRef":"\u003cstring>","transactionId":"\u003cstring>"},"reason":"sapiom_error","authorizedAt":"2024-01-01T00:00:00.000Z"},"trace":{"id":"123e4567-e89b-12d3-a456-426614174000","externalId":"checkout-session-abc123"},"agentId":"123e4567-e89b-12d3-a456-426614174000","agent":{"id":"\u003cstring>","tenantId":"\u003cstring>","label":"\u003cstring>","name":"\u003cstring>","status":"\u003cstring>","createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z","description":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"ba783406-dcdd-4239-90a7-59111e1e871b":{"description":"Transaction not found","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"43fa073a-c5fe-4a75-b394-a1324d54ed65":{"description":"`card_relayed`: payment has started, so the purchase can no longer be cancelled here; never pay or buy again for it, and tell the buyer to check with the merchant. `not_a_browser_purchase`: the transaction buys nothing. `transaction_ended`: it is completed or denied. `payment_settled`: its payment has completed or is settling. A UCP purchase also answers with the checkout route's codes (`session_closed`, `operation_in_flight`, …).","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"a0c1ddfe-f198-4306-a591-cea561bf78a8":{"api-key":{"type":"apiKey","in":"header","name":"x-api-key","description":"Your platform key for buyer management, or a buyer key for everything else.","scopes":[],"schemeName":"api-key"}}},"servers":{"96df3c0a-5b5d-4163-b956-f849b279a52f":{"url":"https://api.sapiom.ai","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-api-key","description":"Your platform key for buyer management, or a buyer key for everything else.","scopes":[],"schemeName":"api-key"},"schema":{"title":"x-api-key","type":"string","description":"Your platform key for buyer management, or a buyer key for everything else.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"api-key","name":"x-api-key"}],"title":"api-key"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"sapiom-1f975ca2","siteName":"Sapiom Pay","title":"Cancel a transaction - Sapiom Pay","contextualStarterQuestions":[{"_id":"6aed01b5232f96e0946f5c22","deploymentId":"6ad7ec02d3b4a79828e24ed4","questionText":"How do I cancel a transaction?","status":"active","generatedBy":"contextual","path":"api-reference/transactions/cancel-a-transaction","createdAt":"2026-11-05T22:22:45.165Z","updatedAt":"2026-11-05T22:22:45.165Z","__v":0},{"_id":"6aed01b5232f96e0946f5c24","deploymentId":"6ad7ec02d3b4a79828e24ed4","questionText":"When can't I cancel a transaction?","status":"active","generatedBy":"contextual","path":"api-reference/transactions/cancel-a-transaction","createdAt":"2026-11-05T22:22:45.165Z","updatedAt":"2026-11-05T22:22:45.165Z","__v":0},{"_id":"6aed01b5232f96e0946f5c23","deploymentId":"6ad7ec02d3b4a79828e24ed4","questionText":"What happens after cancellation?","status":"active","generatedBy":"contextual","path":"api-reference/transactions/cancel-a-transaction","createdAt":"2026-11-05T22:22:45.165Z","updatedAt":"2026-11-05T22:22:45.165Z","__v":0}],"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-04T01:36:30.945Z","originalFileLocation":"api-reference/transactions/cancel-a-transaction.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Cancels the transaction. For ucp_checkout, Sapiom cancels the merchant checkout first, then the card payment. For browser_checkout, Sapiom cancels the card payment and the placeholder stops working. Cancelling again does nothing. Returns 409 once it\u0026#x27;s too late: card_relayed after your agent pays. It doesn\u0026#x27;t refund an order. Requires a buyer key.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Sapiom Pay\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/sapiom-1f975ca2/YgmZC92WGBAfsBaa/_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/sapiom-1f975ca2/YgmZC92WGBAfsBaa/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/sapiom-1f975ca2/YgmZC92WGBAfsBaa/_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/sapiom-1f975ca2/YgmZC92WGBAfsBaa/_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/sapiom-1f975ca2/YgmZC92WGBAfsBaa/_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/sapiom-1f975ca2/YgmZC92WGBAfsBaa/_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/sapiom-1f975ca2/YgmZC92WGBAfsBaa/_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/sapiom-1f975ca2/YgmZC92WGBAfsBaa/_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/sapiom-1f975ca2/YgmZC92WGBAfsBaa/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Cancel a transaction - Sapiom Pay\">\u003cmeta data-mint-head property=\"og:description\" content=\"Cancels the transaction. For ucp_checkout, Sapiom cancels the merchant checkout first, then the card payment. For browser_checkout, Sapiom cancels the card payment and the placeholder stops working. Cancelling again does nothing. Returns 409 once it\u0026#x27;s too late: card_relayed after your agent pays. It doesn\u0026#x27;t refund an order. Requires a buyer key.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Sapiom Pay\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.sapiom.ai/api-reference/transactions/cancel-a-transaction\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://sapiom-1f975ca2.mintlify.site/_mintlify/api/og/v2?division=Transactions\u0026amp;title=Cancel+a+transaction\u0026amp;description=Cancels+the+transaction.+For+%60ucp_checkout%60%2C+Sapiom+cancels+the+merchant+checkout+first%2C+then+the+card+payment.+For+%60browser_checkout%60%2C+Sapiom+cancels+the+card+\u0026amp;theme=e82bf3ae0cd73b9b01c326a0\u0026amp;signature=6b8b1ea6d7d0c7f2ce29d5b09d71656e744c08ccc1fe0809d9f67a8390a2d3e1\">\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=\"Cancel a transaction - Sapiom Pay\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Cancels the transaction. For ucp_checkout, Sapiom cancels the merchant checkout first, then the card payment. For browser_checkout, Sapiom cancels the card payment and the placeholder stops working. Cancelling again does nothing. Returns 409 once it\u0026#x27;s too late: card_relayed after your agent pays. It doesn\u0026#x27;t refund an order. Requires a buyer key.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://sapiom-1f975ca2.mintlify.site/_mintlify/api/og/v2?division=Transactions\u0026amp;title=Cancel+a+transaction\u0026amp;description=Cancels+the+transaction.+For+%60ucp_checkout%60%2C+Sapiom+cancels+the+merchant+checkout+first%2C+then+the+card+payment.+For+%60browser_checkout%60%2C+Sapiom+cancels+the+card+\u0026amp;theme=e82bf3ae0cd73b9b01c326a0\u0026amp;signature=6b8b1ea6d7d0c7f2ce29d5b09d71656e744c08ccc1fe0809d9f67a8390a2d3e1\">\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/sapiom-1f975ca2/YgmZC92WGBAfsBaa/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Sapiom Pay\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#16A34A\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.sapiom.ai/api-reference/transactions/cancel-a-transaction\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/transactions/cancel-a-transaction.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.sapiom.ai/#organization\",\"name\":\"Sapiom Pay\",\"url\":\"https://docs.sapiom.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/sapiom-1f975ca2/K4zW5IjQAMJutZvi/logo/light.svg?fit=max\u0026auto=format\u0026n=K4zW5IjQAMJutZvi\u0026q=85\u0026s=37d04ab53c9792ff376364fd56a2799e\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.sapiom.ai#website\",\"name\":\"Sapiom Pay\",\"url\":\"https://docs.sapiom.ai\",\"publisher\":{\"@id\":\"https://docs.sapiom.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.sapiom.ai/api-reference/transactions/cancel-a-transaction#webpage\",\"url\":\"https://docs.sapiom.ai/api-reference/transactions/cancel-a-transaction\",\"name\":\"Cancel a transaction\",\"description\":\"Cancels the transaction. For ucp_checkout, Sapiom cancels the merchant checkout first, then the card payment. For browser_checkout, Sapiom cancels the card payment and the placeholder stops working. Cancelling again does nothing. Returns 409 once it's too late: card_relayed after your agent pays. It doesn't refund an order. Requires a buyer key.\",\"dateModified\":\"2026-11-04T01:36:30.945Z\",\"isPartOf\":{\"@id\":\"https://docs.sapiom.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.sapiom.ai/api-reference/transactions/cancel-a-transaction#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.sapiom.ai/api-reference/transactions/cancel-a-transaction#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"REST API\",\"item\":\"https://docs.sapiom.ai/api-reference/buyers/create-a-buyer\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Transactions\",\"item\":\"https://docs.sapiom.ai/api-reference/transactions/create-a-transaction\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Cancel a transaction\",\"item\":\"https://docs.sapiom.ai/api-reference/transactions/cancel-a-transaction\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.sapiom.ai/api-reference/transactions/cancel-a-transaction#apireference\",\"headline\":\"Cancel a transaction\",\"name\":\"Cancel a transaction\",\"description\":\"Cancels the transaction. For ucp_checkout, Sapiom cancels the merchant checkout first, then the card payment. For browser_checkout, Sapiom cancels the card payment and the placeholder stops working. Cancelling again does nothing. Returns 409 once it's too late: card_relayed after your agent pays. It doesn't refund an order. Requires a buyer key.\",\"url\":\"https://docs.sapiom.ai/api-reference/transactions/cancel-a-transaction\",\"mainEntityOfPage\":{\"@id\":\"https://docs.sapiom.ai/api-reference/transactions/cancel-a-transaction#webpage\"},\"dateModified\":\"2026-11-04T01:36:30.945Z\",\"publisher\":{\"@id\":\"https://docs.sapiom.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.sapiom.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Sapiom Pay\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Sapiom Pay","nav":{"global":null,"tabs":[{"tab":"Docs","pages":[{"title":"Docs","href":""}]},{"tab":"API reference","groups":[{"group":"Overview","pages":[{"title":"Sapiom Pay API overview","sidebarTitle":"Overview","href":"/api-reference/overview"}]},{"group":"REST API","pages":[{"group":"Buyers","pages":[{"title":"Create a buyer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/tenants","href":"/api-reference/buyers/create-a-buyer"},{"title":"List buyers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/tenants","href":"/api-reference/buyers/list-buyers"},{"title":"Delete a buyer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/tenants/{tenantId}","href":"/api-reference/buyers/delete-a-buyer"},{"title":"Create a buyer key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/tenants/{tenantId}/api-keys","href":"/api-reference/buyers/create-a-buyer-key"}]},{"group":"Cards","pages":[{"title":"Create a setup link","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/payment-cards/setup-links","href":"/api-reference/cards/create-a-setup-link"},{"title":"Get a setup link","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/payment-cards/setup-links/{linkId}","href":"/api-reference/cards/get-a-setup-link"},{"title":"List cards","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/payment-cards","href":"/api-reference/cards/list-cards"},{"title":"Get a card","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/payment-cards/{cardId}","href":"/api-reference/cards/get-a-card"},{"title":"Set the default card","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /v1/payment-cards/{cardId}/default","href":"/api-reference/cards/set-the-default-card"},{"title":"Remove a card","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/payment-cards/{cardId}","href":"/api-reference/cards/remove-a-card"}]},{"group":"Spending limits","pages":[{"title":"Get spending limits","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/payment-cards/{cardId}/spending-limits","href":"/api-reference/spending-limits/get-spending-limits"},{"title":"Set spending limits","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /v1/payment-cards/{cardId}/spending-limits","href":"/api-reference/spending-limits/set-spending-limits"}]},{"group":"Merchants","pages":[{"title":"Check a merchant","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/transaction-compatibility","href":"/api-reference/merchants/check-a-merchant"}]},{"group":"Transactions","pages":[{"title":"Create a transaction","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/transactions","href":"/api-reference/transactions/create-a-transaction"},{"title":"Get a transaction","description":"Returns the transaction's `purchase`, `order`, `version` and `nextAction`. `nextAction` uses the same `type` and `actor` values as the MCP tools. To wait for a change, pass `maxWaitSeconds` and your last `version` as `since`. Requires a [buyer key](/api-reference/overview#authentication).","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/transactions/{transactionId}","href":"/api-reference/transactions/get-a-transaction"},{"title":"Cancel a transaction","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/transactions/{transactionId}/cancel","href":"/api-reference/transactions/cancel-a-transaction"},{"title":"Open the checkout","description":"Discovers the merchant named in the transaction's request facts, negotiates, and creates the merchant checkout. The merchant cannot be changed by this call. A body carrying payment data is rejected. Requires a [buyer key](/api-reference/overview#authentication).","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/transactions/{transactionId}/ucp/checkout","href":"/api-reference/transactions/open-the-checkout"},{"title":"Get the checkout","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/transactions/{transactionId}/ucp/checkout","href":"/api-reference/transactions/get-the-checkout"},{"title":"Replace the checkout","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /v1/transactions/{transactionId}/ucp/checkout","href":"/api-reference/transactions/replace-the-checkout"},{"title":"Cancel the checkout","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/transactions/{transactionId}/ucp/checkout/cancel","href":"/api-reference/transactions/cancel-the-checkout"},{"title":"Refresh the checkout","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/transactions/{transactionId}/ucp/checkout/refresh","href":"/api-reference/transactions/refresh-the-checkout"}]},{"group":"Browser Pay relay","pages":[{"title":"Relay a card request","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/transactions/{transactionId}/payment/relay","href":"/api-reference/browser-pay-relay/relay-a-card-request"}]}]},{"group":"MCP and SDK","pages":[{"title":"Sapiom Pay MCP tools reference","sidebarTitle":"MCP tools","href":"/api-reference/mcp-tools"},{"title":"Browser Pay SDK reference","sidebarTitle":"Browser Pay SDK","href":"/api-reference/browser-pay-sdk"}]},{"group":"Errors","pages":[{"title":"Sapiom Pay errors and how to handle them","sidebarTitle":"Errors","href":"/api-reference/errors"}]}]}]},"basePath":"","title":"Cancel a transaction - Sapiom Pay","buildId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","deploymentId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C-hEh3I2.js","utils-CnF4QiUD.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C7PVNbel.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-8ytevL2A.js","snippetPresets-BT1alx3v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BLXC0i_W.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CyLIGI9_.js","shallow-DC0lGVIW.js","getApiPlaygroundDisplay-CgDQ85tN.js","CodeSnippet-6-I-Gpv9.js","CodeSnippets-BAk1kDdu.js","Page-C945cI-W.js","getPastedJson-B276RuWN.js","icon-BqP8etTm.js","MethodPill-DM6sbxG1.js","DuplicateIcon-PyJglOaE.js","createIcon-CMeOMAc_.js","DynamicMarkdown-BoyYAA8K.js","SectionHeading-DAYv3gvZ.js","axios-vUo_bRtp.js","Markdown-BhTTmazV.js","clsx-CR-RHrVC.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CBUH0-zX.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BmARFYNC.js"]}