{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Payoes","description":"Developer-first payment infrastructure for the Stellar ecosystem.","colors":{"primary":"#054fbf","light":"#e8f0fc","dark":"#043a99"},"logo":{"light":"https://mintcdn.com/payoes/ptmnJFUfenWl0Sc9/images/logo-full.png?fit=max\u0026auto=format\u0026n=ptmnJFUfenWl0Sc9\u0026q=85\u0026s=96cc6064017fe015475612b0c7758624","dark":"https://mintcdn.com/payoes/ptmnJFUfenWl0Sc9/images/logo-full.png?fit=max\u0026auto=format\u0026n=ptmnJFUfenWl0Sc9\u0026q=85\u0026s=96cc6064017fe015475612b0c7758624"},"favicon":"https://mintcdn.com/payoes/smEKUpTtu-RmFsZj/images/logo.svg?fit=max\u0026auto=format\u0026n=smEKUpTtu-RmFsZj\u0026q=85\u0026s=c39d105446febe87ceddac19404166d1","api":{"openapi":"openapi/v1.yaml","mdx":{"auth":{"method":"bearer"}}},"appearance":{"default":"light","strict":true},"navbar":{"links":[]},"footer":{"socials":{}},"contextual":{"options":["copy","view"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"payoes","hasAudioNarration":false,"actualSubdomain":"payoes","customDomains":["docs.payoes.com"],"gitSource":{"type":"github","owner":"yazidalg","repo":"payoes","deployBranch":"main","contentDirectory":"apps/docs","isPrivate":false,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae95c2e3321ce4af6886b7a:success","clientVersion":"0.0.4088","searchFilterCounts":[{"language":"default","tag":"API Reference","count":16},{"language":"default","tag":"Guides","count":13},{"language":"default","tag":"Payments","count":10},{"language":"default","tag":"Local Setup","count":6},{"language":"default","tag":"Developer guide","count":6},{"language":"default","tag":"Core concepts","count":4},{"language":"default","tag":"Invoices","count":4},{"language":"default","tag":"Customers","count":3},{"language":"default","tag":"Payment links","count":3},{"language":"default","tag":"Get started","count":2}]},"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":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"custom.css","content":"#footer a[href*=\"utm_campaign=poweredBy\"]{display:none!important}:root{--primary: #054fbf;--primary-dark: #043a99}#assistant-entry,#assistant-entry-mobile,#chat-assistant-sheet,.chat-assistant-floating-input{display:none!important}"}],"page":{"pagePath":"api-reference/customers/retrieve-a-customer","slug":"/api-reference/customers/retrieve-a-customer","pageMetadata":{"title":"Retrieve a customer","description":"Returns the customer and their payment history in the current environment.","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml get /customers/{id}","href":"/api-reference/customers/retrieve-a-customer","autogeneratedByOpenApi":true},"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: \"Returns the customer and their payment history in the current environment.\"\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":"Retrieve a customer","description":"Returns the customer and their payment history in the current environment.","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml get /customers/{id}","href":"/api-reference/customers/retrieve-a-customer","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"getCustomer","tags":["Customers"],"summary":"Retrieve a customer","description":"Returns the customer and their payment history in the current environment.","parameters":["449463f2-ec31-4aa8-af59-21a4cecccfd9"],"responses":{"200":"2bc57373-330d-459a-b18f-48af10600f3e","401":"545c5e59-9703-40d6-a6d1-ac6384000f7b","404":"76cf03c6-5183-4b92-825d-74f7b9ae3cdd"},"method":"get","type":"path","servers":["ae523be2-dcea-4c03-8dea-108bc4cf2c2f","40d0733b-414c-4f58-8221-21c435dff5cf"],"security":["092c85cb-caaf-41ec-ab1e-56717e2765ae"],"path":"/customers/{id}","baseUrlOptions":["https://payoes.com/api/v1","http://localhost:3000/api/v1"],"title":"Retrieve a customer","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"449463f2-ec31-4aa8-af59-21a4cecccfd9":{"name":"id","in":"path","required":true,"description":"Public customer ID","schema":{"type":"string","example":"cus_abc123xyz","isRequired":true,"description":"Public customer ID","uniqueKey":"","typeLabel":"string"}}},"responses":{"2bc57373-330d-459a-b18f-48af10600f3e":{"description":"Customer with payment history","content":{"application/json":{"schema":{"type":"object","required":["id","environment","created_at","updated_at"],"properties":{"id":{"type":"string","example":"cus_abc123xyz","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"environment":{"type":"string","enum":["sandbox","production"],"isRequired":true,"uniqueKey":"environment","typeLabel":"enum\u003cstring>"},"created_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"updated_at","typeLabel":"string\u003cdate-time>"},"email":{"oneOf":[{"type":"string","uniqueKey":"email.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"email.oneOf.1","typeLabel":"null"}],"uniqueKey":"email","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","uniqueKey":"name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"name.oneOf.1","typeLabel":"null"}],"uniqueKey":"name","typeLabel":"string | null"},"primary_stellar_address":{"oneOf":[{"type":"string","uniqueKey":"primary_stellar_address.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"primary_stellar_address.oneOf.1","typeLabel":"null"}],"uniqueKey":"primary_stellar_address","typeLabel":"string | null"},"notes":{"oneOf":[{"type":"string","uniqueKey":"notes.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"notes.oneOf.1","typeLabel":"null"}],"uniqueKey":"notes","typeLabel":"string | null"},"metadata":{"oneOf":[{"type":"object","additionalProperties":{"type":"string","uniqueKey":"metadata.oneOf.0.additionalProperties","typeLabel":"string"},"uniqueKey":"metadata.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"type":"string","uniqueKey":"metadata.oneOf.1.additionalProperties","typeLabel":"string"},"uniqueKey":"metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"metadata","typeLabel":"object | null"},"payments":{"type":"array","items":{"type":"object","required":["id","object","amount","settlement_asset","allowed_assets","status","checkout_url","created_at"],"properties":{"id":{"type":"string","example":"pay_nLU2gUDk-v3tdyd6","isRequired":true,"uniqueKey":"payments.items.[INDEX].id","typeLabel":"string"},"object":{"type":"string","enum":["payment_intent"],"isRequired":true,"uniqueKey":"payments.items.[INDEX].object","typeLabel":"enum\u003cstring>"},"amount":{"type":"string","example":"2.0000000","isRequired":true,"uniqueKey":"payments.items.[INDEX].amount","typeLabel":"string"},"settlement_asset":{"type":"object","required":["asset_code"],"properties":{"asset_code":{"type":"string","description":"Stellar asset code (1–12 alphanumeric characters, or XLM)","example":"USDC","isRequired":true,"uniqueKey":"payments.items.[INDEX].settlement_asset.asset_code","typeLabel":"string"},"issuer_address":{"oneOf":[{"type":"string","description":"Issuer public key for credit assets. Null for XLM.","uniqueKey":"payments.items.[INDEX].settlement_asset.issuer_address.oneOf.0","typeLabel":"string"},{"type":"null","description":"Issuer public key for credit assets. Null for XLM.","uniqueKey":"payments.items.[INDEX].settlement_asset.issuer_address.oneOf.1","typeLabel":"null"}],"uniqueKey":"payments.items.[INDEX].settlement_asset.issuer_address","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"payments.items.[INDEX].settlement_asset","typeLabel":"object"},"allowed_assets":{"type":"array","items":{"type":"object","required":["asset_code"],"properties":{"asset_code":{"type":"string","description":"Stellar asset code (1–12 alphanumeric characters, or XLM)","example":"USDC","isRequired":true,"uniqueKey":"payments.items.[INDEX].allowed_assets.items.[INDEX].asset_code","typeLabel":"string"},"issuer_address":{"oneOf":[{"type":"string","description":"Issuer public key for credit assets. Null for XLM.","uniqueKey":"payments.items.[INDEX].allowed_assets.items.[INDEX].issuer_address.oneOf.0","typeLabel":"string"},{"type":"null","description":"Issuer public key for credit assets. Null for XLM.","uniqueKey":"payments.items.[INDEX].allowed_assets.items.[INDEX].issuer_address.oneOf.1","typeLabel":"null"}],"uniqueKey":"payments.items.[INDEX].allowed_assets.items.[INDEX].issuer_address","typeLabel":"string | null"}},"uniqueKey":"payments.items.[INDEX].allowed_assets.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"payments.items.[INDEX].allowed_assets","typeLabel":"object[]"},"status":{"type":"string","enum":["pending","completed","failed","expired"],"isRequired":true,"uniqueKey":"payments.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"checkout_url":{"type":"string","format":"uri","isRequired":true,"uniqueKey":"payments.items.[INDEX].checkout_url","typeLabel":"string\u003curi>"},"created_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"payments.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"paid_asset":{"oneOf":[{"type":"object","description":"Asset the customer actually paid with (set after checkout)","required":["asset_code"],"properties":{"asset_code":{"type":"string","description":"Stellar asset code (1–12 alphanumeric characters, or XLM)","example":"USDC","isRequired":true,"uniqueKey":"payments.items.[INDEX].paid_asset.oneOf.0.asset_code","typeLabel":"string"},"issuer_address":{"oneOf":[{"type":"string","description":"Issuer public key for credit assets. Null for XLM.","uniqueKey":"payments.items.[INDEX].paid_asset.oneOf.0.issuer_address.oneOf.0","typeLabel":"string"},{"type":"null","description":"Issuer public key for credit assets. Null for XLM.","uniqueKey":"payments.items.[INDEX].paid_asset.oneOf.0.issuer_address.oneOf.1","typeLabel":"null"}],"uniqueKey":"payments.items.[INDEX].paid_asset.oneOf.0.issuer_address","typeLabel":"string | null"}},"uniqueKey":"payments.items.[INDEX].paid_asset.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"payments.items.[INDEX].paid_asset.oneOf.1","typeLabel":"null"}],"uniqueKey":"payments.items.[INDEX].paid_asset","typeLabel":"object | null"},"description":{"oneOf":[{"type":"string","uniqueKey":"payments.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"payments.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"payments.items.[INDEX].description","typeLabel":"string | null"},"metadata":{"oneOf":[{"type":"object","additionalProperties":{"type":"string","uniqueKey":"payments.items.[INDEX].metadata.oneOf.0.additionalProperties","typeLabel":"string"},"uniqueKey":"payments.items.[INDEX].metadata.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"type":"string","uniqueKey":"payments.items.[INDEX].metadata.oneOf.1.additionalProperties","typeLabel":"string"},"uniqueKey":"payments.items.[INDEX].metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"payments.items.[INDEX].metadata","typeLabel":"object | null"},"source_type":{"type":"string","enum":["direct","checkout_session","payment_link","invoice"],"uniqueKey":"payments.items.[INDEX].source_type","typeLabel":"enum\u003cstring>"},"customer_id":{"oneOf":[{"type":"string","uniqueKey":"payments.items.[INDEX].customer_id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"payments.items.[INDEX].customer_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"payments.items.[INDEX].customer_id","typeLabel":"string | null"},"payer_address":{"oneOf":[{"type":"string","uniqueKey":"payments.items.[INDEX].payer_address.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"payments.items.[INDEX].payer_address.oneOf.1","typeLabel":"null"}],"uniqueKey":"payments.items.[INDEX].payer_address","typeLabel":"string | null"},"tx_hash":{"oneOf":[{"type":"string","uniqueKey":"payments.items.[INDEX].tx_hash.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"payments.items.[INDEX].tx_hash.oneOf.1","typeLabel":"null"}],"uniqueKey":"payments.items.[INDEX].tx_hash","typeLabel":"string | null"},"confirmed_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"payments.items.[INDEX].confirmed_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"payments.items.[INDEX].confirmed_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"payments.items.[INDEX].confirmed_at","typeLabel":"string\u003cdate-time> | null"},"expires_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"payments.items.[INDEX].expires_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"payments.items.[INDEX].expires_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"payments.items.[INDEX].expires_at","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"payments.items.[INDEX]","typeLabel":"object"},"uniqueKey":"payments","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"cus_abc123xyz","environment":"sandbox","created_at":"2023-11-07T05:31:56Z","updated_at":"2023-11-07T05:31:56Z","email":"\u003cstring>","name":"\u003cstring>","primary_stellar_address":"\u003cstring>","notes":"\u003cstring>","metadata":{},"payments":[{"id":"pay_nLU2gUDk-v3tdyd6","object":"payment_intent","amount":"2.0000000","settlement_asset":{"asset_code":"USDC","issuer_address":"\u003cstring>"},"allowed_assets":[{"asset_code":"USDC","issuer_address":"\u003cstring>"}],"status":"pending","checkout_url":"\u003cstring>","created_at":"2023-11-07T05:31:56Z","paid_asset":{"asset_code":"USDC","issuer_address":"\u003cstring>"},"description":"\u003cstring>","metadata":{},"source_type":"direct","customer_id":"\u003cstring>","payer_address":"\u003cstring>","tx_hash":"\u003cstring>","confirmed_at":"2023-11-07T05:31:56Z","expires_at":"2023-11-07T05:31:56Z"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"545c5e59-9703-40d6-a6d1-ac6384000f7b":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":"Unauthorized"},"examples":{"Example":{"title":"Example","value":{"error":"Unauthorized"}}},"exampleType":"examples"}},"exampleType":"examples"},"76cf03c6-5183-4b92-825d-74f7b9ae3cdd":{"description":"Resource not found","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":"Payment not found"},"examples":{"Example":{"title":"Example","value":{"error":"Payment not found"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"092c85cb-caaf-41ec-ab1e-56717e2765ae":{"bearerAuth":{"type":"http","scheme":"bearer","description":"API key from the Payoes dashboard (`pk_test_...` or `pk_live_...`)","scopes":[]}}},"servers":{"ae523be2-dcea-4c03-8dea-108bc4cf2c2f":{"url":"https://payoes.com/api/v1","description":"Production host (replace with your deployment URL)"},"40d0733b-414c-4f58-8221-21c435dff5cf":{"url":"http://localhost:3000/api/v1","description":"Local development"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"API key from the Payoes dashboard (`pk_test_...` or `pk_live_...`)","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"API key from the Payoes dashboard (`pk_test_...` or `pk_live_...`)","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi/v1.yaml"},"subdomain":"payoes","siteName":"Payoes","title":"Retrieve a customer - Payoes","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-07-16T16:45:22.492Z","originalFileLocation":"api-reference/customers/retrieve-a-customer.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=\"light\";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=\"light\"}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=\"Returns the customer and their payment history in the current environment.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Payoes\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/payoes/VbSa6I0Hvc23ZqPO/_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/payoes/VbSa6I0Hvc23ZqPO/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/payoes/VbSa6I0Hvc23ZqPO/_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/payoes/VbSa6I0Hvc23ZqPO/_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/payoes/VbSa6I0Hvc23ZqPO/_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/payoes/VbSa6I0Hvc23ZqPO/_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/payoes/VbSa6I0Hvc23ZqPO/_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/payoes/VbSa6I0Hvc23ZqPO/_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/payoes/VbSa6I0Hvc23ZqPO/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Retrieve a customer - Payoes\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns the customer and their payment history in the current environment.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Payoes\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.payoes.com/api-reference/customers/retrieve-a-customer\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://payoes.mintlify.site/_mintlify/api/og/v2?division=Customers\u0026amp;title=Retrieve+a+customer\u0026amp;description=Returns+the+customer+and+their+payment+history+in+the+current+environment.\u0026amp;theme=a74f08f552172b411f7f902f\u0026amp;signature=03f112f904ad62b1b108df9d18e3fe6ad98f9257fb792f17ba18b754727f2bf3\">\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 customer - Payoes\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns the customer and their payment history in the current environment.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://payoes.mintlify.site/_mintlify/api/og/v2?division=Customers\u0026amp;title=Retrieve+a+customer\u0026amp;description=Returns+the+customer+and+their+payment+history+in+the+current+environment.\u0026amp;theme=a74f08f552172b411f7f902f\u0026amp;signature=03f112f904ad62b1b108df9d18e3fe6ad98f9257fb792f17ba18b754727f2bf3\">\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/payoes/VbSa6I0Hvc23ZqPO/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Payoes\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#054fbf\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.payoes.com/api-reference/customers/retrieve-a-customer\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/customers/retrieve-a-customer.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.payoes.com/#organization\",\"name\":\"Payoes\",\"url\":\"https://docs.payoes.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/payoes/ptmnJFUfenWl0Sc9/images/logo-full.png?fit=max\u0026auto=format\u0026n=ptmnJFUfenWl0Sc9\u0026q=85\u0026s=96cc6064017fe015475612b0c7758624\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.payoes.com#website\",\"name\":\"Payoes\",\"url\":\"https://docs.payoes.com\",\"publisher\":{\"@id\":\"https://docs.payoes.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.payoes.com/api-reference/customers/retrieve-a-customer#webpage\",\"url\":\"https://docs.payoes.com/api-reference/customers/retrieve-a-customer\",\"name\":\"Retrieve a customer\",\"description\":\"Returns the customer and their payment history in the current environment.\",\"dateModified\":\"2026-07-16T16:45:22.492Z\",\"isPartOf\":{\"@id\":\"https://docs.payoes.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.payoes.com/api-reference/customers/retrieve-a-customer#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.payoes.com/api-reference/customers/retrieve-a-customer#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Customers\",\"item\":\"https://docs.payoes.com/api-reference/customers/list-customers\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Retrieve a customer\",\"item\":\"https://docs.payoes.com/api-reference/customers/retrieve-a-customer\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.payoes.com/api-reference/customers/retrieve-a-customer#apireference\",\"headline\":\"Retrieve a customer\",\"name\":\"Retrieve a customer\",\"description\":\"Returns the customer and their payment history in the current environment.\",\"url\":\"https://docs.payoes.com/api-reference/customers/retrieve-a-customer\",\"mainEntityOfPage\":{\"@id\":\"https://docs.payoes.com/api-reference/customers/retrieve-a-customer#webpage\"},\"dateModified\":\"2026-07-16T16:45:22.492Z\",\"publisher\":{\"@id\":\"https://docs.payoes.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.payoes.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Payoes\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Payoes","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/introduction"}]},{"tab":"Local Setup","pages":[{"title":"Local Setup","href":"/local-setup/overview"}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"API overview","href":"/api-reference/overview"}]},{"group":"Payments","pages":[{"title":"List payments","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml get /payments","href":"/api-reference/payments/list-payments"},{"title":"Create a payment","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml post /payments","href":"/api-reference/payments/create-a-payment"},{"title":"Retrieve a payment","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml get /payments/{id}","href":"/api-reference/payments/retrieve-a-payment"}]},{"group":"Customers","pages":[{"title":"List customers","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml get /customers","href":"/api-reference/customers/list-customers"},{"title":"Create a customer","description":null,"deprecated":null,"version":null,"openapi":"/openapi/v1.yaml post /customers","href":"/api-reference/customers/create-a-customer"},{"title":"Retrieve a customer","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml get /customers/{id}","href":"/api-reference/customers/retrieve-a-customer"}]},{"group":"Checkout sessions","pages":[{"title":"List checkout sessions","description":null,"deprecated":null,"version":null,"openapi":"/openapi/v1.yaml get /checkout-sessions","href":"/api-reference/checkout-sessions/list-checkout-sessions"},{"title":"Retrieve a checkout session","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml get /checkout-sessions/{id}","href":"/api-reference/checkout-sessions/retrieve-a-checkout-session"}]},{"group":"Payment links","pages":[{"title":"List payment links","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml get /payment-links","href":"/api-reference/payment-links/list-payment-links"},{"title":"Create a payment link","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml post /payment-links","href":"/api-reference/payment-links/create-a-payment-link"},{"title":"Retrieve a payment link","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml get /payment-links/{id}","href":"/api-reference/payment-links/retrieve-a-payment-link"}]},{"group":"Invoices","pages":[{"title":"List invoices","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml get /invoices","href":"/api-reference/invoices/list-invoices"},{"title":"Create an invoice","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml post /invoices","href":"/api-reference/invoices/create-an-invoice"},{"title":"Retrieve an invoice","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml get /invoices/{id}","href":"/api-reference/invoices/retrieve-an-invoice"},{"title":"Finalize an invoice","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml post /invoices/{id}/finalize","href":"/api-reference/invoices/finalize-an-invoice"}]}]}]},"basePath":"","title":"Retrieve a customer - Payoes","buildId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","deploymentId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-5FCzAcfS.js","utils-SLtAG4EZ.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-2DZi8ZMu.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-D7J3nkzE.js","snippetPresets-D0Alv0AH.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BI4qNJ2c.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BD3uyr8j.js","shallow-D8iEBr5z.js","getApiPlaygroundDisplay-CgNP4lzR.js","CodeSnippet-CX-QHuMs.js","CodeSnippets-VlXE-ZUf.js","Page-D9ithiIZ.js","getPastedJson-DYNQkZ1M.js","icon-CzacdwOi.js","MethodPill-2JVqoYKi.js","DuplicateIcon-_xVXs-U8.js","createIcon-BRHrweLo.js","DynamicMarkdown-mQG_iQiE.js","SectionHeading-DMpJzv8f.js","axios-vUo_bRtp.js","Markdown-5FGIym-8.js","clsx-D-TRO5q5.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CdrJecqK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CHlcWBLM.js"]}