{
"error": "Token de autenticação inválido ou ausente."
}
{
"error": "Billing not found"
}
Retorna um checkout pelo id, pelo externalId ou pelo customerId. Use para conferir o status quando o cliente volta ao seu site ou quando chega um webhook.
Requer a permissão CHECKOUT:READ.
Entenda o checkout
O que significa cada status, quando paidAmount é preenchido e o que muda com o upsell.
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.
Método de pagamento. Casa o checkout que oferece este método, mesmo que ofereça outros também.
Available options:
PIX,
CARD,
BOLETO
Response
Cobrança encontrada com sucesso.
data
object
Show child attributes
error
string | null
Example:
null
success
boolean
Se a requisição obteve sucesso ou não.
Example:
true
Was this page helpful?
{"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/payment/one","slug":"/pages/payment/one","pageMetadata":{"title":"Buscar um Checkout","openapi":"GET /checkouts/get","description":"Retorna os dados de um Checkout específico usando o ID.\n\nVocê pode usar essa rota para buscar um Checkout por ID e visualizar seus detalhes, status e informações relacionadas.\n\nInforme ao menos um entre `id`, `externalId` e `customerId`. Sem nenhum deles, a API retorna `Provide id, externalId or customerId`.\n\nCheckouts de assinatura (`frequency: SUBSCRIPTION`) não são retornados por esta rota. Use `GET /subscriptions/checkouts/get`.\n","href":"/pages/payment/one"},"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: [_jsx(_components.p, {\n children: \"Retorna os dados de um Checkout específico usando o ID.\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"Você pode usar essa rota para buscar um Checkout por ID e visualizar seus detalhes, status e informações relacionadas.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Informe ao menos um entre \", _jsx(_components.code, {\n children: \"id\"\n }), \", \", _jsx(_components.code, {\n children: \"externalId\"\n }), \" e \", _jsx(_components.code, {\n children: \"customerId\"\n }), \". Sem nenhum deles, a API retorna \", _jsx(_components.code, {\n children: \"Provide id, externalId or customerId\"\n }), \".\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Checkouts de assinatura (\", _jsx(_components.code, {\n children: \"frequency: SUBSCRIPTION\"\n }), \") não são retornados por esta rota. Use \", _jsx(_components.code, {\n children: \"GET /subscriptions/checkouts/get\"\n }), \".\"]\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={a:`a`,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:[_jsxs(_components.p,{children:[`Retorna um checkout pelo `,_jsx(_components.code,{children:`id`}),`, pelo `,_jsx(_components.code,{children:`externalId`}),` ou pelo `,_jsx(_components.code,{children:`customerId`}),`. Use para conferir o `,_jsx(_components.code,{children:`status`}),` quando o cliente volta ao seu site ou quando chega um `,_jsx(_components.a,{href:`/pages/notificacoes/webhooks`,children:`webhook`}),`.`]}),`\n`,_jsx(Card,{horizontal:true,children:_jsxs(_components.p,{children:[`Requer a permissão `,_jsx(_components.code,{children:`CHECKOUT:READ`}),`.`]})}),`\n`,_jsx(Card,{title:`Entenda o checkout`,icon:`book-open`,href:`/pages/cobrar/checkout#status-do-checkout`,horizontal:true,children:_jsxs(_components.p,{children:[`O que significa cada status, quando `,_jsx(_components.code,{children:`paidAmount`}),` é preenchido e o que muda com o upsell.`]})}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Exemplo:`})}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`2`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://api.abacatepay.com/v2/checkouts/get?id=bill_abc123xyz\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer SUA_CHAVE\"`})]}),`\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:`Provide id, externalId or customerId`})}),_jsx(_components.td,{children:`Nenhum dos três parâmetros foi enviado.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`Billing not found`})}),_jsxs(_components.td,{children:[`Não existe checkout de pagamento único com esse valor na sua loja. Links de pagamento ficam em `,_jsx(_components.a,{href:`/pages/payment-links/one`,children:`Buscar um link de pagamento`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`This is a subscription checkout. Use /v2/subscriptions/checkouts/get`})}),_jsxs(_components.td,{children:[`O `,_jsx(_components.code,{children:`id`}),` é de um checkout de assinatura. Use `,_jsx(_components.a,{href:`/pages/subscriptions/checkouts-get`,children:`Buscar checkout de assinatura`}),`.`]})]})]})]})]})}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":"Buscar um Checkout","openapi":"GET /checkouts/get","description":"Retorna os dados de um Checkout específico usando o ID.\n\nVocê pode usar essa rota para buscar um Checkout por ID e visualizar seus detalhes, status e informações relacionadas.\n\nInforme ao menos um entre `id`, `externalId` e `customerId`. Sem nenhum deles, a API retorna `Provide id, externalId or customerId`.\n\nCheckouts de assinatura (`frequency: SUBSCRIPTION`) não são retornados por esta rota. Use `GET /subscriptions/checkouts/get`.\n","href":"/pages/payment/one"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Erros","slug":"erros","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Buscar um Checkout","description":"Retorna os dados de um Checkout específico usando o ID.\n\nVocê pode usar essa rota para buscar um Checkout por ID e visualizar seus detalhes, status e informações relacionadas.\n\nInforme ao menos um entre `id`, `externalId` e `customerId`. Sem nenhum deles, a API retorna `Provide id, externalId or customerId`.\n\nCheckouts de assinatura (`frequency: SUBSCRIPTION`) não são retornados por esta rota. Use `GET /subscriptions/checkouts/get`.\n","security":["cd9b5448-ad6c-4bbf-ae7e-0e8a0e5c362b"],"parameters":["37a7875f-3664-448e-a014-12c11ef46be9","6ef17c32-9e4a-4259-8496-83aae5e51d20","620c774e-0209-49b5-b088-e55049a85835","b7c48690-875c-4f84-9ef2-3111e64c887b"],"responses":{"200":"00f5e4d1-8254-46a5-912b-2aeba8dc8008","401":"f0aef0ea-3c44-4c03-b57e-50936fbf6b85","404":"3b4b41aa-f753-4dec-a81e-23b7a982b6ec"},"method":"get","type":"path","servers":["6c1295f0-9202-4721-8245-460eeb766b0a"],"path":"/checkouts/get","baseUrlOptions":["https://api.abacatepay.com/v2"],"title":"Buscar um Checkout","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"37a7875f-3664-448e-a014-12c11ef46be9":{"name":"id","in":"query","description":"Identificador único do Checkout","required":false,"schema":{"type":"string","example":"bill_abc123xyz","isRequired":false,"description":"Identificador único do Checkout","uniqueKey":"","typeLabel":"string"}},"6ef17c32-9e4a-4259-8496-83aae5e51d20":{"name":"externalId","in":"query","description":"Identificador do Checkout no seu sistema","required":false,"schema":{"type":"string","example":"pedido-123","isRequired":false,"description":"Identificador do Checkout no seu sistema","uniqueKey":"","typeLabel":"string"}},"620c774e-0209-49b5-b088-e55049a85835":{"name":"customerId","in":"query","description":"Identificador do cliente associado","required":false,"schema":{"type":"string","example":"cust_abc123xyz","isRequired":false,"description":"Identificador do cliente associado","uniqueKey":"","typeLabel":"string"}},"b7c48690-875c-4f84-9ef2-3111e64c887b":{"name":"method","in":"query","description":"Método de pagamento. Casa o checkout que oferece este método, mesmo que ofereça outros também.","required":false,"schema":{"type":"string","enum":["PIX","CARD","BOLETO"],"isRequired":false,"description":"Método de pagamento. Casa o checkout que oferece este método, mesmo que ofereça outros também.","uniqueKey":"","typeLabel":"enum\u003cstring>"}}},"responses":{"00f5e4d1-8254-46a5-912b-2aeba8dc8008":{"description":"Cobrança encontrada com sucesso.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"Identificador único do Checkout.","example":"bill_abc123xyz","uniqueKey":"data.id","typeLabel":"string"},"externalId":{"oneOf":[{"type":"string","description":"ID do Checkout no seu sistema.","example":"pedido-123","uniqueKey":"data.externalId.oneOf.0","typeLabel":"string"},{"type":"null","description":"ID do Checkout no seu sistema.","example":"pedido-123","uniqueKey":"data.externalId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.externalId","typeLabel":"string | null"},"url":{"type":"string","format":"uri","description":"URL onde o usuário pode concluir o pagamento.","example":"https://app.abacatepay.com/pay/bill_abc123xyz","uniqueKey":"data.url","typeLabel":"string\u003curi>"},"amount":{"type":"number","description":"Valor total a ser pago em centavos.","example":10000,"uniqueKey":"data.amount","typeLabel":"number"},"paidAmount":{"oneOf":[{"type":"number","description":"Valor já pago em centavos. Null se ainda não foi pago.","example":null,"uniqueKey":"data.paidAmount.oneOf.0","typeLabel":"number"},{"type":"null","description":"Valor já pago em centavos. Null se ainda não foi pago.","example":null,"uniqueKey":"data.paidAmount.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.paidAmount","typeLabel":"number | null"},"items":{"type":"array","description":"Lista de itens no Checkout.","items":{"type":"object","properties":{"id":{"type":"string","description":"ID do produto.","example":"prod_456","uniqueKey":"data.\\items.items.[INDEX].id","typeLabel":"string"},"quantity":{"type":"integer","description":"Quantidade do item.","example":2,"uniqueKey":"data.\\items.items.[INDEX].quantity","typeLabel":"integer"}},"uniqueKey":"data.\\items.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.\\items","typeLabel":"object[]"},"status":{"type":"string","description":"Status atual do Checkout. `REDEEMED` quando o cliente fechou o checkout com um cupom de 100%, sem pagar nada.","enum":["PENDING","EXPIRED","CANCELLED","PAID","REFUNDED","REDEEMED"],"example":"PENDING","uniqueKey":"data.status","typeLabel":"enum\u003cstring>"},"coupons":{"type":"array","description":"Lista de cupons aplicados no Checkout.","items":{"type":"string","uniqueKey":"data.coupons.items.[INDEX]","typeLabel":"string"},"example":[],"uniqueKey":"data.coupons","typeLabel":"string[]"},"devMode":{"type":"boolean","description":"Indica se a cobrança foi criada em ambiente de testes.","example":false,"uniqueKey":"data.devMode","typeLabel":"boolean"},"customerId":{"oneOf":[{"type":"string","description":"ID do cliente associado ao Checkout.","example":null,"uniqueKey":"data.customerId.oneOf.0","typeLabel":"string"},{"type":"null","description":"ID do cliente associado ao Checkout.","example":null,"uniqueKey":"data.customerId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.customerId","typeLabel":"string | null"},"returnUrl":{"oneOf":[{"type":"string","format":"uri","description":"URL para onde o cliente será redirecionado ao clicar em \"Voltar\".","example":null,"uniqueKey":"data.returnUrl.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"URL para onde o cliente será redirecionado ao clicar em \"Voltar\".","example":null,"uniqueKey":"data.returnUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.returnUrl","typeLabel":"string\u003curi> | null"},"completionUrl":{"oneOf":[{"type":"string","format":"uri","description":"URL para onde o cliente será redirecionado após o pagamento.","example":null,"uniqueKey":"data.completionUrl.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"URL para onde o cliente será redirecionado após o pagamento.","example":null,"uniqueKey":"data.completionUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.completionUrl","typeLabel":"string\u003curi> | null"},"receiptUrl":{"oneOf":[{"type":"string","format":"uri","description":"URL do comprovante de pagamento.","example":null,"uniqueKey":"data.receiptUrl.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"URL do comprovante de pagamento.","example":null,"uniqueKey":"data.receiptUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.receiptUrl","typeLabel":"string\u003curi> | null"},"upSellProductId":{"oneOf":[{"type":"string","description":"ID do produto de upsell vinculado ao Checkout. Null se nenhum produto de upsell foi informado na criação.","example":"prod_bump456xyz","uniqueKey":"data.upSellProductId.oneOf.0","typeLabel":"string"},{"type":"null","description":"ID do produto de upsell vinculado ao Checkout. Null se nenhum produto de upsell foi informado na criação.","example":"prod_bump456xyz","uniqueKey":"data.upSellProductId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.upSellProductId","typeLabel":"string | null"},"installmentsCount":{"oneOf":[{"type":"integer","description":"Número de parcelas do pagamento quando realizado via Cartão de crédito com mais de uma parcela. `null` para pagamentos à vista ou realizados por outros métodos (PIX, Boleto).","example":3,"uniqueKey":"data.installmentsCount.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Número de parcelas do pagamento quando realizado via Cartão de crédito com mais de uma parcela. `null` para pagamentos à vista ou realizados por outros métodos (PIX, Boleto).","example":3,"uniqueKey":"data.installmentsCount.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.installmentsCount","typeLabel":"integer | null"},"card":{"type":"object","description":"Configuração do pagamento por cartão enviada na criação.","properties":{"maxInstallments":{"type":"integer","description":"Número máximo de parcelas oferecidas no checkout.","example":12,"uniqueKey":"data.card.maxInstallments","typeLabel":"integer"},"passFeesToCustomer":{"type":"boolean","description":"Se a taxa do cartão é repassada ao cliente.","example":false,"uniqueKey":"data.card.passFeesToCustomer","typeLabel":"boolean"}},"uniqueKey":"data.card","typeLabel":"object"},"customerFee":{"oneOf":[{"type":"integer","description":"Acréscimo, em centavos, que o cliente pagou com o repasse da taxa do cartão (`card.passFeesToCustomer`). `null` sem repasse ou quando o pagamento não foi no cartão.","example":null,"uniqueKey":"data.customerFee.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Acréscimo, em centavos, que o cliente pagou com o repasse da taxa do cartão (`card.passFeesToCustomer`). `null` sem repasse ou quando o pagamento não foi no cartão.","example":null,"uniqueKey":"data.customerFee.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.customerFee","typeLabel":"integer | null"},"dueDate":{"oneOf":[{"type":"string","format":"date","description":"Data de vencimento do boleto (`YYYY-MM-DD`). `null` quando não foi configurada ou quando o método de pagamento não é BOLETO.","example":"2026-08-15","uniqueKey":"data.dueDate.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","description":"Data de vencimento do boleto (`YYYY-MM-DD`). `null` quando não foi configurada ou quando o método de pagamento não é BOLETO.","example":"2026-08-15","uniqueKey":"data.dueDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.dueDate","typeLabel":"string\u003cdate> | null"},"interest":{"oneOf":[{"type":"object","description":"Juros por atraso configurados para o boleto. `null` quando não foi configurado ou quando o método de pagamento não é BOLETO.","required":["value"],"properties":{"value":{"type":"integer","minimum":0,"description":"Percentual de juros ao mês em centésimos de percentual (`100` = 1% ao mês, `250` = 2,5% ao mês). Quando `0` ou omitido, sem juros. Calculado pro rata die após o vencimento.\nEN: Monthly late-interest rate in hundredths of a percent (`100` = 1%/month). Accrues pro rata die after the due date; `0` or omitted disables interest.","example":100,"isRequired":true,"uniqueKey":"data.interest.oneOf.0.value","typeLabel":"integer"}},"additionalProperties":false,"uniqueKey":"data.interest.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"data.interest.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.interest","typeLabel":"object | null"},"fine":{"oneOf":[{"type":"object","description":"Multa por atraso configurada para o boleto. `null` quando não foi configurada ou quando o método de pagamento não é BOLETO.","required":["value","type"],"properties":{"value":{"type":"integer","minimum":0,"description":"Quando `type = \"PERCENTAGE\"`: centésimos de percentual sobre o valor do boleto (`200` = 2%). Quando `type = \"FIXED\"`: valor fixo em centavos (`1000` = R$ 10,00). Quando `0` ou omitido, sem multa.\nEN: With `type: \"PERCENTAGE\"`, value is in hundredths of a percent (`200` = 2%). With `type: \"FIXED\"`, value is in cents (`1000` = R$ 10.00). `0` or omitted disables the fine.","example":200,"isRequired":true,"uniqueKey":"data.fine.oneOf.0.value","typeLabel":"integer"},"type":{"type":"string","description":"Tipo da multa. `PERCENTAGE` aplica percentual sobre o valor do boleto; `FIXED` aplica um valor fixo em centavos.\nEN: Fine type. `PERCENTAGE` applies a percent of the boleto amount; `FIXED` applies a fixed amount in cents.","enum":["PERCENTAGE","FIXED"],"example":"PERCENTAGE","isRequired":true,"uniqueKey":"data.fine.oneOf.0.type","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"data.fine.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"data.fine.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.fine","typeLabel":"object | null"},"metadata":{"type":"object","description":"Metadados adicionais do Checkout.","additionalProperties":true,"example":{},"uniqueKey":"data.metadata","typeLabel":"object"},"createdAt":{"type":"string","format":"date-time","description":"Data e hora de criação do Checkout.","example":"2024-11-04T18:38:28.573Z","uniqueKey":"data.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","description":"Data e hora da última atualização do Checkout.","example":"2024-11-04T18:38:28.573Z","uniqueKey":"data.updatedAt","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":"bill_abc123xyz","externalId":"pedido-123","url":"https://app.abacatepay.com/pay/bill_abc123xyz","amount":10000,"paidAmount":null,"items":[{"id":"prod_456","quantity":2}],"status":"PENDING","coupons":[],"devMode":false,"customerId":null,"returnUrl":null,"completionUrl":null,"receiptUrl":null,"upSellProductId":"prod_bump456xyz","installmentsCount":3,"card":{"maxInstallments":12,"passFeesToCustomer":false},"customerFee":null,"dueDate":"2026-08-15","interest":{"value":100},"fine":{"value":200,"type":"PERCENTAGE"},"metadata":{},"createdAt":"2024-11-04T18:38:28.573Z","updatedAt":"2024-11-04T18:38:28.573Z"},"error":null,"success":true}}},"exampleType":"generated"}},"exampleType":"generated"},"f0aef0ea-3c44-4c03-b57e-50936fbf6b85":{"description":"Não autorizado. Falha na autenticação.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Mensagem de erro descrevendo o motivo da falha na autenticação.","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"},"3b4b41aa-f753-4dec-a81e-23b7a982b6ec":{"description":"Cobrança não encontrada.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Mensagem de erro indicando que a cobrança não foi encontrada.","example":"Billing not found","uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Billing not found"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"cd9b5448-ad6c-4bbf-ae7e-0e8a0e5c362b":{"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":"Buscar um Checkout - AbacatePay","navMaps":{"firstHrefInVersion":{"v2":{"href":"/pages/payment/one","matchLevel":0},"v1":{"href":"/pages/v1/introduction","matchLevel":4}},"firstHrefInLanguage":{}},"lastModified":"2026-11-10T18:22:53.964Z","originalFileLocation":"pages/payment/one.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=\"Retorna os dados de um Checkout específico usando o ID. Você pode usar essa rota para buscar um Checkout por ID e visualizar seus detalhes, status e informações relacionadas. Informe ao menos um entre id, externalId e customerId. Sem nenhum deles, a API retorna Provide id, externalId or customerId. Checkouts de assinatura (frequency: SUBSCRIPTION) não são retornados por esta rota. Use GET /subscriptions/checkouts/get.\">\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=\"Buscar um Checkout - AbacatePay\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retorna os dados de um Checkout específico usando o ID. Você pode usar essa rota para buscar um Checkout por ID e visualizar seus detalhes, status e informações relacionadas. Informe ao menos um entre id, externalId e customerId. Sem nenhum deles, a API retorna Provide id, externalId or customerId. Checkouts de assinatura (frequency: SUBSCRIPTION) não são retornados por esta rota. Use GET /subscriptions/checkouts/get.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"AbacatePay\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.abacatepay.com/pages/payment/one\">\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=Checkouts\u0026amp;title=Buscar+um+Checkout\u0026amp;description=Retorna+os+dados+de+um+Checkout+espec%C3%ADfico+usando+o+ID.%0A%0AVoc%C3%AA+pode+usar+essa+rota+para+buscar+um+Checkout+por+ID+e+visualizar+seus+detalhes%2C+status+e+informa%C3%A7%C3%B5e\u0026amp;theme=d064f9bb23a6adfe2e6e208f\u0026amp;signature=b4dadfcc26a96a3d8423d5d62d2c1e53dcf25cd9cb9cae30894c5bb5f1216f96\">\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=\"Buscar um Checkout - AbacatePay\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retorna os dados de um Checkout específico usando o ID. Você pode usar essa rota para buscar um Checkout por ID e visualizar seus detalhes, status e informações relacionadas. Informe ao menos um entre id, externalId e customerId. Sem nenhum deles, a API retorna Provide id, externalId or customerId. Checkouts de assinatura (frequency: SUBSCRIPTION) não são retornados por esta rota. Use GET /subscriptions/checkouts/get.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://abacatepay.mintlify.site/_mintlify/api/og/v2?division=Checkouts\u0026amp;title=Buscar+um+Checkout\u0026amp;description=Retorna+os+dados+de+um+Checkout+espec%C3%ADfico+usando+o+ID.%0A%0AVoc%C3%AA+pode+usar+essa+rota+para+buscar+um+Checkout+por+ID+e+visualizar+seus+detalhes%2C+status+e+informa%C3%A7%C3%B5e\u0026amp;theme=d064f9bb23a6adfe2e6e208f\u0026amp;signature=b4dadfcc26a96a3d8423d5d62d2c1e53dcf25cd9cb9cae30894c5bb5f1216f96\">\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/payment/one\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/pages/payment/one.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/payment/one#webpage\",\"url\":\"https://docs.abacatepay.com/pages/payment/one\",\"name\":\"Buscar um Checkout\",\"description\":\"Retorna os dados de um Checkout específico usando o ID. Você pode usar essa rota para buscar um Checkout por ID e visualizar seus detalhes, status e informações relacionadas. Informe ao menos um entre id, externalId e customerId. Sem nenhum deles, a API retorna Provide id, externalId or customerId. Checkouts de assinatura (frequency: SUBSCRIPTION) não são retornados por esta rota. Use GET /subscriptions/checkouts/get.\",\"dateModified\":\"2026-11-10T18:22:53.964Z\",\"isPartOf\":{\"@id\":\"https://docs.abacatepay.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.abacatepay.com/pages/payment/one#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.abacatepay.com/pages/payment/one#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Checkouts\",\"item\":\"https://docs.abacatepay.com/pages/payment/create\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Buscar um Checkout\",\"item\":\"https://docs.abacatepay.com/pages/payment/one\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.abacatepay.com/pages/payment/one#apireference\",\"headline\":\"Buscar um Checkout\",\"name\":\"Buscar um Checkout\",\"description\":\"Retorna os dados de um Checkout específico usando o ID. Você pode usar essa rota para buscar um Checkout por ID e visualizar seus detalhes, status e informações relacionadas. Informe ao menos um entre id, externalId e customerId. Sem nenhum deles, a API retorna Provide id, externalId or customerId. Checkouts de assinatura (frequency: SUBSCRIPTION) não são retornados por esta rota. Use GET /subscriptions/checkouts/get.\",\"url\":\"https://docs.abacatepay.com/pages/payment/one\",\"mainEntityOfPage\":{\"@id\":\"https://docs.abacatepay.com/pages/payment/one#webpage\"},\"dateModified\":\"2026-11-10T18:22:53.964Z\",\"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/payment/one.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","description":"Retorna os Checkouts de pagamento único (`frequency: ONE_TIME`) que você criou.\n\nLinks de pagamento (`MULTIPLE_PAYMENTS`) e checkouts de assinatura (`SUBSCRIPTION`) não entram nesta lista: use `GET /payment-links/list` e `GET /subscriptions/checkouts/list`.\n","href":"/pages/payment/list"},{"title":"Buscar um Checkout","openapi":"GET /checkouts/get","href":"/pages/payment/one"},{"title":"Reembolsar um Checkout","openapi":"POST /checkouts/refund","description":"Reembolsa integralmente um Checkout pago (PIX ou Cartão). O valor reembolsado é igual ao valor original da transação — reembolsos parciais não são suportados.\n\nCobranças de assinatura não podem ser reembolsadas pela API v2.\n","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","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","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":"Buscar um Checkout - 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"]}