{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"PrimePay","colors":{"primary":"#09000D","light":"#EBCC00","dark":"#09000D"},"logo":{"light":"https://mintcdn.com/prosystems-tech/rcMYSU1YPPUUcDzf/logo/primepay-v3-light.png?fit=max\u0026auto=format\u0026n=rcMYSU1YPPUUcDzf\u0026q=85\u0026s=eb5592018cf5323277a3135853fc9d6d","dark":"https://mintcdn.com/prosystems-tech/rcMYSU1YPPUUcDzf/logo/primepay-v3-dark.png?fit=max\u0026auto=format\u0026n=rcMYSU1YPPUUcDzf\u0026q=85\u0026s=ef373fc158fa9e283a01388a72fdf696"},"favicon":"https://mintcdn.com/prosystems-tech/b52CKE3uGy6vUOXL/logo/primepay-yellow.png?fit=max\u0026auto=format\u0026n=b52CKE3uGy6vUOXL\u0026q=85\u0026s=2780e0e1e5910c8dd14e61055baf15e5","background":{"color":{"dark":"#000000"}},"navbar":{"links":[{"href":"https://primepay.mw/help","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://dashboard.primepay.mw/"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"prosystems-tech","hasAudioNarration":false,"actualSubdomain":"prosystems-tech","customDomains":["docs.primepay.mw"],"gitSource":{"type":"github","owner":"prosystemstechltd-company","repo":"primepay-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":"","_id":"6af44b9d566700d04ef4b621"},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af5eaf304140d5ce9d767c7","clientVersion":"0.0.4111","searchFilterCounts":[{"language":"default","tag":"API Reference","count":30},{"language":"default","tag":"Docs","count":10},{"language":"default","tag":"Get started","count":7},{"language":"default","tag":"Payouts","count":7},{"language":"default","tag":"Payment links","count":6},{"language":"default","tag":"Transfers","count":6},{"language":"default","tag":"Recipes","count":6},{"language":"default","tag":"Payments","count":5},{"language":"default","tag":"Checkout sessions","count":3},{"language":"default","tag":"Refunds","count":3}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/checkout-sessions/cancel-a-checkout-session","slug":"/api-reference/checkout-sessions/cancel-a-checkout-session","pageMetadata":{"title":"Cancel a checkout session","description":"Cancels an unpaid session. No body. A paid session can't be cancelled (`409 session_complete`).\n","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/checkout/sessions/{id}/expire","href":"/api-reference/checkout-sessions/cancel-a-checkout-session","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: [\"Cancels an unpaid session. No body. A paid session can’t be cancelled (\", _jsx(_components.code, {\n children: \"409 session_complete\"\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 checkout session","description":"Cancels an unpaid session. No body. A paid session can't be cancelled (`409 session_complete`).\n","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/checkout/sessions/{id}/expire","href":"/api-reference/checkout-sessions/cancel-a-checkout-session","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Checkout sessions"],"summary":"Cancel a checkout session","operationId":"expireCheckoutSession","description":"Cancels an unpaid session. No body. A paid session can't be cancelled (`409 session_complete`).\n","parameters":["6a92f8ca-d532-4f58-ba1b-5ad293b64128"],"responses":{"200":"4b6b7619-925e-483c-b856-b64337586888","404":"6d7a3320-1cd7-43fb-a61b-ce7328b0bc46","409":"f321081b-d69e-47f3-b95c-3f6fe3dd471d"},"method":"post","type":"path","servers":["d911aee0-b44b-48be-9f3a-fd7b00e1e819","405140b9-f90a-47e4-aeaa-9946817b93f4"],"security":["f2d79d5d-613e-429d-be97-e78e77778c27"],"path":"/v1/checkout/sessions/{id}/expire","baseUrlOptions":["https://api.primepay.mw","https://sandbox-api.primepay.mw"],"title":"Cancel a checkout session","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"6a92f8ca-d532-4f58-ba1b-5ad293b64128":{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","example":"3c0f6f4e-7a1b-4c59-9a3e-0d5b7f2c8e11","isRequired":true,"description":"The session's `id`.","uniqueKey":"","typeLabel":"string\u003cuuid>"},"description":"The session's `id`."}},"responses":{"4b6b7619-925e-483c-b856-b64337586888":{"description":"The session.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","uniqueKey":"id","typeLabel":"string\u003cuuid>"},"object":{"type":"string","example":"checkout.session","uniqueKey":"object","typeLabel":"string"},"url":{"oneOf":[{"type":"string","description":"The payment page. `null` once the session can no longer be paid.","uniqueKey":"url.oneOf.0","typeLabel":"string"},{"type":"null","description":"The payment page. `null` once the session can no longer be paid.","uniqueKey":"url.oneOf.1","typeLabel":"null"}],"uniqueKey":"url","typeLabel":"string | null"},"status":{"type":"string","enum":["open","processing","complete","expired","cancelled"],"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"livemode":{"type":"boolean","uniqueKey":"livemode","typeLabel":"boolean"},"amount":{"type":"number","uniqueKey":"amount","typeLabel":"number"},"currency":{"type":"string","example":"MWK","uniqueKey":"currency","typeLabel":"string"},"reference":{"type":"string","uniqueKey":"reference","typeLabel":"string"},"description":{"oneOf":[{"type":"string","uniqueKey":"description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"description.oneOf.1","typeLabel":"null"}],"uniqueKey":"description","typeLabel":"string | null"},"customer":{"type":"object","properties":{"first_name":{"oneOf":[{"type":"string","maxLength":100,"uniqueKey":"customer.first_name.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":100,"uniqueKey":"customer.first_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.first_name","typeLabel":"string | null"},"last_name":{"oneOf":[{"type":"string","maxLength":100,"uniqueKey":"customer.last_name.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":100,"uniqueKey":"customer.last_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.last_name","typeLabel":"string | null"},"email":{"oneOf":[{"type":"string","format":"email","uniqueKey":"customer.email.oneOf.0","typeLabel":"string\u003cemail>"},{"type":"null","format":"email","uniqueKey":"customer.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.email","typeLabel":"string\u003cemail> | null"},"phone":{"oneOf":[{"type":"string","description":"A Malawi mobile number, for example `0991234567` or `265991234567`. Returned as `+265991234567`.","uniqueKey":"customer.phone.oneOf.0","typeLabel":"string"},{"type":"null","description":"A Malawi mobile number, for example `0991234567` or `265991234567`. Returned as `+265991234567`.","uniqueKey":"customer.phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.phone","typeLabel":"string | null"}},"uniqueKey":"customer","typeLabel":"object"},"line_items":{"type":"array","items":{"type":"object","required":["name","quantity","unit_amount"],"properties":{"name":{"type":"string","maxLength":200,"isRequired":true,"uniqueKey":"line_items.items.[INDEX].name","typeLabel":"string"},"quantity":{"type":"integer","minimum":1,"isRequired":true,"uniqueKey":"line_items.items.[INDEX].quantity","typeLabel":"integer"},"unit_amount":{"type":"number","minimum":0,"isRequired":true,"uniqueKey":"line_items.items.[INDEX].unit_amount","typeLabel":"number"},"description":{"oneOf":[{"type":"string","maxLength":500,"uniqueKey":"line_items.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":500,"uniqueKey":"line_items.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"line_items.items.[INDEX].description","typeLabel":"string | null"}},"uniqueKey":"line_items.items.[INDEX]","typeLabel":"object"},"uniqueKey":"line_items","typeLabel":"object[]"},"metadata":{"oneOf":[{"type":"object","additionalProperties":true,"uniqueKey":"metadata.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":true,"uniqueKey":"metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"metadata","typeLabel":"object | null"},"sub_merchant_account_code":{"oneOf":[{"type":"string","uniqueKey":"sub_merchant_account_code.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"sub_merchant_account_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"sub_merchant_account_code","typeLabel":"string | null"},"return_url":{"type":"string","uniqueKey":"return_url","typeLabel":"string"},"cancel_url":{"type":"string","uniqueKey":"cancel_url","typeLabel":"string"},"payment":{"oneOf":[{"type":"object","description":"The payment that completed the session. `null` until it is paid.","properties":{"transaction_id":{"type":"string","format":"uuid","uniqueKey":"payment.oneOf.0.transaction_id","typeLabel":"string\u003cuuid>"},"transaction_reference":{"type":"string","example":"TXN-WRYF6S2W3DQW","uniqueKey":"payment.oneOf.0.transaction_reference","typeLabel":"string"},"method":{"type":"string","example":"wallet","uniqueKey":"payment.oneOf.0.method","typeLabel":"string"},"provider":{"oneOf":[{"type":"string","example":"airtel","uniqueKey":"payment.oneOf.0.provider.oneOf.0","typeLabel":"string"},{"type":"null","example":"airtel","uniqueKey":"payment.oneOf.0.provider.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment.oneOf.0.provider","typeLabel":"string | null"},"amount":{"type":"number","example":42500,"uniqueKey":"payment.oneOf.0.amount","typeLabel":"number"},"fee":{"type":"number","example":1275,"uniqueKey":"payment.oneOf.0.fee","typeLabel":"number"},"levy":{"type":"number","example":0,"uniqueKey":"payment.oneOf.0.levy","typeLabel":"number"},"aggregator_fee":{"type":"number","example":0,"description":"Aggregator sessions: the aggregator's share.","uniqueKey":"payment.oneOf.0.aggregator_fee","typeLabel":"number"},"net":{"type":"number","example":41225,"description":"What reaches the account after fees.","uniqueKey":"payment.oneOf.0.net","typeLabel":"number"},"paid_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"payment.oneOf.0.paid_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"payment.oneOf.0.paid_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment.oneOf.0.paid_at","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"payment.oneOf.0","typeLabel":"object"},{"type":"null","description":"The payment that completed the session. `null` until it is paid.","properties":{"transaction_id":{"type":"string","format":"uuid"},"transaction_reference":{"type":"string","example":"TXN-WRYF6S2W3DQW"},"method":{"type":"string","example":"wallet"},"provider":{"oneOf":[{"type":"string","example":"airtel"},{"type":"null","example":"airtel"}]},"amount":{"type":"number","example":42500},"fee":{"type":"number","example":1275},"levy":{"type":"number","example":0},"aggregator_fee":{"type":"number","example":0,"description":"Aggregator sessions: the aggregator's share."},"net":{"type":"number","example":41225,"description":"What reaches the account after fees."},"paid_at":{"oneOf":[{"type":"string","format":"date-time"},{"type":"null","format":"date-time"}]}},"uniqueKey":"payment.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment","typeLabel":"object | null"},"created_at":{"type":"string","format":"date-time","uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"expires_at":{"type":"string","format":"date-time","uniqueKey":"expires_at","typeLabel":"string\u003cdate-time>"},"completed_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"completed_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"completed_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"completed_at","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","object":"checkout.session","url":"\u003cstring>","status":"open","livemode":true,"amount":123,"currency":"MWK","reference":"\u003cstring>","description":"\u003cstring>","customer":{"first_name":"\u003cstring>","last_name":"\u003cstring>","email":"jsmith@example.com","phone":"\u003cstring>"},"line_items":[{"name":"\u003cstring>","quantity":2,"unit_amount":1,"description":"\u003cstring>"}],"metadata":{},"sub_merchant_account_code":"\u003cstring>","return_url":"\u003cstring>","cancel_url":"\u003cstring>","payment":{"transaction_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","transaction_reference":"TXN-WRYF6S2W3DQW","method":"wallet","provider":"airtel","amount":42500,"fee":1275,"levy":0,"aggregator_fee":0,"net":41225,"paid_at":"2023-11-07T05:31:56Z"},"created_at":"2023-11-07T05:31:56Z","expires_at":"2023-11-07T05:31:56Z","completed_at":"2023-11-07T05:31:56Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"6d7a3320-1cd7-43fb-a61b-ce7328b0bc46":{"description":"An error. `param` names the field at fault. Use `code` in your code; show `message` to people.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","example":"invalid_request_error","uniqueKey":"error.type","typeLabel":"string"},"code":{"type":"string","example":"line_items_total_mismatch","uniqueKey":"error.code","typeLabel":"string"},"param":{"oneOf":[{"type":"string","example":"line_items","uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","example":"line_items","uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.param","typeLabel":"string | null"},"message":{"type":"string","example":"line_items add up to 40000.00 but amount is 42500.00.","uniqueKey":"error.message","typeLabel":"string"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"type":"invalid_request_error","code":"line_items_total_mismatch","param":"line_items","message":"line_items add up to 40000.00 but amount is 42500.00."}}}},"exampleType":"generated"}},"exampleType":"generated"},"f321081b-d69e-47f3-b95c-3f6fe3dd471d":{"description":"An error. `param` names the field at fault. Use `code` in your code; show `message` to people.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","example":"invalid_request_error","uniqueKey":"error.type","typeLabel":"string"},"code":{"type":"string","example":"line_items_total_mismatch","uniqueKey":"error.code","typeLabel":"string"},"param":{"oneOf":[{"type":"string","example":"line_items","uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","example":"line_items","uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.param","typeLabel":"string | null"},"message":{"type":"string","example":"line_items add up to 40000.00 but amount is 42500.00.","uniqueKey":"error.message","typeLabel":"string"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"type":"invalid_request_error","code":"line_items_total_mismatch","param":"line_items","message":"line_items add up to 40000.00 but amount is 42500.00."}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"f2d79d5d-613e-429d-be97-e78e77778c27":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Your API key: `sk_live_…` / `sk_test_…` (secret), `pk_live_…` / `pk_test_…` (publishable, read-only reference data) or `rk_live_…` / `rk_test_…` (payments only).\n","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"d911aee0-b44b-48be-9f3a-fd7b00e1e819":{"url":"https://api.primepay.mw","description":"Live API (live keys, `sk_live_…`)"},"405140b9-f90a-47e4-aeaa-9946817b93f4":{"url":"https://sandbox-api.primepay.mw","description":"Sandbox API (test keys, `sk_test_…`)"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Your API key: `sk_live_…` / `sk_test_…` (secret), `pk_live_…` / `pk_test_…` (publishable, read-only reference data) or `rk_live_…` / `rk_test_…` (payments only).\n","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Your API key: `sk_live_…` / `sk_test_…` (secret), `pk_live_…` / `pk_test_…` (publishable, read-only reference data) or `rk_live_…` / `rk_test_…` (payments only).\n","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi.yaml"},"subdomain":"prosystems-tech","siteName":"PrimePay","title":"Cancel a checkout session - PrimePay","navMaps":{"firstHrefInVersion":{"v1":{"href":"/api-reference/checkout-sessions/cancel-a-checkout-session","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-11-12T16:36:07.388Z","originalFileLocation":"api-reference/checkout-sessions/cancel-a-checkout-session.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 an unpaid session. No body. A paid session can\u0026#x27;t be cancelled (409 session_complete).\">\u003cmeta data-mint-head name=\"application-name\" content=\"PrimePay\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/prosystems-tech/bgyknVzzbWNYws3_/_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/prosystems-tech/bgyknVzzbWNYws3_/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/prosystems-tech/bgyknVzzbWNYws3_/_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/prosystems-tech/bgyknVzzbWNYws3_/_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/prosystems-tech/bgyknVzzbWNYws3_/_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/prosystems-tech/bgyknVzzbWNYws3_/_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/prosystems-tech/bgyknVzzbWNYws3_/_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/prosystems-tech/bgyknVzzbWNYws3_/_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/prosystems-tech/bgyknVzzbWNYws3_/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Cancel a checkout session - PrimePay\">\u003cmeta data-mint-head property=\"og:description\" content=\"Cancels an unpaid session. No body. A paid session can\u0026#x27;t be cancelled (409 session_complete).\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"PrimePay\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.primepay.mw/api-reference/checkout-sessions/cancel-a-checkout-session\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://prosystems-tech.mintlify.site/_mintlify/api/og/v2?division=Checkout+sessions\u0026amp;title=Cancel+a+checkout+session\u0026amp;description=Cancels+an+unpaid+session.+No+body.+A+paid+session+can%27t+be+cancelled+%28%60409+session_complete%60%29.%0A\u0026amp;theme=b265b6de14d9582a003885b7\u0026amp;signature=4f6edb2496d32e15d2efc881aee2001f7a784430883ad13ba87ec3ebac8c6a8b\">\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 checkout session - PrimePay\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Cancels an unpaid session. No body. A paid session can\u0026#x27;t be cancelled (409 session_complete).\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://prosystems-tech.mintlify.site/_mintlify/api/og/v2?division=Checkout+sessions\u0026amp;title=Cancel+a+checkout+session\u0026amp;description=Cancels+an+unpaid+session.+No+body.+A+paid+session+can%27t+be+cancelled+%28%60409+session_complete%60%29.%0A\u0026amp;theme=b265b6de14d9582a003885b7\u0026amp;signature=4f6edb2496d32e15d2efc881aee2001f7a784430883ad13ba87ec3ebac8c6a8b\">\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/prosystems-tech/bgyknVzzbWNYws3_/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"PrimePay\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#09000D\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.primepay.mw/api-reference/checkout-sessions/cancel-a-checkout-session\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/checkout-sessions/cancel-a-checkout-session.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.primepay.mw/#organization\",\"name\":\"PrimePay\",\"url\":\"https://docs.primepay.mw\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/prosystems-tech/rcMYSU1YPPUUcDzf/logo/primepay-v3-light.png?fit=max\u0026auto=format\u0026n=rcMYSU1YPPUUcDzf\u0026q=85\u0026s=eb5592018cf5323277a3135853fc9d6d\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.primepay.mw#website\",\"name\":\"PrimePay\",\"url\":\"https://docs.primepay.mw\",\"publisher\":{\"@id\":\"https://docs.primepay.mw/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.primepay.mw/api-reference/checkout-sessions/cancel-a-checkout-session#webpage\",\"url\":\"https://docs.primepay.mw/api-reference/checkout-sessions/cancel-a-checkout-session\",\"name\":\"Cancel a checkout session\",\"description\":\"Cancels an unpaid session. No body. A paid session can't be cancelled (409 session_complete).\",\"dateModified\":\"2026-11-12T16:36:07.388Z\",\"isPartOf\":{\"@id\":\"https://docs.primepay.mw#website\"},\"breadcrumb\":{\"@id\":\"https://docs.primepay.mw/api-reference/checkout-sessions/cancel-a-checkout-session#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.primepay.mw/api-reference/checkout-sessions/cancel-a-checkout-session#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Checkout sessions\",\"item\":\"https://docs.primepay.mw/api-reference/checkout-sessions/create-a-checkout-session\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Cancel a checkout session\",\"item\":\"https://docs.primepay.mw/api-reference/checkout-sessions/cancel-a-checkout-session\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.primepay.mw/api-reference/checkout-sessions/cancel-a-checkout-session#apireference\",\"headline\":\"Cancel a checkout session\",\"name\":\"Cancel a checkout session\",\"description\":\"Cancels an unpaid session. No body. A paid session can't be cancelled (409 session_complete).\",\"url\":\"https://docs.primepay.mw/api-reference/checkout-sessions/cancel-a-checkout-session\",\"mainEntityOfPage\":{\"@id\":\"https://docs.primepay.mw/api-reference/checkout-sessions/cancel-a-checkout-session#webpage\"},\"dateModified\":\"2026-11-12T16:36:07.388Z\",\"publisher\":{\"@id\":\"https://docs.primepay.mw/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.primepay.mw#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"PrimePay\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"PrimePay\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/checkout-sessions/cancel-a-checkout-session.md","siteName":"PrimePay","nav":{"global":null,"versions":[{"version":"v1","tabs":[{"tab":"Docs","pages":[{"title":"Docs","href":""}]},{"tab":"API Reference","groups":[{"group":"Get started","pages":[{"title":"PrimePay API v1","sidebarTitle":"Introduction","href":"/api-reference/introduction"},{"title":"Idempotency","href":"/api-reference/idempotency"},{"title":"Errors","href":"/api-reference/errors"}]},{"group":"Operators","pages":[{"title":"List mobile money operators","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /mobile-money/operators","href":"/api-reference/operators/list-mobile-money-operators"}]},{"group":"Payments","pages":[{"title":"Create a payment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/payments/mobile-money","href":"/api-reference/payments/create-a-payment"},{"title":"Collect for a sub-merchant","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/sub-merchants/{subMerchantCode}/payments/mobile-money","href":"/api-reference/payments/collect-for-a-sub-merchant"},{"title":"Get a payment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/payments/{reference}","href":"/api-reference/payments/get-a-payment"},{"title":"Find a payment by order","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/payments","href":"/api-reference/payments/find-a-payment-by-order"}]},{"group":"Refunds","pages":[{"title":"Refund a payment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/payments/{reference}/refunds","href":"/api-reference/refunds/refund-a-payment"},{"title":"List a payment's refunds","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/payments/{reference}/refunds","href":"/api-reference/refunds/list-a-payments-refunds"},{"title":"Get a refund","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/refunds/{reference}","href":"/api-reference/refunds/get-a-refund"}]},{"group":"Transfers","pages":[{"title":"Look up a merchant account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/transfers/merchant-account/recipient","href":"/api-reference/transfers/look-up-a-merchant-account"},{"title":"Look up a PrimePay wallet","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/transfers/wallet/recipient","href":"/api-reference/transfers/look-up-a-primepay-wallet"},{"title":"Transfer to a merchant account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/transfers/merchant-account","href":"/api-reference/transfers/transfer-to-a-merchant-account"},{"title":"Transfer to a PrimePay wallet","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/transfers/wallet","href":"/api-reference/transfers/transfer-to-a-primepay-wallet"},{"title":"Get a transfer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/transfers/{reference}","href":"/api-reference/transfers/get-a-transfer"}]},{"group":"Payouts","pages":[{"title":"Look up a mobile money number","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/payouts/mobile-money/recipient","href":"/api-reference/payouts/look-up-a-mobile-money-number"},{"title":"Look up a bank account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/payouts/bank/recipient","href":"/api-reference/payouts/look-up-a-bank-account"},{"title":"List banks","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/payouts/banks","href":"/api-reference/payouts/list-banks"},{"title":"Pay a mobile money number","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/payouts/mobile-money","href":"/api-reference/payouts/pay-a-mobile-money-number"},{"title":"Pay a bank account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/payouts/bank","href":"/api-reference/payouts/pay-a-bank-account"},{"title":"Get a payout","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/payouts/{reference}","href":"/api-reference/payouts/get-a-payout"}]},{"group":"Payment links","pages":[{"title":"Create a payment link","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/payment-links","href":"/api-reference/payment-links/create-a-payment-link"},{"title":"Create a payment link for a sub-merchant","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/sub-merchants/{subMerchantCode}/payment-links","href":"/api-reference/payment-links/create-a-payment-link-for-a-sub-merchant"},{"title":"Get a payment link","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/payment-links/{id}","href":"/api-reference/payment-links/get-a-payment-link"},{"title":"Deactivate a payment link","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/payment-links/{id}/deactivate","href":"/api-reference/payment-links/deactivate-a-payment-link"},{"title":"Reactivate a payment link","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/payment-links/{id}/reactivate","href":"/api-reference/payment-links/reactivate-a-payment-link"}]},{"group":"Checkout sessions","pages":[{"title":"Create a checkout session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/checkout/sessions","href":"/api-reference/checkout-sessions/create-a-checkout-session"},{"title":"Check a checkout session","description":"Returns the session. Fulfil the order only when `status` is `complete`.\n","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/checkout/sessions/{id}","href":"/api-reference/checkout-sessions/check-a-checkout-session"},{"title":"Cancel a checkout session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/checkout/sessions/{id}/expire","href":"/api-reference/checkout-sessions/cancel-a-checkout-session"}]}]},{"tab":"SDKs","pages":[{"title":"SDKs","href":"/sdks/overview"}]},{"tab":"Recipes","pages":[{"title":"Recipes","href":"/recipes/overview"}]},{"tab":"Changelogs","pages":[{"title":"Changelogs","href":"/changelog"}]}]}]},"basePath":"","title":"Cancel a checkout session - PrimePay","buildId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","deploymentId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CybtLBIt.js","utils-BMLj2fvV.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-B6In562Y.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dr8Mfhp9.js","snippetPresets-2rmQvMVl.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-WMqJYdZj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CJ-MlPHu.js","shallow-dY3TMRCk.js","getApiPlaygroundDisplay-v-1B2bKm.js","CodeSnippet-BDhiTB7U.js","CodeSnippets-D9hnzQcS.js","Page-C4GwDT3_.js","getPastedJson-Th2V45jI.js","icon-BQXch1W9.js","MethodPill-BCqUneP3.js","DuplicateIcon-Q_-bhurZ.js","createIcon-DUjLHRqp.js","DynamicMarkdown-B-f2cqXQ.js","SectionHeading-Da5NsV4v.js","axios-vUo_bRtp.js","Markdown-D13FWkIM.js","clsx-D3Isdib3.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-C-XZBk9h.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink--qIqmmVG.js"]}