Returns a session as it stands. No credential is needed: the session ID is the key. Poll this from your server and fulfil the order once state is completed.
string
required
The session ID.
Response
object
Show properties
string
The session ID.
string
open, processing, completed, cancelled or expired. Only completed means paid.
object
minorUnits and currency.
string
ISO 3166-1 alpha-2.
string | null
Your business’s verified name, as shown to the payer.
string
test or live.
string[]
Methods the payer can use.
string | null
The payment, once one has been made.
boolean
While processing: held for a compliance review. Nothing charged yet.
object[]
Each attempt’s method, outcome (pending, processing, succeeded, declined or errored) and declineCode.
integer
Epoch milliseconds.
integer
Epoch milliseconds. A processing session doesn’t expire.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Talescria","colors":{"primary":"#FF6600","light":"#FF9A32","dark":"#E65C00"},"logo":{"light":"https://mintcdn.com/talescria/itDUVhw6qT1GpDxp/logo/light.svg?fit=max\u0026auto=format\u0026n=itDUVhw6qT1GpDxp\u0026q=85\u0026s=1783c16919171f6b1f28c928fecc3a63","dark":"https://mintcdn.com/talescria/itDUVhw6qT1GpDxp/logo/dark.svg?fit=max\u0026auto=format\u0026n=itDUVhw6qT1GpDxp\u0026q=85\u0026s=bdeff1708e4347fc28b219c66345aefc","href":"https://talescria.com"},"favicon":"https://mintcdn.com/talescria/itDUVhw6qT1GpDxp/favicon.svg?fit=max\u0026auto=format\u0026n=itDUVhw6qT1GpDxp\u0026q=85\u0026s=bc42be5a40be869a36b295ba829bcf39","api":{"playground":{"display":"interactive"},"examples":{"languages":["curl","python","javascript"]}},"navbar":{"primary":{"type":"button","label":"Dashboard","href":"https://talescria.com/login"}},"footer":{"socials":{"website":"https://talescria.com"}},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"talescria","hasAudioNarration":false,"actualSubdomain":"talescria","customDomains":["docs.talescria.com"],"gitSource":{"type":"github","owner":"talescrya","repo":"documentation","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":"","_id":"6afc888f097841e8df51a72b"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6afc8900097841e8df51b73a","clientVersion":"0.0.4177","searchFilterCounts":[{"language":"default","tag":"API reference","count":39},{"language":"default","tag":"Documentation","count":16},{"language":"default","tag":"Invoices","count":10},{"language":"default","tag":"Recipients","count":6},{"language":"default","tag":"Core concepts","count":5},{"language":"default","tag":"Customers","count":5},{"language":"default","tag":"Payments","count":5},{"language":"default","tag":"Pay out","count":4},{"language":"default","tag":"Get paid","count":4},{"language":"default","tag":"Payment links","count":4}]},"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":"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":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/checkout/retrieve-a-session","slug":"/api-reference/checkout/retrieve-a-session","pageMetadata":{"title":"Retrieve a checkout session","api":"GET https://pay.talescria.com/v1/sessions/{id}","description":"Check whether a checkout session has been paid.","authMethod":"none","href":"/api-reference/checkout/retrieve-a-session"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Check whether a checkout session has been paid.\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{Expandable,Heading,ParamField,ResponseField,Table}=_components;if(!Expandable)_missingMdxReference(`Expandable`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Returns a session as it stands. No credential is needed: the session ID is the key. Poll this from your server and fulfil the order once `,_jsx(_components.code,{children:`state`}),` is `,_jsx(_components.code,{children:`completed`}),`.`]}),`\n`,_jsx(ParamField,{path:`id`,type:`string`,required:true,id:`param-id`,children:_jsx(_components.p,{children:`The session ID.`})}),`\n`,_jsx(Heading,{level:`3`,id:`response`,children:`Response`}),`\n`,_jsx(ResponseField,{name:`session`,type:`object`,id:`param-session`,children:_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`id`,type:`string`,id:`param-id-1`,children:`The session ID.`}),_jsx(ResponseField,{name:`state`,type:`string`,id:`param-state`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`open`}),`, `,_jsx(_components.code,{children:`processing`}),`, `,_jsx(_components.code,{children:`completed`}),`, `,_jsx(_components.code,{children:`cancelled`}),` or `,_jsx(_components.code,{children:`expired`}),`. Only `,_jsx(_components.code,{children:`completed`}),` means paid.`]})}),_jsxs(ResponseField,{name:`amount`,type:`object`,id:`param-amount`,children:[_jsx(_components.code,{children:`minorUnits`}),` and `,_jsx(_components.code,{children:`currency`}),`.`]}),_jsx(ResponseField,{name:`country`,type:`string`,id:`param-country`,children:`ISO 3166-1 alpha-2.`}),_jsx(ResponseField,{name:`merchantName`,type:`string | null`,id:`param-merchant-name`,children:`Your business’s verified name, as shown to the payer.`}),_jsxs(ResponseField,{name:`environment`,type:`string`,id:`param-environment`,children:[_jsx(_components.code,{children:`test`}),` or `,_jsx(_components.code,{children:`live`}),`.`]}),_jsx(ResponseField,{name:`availableMethods`,type:`string[]`,id:`param-available-methods`,children:`Methods the payer can use.`}),_jsx(ResponseField,{name:`paymentId`,type:`string | null`,id:`param-payment-id`,children:`The payment, once one has been made.`}),_jsxs(ResponseField,{name:`underReview`,type:`boolean`,id:`param-under-review`,children:[`While `,_jsx(_components.code,{children:`processing`}),`: held for a compliance review. Nothing charged yet.`]}),_jsx(ResponseField,{name:`attempts`,type:`object[]`,id:`param-attempts`,children:_jsxs(_components.p,{children:[`Each attempt’s `,_jsx(_components.code,{children:`method`}),`, `,_jsx(_components.code,{children:`outcome`}),` (`,_jsx(_components.code,{children:`pending`}),`, `,_jsx(_components.code,{children:`processing`}),`, `,_jsx(_components.code,{children:`succeeded`}),`, `,_jsx(_components.code,{children:`declined`}),` or `,_jsx(_components.code,{children:`errored`}),`) and `,_jsx(_components.code,{children:`declineCode`}),`.`]})}),_jsx(ResponseField,{name:`createdAt`,type:`integer`,id:`param-created-at`,children:`Epoch milliseconds.`}),_jsxs(ResponseField,{name:`expiresAt`,type:`integer`,id:`param-expires-at`,children:[`Epoch milliseconds. A `,_jsx(_components.code,{children:`processing`}),` session doesn’t expire.`]}),_jsx(ResponseField,{name:`updatedAt`,type:`integer`,id:`param-updated-at`,children:`Epoch milliseconds.`})]})}),`\n`,_jsx(Heading,{level:`3`,id:`errors`,children:`Errors`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Status`}),_jsx(_components.th,{children:`Code`}),_jsx(_components.th,{children:`Meaning`})]})}),_jsx(_components.tbody,{children:_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`404`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`NOT_FOUND`})}),_jsx(_components.td,{children:`No such session.`})]})})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Retrieve a checkout session","api":"GET https://pay.talescria.com/v1/sessions/{id}","description":"Check whether a checkout session has been paid.","authMethod":"none","href":"/api-reference/checkout/retrieve-a-session"}}},"mdxSourceWithNoJs":null,"noJsSplices":[[199,217,"pre:`pre`,span:`span`,tbody:`tbody`,td:`"],[297,359,"CodeBlock,Expandable,Heading,ParamField,RequestExample,ResponseField,Table}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true)"],[525,542,"questExample)_missingMdxReference(`RequestExample`,true);if(!ResponseField)_miss"],[4376,4391,",`\n`,_jsxs(RequestExample,{children:[_jsx(CodeBlock,{filename:`curl`,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://pay.talescria.com/v1/sessions/chk_3f6e2c1a-…`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`Python`,numberOfLines:`3`,language:`python`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`python`,children:_jsxs(_components.code,{language:`python`,numberOfLines:`3`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`resp `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` requests.get(`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`f`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://pay.talescria.com/v1/sessions/`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`{`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`session_id`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`}`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:`timeout`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`30`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`session `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` resp.json()[`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"session\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`]`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`paid `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` session[`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"state\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`] `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`==`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"completed\"`})]}),`\n`]})})})]})]})}function MD"]]},"mdxExtracts":{"tableOfContents":[{"title":"Response","slug":"response","depth":3,"children":[]},{"title":"Errors","slug":"errors","depth":3,"children":[]}],"codeExamples":{"request":{"type":"RequestExample","children":[{"filename":"curl","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"shellscript\">\u003ccode language=\"shellscript\" numberOfLines=\"1\">\u003cspan class=\"line\">\u003cspan style=\"color:#953800;--shiki-dark:#DCDCAA\">curl\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> https://pay.talescria.com/v1/sessions/chk_3f6e2c1a-…\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"},{"filename":"Python","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"python\">\u003ccode language=\"python\" numberOfLines=\"3\">\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">resp \u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D4D4D4\">=\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> requests.get(\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#569CD6\">f\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"https://pay.talescria.com/v1/sessions/\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#569CD6\">{\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">session_id\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#569CD6\">}\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">, \u003c/span>\u003cspan style=\"color:#953800;--shiki-dark:#9CDCFE\">timeout\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D4D4D4\">=\u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">30\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">)\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">session \u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D4D4D4\">=\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> resp.json()[\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"session\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">]\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">paid \u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D4D4D4\">=\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> session[\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"state\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">] \u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D4D4D4\">==\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"completed\"\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"}],"attributes":[]}},"endpoint":{"title":"Retrieve a checkout session","path":"/v1/sessions/{id}","servers":[{"url":"https://pay.talescria.com"}],"method":"get","request":{"security":[],"parameters":{"query":{},"header":{},"cookie":{},"path":{"id":{"schema":[{"type":"string","description":"The session ID.","required":true}]}}},"body":{}},"response":{"200":{"application/json":{"schemaArray":[{"type":"object","properties":{"session":[{"type":"object","properties":{"id":[{"type":"string","description":"The session ID."}],"state":[{"type":"string","description":"`open` , `processing` , `completed` , `cancelled` or `expired` . Only `completed` means paid."}],"amount":[{"type":"object","properties":{},"description":"`minorUnits` and `currency` ."}],"country":[{"type":"string","description":"ISO 3166-1 alpha-2."}],"merchantName":[{"type":"object","properties":{},"description":"Your business’s verified name, as shown to the payer."}],"environment":[{"type":"string","description":"`test` or `live` ."}],"availableMethods":[{"type":"array","items":[{"type":"string"}],"description":"Methods the payer can use."}],"paymentId":[{"type":"object","properties":{},"description":"The payment, once one has been made."}],"underReview":[{"type":"boolean","description":"While `processing` : held for a compliance review. Nothing charged yet."}],"attempts":[{"type":"array","items":[{"type":"object","properties":{}}],"description":"Each attempt’s `method` , `outcome` ( `pending` , `processing` , `succeeded` , `declined` or `errored` ) and `declineCode` ."}],"createdAt":[{"type":"integer","description":"Epoch milliseconds."}],"expiresAt":[{"type":"integer","description":"Epoch milliseconds. A `processing` session doesn’t expire."}],"updatedAt":[{"type":"integer","description":"Epoch milliseconds."}]}}]}}],"examples":{"example":{"value":{"session":{"id":"\u003cstring>","state":"\u003cstring>","amount":{},"country":"\u003cstring>","merchantName":{},"environment":"\u003cstring>","availableMethods":["\u003cstring>"],"paymentId":{},"underReview":true,"attempts":[{}],"createdAt":123,"expiresAt":123,"updatedAt":123}}}}}}},"deprecated":false}},"jsLinks":[],"subdomain":"talescria","siteName":"Talescria","title":"Retrieve a checkout session - Talescria","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-17T17:04:08.648Z","originalFileLocation":"api-reference/checkout/retrieve-a-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=\"Check whether a checkout session has been paid.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Talescria\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/talescria/Y1lJeoVQyIA6Yog1/_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/talescria/Y1lJeoVQyIA6Yog1/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/talescria/Y1lJeoVQyIA6Yog1/_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/talescria/Y1lJeoVQyIA6Yog1/_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/talescria/Y1lJeoVQyIA6Yog1/_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/talescria/Y1lJeoVQyIA6Yog1/_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/talescria/Y1lJeoVQyIA6Yog1/_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/talescria/Y1lJeoVQyIA6Yog1/_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/talescria/Y1lJeoVQyIA6Yog1/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Retrieve a checkout session - Talescria\">\u003cmeta data-mint-head property=\"og:description\" content=\"Check whether a checkout session has been paid.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Talescria\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.talescria.com/api-reference/checkout/retrieve-a-session\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://talescria.mintlify.site/_mintlify/api/og/v2?division=Checkout\u0026amp;title=Retrieve+a+checkout+session\u0026amp;description=Check+whether+a+checkout+session+has+been+paid.\u0026amp;theme=6c6e5c86e601a0971e5ce304\u0026amp;signature=3cf525f2ced2eeed69c6d805c39b1f4187b2397a989501bdb0520b27adf42466\">\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=\"Retrieve a checkout session - Talescria\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Check whether a checkout session has been paid.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://talescria.mintlify.site/_mintlify/api/og/v2?division=Checkout\u0026amp;title=Retrieve+a+checkout+session\u0026amp;description=Check+whether+a+checkout+session+has+been+paid.\u0026amp;theme=6c6e5c86e601a0971e5ce304\u0026amp;signature=3cf525f2ced2eeed69c6d805c39b1f4187b2397a989501bdb0520b27adf42466\">\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/talescria/Y1lJeoVQyIA6Yog1/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Talescria\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#FF6600\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.talescria.com/api-reference/checkout/retrieve-a-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/retrieve-a-session.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.talescria.com/#organization\",\"name\":\"Talescria\",\"url\":\"https://docs.talescria.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/talescria/itDUVhw6qT1GpDxp/logo/light.svg?fit=max\u0026auto=format\u0026n=itDUVhw6qT1GpDxp\u0026q=85\u0026s=1783c16919171f6b1f28c928fecc3a63\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.talescria.com#website\",\"name\":\"Talescria\",\"url\":\"https://docs.talescria.com\",\"publisher\":{\"@id\":\"https://docs.talescria.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.talescria.com/api-reference/checkout/retrieve-a-session#webpage\",\"url\":\"https://docs.talescria.com/api-reference/checkout/retrieve-a-session\",\"name\":\"Retrieve a checkout session\",\"description\":\"Check whether a checkout session has been paid.\",\"dateModified\":\"2026-11-17T17:04:08.648Z\",\"isPartOf\":{\"@id\":\"https://docs.talescria.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.talescria.com/api-reference/checkout/retrieve-a-session#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.talescria.com/api-reference/checkout/retrieve-a-session#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Checkout\",\"item\":\"https://docs.talescria.com/api-reference/checkout/create-a-session\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Retrieve a checkout session\",\"item\":\"https://docs.talescria.com/api-reference/checkout/retrieve-a-session\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.talescria.com/api-reference/checkout/retrieve-a-session#apireference\",\"headline\":\"Retrieve a checkout session\",\"name\":\"Retrieve a checkout session\",\"description\":\"Check whether a checkout session has been paid.\",\"url\":\"https://docs.talescria.com/api-reference/checkout/retrieve-a-session\",\"mainEntityOfPage\":{\"@id\":\"https://docs.talescria.com/api-reference/checkout/retrieve-a-session#webpage\"},\"dateModified\":\"2026-11-17T17:04:08.648Z\",\"publisher\":{\"@id\":\"https://docs.talescria.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.talescria.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Talescria\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Talescria\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/checkout/retrieve-a-session.md","siteName":"Talescria","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":""}]},{"tab":"API reference","groups":[{"group":"Authentication","pages":[{"title":"API reference","href":"/api-reference/introduction"},{"title":"Get an access token","api":"POST https://idp.talescria.com/oauth/token","href":"/api-reference/get-an-access-token"}]},{"group":"Accounts","pages":[{"title":"List accounts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/accounts","href":"/api-reference/accounts/list-accounts"},{"title":"Open an account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/accounts","href":"/api-reference/accounts/open-an-account"}]},{"group":"Recipients","pages":[{"title":"List recipients","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/recipients","href":"/api-reference/recipients/list-recipients"},{"title":"Create a recipient","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/recipients","href":"/api-reference/recipients/create-a-recipient"},{"title":"Retrieve a recipient","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/recipients/{recipientId}","href":"/api-reference/recipients/retrieve-a-recipient"},{"title":"Add a destination","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/recipients/{recipientId}/destinations","href":"/api-reference/recipients/add-a-destination"},{"title":"Get destination requirements","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/destination-requirements","href":"/api-reference/recipients/get-destination-requirements"},{"title":"List banks","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/banks","href":"/api-reference/recipients/list-banks"}]},{"group":"Payments","pages":[{"title":"List payment reasons","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/transfer-reasons","href":"/api-reference/payments/list-payment-reasons"},{"title":"Create an FX quote","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/fx-quotes","href":"/api-reference/payments/create-an-fx-quote"},{"title":"Retrieve an FX quote","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/fx-quotes/{quoteId}","href":"/api-reference/payments/retrieve-an-fx-quote"},{"title":"Send a payment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/transfers","href":"/api-reference/payments/send-a-payment"},{"title":"Retrieve a payment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/transfers/{transferId}","href":"/api-reference/payments/retrieve-a-payment"}]},{"group":"Transfers","pages":[{"title":"Quote a transfer between your accounts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/conversions/quotes","href":"/api-reference/transfers/quote-a-transfer-between-your-accounts"},{"title":"Transfer between your accounts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/conversions","href":"/api-reference/transfers/transfer-between-your-accounts"},{"title":"Retrieve a transfer between your accounts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/conversions/{conversionId}","href":"/api-reference/transfers/retrieve-a-transfer-between-your-accounts"}]},{"group":"Payment links","pages":[{"title":"List payment links","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/payment-links","href":"/api-reference/payment-links/list-payment-links"},{"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":"Retrieve a payment link","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/payment-links/{linkId}","href":"/api-reference/payment-links/retrieve-a-payment-link"},{"title":"Archive a payment link","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/payment-links/{linkId}/archive","href":"/api-reference/payment-links/archive-a-payment-link"}]},{"group":"Customers","pages":[{"title":"List customers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/customers","href":"/api-reference/customers/list-customers"},{"title":"Create a customer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/customers","href":"/api-reference/customers/create-a-customer"},{"title":"Retrieve a customer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/customers/{customerId}","href":"/api-reference/customers/retrieve-a-customer"},{"title":"Update a customer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v1/customers/{customerId}","href":"/api-reference/customers/update-a-customer"},{"title":"Delete a customer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v1/customers/{customerId}","href":"/api-reference/customers/delete-a-customer"}]},{"group":"Invoices","pages":[{"title":"List invoices","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/invoices","href":"/api-reference/invoices/list-invoices"},{"title":"Create an invoice","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/invoices","href":"/api-reference/invoices/create-an-invoice"},{"title":"Preview the next invoice number","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/invoices/next-number","href":"/api-reference/invoices/preview-the-next-invoice-number"},{"title":"Retrieve an invoice","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/invoices/{invoiceId}","href":"/api-reference/invoices/retrieve-an-invoice"},{"title":"Void an invoice","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/invoices/{invoiceId}/void","href":"/api-reference/invoices/void-an-invoice"},{"title":"Resend an invoice","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/invoices/{invoiceId}/send","href":"/api-reference/invoices/resend-an-invoice"},{"title":"List recurring series","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/invoice-series","href":"/api-reference/invoices/list-recurring-series"},{"title":"Create a recurring series","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/invoice-series","href":"/api-reference/invoices/create-a-recurring-series"},{"title":"Retrieve a recurring series","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/invoice-series/{seriesId}","href":"/api-reference/invoices/retrieve-a-recurring-series"},{"title":"Cancel a recurring series","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/invoice-series/{seriesId}/cancel","href":"/api-reference/invoices/cancel-a-recurring-series"}]},{"group":"Checkout","pages":[{"title":"Create a checkout session","api":"POST https://pay.talescria.com/v1/sessions","description":"Start a hosted payment page for an amount your server sets.","href":"/api-reference/checkout/create-a-session"},{"title":"Retrieve a checkout session","api":"GET https://pay.talescria.com/v1/sessions/{id}","href":"/api-reference/checkout/retrieve-a-session"}]}]}]},"basePath":"","title":"Retrieve a checkout session - Talescria","deploymentId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","buildId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff"],"chunks":["OpenApiReferenceProvider-jJHA3WSo.js","utils-DbZn3Mjn.js","cloneDeep-CnBnaSyy.js","_Uint8Array-CMQtTgBR.js","isObject-FP1Yky1u.js","utils-Bl2DvzOJ.js","addUniqueKeysToSchema-BwOLo9p1.js","snippetPresets-BBiPpKa-.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-C0px4Tml.js","isEqual-zAyttAAO.js","usePlaygroundInputsStore-Dell6dGw.js","shallow-0VKqkSqN.js","getApiPlaygroundDisplay-CP_ctPEB.js","CodeSnippet-5L35ic0s.js","CodeSnippets-DOXbNhJw.js","Page-DRLI_2Ue.js","getPastedJson-VhzT9m2P.js","icon-CD8_AtCO.js","MethodPill-DGgOMftG.js","DuplicateIcon-DZ6A_EtN.js","createIcon-DUl4oM5f.js","DynamicMarkdown-BGHukeRM.js","SectionHeading-ChrEUs8u.js","axios-vUo_bRtp.js"]}