Whole seconds until expiresAt when status is unknown, otherwise null
{"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.","Agents call the hosted MCP tools at https://api.sapiom.ai/v1/mcp. Backends call the REST API at https://api.sapiom.ai/v1. Both take the key in an x-api-key header.","Never ask a buyer for a card number, expiry date or CVV in chat. Buyers enter card details only on Sapiom's hosted pages.","Follow the nextAction in each transaction result. Action links are secrets for the intended buyer only.","Use one idempotencyKey per transaction. After a timeout, retry with the same key. Never start a new transaction to escape an uncertain outcome.","Report an order as placed only when order.outcome is confirmed. If it is unknown, stop and hand off to a person."]},"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":""},"chroma":{"latestBuiltDeploymentHistoryId":"6adc09fb88e4302084f07b26","collectionId":"63ee2a9b-edcc-4ec4-bdef-e6e8dece8b95","liveDeploymentHistoryId":"6adc09fb88e4302084f07b26","schemaVersion":"v3"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6adc2ddc1885992e09c7803b","clientVersion":"0.0.3964","searchFilterCounts":[{"language":"default","tag":"API reference","count":26},{"language":"default","tag":"REST API","count":22},{"language":"default","tag":"Docs","count":14},{"language":"default","tag":"Transactions","count":9},{"language":"default","tag":"Cards","count":8},{"language":"default","tag":"Buyers","count":6},{"language":"default","tag":"Get started","count":3},{"language":"default","tag":"Browser checkout","count":3},{"language":"default","tag":"MCP and SDK","count":2},{"language":"default","tag":"Early access","count":2}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"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":"billing-updated-9-15","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}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/merchants/check-a-merchant","slug":"/api-reference/merchants/check-a-merchant","pageMetadata":{"title":"Check a merchant","description":"Checks whether a merchant offers a UCP checkout Sapiom can authorize. Buy only from merchants whose `status` is `supported`. Requires a [buyer key](/api-reference/overview#authentication).","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/transaction-compatibility","href":"/api-reference/merchants/check-a-merchant","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: [\"Checks whether a merchant offers a UCP checkout Sapiom can authorize. Buy only from merchants whose \", _jsx(_components.code, {\n children: \"status\"\n }), \" is \", _jsx(_components.code, {\n children: \"supported\"\n }), \". 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":"Check a merchant","description":"Checks whether a merchant offers a UCP checkout Sapiom can authorize. Buy only from merchants whose `status` is `supported`. Requires a [buyer key](/api-reference/overview#authentication).","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/transaction-compatibility","href":"/api-reference/merchants/check-a-merchant","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"Checks whether a merchant offers a UCP checkout Sapiom can authorize. Buy only from merchants whose `status` is `supported`. Requires a [buyer key](/api-reference/overview#authentication).","operationId":"TransactionCompatibilityController_check","parameters":["bcabedde-fec0-4b1e-a43d-ab19e59497bc"],"responses":{"200":"55598a03-3436-4912-b292-9284538d8287","400":"38f1eb67-61bc-45ce-9631-722227c5102d","401":"23a888bd-7611-405f-b687-fd277df71e8c","403":"222df026-b8c0-4c34-9f38-cc1e39a2a8f6","429":"c408e543-0026-4781-b1b6-7a325bd98901","503":"9f4bbd6d-ac39-4171-9d16-80b998d0fd8a"},"security":["d0f64f47-7799-43d5-a4b8-bc86541c9b85"],"summary":"Check a merchant","tags":["Merchants"],"method":"get","type":"path","servers":["129d4bde-9564-498b-9b32-242ff84fee16"],"path":"/v1/transaction-compatibility","baseUrlOptions":["https://api.sapiom.ai"],"title":"Check a merchant","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"bcabedde-fec0-4b1e-a43d-ab19e59497bc":{"name":"domain","required":true,"in":"query","description":"Merchant to check: a bare domain or an https origin with an optional root slash","schema":{"example":"shop.example","type":"string","isRequired":true,"description":"Merchant to check: a bare domain or an https origin with an optional root slash","uniqueKey":"","typeLabel":"string"}}},"responses":{"55598a03-3436-4912-b292-9284538d8287":{"description":"Transaction compatibility result.","content":{"application/json":{"schema":{"type":"object","properties":{"merchant":{"type":"object","description":"The merchant that was checked","required":["domain","origin"],"properties":{"domain":{"type":"string","description":"The normalized domain from the input","example":"shop.example","isRequired":true,"uniqueKey":"merchant.domain","typeLabel":"string"},"origin":{"type":"string","description":"The https origin that answered the lookup","example":"https://shop.example","isRequired":true,"uniqueKey":"merchant.origin","typeLabel":"string"}},"isRequired":true,"uniqueKey":"merchant","typeLabel":"object"},"status":{"type":"string","description":"supported: structured checkout is available. Anything else: use browser checkout","enum":["supported","unsupported","unknown"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"reason":{"type":"string","description":"Why the merchant has this status","enum":["compatible_ucp_profile","no_manifest","no_compatible_version","no_checkout","timeout","fetch_failed","upstream_error","invalid_profile"],"isRequired":true,"uniqueKey":"reason","typeLabel":"enum\u003cstring>"},"protocol":{"oneOf":[{"type":"object","description":"The protocol and version negotiated; null unless status is supported","required":["name","version"],"properties":{"name":{"type":"string","description":"Commerce protocol the merchant speaks","enum":["ucp"],"isRequired":true,"uniqueKey":"protocol.oneOf.0.name","typeLabel":"enum\u003cstring>"},"version":{"type":"string","description":"The protocol release negotiated with the merchant","example":"2026-08-25","isRequired":true,"uniqueKey":"protocol.oneOf.0.version","typeLabel":"string"}},"isRequired":true,"uniqueKey":"protocol.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"protocol.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"protocol","typeLabel":"object | null"},"capabilities":{"description":"Allowlisted capabilities the merchant advertises; empty unless status is supported","type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Advertised capability name, from the known-capability allowlist only","enum":["dev.ucp.shopping.checkout","dev.ucp.shopping.fulfillment","dev.ucp.shopping.discount","dev.ucp.shopping.cart"],"isRequired":true,"uniqueKey":"capabilities.items.[INDEX].name","typeLabel":"enum\u003cstring>"},"supported":{"type":"boolean","description":"True when Sapiom implements this capability","isRequired":true,"uniqueKey":"capabilities.items.[INDEX].supported","typeLabel":"boolean"}},"required":["name","supported"],"uniqueKey":"capabilities.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"capabilities","typeLabel":"object[]"},"checkedAt":{"type":"string","description":"When the merchant profile was fetched (ISO 8601)","example":"2026-10-16T23:00:00Z","isRequired":true,"uniqueKey":"checkedAt","typeLabel":"string"},"expiresAt":{"type":"string","description":"When this answer stops being fresh (ISO 8601)","example":"2026-10-16T23:05:00Z","isRequired":true,"uniqueKey":"expiresAt","typeLabel":"string"},"retryAfterSeconds":{"oneOf":[{"type":"number","description":"Whole seconds until expiresAt when status is unknown, otherwise null","isRequired":true,"uniqueKey":"retryAfterSeconds.oneOf.0","typeLabel":"number"},{"type":"null","description":"Whole seconds until expiresAt when status is unknown, otherwise null","isRequired":true,"uniqueKey":"retryAfterSeconds.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"retryAfterSeconds","typeLabel":"number | null"}},"required":["merchant","status","reason","protocol","capabilities","checkedAt","expiresAt","retryAfterSeconds"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"merchant":{"domain":"shop.example","origin":"https://shop.example"},"status":"supported","reason":"compatible_ucp_profile","protocol":{"name":"ucp","version":"2026-08-25"},"capabilities":[{"name":"dev.ucp.shopping.checkout","supported":true}],"checkedAt":"2026-10-16T23:00:00Z","expiresAt":"2026-10-16T23:05:00Z","retryAfterSeconds":123}}},"exampleType":"generated"}},"exampleType":"generated"},"38f1eb67-61bc-45ce-9631-722227c5102d":{"description":"The merchant domain is invalid; a retryable origin may be included as derivedOrigin.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","example":"path","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"derivedOrigin":{"type":"string","example":"https://shop.example","uniqueKey":"derivedOrigin","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"path","message":"\u003cstring>","derivedOrigin":"https://shop.example"}}},"exampleType":"generated"}},"exampleType":"generated"},"23a888bd-7611-405f-b687-fd277df71e8c":{"description":"Authentication is missing or invalid.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"222df026-b8c0-4c34-9f38-cc1e39a2a8f6":{"description":"The caller lacks org.transactions.read.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"c408e543-0026-4781-b1b6-7a325bd98901":{"description":"Rate limited to 60 requests per minute per IP.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"9f4bbd6d-ac39-4171-9d16-80b998d0fd8a":{"description":"Transaction compatibility is temporarily unavailable; this is not a merchant verdict.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"d0f64f47-7799-43d5-a4b8-bc86541c9b85":{"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":{"129d4bde-9564-498b-9b32-242ff84fee16":{"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":"Check a merchant - Sapiom Pay","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-24T01:29:35.482Z","originalFileLocation":"api-reference/merchants/check-a-merchant.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=\"Checks whether a merchant offers a UCP checkout Sapiom can authorize. Buy only from merchants whose status is supported. 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=\"Check a merchant - Sapiom Pay\">\u003cmeta data-mint-head property=\"og:description\" content=\"Checks whether a merchant offers a UCP checkout Sapiom can authorize. Buy only from merchants whose status is supported. 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/merchants/check-a-merchant\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://sapiom-1f975ca2.mintlify.app/_mintlify/api/og/v2?division=Merchants\u0026amp;title=Check+a+merchant\u0026amp;description=Checks+whether+a+merchant+offers+a+UCP+checkout+Sapiom+can+authorize.+Buy+only+from+merchants+whose+%60status%60+is+%60supported%60.+Requires+a+%5Bbuyer+key%5D%28%2Fapi-referen\u0026amp;theme=094d3944263395c13d2c9b53\u0026amp;signature=d288506420a73a4466edf37aa84732dd24d9d32fcc4e921a1bfa1673228747cf\">\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=\"Check a merchant - Sapiom Pay\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Checks whether a merchant offers a UCP checkout Sapiom can authorize. Buy only from merchants whose status is supported. Requires a buyer key.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://sapiom-1f975ca2.mintlify.app/_mintlify/api/og/v2?division=Merchants\u0026amp;title=Check+a+merchant\u0026amp;description=Checks+whether+a+merchant+offers+a+UCP+checkout+Sapiom+can+authorize.+Buy+only+from+merchants+whose+%60status%60+is+%60supported%60.+Requires+a+%5Bbuyer+key%5D%28%2Fapi-referen\u0026amp;theme=094d3944263395c13d2c9b53\u0026amp;signature=d288506420a73a4466edf37aa84732dd24d9d32fcc4e921a1bfa1673228747cf\">\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/merchants/check-a-merchant\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/merchants/check-a-merchant.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/merchants/check-a-merchant#webpage\",\"url\":\"https://docs.sapiom.ai/api-reference/merchants/check-a-merchant\",\"name\":\"Check a merchant\",\"description\":\"Checks whether a merchant offers a UCP checkout Sapiom can authorize. Buy only from merchants whose status is supported. Requires a buyer key.\",\"dateModified\":\"2026-10-24T01:29:35.482Z\",\"isPartOf\":{\"@id\":\"https://docs.sapiom.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.sapiom.ai/api-reference/merchants/check-a-merchant#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.sapiom.ai/api-reference/merchants/check-a-merchant#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\":\"Check a merchant\",\"item\":\"https://docs.sapiom.ai/api-reference/merchants/check-a-merchant\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.sapiom.ai/api-reference/merchants/check-a-merchant#apireference\",\"headline\":\"Check a merchant\",\"name\":\"Check a merchant\",\"description\":\"Checks whether a merchant offers a UCP checkout Sapiom can authorize. Buy only from merchants whose status is supported. Requires a buyer key.\",\"url\":\"https://docs.sapiom.ai/api-reference/merchants/check-a-merchant\",\"mainEntityOfPage\":{\"@id\":\"https://docs.sapiom.ai/api-reference/merchants/check-a-merchant#webpage\"},\"dateModified\":\"2026-10-24T01:29:35.482Z\",\"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","description":"Replaces a card's spending limits. Send the `version` from [Get spending limits](/api-reference/spending-limits/get-spending-limits), or `0` the first time, and `null` for any limit you don't want. Returns `409` when that version is out of date or the card can't be used. Requires a key with `org.read` to read limits or `org.write` to set them, such as your [platform key](/api-reference/overview#authentication), and the buyer's ID in the `sapiom-tenant` header. Buyer keys have neither permission.","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","description":"Creates a new transaction for the organization associated with the API key. Automatically handles authorization and payment if required. Supports an optional `x-idempotency-key` header (max 255 chars), unique per tenant: replaying a key returns the previously created transaction — whatever its state — instead of creating a new one. First-write-wins: the original transaction is returned even if the replayed request body differs, so use a fresh key for each genuinely new request. Requires a [buyer key](/api-reference/overview#authentication).","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/transactions","href":"/api-reference/transactions/create-a-transaction"},{"title":"Open the checkout","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 checkout","pages":[{"title":"List placeholder cards","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/card-placeholders","href":"/api-reference/browser-checkout/list-placeholder-cards"},{"title":"List relay profiles","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/injection-profiles","href":"/api-reference/browser-checkout/list-relay-profiles"},{"title":"Relay a card request","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/transactions/{transactionId}/payment/relay","href":"/api-reference/browser-checkout/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"}]}]}]},"title":"Check a merchant - Sapiom Pay","buildId":"dpl_HcHmUS6i3UwswnTHJUEdcTtwfdTQ","deploymentId":"dpl_HcHmUS6i3UwswnTHJUEdcTtwfdTQ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-BRm_l__d.js","utils-f1l1Oc-G.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BlhqDhJO.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DHCB7rsC.js","snippetPresets-CYXLx6Hv.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-B78P2dEq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C4YLPVAh.js","shallow-vlLnTDkQ.js","getApiPlaygroundDisplay-D_98hhvf.js","CodeSnippet-DtnZHGqq.js","CodeSnippets-CLFb8KJt.js","Page-kQh739Uz.js","getPastedJson-Cq-zlbnU.js","icon-sN3t983t.js","MethodPill-P_YQ2s09.js","DuplicateIcon-BVzyNsGJ.js","createIcon-B3jqgqC6.js","DynamicMarkdown-Crwq6WG_.js","SectionHeading-C7pGS2Bb.js","axios-vUo_bRtp.js","Markdown-BuPH8yuW.js","clsx-CCOYKgaU.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BnkC_6oA.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BM4S31-f.js"]}