{
"error": "Token de autenticação inválido ou ausente."
}
Portal do cliente
Criar um link do portal
Gera o link do portal do cliente para um cliente e um checkout que ele pagou. Chamar de novo com o mesmo customerId e checkoutId devolve o mesmo link.
O cliente entra no portal com um código de 6 dígitos enviado ao e-mail do cadastro e consegue ver os pagamentos, pedir reembolso, cancelar a assinatura e trocar o cartão.
O checkoutId não existe na sua loja, ou é do outro ambiente (Modo Teste ou produção).
Customer not found
O customerId não existe ou foi removido.
Customer has no email to receive the access code
O cliente não tem e-mail. O código de acesso vai por e-mail.
Customer has no payment for this checkout
O cliente ainda não pagou esse checkout. Em assinatura, ainda não tem assinatura criada nele.
Authorizations
Authorization
string
header
required
Todas as requisições devem incluir sua chave de API no header Authorization usando o formato Bearer <abacatepay-api-key>. Sem esse header a requisição será rejeitada.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"AbacatePay","colors":{"primary":"#9EEA6C","light":"#9EEA6C","dark":"#9EEA6C"},"logo":{"light":"https://mintcdn.com/abacatepay/xO7P7BJz7mYAZGWC/images/logo_abkt.svg?fit=max\u0026auto=format\u0026n=xO7P7BJz7mYAZGWC\u0026q=85\u0026s=80cd7615ed55a1cad74cbb6920fa0bed","dark":"https://mintcdn.com/abacatepay/xO7P7BJz7mYAZGWC/images/logo_abkt.svg?fit=max\u0026auto=format\u0026n=xO7P7BJz7mYAZGWC\u0026q=85\u0026s=80cd7615ed55a1cad74cbb6920fa0bed"},"favicon":"https://mintcdn.com/abacatepay/A_mLrlQaTYJZv5aB/favicon.ico?fit=max\u0026auto=format\u0026n=A_mLrlQaTYJZv5aB\u0026q=85\u0026s=6ef5964a0b4fdbe414358c16720e89ae","api":{"mdx":{"auth":{"method":"bearer"},"server":"https://api.abacatepay.com/v2"}},"appearance":{"default":"dark","strict":true},"navbar":{"links":[{"href":"https://docs.abacatepay.com/llms.txt","label":"llms.txt"},{"href":"https://github.com/AbacatePay/documentation","label":"Repositório"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.abacatepay.com/"}},"footer":{"socials":{"x":"https://x.com/abacatepay","github":"https://github.com/AbacatePay","discord":"https://discord.com/invite/CP57mm7EFk","linkedin":"https://br.linkedin.com/company/abacatepay?trk=public_post_feed-actor-name","youtube":"https://www.youtube.com/@abacatepay","instagram":"https://www.instagram.com/abacatepay"}},"fonts":{"family":"Fustat"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"abacatepay","hasAudioNarration":false,"actualSubdomain":"abacatepay","customDomains":["docs.abacatepay.com"],"gitSource":{"type":"github","owner":"abacatepay","repo":"documentation","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6af48cb48374f67b33c35d45","clientVersion":"0.0.4143","searchFilterCounts":[{"language":"default","tag":"Referência da API","count":60},{"language":"default","tag":"Documentação","count":46},{"language":"default","tag":"API Reference","count":32},{"language":"default","tag":"Vídeos","count":16},{"language":"default","tag":"CLI","count":14},{"language":"default","tag":"SDKs","count":11},{"language":"default","tag":"Para lojistas","count":10},{"language":"default","tag":"Assinaturas","count":9},{"language":"default","tag":"Ferramentas","count":8},{"language":"default","tag":"Ecossistema","count":8}]},"assistantConfig":{},"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":"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":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[{"filePath":"custom.css","content":"button[class*=\"try-it\"],button[aria-label*=\"Try it\"],button:has-text(\"Try it\"){background-color:#9EEA6C!important;color:#0A1B39!important}button[data-testid=\"try-it-button\"],.mintlify-code-block button[class*=\"try\"],pre button[class*=\"try\"],.mintlify-code button{background-color:#9eea6c!important;color:#0a1b39!important}button[class*=\"try-it\"]:hover,button[aria-label*=\"Try it\"]:hover{background-color:#8dd95b!important}[class*=\"TryIt\"] button,[class*=\"try-it\"] button,button:contains(\"Try it\"){background-color:#9EEA6C!important;color:#0A1B39!important}"}],"page":{"pagePath":"pages/customer-portal/create","slug":"/pages/customer-portal/create","pageMetadata":{"title":"Criar um link do portal","openapi":"POST /customer-portal/create","description":"Gera o link do portal do cliente para um cliente e um checkout que ele pagou. Chamar de novo com o mesmo `customerId` e `checkoutId` devolve o mesmo link.\n\nO cliente entra no portal com um código de 6 dígitos enviado ao e-mail do cadastro e consegue ver os pagamentos, pedir reembolso, cancelar a assinatura e trocar o cartão.\n","href":"/pages/customer-portal/create"},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [\"Gera o link do portal do cliente para um cliente e um checkout que ele pagou. Chamar de novo com o mesmo \", _jsx(_components.code, {\n children: \"customerId\"\n }), \" e \", _jsx(_components.code, {\n children: \"checkoutId\"\n }), \" devolve o mesmo link.\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"O cliente entra no portal com um código de 6 dígitos enviado ao e-mail do cadastro e consegue ver os pagamentos, pedir reembolso, cancelar a assinatura e trocar o cartão.\"\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{Card,CodeBlock,Heading,Table}=_components;if(!Card)_missingMdxReference(`Card`,true);if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Gera o link do portal do cliente para um cliente e um checkout que ele pagou. Chamar de novo com os mesmos IDs devolve o mesmo link.`}),`\n`,_jsx(Card,{horizontal:true,children:_jsxs(_components.p,{children:[`Requer uma destas permissões: `,_jsx(_components.code,{children:`CHECKOUT:CREATE`}),`, `,_jsx(_components.code,{children:`SUBSCRIPTION:CREATE`}),` ou `,_jsx(_components.code,{children:`CUSTOMER:CREATE`}),`.`]})}),`\n`,_jsx(Card,{title:`Entenda o portal do cliente`,icon:`book-open`,href:`/pages/vender/portal-do-cliente`,horizontal:true,children:_jsx(_components.p,{children:`O que o cliente pode fazer, como ele entra e os webhooks que você recebe.`})}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`checkoutId`}),` aceita o `,_jsx(_components.code,{children:`id`}),` de um checkout, de um link de pagamento ou de um checkout de assinatura.`]}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Exemplo:`})}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`4`,language:`json`,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:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`4`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"customerId\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"cust_abc123xyz\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"checkoutId\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"bill_abc123xyz\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`erros`,children:`Erros`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Erro`}),_jsx(_components.th,{children:`Motivo`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`Checkout not found`})}),_jsxs(_components.td,{children:[`O `,_jsx(_components.code,{children:`checkoutId`}),` não existe na sua loja, ou é do outro ambiente (Modo Teste ou produção).`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`Customer not found`})}),_jsxs(_components.td,{children:[`O `,_jsx(_components.code,{children:`customerId`}),` não existe ou foi removido.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`Customer has no email to receive the access code`})}),_jsx(_components.td,{children:`O cliente não tem e-mail. O código de acesso vai por e-mail.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`Customer has no payment for this checkout`})}),_jsx(_components.td,{children:`O cliente ainda não pagou esse checkout. Em assinatura, ainda não tem assinatura criada nele.`})]})]})]})]})}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":"Criar um link do portal","openapi":"POST /customer-portal/create","description":"Gera o link do portal do cliente para um cliente e um checkout que ele pagou. Chamar de novo com o mesmo `customerId` e `checkoutId` devolve o mesmo link.\n\nO cliente entra no portal com um código de 6 dígitos enviado ao e-mail do cadastro e consegue ver os pagamentos, pedir reembolso, cancelar a assinatura e trocar o cartão.\n","href":"/pages/customer-portal/create"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Erros","slug":"erros","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Criar um link do portal do cliente","description":"Gera o link do portal do cliente para um cliente e um checkout que ele pagou. Chamar de novo com o mesmo `customerId` e `checkoutId` devolve o mesmo link.\n\nO cliente entra no portal com um código de 6 dígitos enviado ao e-mail do cadastro e consegue ver os pagamentos, pedir reembolso, cancelar a assinatura e trocar o cartão.\n","security":["01231446-1e9b-4c3d-814e-fe351ae23ad5"],"requestBody":"2b6ce009-2031-400a-a3fb-1b368fdd9a55","responses":{"200":"a00c9368-2d4e-4495-8475-0ae8a51e1087","401":"9f470bcf-52dc-4c82-a7b8-837898851b89"},"method":"post","type":"path","servers":["6c1295f0-9202-4721-8245-460eeb766b0a"],"path":"/customer-portal/create","baseUrlOptions":["https://api.abacatepay.com/v2"],"title":"Criar um link do portal do cliente","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["customerId","checkoutId"],"additionalProperties":false,"properties":{"customerId":{"type":"string","description":"ID do cliente que pagou o checkout","example":"cust_abc123xyz","isRequired":true,"uniqueKey":"customerId","typeLabel":"string"},"checkoutId":{"type":"string","description":"ID do checkout (avulso ou de assinatura)","example":"bill_abc123xyz","isRequired":true,"uniqueKey":"checkoutId","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"customerId":"cust_abc123xyz","checkoutId":"bill_abc123xyz"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"a00c9368-2d4e-4495-8475-0ae8a51e1087":{"description":"Link do portal criado (ou o existente).","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"ID do link","example":"cpl_abc123xyz","uniqueKey":"data.id","typeLabel":"string"},"url":{"type":"string","description":"Link para mandar ao cliente","example":"https://portal.abacatepay.com/k3J9xQ2mP7vL1nR8sT4wY6zA0bC5dE2f","uniqueKey":"data.url","typeLabel":"string"},"customerId":{"type":"string","example":"cust_abc123xyz","uniqueKey":"data.customerId","typeLabel":"string"},"checkoutId":{"type":"string","example":"bill_abc123xyz","uniqueKey":"data.checkoutId","typeLabel":"string"},"devMode":{"type":"boolean","example":false,"uniqueKey":"data.devMode","typeLabel":"boolean"},"createdAt":{"type":"string","format":"date-time","example":"2026-10-19T12:00:00.000Z","uniqueKey":"data.createdAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"data","typeLabel":"object"},"error":{"oneOf":[{"type":"string","example":null,"uniqueKey":"error.oneOf.0","typeLabel":"string"},{"type":"null","example":null,"uniqueKey":"error.oneOf.1","typeLabel":"null"}],"uniqueKey":"error","typeLabel":"string | null"},"success":{"type":"boolean","description":"Se a requisição obteve sucesso ou não.","example":true,"uniqueKey":"success","typeLabel":"boolean"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{"id":"cpl_abc123xyz","url":"https://portal.abacatepay.com/k3J9xQ2mP7vL1nR8sT4wY6zA0bC5dE2f","customerId":"cust_abc123xyz","checkoutId":"bill_abc123xyz","devMode":false,"createdAt":"2026-10-19T12:00:00.000Z"},"error":null,"success":true}}},"exampleType":"generated"}},"exampleType":"generated"},"9f470bcf-52dc-4c82-a7b8-837898851b89":{"description":"Não autorizado. Falha na autenticação.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Token de autenticação inválido ou ausente.","uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Token de autenticação inválido ou ausente."}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"01231446-1e9b-4c3d-814e-fe351ae23ad5":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Todas as requisições devem incluir sua chave de API no header Authorization usando o formato `Bearer \u003cabacatepay-api-key>`. Sem esse header a requisição será rejeitada.\n\nSaiba mais sobre como criar e usar chaves de API na [documentação de autenticação](/pages/authentication).\n","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"6c1295f0-9202-4721-8245-460eeb766b0a":{"url":"https://api.abacatepay.com/v2","description":"Único servidor para os ambientes de produção e sandbox."}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Todas as requisições devem incluir sua chave de API no header Authorization usando o formato `Bearer \u003cabacatepay-api-key>`. Sem esse header a requisição será rejeitada.\n\nSaiba mais sobre como criar e usar chaves de API na [documentação de autenticação](/pages/authentication).\n","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Todas as requisições devem incluir sua chave de API no header Authorization usando o formato `Bearer \u003cabacatepay-api-key>`. Sem esse header a requisição será rejeitada.\n\nSaiba mais sobre como criar e usar chaves de API na [documentação de autenticação](/pages/authentication).\n","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi.yaml"},"subdomain":"abacatepay","siteName":"AbacatePay","title":"Criar um link do portal - AbacatePay","navMaps":{"firstHrefInVersion":{"v2":{"href":"/pages/customer-portal/create","matchLevel":0},"v1":{"href":"/pages/v1/introduction","matchLevel":4}},"firstHrefInLanguage":{}},"lastModified":"2026-11-10T18:22:53.984Z","originalFileLocation":"pages/customer-portal/create.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=\"dark\";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=\"description\" content=\"Gera o link do portal do cliente para um cliente e um checkout que ele pagou. Chamar de novo com o mesmo customerId e checkoutId devolve o mesmo link. O cliente entra no portal com um código de 6 dígitos enviado ao e-mail do cadastro e consegue ver os pagamentos, pedir reembolso, cancelar a assinatura e trocar o cartão.\">\u003cmeta data-mint-head name=\"application-name\" content=\"AbacatePay\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/abacatepay/3vOAsUCVrWwWFehF/_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/abacatepay/3vOAsUCVrWwWFehF/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/abacatepay/3vOAsUCVrWwWFehF/_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/abacatepay/3vOAsUCVrWwWFehF/_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/abacatepay/3vOAsUCVrWwWFehF/_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/abacatepay/3vOAsUCVrWwWFehF/_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/abacatepay/3vOAsUCVrWwWFehF/_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/abacatepay/3vOAsUCVrWwWFehF/_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/abacatepay/3vOAsUCVrWwWFehF/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Criar um link do portal - AbacatePay\">\u003cmeta data-mint-head property=\"og:description\" content=\"Gera o link do portal do cliente para um cliente e um checkout que ele pagou. Chamar de novo com o mesmo customerId e checkoutId devolve o mesmo link. O cliente entra no portal com um código de 6 dígitos enviado ao e-mail do cadastro e consegue ver os pagamentos, pedir reembolso, cancelar a assinatura e trocar o cartão.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"AbacatePay\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.abacatepay.com/pages/customer-portal/create\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://abacatepay.mintlify.site/_mintlify/api/og/v2?division=Portal+do+cliente\u0026amp;title=Criar+um+link+do+portal\u0026amp;description=Gera+o+link+do+portal+do+cliente+para+um+cliente+e+um+checkout+que+ele+pagou.+Chamar+de+novo+com+o+mesmo+%60customerId%60+e+%60checkoutId%60+devolve+o+mesmo+link.%0A%0AO+cl\u0026amp;theme=d064f9bb23a6adfe2e6e208f\u0026amp;signature=bd4c21af71987a3f3a58f7d5a02a95a64557a65c5e196f4bae47ebabab821521\">\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=\"Criar um link do portal - AbacatePay\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Gera o link do portal do cliente para um cliente e um checkout que ele pagou. Chamar de novo com o mesmo customerId e checkoutId devolve o mesmo link. O cliente entra no portal com um código de 6 dígitos enviado ao e-mail do cadastro e consegue ver os pagamentos, pedir reembolso, cancelar a assinatura e trocar o cartão.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://abacatepay.mintlify.site/_mintlify/api/og/v2?division=Portal+do+cliente\u0026amp;title=Criar+um+link+do+portal\u0026amp;description=Gera+o+link+do+portal+do+cliente+para+um+cliente+e+um+checkout+que+ele+pagou.+Chamar+de+novo+com+o+mesmo+%60customerId%60+e+%60checkoutId%60+devolve+o+mesmo+link.%0A%0AO+cl\u0026amp;theme=d064f9bb23a6adfe2e6e208f\u0026amp;signature=bd4c21af71987a3f3a58f7d5a02a95a64557a65c5e196f4bae47ebabab821521\">\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/abacatepay/3vOAsUCVrWwWFehF/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"AbacatePay\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#9EEA6C\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.abacatepay.com/pages/customer-portal/create\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/pages/customer-portal/create.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.abacatepay.com/#organization\",\"name\":\"AbacatePay\",\"url\":\"https://docs.abacatepay.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/abacatepay/xO7P7BJz7mYAZGWC/images/logo_abkt.svg?fit=max\u0026auto=format\u0026n=xO7P7BJz7mYAZGWC\u0026q=85\u0026s=80cd7615ed55a1cad74cbb6920fa0bed\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.abacatepay.com#website\",\"name\":\"AbacatePay\",\"url\":\"https://docs.abacatepay.com\",\"publisher\":{\"@id\":\"https://docs.abacatepay.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.abacatepay.com/pages/customer-portal/create#webpage\",\"url\":\"https://docs.abacatepay.com/pages/customer-portal/create\",\"name\":\"Criar um link do portal\",\"description\":\"Gera o link do portal do cliente para um cliente e um checkout que ele pagou. Chamar de novo com o mesmo customerId e checkoutId devolve o mesmo link. O cliente entra no portal com um código de 6 dígitos enviado ao e-mail do cadastro e consegue ver os pagamentos, pedir reembolso, cancelar a assinatura e trocar o cartão.\",\"dateModified\":\"2026-11-10T18:22:53.984Z\",\"isPartOf\":{\"@id\":\"https://docs.abacatepay.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.abacatepay.com/pages/customer-portal/create#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.abacatepay.com/pages/customer-portal/create#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"AbacatePay\",\"item\":\"https://docs.abacatepay.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Criar um link do portal\",\"item\":\"https://docs.abacatepay.com/pages/customer-portal/create\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.abacatepay.com/pages/customer-portal/create#apireference\",\"headline\":\"Criar um link do portal\",\"name\":\"Criar um link do portal\",\"description\":\"Gera o link do portal do cliente para um cliente e um checkout que ele pagou. Chamar de novo com o mesmo customerId e checkoutId devolve o mesmo link. O cliente entra no portal com um código de 6 dígitos enviado ao e-mail do cadastro e consegue ver os pagamentos, pedir reembolso, cancelar a assinatura e trocar o cartão.\",\"url\":\"https://docs.abacatepay.com/pages/customer-portal/create\",\"mainEntityOfPage\":{\"@id\":\"https://docs.abacatepay.com/pages/customer-portal/create#webpage\"},\"dateModified\":\"2026-11-10T18:22:53.984Z\",\"publisher\":{\"@id\":\"https://docs.abacatepay.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.abacatepay.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"AbacatePay\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"AbacatePay\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/pages/customer-portal/create.md","siteName":"AbacatePay","nav":{"global":null,"versions":[{"version":"v2","tag":"Current","tabs":[{"tab":"Documentação","pages":[{"title":"Documentação","href":"/pages/comecar/sobre"}]},{"tab":"Referência da API","groups":[{"group":"Introdução","pages":[{"title":"Introdução","icon":"book-open","href":"/pages/reference/introduction"}]},{"group":"Checkouts","pages":[{"title":"Criar um Checkout","openapi":"POST /checkouts/create","href":"/pages/payment/create"},{"title":"Listar Checkouts","openapi":"GET /checkouts/list","href":"/pages/payment/list"},{"title":"Buscar um Checkout","openapi":"GET /checkouts/get","href":"/pages/payment/one"},{"title":"Reembolsar um Checkout","openapi":"POST /checkouts/refund","href":"/pages/payment/refund"}]},{"group":"Links de pagamento","pages":[{"title":"Criar um link de pagamento","openapi":"POST /payment-links/create","href":"/pages/payment-links/create"},{"title":"Listar links de pagamento","openapi":"GET /payment-links/list","href":"/pages/payment-links/list"},{"title":"Buscar um link de pagamento","openapi":"GET /payment-links/get","href":"/pages/payment-links/one"},{"title":"Reembolsar pagamento de link","openapi":"POST /payment-links/refund","href":"/pages/payment-links/refund"}]},{"group":"Checkout transparente","pages":[{"title":"Criar cobrança Pix","openapi":"POST /transparents/create","href":"/pages/transparents/create"},{"title":"Criar cobrança Boleto","openapi":"POST /transparents/create","href":"/pages/transparents/boleto"},{"title":"Criar cobrança Cartão","openapi":"POST /transparents/create","href":"/pages/transparents/card"},{"title":"Listar Checkouts Transparentes","openapi":"GET /transparents/list","href":"/pages/transparents/list"},{"title":"Checar Status","openapi":"GET /transparents/check","href":"/pages/transparents/check"},{"title":"Simular Pagamento","openapi":"POST /transparents/simulate-payment","href":"/pages/transparents/simulate-payment"},{"title":"Reembolsar Checkout Transparente","openapi":"POST /transparents/refund","href":"/pages/transparents/refund"},{"title":"abacatepay.js","icon":"js","href":"/pages/transparents/abacatepay-js"}]},{"group":"Clientes","pages":[{"title":"Criar um Cliente","openapi":"POST /customers/create","href":"/pages/client/create"},{"title":"Listar Clientes","openapi":"GET /customers/list","href":"/pages/client/list"},{"title":"Buscar um Cliente","openapi":"GET /customers/get","href":"/pages/client/get"},{"title":"Deletar um Cliente","openapi":"POST /customers/delete","description":"Remove um cliente da sua loja.\n\nEsta operação é irreversível. Use com cuidado.\n","href":"/pages/client/delete"}]},{"group":"Portal do cliente","pages":[{"title":"Criar um link do portal","openapi":"POST /customer-portal/create","href":"/pages/customer-portal/create"}]},{"group":"Produtos","pages":[{"title":"Criar um produto","openapi":"POST /products/create","description":"Permite que você crie um novo produto que pode ser usado em cobranças.\nProdutos podem ser avulsos (pagamento único) ou de assinatura; use o campo opcional `cycle` para definir a recorrência (`WEEKLY`, `MONTHLY`, `QUARTERLY`, `SEMIANNUALLY`, `ANNUALLY`). Quando `cycle` é omitido ou `null`, o produto é avulso.\n\n**Alternativa**: Você também pode criar e gerenciar seus produtos pelo [Dashboard da AbacatePay](https://app.abacatepay.com/produtos).\n","href":"/pages/products/create"},{"title":"Listar produtos","openapi":"GET /products/list","href":"/pages/products/list"},{"title":"Buscar um produto","openapi":"GET /products/get","href":"/pages/products/get"},{"title":"Deletar um Produto","openapi":"POST /products/delete","href":"/pages/products/delete"}]},{"group":"Cupons","pages":[{"title":"Criar um cupom","openapi":"POST /coupons/create","href":"/pages/coupons/create"},{"title":"Listar cupons","openapi":"GET /coupons/list","href":"/pages/coupons/list"},{"title":"Buscar um Cupom","openapi":"GET /coupons/get","href":"/pages/coupons/get"},{"title":"Deletar um Cupom","openapi":"POST /coupons/delete","href":"/pages/coupons/delete"},{"title":"Alternar Status de um Cupom","openapi":"POST /coupons/toggle","href":"/pages/coupons/toggle"}]},{"group":"Assinaturas","pages":[{"title":"Criar checkout de assinatura","openapi":"POST /subscriptions/create","href":"/pages/subscriptions/create"},{"title":"Buscar um checkout de assinatura","openapi":"GET /subscriptions/checkouts/get","href":"/pages/subscriptions/checkouts-get"},{"title":"Listar checkouts de assinatura","openapi":"GET /subscriptions/checkouts/list","href":"/pages/subscriptions/checkouts-list"},{"title":"Excluir um checkout de assinatura","openapi":"POST /subscriptions/checkouts/delete","href":"/pages/subscriptions/checkouts-delete"},{"title":"Buscar uma assinatura","openapi":"GET /subscriptions/get","href":"/pages/subscriptions/get"},{"title":"Listar assinaturas","openapi":"GET /subscriptions/list","href":"/pages/subscriptions/list"},{"title":"Cancelar uma assinatura","openapi":"POST /subscriptions/cancel","href":"/pages/subscriptions/cancel"},{"title":"Alterar plano da assinatura","openapi":"POST /subscriptions/change-plan","href":"/pages/subscriptions/change-plan"},{"title":"Registrar uso","openapi":"POST /subscriptions/record-usage","href":"/pages/subscriptions/record-usage"}]},{"group":"Saques","pages":[{"title":"Criar um Saque","openapi":"POST /payouts/create","href":"/pages/payouts/create"},{"title":"Buscar saque","openapi":"GET /payouts/get","href":"/pages/payouts/get"},{"title":"Listar Saques","openapi":"GET /payouts/list","href":"/pages/payouts/list"}]},{"group":"Enviar Pix","pages":[{"title":"Enviar Pix","openapi":"POST /pix/send","href":"/pages/pix/create"},{"title":"Buscar Pix","openapi":"GET /pix/get","href":"/pages/pix/get"},{"title":"Listar Pix","openapi":"GET /pix/list","href":"/pages/pix/list"}]},{"group":"Subcontas","pages":[{"title":"Criar subconta","openapi":"POST /sub-accounts/create","href":"/pages/sub-accounts/create"},{"title":"Buscar subconta","openapi":"GET /sub-accounts/get","href":"/pages/sub-accounts/get"},{"title":"Listar subcontas","openapi":"GET /sub-accounts/list","href":"/pages/sub-accounts/list"},{"title":"Sacar da subconta","openapi":"POST /sub-accounts/withdraw","href":"/pages/sub-accounts/withdraw"}]},{"group":"Extrato","pages":[{"title":"Listar extrato","openapi":"GET /bank-statement/list","href":"/pages/bank-statement/list"}]},{"group":"Loja","pages":[{"title":"Obter detalhes da loja","openapi":"GET /stores/get","href":"/pages/store/get"}]},{"group":"Public MRR","pages":[{"title":"Obter MRR","openapi":"openapi.yaml GET /public-mrr/mrr","href":"/pages/trustMRR/mrr"},{"title":"Obter MRR por Dia","openapi":"openapi.yaml GET /public-mrr/mrr-by-day","href":"/pages/trustMRR/mrr-by-day"},{"title":"Obter Informações do Merchant","openapi":"openapi.yaml GET /public-mrr/merchant-info","href":"/pages/trustMRR/merchant-info"},{"title":"Obter Receita por Período","openapi":"openapi.yaml GET /public-mrr/revenue","href":"/pages/trustMRR/revenue"}]},{"group":"Webhooks","pages":[{"title":"Criar um webhook","openapi":"POST /webhooks/create","href":"/pages/webhooks/create"},{"title":"Listar webhooks","openapi":"GET /webhooks/list","href":"/pages/webhooks/list"},{"title":"Buscar um webhook","openapi":"GET /webhooks/get","href":"/pages/webhooks/get"},{"title":"Deletar um webhook","openapi":"POST /webhooks/delete","href":"/pages/webhooks/delete"}]}]},{"tab":"SDKs","pages":[{"title":"SDKs","href":"/pages/sdks/sdks"}]},{"tab":"CLI","pages":[{"title":"CLI","href":"/pages/cli/overview"}]},{"tab":"AI","pages":[{"title":"AI","href":"/pages/ai/overview"}]},{"tab":"Ferramentas","pages":[{"title":"Ferramentas","href":"/pages/ecosystem/ecosystem"}]},{"tab":"Vídeos","pages":[{"title":"Vídeos","href":"/pages/videos"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/pages/changelog"}]}]},{"version":"v1","tag":"Legacy","pages":[{"title":"v1","href":"/pages/v1/introduction"}]}]},"basePath":"","title":"Criar um link do portal - AbacatePay","buildId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","deploymentId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DdEMm2kG.js","utils-BMo572L7.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C-4m9KAx.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DPLK2Oq9.js","snippetPresets-BKjfJMC9.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-DTsgtCEj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C8vmhyQM.js","shallow-r9w8LQGS.js","getApiPlaygroundDisplay-DjPI64HQ.js","CodeSnippet-C8Bvhl16.js","CodeSnippets-BtWUwcMy.js","Page-BIYvYBgk.js","getPastedJson-Dcm_3Pgl.js","icon-BXwrTpjc.js","MethodPill-CcjfVmmy.js","DuplicateIcon-BuKIbXAQ.js","createIcon-DaL9yXsO.js","DynamicMarkdown-Co5nikxh.js","SectionHeading-P4UNTsMZ.js","axios-vUo_bRtp.js","Markdown-CEfymfIH.js","clsx-Dq9TQuNi.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-D2J8knkn.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BgZ2ThuU.js"]}