{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Kalixo Developers","description":"Developer documentation for Kalixo: the Distribution API (catalog, ordering and wallet) and Kalixo Checkout (payments with Kalixo as merchant of record).","colors":{"primary":"#c9f73a","light":"#c9f73a","dark":"#c9f73a"},"logo":{"light":"https://mintcdn.com/kalixo-3d06b8ab/i1gWPLf-7UA5aCX4/logo/kalixo-black.svg?fit=max\u0026auto=format\u0026n=i1gWPLf-7UA5aCX4\u0026q=85\u0026s=10cb3de56b003645223ff09a03738f0d","dark":"https://mintcdn.com/kalixo-3d06b8ab/i1gWPLf-7UA5aCX4/logo/kalixo-white.svg?fit=max\u0026auto=format\u0026n=i1gWPLf-7UA5aCX4\u0026q=85\u0026s=3ee9e307d7b82e8aba826a034600d79e","href":"https://developer.kalixo.io"},"favicon":"https://mintcdn.com/kalixo-3d06b8ab/0ntOkvykKU-c41Xj/favicon.ico?fit=max\u0026auto=format\u0026n=0ntOkvykKU-c41Xj\u0026q=85\u0026s=01818a4ce05801b7068c62aab761e615","api":{"playground":{"display":"interactive"},"examples":{"languages":["bash","javascript","python","php"]}},"appearance":{"default":"dark","strict":false},"background":{"color":{"light":"#ffffff","dark":"#0a0c03"}},"navbar":{"links":[{"href":"mailto:[email protected]","label":"Support"},{"href":"/quickstart#postman-collection","label":"Postman"}],"primary":{"type":"button","label":"Get API keys","href":"mailto:[email protected]"}},"footer":{"socials":{"website":"https://kalixo.io","linkedin":"https://www.linkedin.com/company/kalixo"}},"search":{"prompt":"Search the Kalixo developer docs"},"styling":{"eyebrows":"section","codeblocks":"dark","latex":false},"contextual":{"options":["copy","view","chatgpt","claude","download-spec"],"display":"header"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"kalixo-3d06b8ab","hasAudioNarration":false,"actualSubdomain":"kalixo-3d06b8ab","customDomains":["developer.kalixo.io"],"gitSource":{"type":"github","owner":"fhp-developers","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6af3b1d7d80155e0099b7ee8","clientVersion":"0.0.4102","searchFilterCounts":[{"language":"default","tag":"Checkout","count":60},{"language":"default","tag":"API reference","count":48},{"language":"default","tag":"Endpoints","count":46},{"language":"default","tag":"Guides","count":38},{"language":"default","tag":"Distribution API","count":26},{"language":"default","tag":"Core concepts","count":18},{"language":"default","tag":"Get started","count":10},{"language":"default","tag":"Webhook endpoints","count":6},{"language":"default","tag":"Accept payments","count":5},{"language":"default","tag":"Checkout sessions","count":5}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"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":[{"filePath":"custom.css","content":":root{--kalixo-50: #f4fdd8;--kalixo-100: #f4fdd8;--kalixo-200: #e9fcb0;--kalixo-300: #dffa89;--kalixo-400: #d4f961;--kalixo-500: #c9f73a;--kalixo-600: #a1c62e;--kalixo-700: #799423;--kalixo-800: #506317;--kalixo-900: #28310c;--kalixo-950: #0a0c03;--kalixo-border-light: color-mix(in srgb, var(--kalixo-500) 25%, #e5e7eb)}#topbar-cta-button a,#topbar-cta-button a *,a:has(>.bg-primary-dark) .text-white,button:has(>.bg-primary-dark) .text-white,.bg-primary-dark.text-white{color:var(--kalixo-950)!important}.tryit-button{background-color:var(--kalixo-500)!important;color:var(--kalixo-950)!important}.tryit-button svg.bg-white{background-color:var(--kalixo-950)!important}html:not(.dark) #navbar{background-color:#ffffff;border-bottom:1px solid var(--kalixo-border-light)}html:not(.dark) #sidebar{background-color:#ffffff;border-right:1px solid var(--kalixo-border-light)}html:not(.dark) .text-primary,html:not(.dark) .group:hover .group-hover\\:text-primary{color:var(--kalixo-950)}html:not(.dark) svg.bg-primary:not(.bg-codeblock *){background-color:var(--kalixo-950)}html:not(.dark) #sidebar-content li[data-active]>a{background-color:transparent;color:inherit}html:not(.dark) #sidebar-content li[data-active]:not(:has(li[data-active]))>a{background-color:var(--kalixo-500);color:var(--kalixo-950)}html:not(.dark) .sidebar-group[data-active] .sidebar-group-header{background-color:transparent}html:not(.dark) #sidebar-content a:hover{color:var(--kalixo-950)}html:not(.dark) .nav-tabs-item>.bg-primary{height:2px}html:not(.dark) .bg-codeblock [role=\"menuitem\"]:hover,html:not(.dark) .bg-codeblock [role=\"menuitem\"]:focus-visible{color:#ffffff!important;background-color:rgba(255, 255, 255, 0.08)!important}html:not(.dark) .bg-codeblock [role=\"menuitem\"]:hover *,html:not(.dark) .bg-codeblock [role=\"menuitem\"]:focus-visible *{color:inherit!important}html:not(.dark) .bg-codeblock [role=\"menuitem\"][data-active=\"true\"]{color:var(--kalixo-500)!important}html:not(.dark) .bg-codeblock [role=\"menuitem\"][data-active=\"true\"] *{color:inherit!important}.dark #sidebar-content li[data-active]>a{background-color:transparent}.dark #sidebar-content li[data-active]:not(:has(li[data-active]))>a{background-color:color-mix(in srgb, var(--kalixo-500) 14%, transparent)}.dark .sidebar-group[data-active] .sidebar-group-header{background-color:transparent}"}],"page":{"pagePath":"checkout/api-reference/payment-links/retrieve-a-payment-link","slug":"/checkout/api-reference/payment-links/retrieve-a-payment-link","pageMetadata":{"title":"Retrieve a payment link","description":null,"deprecated":null,"version":null,"openapi":"/checkout/openapi.yaml get /v1/payment-links/{id}","href":"/checkout/api-reference/payment-links/retrieve-a-payment-link","autogeneratedByOpenApi":true},"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":{"codeStyling":"dark","config":{},"pageMetadata":{"title":"Retrieve a payment link","description":null,"deprecated":null,"version":null,"openapi":"/checkout/openapi.yaml get /v1/payment-links/{id}","href":"/checkout/api-reference/payment-links/retrieve-a-payment-link","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/kalixo-3d06b8ab/685272f2d8ab6aee/examples/kalixo-node/client.js"],"openApiReferenceData":{"operation":{"tags":["Payment links"],"operationId":"retrievePaymentLink","summary":"Retrieve a payment link","responses":{"200":"74774689-23a2-438e-bea6-dc241e755289","default":"b7bff84c-e43f-46d6-9d4e-a1ad95074ad5"},"method":"get","type":"path","servers":["f7cd16a5-4f68-4758-a688-df284f2f2b13","221ed64b-73ec-48f6-aee7-ef389c521dc8"],"security":["bfd8595c-fcc2-4201-be07-405ba370af4d"],"path":"/v1/payment-links/{id}","baseUrlOptions":["https://checkout.kalixo.io","https://sandbox.checkout.kalixo.io"],"title":"Retrieve a payment link","description":"","codeSamples":[],"requestExampleLanguages":["bash","javascript","python","php"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"cc4d43fa-cf75-4e46-9a36-ef884387bc04":{"name":"id","in":"path","required":true,"schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"responses":{"74774689-23a2-438e-bea6-dc241e755289":{"description":"The payment link.","content":{"application/json":{"schema":{"type":"object","required":["id","object","url","status","amount","currency","country","reference","reusable","capture_method","created_at","metadata"],"properties":{"id":{"type":"string","examples":["plink_01JABCDEF"],"isRequired":true,"uniqueKey":"id","typeLabel":"string"},"object":{"type":"string","const":"payment_link","isRequired":true,"uniqueKey":"object","typeLabel":"string"},"url":{"type":"string","format":"uri","isRequired":true,"uniqueKey":"url","typeLabel":"string\u003curi>"},"status":{"type":"string","enum":["active","inactive","completed","expired"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"amount":{"type":"integer","format":"int64","minimum":0,"description":"Amount in the currency's minor unit.","isRequired":true,"uniqueKey":"amount","typeLabel":"integer\u003cint64>"},"currency":{"type":"string","pattern":"^[A-Z]{3}$","description":"ISO 4217 currency code, uppercase.","examples":["EUR"],"isRequired":true,"uniqueKey":"currency","typeLabel":"string"},"country":{"type":"string","pattern":"^[A-Z]{2}$","description":"ISO 3166-1 alpha-2 country code of the shopper.","examples":["NL"],"isRequired":true,"uniqueKey":"country","typeLabel":"string"},"reference":{"type":"string","isRequired":true,"uniqueKey":"reference","typeLabel":"string"},"reusable":{"type":"boolean","description":"If true the link can be paid more than once.","isRequired":true,"uniqueKey":"reusable","typeLabel":"boolean"},"capture_method":{"type":"string","enum":["automatic","manual"],"isRequired":true,"uniqueKey":"capture_method","typeLabel":"enum\u003cstring>"},"metadata":{"type":"object","description":"Up to 50 keys. Keys up to 40 characters, values up to 500 characters. Echoed back unchanged.","additionalProperties":{"type":"string","maxLength":500,"uniqueKey":"metadata.additionalProperties","typeLabel":"string"},"maxProperties":50,"isRequired":true,"uniqueKey":"metadata","typeLabel":"object"},"created_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"description":{"oneOf":[{"type":"string","uniqueKey":"description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"description.oneOf.1","typeLabel":"null"}],"uniqueKey":"description","typeLabel":"string | null"},"return_url":{"oneOf":[{"type":"string","format":"uri","uniqueKey":"return_url.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","uniqueKey":"return_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"return_url","typeLabel":"string\u003curi> | null"},"expires_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"expires_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"expires_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"expires_at","typeLabel":"string\u003cdate-time> | null"},"payments_count":{"type":"integer","uniqueKey":"payments_count","typeLabel":"integer"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"plink_01JABCDEF","object":"payment_link","url":"\u003cstring>","status":"active","amount":1,"currency":"EUR","country":"NL","reference":"\u003cstring>","reusable":true,"capture_method":"automatic","metadata":{},"created_at":"2023-11-07T05:31:56Z","description":"\u003cstring>","return_url":"\u003cstring>","expires_at":"2023-11-07T05:31:56Z","payments_count":123}}},"exampleType":"generated"}},"exampleType":"generated"},"b7bff84c-e43f-46d6-9d4e-a1ad95074ad5":{"description":"Error.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["type","code","message","request_id"],"properties":{"type":{"type":"string","enum":["invalid_request_error","authentication_error","permission_error","not_found_error","idempotency_error","payment_error","rate_limit_error","api_error"],"isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","examples":["amount_locked"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"decline_code":{"oneOf":[{"type":"string","uniqueKey":"error.decline_code.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"error.decline_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.decline_code","typeLabel":"string | null"},"param":{"oneOf":[{"type":"string","uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.param","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"type":"invalid_request_error","code":"amount_locked","message":"\u003cstring>","request_id":"\u003cstring>","decline_code":"\u003cstring>","param":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"bfd8595c-fcc2-4201-be07-405ba370af4d":{"secretKey":{"type":"http","scheme":"bearer","description":"Secret key, `kc_sk_test_...` or `kc_sk_live_...`. Server-side only.","scopes":[],"schemeName":"secretKey"}}},"servers":{"f7cd16a5-4f68-4758-a688-df284f2f2b13":{"url":"https://checkout.kalixo.io","description":"Live"},"221ed64b-73ec-48f6-aee7-ef389c521dc8":{"url":"https://sandbox.checkout.kalixo.io","description":"Sandbox (test keys only, connected to the provider test environment)"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Secret key, `kc_sk_test_...` or `kc_sk_live_...`. Server-side only.","scopes":[],"schemeName":"secretKey"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Secret key, `kc_sk_test_...` or `kc_sk_live_...`. Server-side only.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"secretKey","name":"Authorization"}],"title":"secretKey"}]},"originalFileLocation":"checkout/openapi.yaml"},"subdomain":"kalixo-3d06b8ab","siteName":"Kalixo Developers","title":"Retrieve a payment link - Kalixo Developers","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-11T00:07:58.233Z","originalFileLocation":"checkout/api-reference/payment-links/retrieve-a-payment-link.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=\"dark\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"Kalixo Developers\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/kalixo-3d06b8ab/8cvpfdOTq_MVvelK/_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/kalixo-3d06b8ab/8cvpfdOTq_MVvelK/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/kalixo-3d06b8ab/8cvpfdOTq_MVvelK/_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/kalixo-3d06b8ab/8cvpfdOTq_MVvelK/_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/kalixo-3d06b8ab/8cvpfdOTq_MVvelK/_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/kalixo-3d06b8ab/8cvpfdOTq_MVvelK/_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/kalixo-3d06b8ab/8cvpfdOTq_MVvelK/_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/kalixo-3d06b8ab/8cvpfdOTq_MVvelK/_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/kalixo-3d06b8ab/8cvpfdOTq_MVvelK/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Retrieve a payment link - Kalixo Developers\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Kalixo Developers\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developer.kalixo.io/checkout/api-reference/payment-links/retrieve-a-payment-link\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://kalixo-3d06b8ab.mintlify.site/_mintlify/api/og/v2?division=Payment+links\u0026amp;title=Retrieve+a+payment+link\u0026amp;theme=56605433751badd6832827d1\u0026amp;signature=f96d614959c85c3f640bbc53effdc8e4c5bec44aba57666a88a812732689fee3\">\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 payment link - Kalixo Developers\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://kalixo-3d06b8ab.mintlify.site/_mintlify/api/og/v2?division=Payment+links\u0026amp;title=Retrieve+a+payment+link\u0026amp;theme=56605433751badd6832827d1\u0026amp;signature=f96d614959c85c3f640bbc53effdc8e4c5bec44aba57666a88a812732689fee3\">\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/kalixo-3d06b8ab/8cvpfdOTq_MVvelK/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Kalixo Developers\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#c9f73a\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developer.kalixo.io/checkout/api-reference/payment-links/retrieve-a-payment-link\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/checkout/api-reference/payment-links/retrieve-a-payment-link.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developer.kalixo.io/#organization\",\"name\":\"Kalixo Developers\",\"url\":\"https://developer.kalixo.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/kalixo-3d06b8ab/i1gWPLf-7UA5aCX4/logo/kalixo-black.svg?fit=max\u0026auto=format\u0026n=i1gWPLf-7UA5aCX4\u0026q=85\u0026s=10cb3de56b003645223ff09a03738f0d\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developer.kalixo.io#website\",\"name\":\"Kalixo Developers\",\"url\":\"https://developer.kalixo.io\",\"publisher\":{\"@id\":\"https://developer.kalixo.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developer.kalixo.io/checkout/api-reference/payment-links/retrieve-a-payment-link#webpage\",\"url\":\"https://developer.kalixo.io/checkout/api-reference/payment-links/retrieve-a-payment-link\",\"name\":\"Retrieve a payment link\",\"dateModified\":\"2026-11-11T00:07:58.233Z\",\"isPartOf\":{\"@id\":\"https://developer.kalixo.io#website\"},\"breadcrumb\":{\"@id\":\"https://developer.kalixo.io/checkout/api-reference/payment-links/retrieve-a-payment-link#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developer.kalixo.io/checkout/api-reference/payment-links/retrieve-a-payment-link#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://developer.kalixo.io/checkout/api-reference/checkout-sessions/list-checkout-sessions\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Payment links\",\"item\":\"https://developer.kalixo.io/checkout/api-reference/payment-links/list-payment-links\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Retrieve a payment link\",\"item\":\"https://developer.kalixo.io/checkout/api-reference/payment-links/retrieve-a-payment-link\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developer.kalixo.io/checkout/api-reference/payment-links/retrieve-a-payment-link#apireference\",\"headline\":\"Retrieve a payment link\",\"name\":\"Retrieve a payment link\",\"url\":\"https://developer.kalixo.io/checkout/api-reference/payment-links/retrieve-a-payment-link\",\"mainEntityOfPage\":{\"@id\":\"https://developer.kalixo.io/checkout/api-reference/payment-links/retrieve-a-payment-link#webpage\"},\"dateModified\":\"2026-11-11T00:07:58.233Z\",\"publisher\":{\"@id\":\"https://developer.kalixo.io/#organization\"},\"isPartOf\":{\"@id\":\"https://developer.kalixo.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Kalixo Developers\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Kalixo Developers\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/checkout/api-reference/payment-links/retrieve-a-payment-link.md","siteName":"Kalixo Developers","nav":{"global":null,"products":[{"product":"Distribution API","icon":"gift","description":"Catalog, ordering and wallet","pages":[{"title":"Distribution API","href":""}]},{"product":"Checkout","icon":"credit-card","description":"Accept payments with Kalixo as merchant of record","tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/checkout"}]},{"tab":"API reference","groups":[{"group":"Overview","pages":[{"title":"API reference","icon":"book","href":"/checkout/api-reference/introduction"}]},{"group":"Endpoints","pages":[{"group":"Checkout sessions","pages":[{"title":"List checkout sessions","deprecated":null,"version":null,"openapi":"/checkout/openapi.yaml get /v1/checkout-sessions","href":"/checkout/api-reference/checkout-sessions/list-checkout-sessions"},{"title":"Create a checkout session","deprecated":null,"version":null,"openapi":"/checkout/openapi.yaml post /v1/checkout-sessions","href":"/checkout/api-reference/checkout-sessions/create-a-checkout-session"},{"title":"Retrieve a checkout session","deprecated":null,"version":null,"openapi":"/checkout/openapi.yaml get /v1/checkout-sessions/{id}","href":"/checkout/api-reference/checkout-sessions/retrieve-a-checkout-session"},{"title":"Update a checkout session","deprecated":null,"version":null,"openapi":"/checkout/openapi.yaml patch /v1/checkout-sessions/{id}","href":"/checkout/api-reference/checkout-sessions/update-a-checkout-session"},{"title":"Expire a checkout session","deprecated":null,"version":null,"openapi":"/checkout/openapi.yaml post /v1/checkout-sessions/{id}/expire","href":"/checkout/api-reference/checkout-sessions/expire-a-checkout-session"}]},{"group":"Payments","pages":[{"title":"List payments","deprecated":null,"version":null,"openapi":"/checkout/openapi.yaml get /v1/payments","href":"/checkout/api-reference/payments/list-payments"},{"title":"Retrieve a payment","deprecated":null,"version":null,"openapi":"/checkout/openapi.yaml get /v1/payments/{id}","href":"/checkout/api-reference/payments/retrieve-a-payment"},{"title":"Capture an authorized payment","deprecated":null,"version":null,"openapi":"/checkout/openapi.yaml post /v1/payments/{id}/capture","href":"/checkout/api-reference/payments/capture-an-authorized-payment"},{"title":"Cancel an authorized payment","deprecated":null,"version":null,"openapi":"/checkout/openapi.yaml post /v1/payments/{id}/cancel","href":"/checkout/api-reference/payments/cancel-an-authorized-payment"}]},{"group":"Refunds","pages":[{"title":"List refunds","deprecated":null,"version":null,"openapi":"/checkout/openapi.yaml get /v1/refunds","href":"/checkout/api-reference/refunds/list-refunds"},{"title":"Refund a captured payment","deprecated":null,"version":null,"openapi":"/checkout/openapi.yaml post /v1/refunds","href":"/checkout/api-reference/refunds/refund-a-captured-payment"},{"title":"Retrieve a refund","deprecated":null,"version":null,"openapi":"/checkout/openapi.yaml get /v1/refunds/{id}","href":"/checkout/api-reference/refunds/retrieve-a-refund"}]},{"group":"Payment links","pages":[{"title":"List payment links","deprecated":null,"version":null,"openapi":"/checkout/openapi.yaml get /v1/payment-links","href":"/checkout/api-reference/payment-links/list-payment-links"},{"title":"Create a payment link","description":"Creates a Kalixo payment link (`https://checkout.kalixo.io/l/:code`). Links\nare independent of the payment provider and keep working after a\nprovider switch.\n","deprecated":null,"version":null,"openapi":"/checkout/openapi.yaml post /v1/payment-links","href":"/checkout/api-reference/payment-links/create-a-payment-link"},{"title":"Retrieve a payment link","deprecated":null,"version":null,"openapi":"/checkout/openapi.yaml get /v1/payment-links/{id}","href":"/checkout/api-reference/payment-links/retrieve-a-payment-link"},{"title":"Deactivate a payment link","description":null,"deprecated":null,"version":null,"openapi":"/checkout/openapi.yaml post /v1/payment-links/{id}/deactivate","href":"/checkout/api-reference/payment-links/deactivate-a-payment-link"}]},{"group":"Customers","pages":[{"title":"List customers","deprecated":null,"version":null,"openapi":"/checkout/openapi.yaml get /v1/customers","href":"/checkout/api-reference/customers/list-customers"},{"title":"Create a customer","deprecated":null,"version":null,"openapi":"/checkout/openapi.yaml post /v1/customers","href":"/checkout/api-reference/customers/create-a-customer"},{"title":"Retrieve a customer","deprecated":null,"version":null,"openapi":"/checkout/openapi.yaml get /v1/customers/{id}","href":"/checkout/api-reference/customers/retrieve-a-customer"},{"title":"List a customer's stored payment methods","deprecated":null,"version":null,"openapi":"/checkout/openapi.yaml get /v1/customers/{id}/payment-methods","href":"/checkout/api-reference/customers/list-a-customers-stored-payment-methods"},{"title":"Detach a stored payment method","deprecated":null,"version":null,"openapi":"/checkout/openapi.yaml delete /v1/customers/{id}/payment-methods/{payment_method_id}","href":"/checkout/api-reference/customers/detach-a-stored-payment-method"}]},{"group":"Disputes","pages":[{"title":"List disputes","deprecated":null,"version":null,"openapi":"/checkout/openapi.yaml get /v1/disputes","href":"/checkout/api-reference/disputes/list-disputes"},{"title":"Retrieve a dispute","deprecated":null,"version":null,"openapi":"/checkout/openapi.yaml get /v1/disputes/{id}","href":"/checkout/api-reference/disputes/retrieve-a-dispute"},{"title":"Upload dispute evidence","deprecated":null,"version":null,"openapi":"/checkout/openapi.yaml post /v1/disputes/{id}/evidence","href":"/checkout/api-reference/disputes/upload-dispute-evidence"}]},{"group":"Events","pages":[{"title":"List events","deprecated":null,"version":null,"openapi":"/checkout/openapi.yaml get /v1/events","href":"/checkout/api-reference/events/list-events"},{"title":"Retrieve an event","deprecated":null,"version":null,"openapi":"/checkout/openapi.yaml get /v1/events/{id}","href":"/checkout/api-reference/events/retrieve-an-event"}]},{"group":"Webhook endpoints","pages":[{"title":"List webhook endpoints","deprecated":null,"version":null,"openapi":"/checkout/openapi.yaml get /v1/webhook-endpoints","href":"/checkout/api-reference/webhook-endpoints/list-webhook-endpoints"},{"title":"Create a webhook endpoint","deprecated":null,"version":null,"openapi":"/checkout/openapi.yaml post /v1/webhook-endpoints","href":"/checkout/api-reference/webhook-endpoints/create-a-webhook-endpoint"},{"title":"Retrieve a webhook endpoint","deprecated":null,"version":null,"openapi":"/checkout/openapi.yaml get /v1/webhook-endpoints/{id}","href":"/checkout/api-reference/webhook-endpoints/retrieve-a-webhook-endpoint"},{"title":"Delete a webhook endpoint","deprecated":null,"version":null,"openapi":"/checkout/openapi.yaml delete /v1/webhook-endpoints/{id}","href":"/checkout/api-reference/webhook-endpoints/delete-a-webhook-endpoint"},{"title":"Update a webhook endpoint","deprecated":null,"version":null,"openapi":"/checkout/openapi.yaml patch /v1/webhook-endpoints/{id}","href":"/checkout/api-reference/webhook-endpoints/update-a-webhook-endpoint"},{"title":"Rotate the signing secret","deprecated":null,"version":null,"openapi":"/checkout/openapi.yaml post /v1/webhook-endpoints/{id}/rotate-secret","href":"/checkout/api-reference/webhook-endpoints/rotate-the-signing-secret"}]},{"group":"Reports","pages":[{"title":"List report exports","deprecated":null,"version":null,"openapi":"/checkout/openapi.yaml get /v1/reports","href":"/checkout/api-reference/reports/list-report-exports"},{"title":"Create a transaction report","deprecated":null,"version":null,"openapi":"/checkout/openapi.yaml post /v1/reports","href":"/checkout/api-reference/reports/create-a-transaction-report"},{"title":"Retrieve a report export","deprecated":null,"version":null,"openapi":"/checkout/openapi.yaml get /v1/reports/{id}","href":"/checkout/api-reference/reports/retrieve-a-report-export"},{"title":"Download a ready report as CSV","deprecated":null,"version":null,"openapi":"/checkout/openapi.yaml get /v1/reports/{id}/download","href":"/checkout/api-reference/reports/download-a-ready-report-as-csv"}]},{"group":"Client","pages":[{"title":"Bootstrap a checkout (Kalixo.js)","deprecated":null,"version":null,"openapi":"/checkout/openapi.yaml get /v1/client/checkout-sessions/{id}","href":"/checkout/api-reference/client/bootstrap-a-checkout-kalixojs"},{"title":"Submit a payment attempt (Kalixo.js)","deprecated":null,"version":null,"openapi":"/checkout/openapi.yaml post /v1/client/checkout-sessions/{id}/attempts","href":"/checkout/api-reference/client/submit-a-payment-attempt-kalixojs"},{"title":"Submit additional details for an attempt (Kalixo.js)","deprecated":null,"version":null,"openapi":"/checkout/openapi.yaml post /v1/client/attempts/{id}/details","href":"/checkout/api-reference/client/submit-additional-details-for-an-attempt-kalixojs"}]},{"group":"API Reference","pages":[{"title":"Kalixo event delivery","version":null,"deprecated":null,"openapi":"/checkout/openapi.yaml webhook event","href":"/checkout/api-reference/kalixo-event-delivery"}]}]}]}]}]},"basePath":"","title":"Retrieve a payment link - Kalixo Developers","buildId":"dpl_596ePT575z4qnAFksq1biRW97aLY","deploymentId":"dpl_596ePT575z4qnAFksq1biRW97aLY","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C9Wu0MeN.js","utils-jWgu-6Qf.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DBD8f9qn.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BGuX1ui5.js","snippetPresets-Evy63nQB.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BQHO1lnV.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-B6C8m-t_.js","shallow-BG4cT0fH.js","getApiPlaygroundDisplay-CgEPrE-D.js","CodeSnippet-CU8JyZ9N.js","CodeSnippets-BnxHU32T.js","Page-D6S0Yh6q.js","getPastedJson-CwiYOonh.js","icon-DYDpWmDf.js","MethodPill-C-J-l7_c.js","DuplicateIcon-B6ARwg9w.js","createIcon-Dsv4MtDq.js","DynamicMarkdown-CtasenyM.js","SectionHeading-YNcgYwjB.js","axios-vUo_bRtp.js","Markdown-CwLx6PAg.js","clsx-C3kuh_dz.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CmKHfscc.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-U3mI6Ljh.js"]}