Use upSellProductId para oferecer um produto adicional ao cliente após a conclusão do pagamento. O produto deve ser avulso (sem cycle) e estar com status ACTIVE. Veja a referência completa de upsell.
Use dueDate (YYYY-MM-DD) para definir a data de vencimento. Se omitido, o padrão é 3 dias úteis. Só se aplica a methods: ["BOLETO"]. Veja a referência completa.
Use interest e fine para configurar juros por atraso e multa caso o cliente pague depois do vencimento. Os campos só se aplicam a methods: ["BOLETO"] e são ignorados nos demais métodos. Veja a referência completa.
Use card.maxInstallments (1–12) para permitir que o cliente parcele no cartão. O valor mínimo por parcela é R$ 10,00. Veja a doc completa de parcelamento.
Use card.passFeesToCustomer: true para o cliente pagar a taxa do cartão e você receber o preço cheio. O acréscimo pago vem em customerFee. Veja como funciona.
Redirecione o cliente para data.url — é lá que ele finaliza o pagamento.
Acrescente ?skip_customer=true à url para tirar a etapa de dados pessoais e skip_address=true para tirar a de endereço. Veja como fica cada forma de pagamento.
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.
Data de vencimento do boleto no formato YYYY-MM-DD (ex: "2026-08-15"). Opcional. Só é válido quando methods inclui BOLETO; ignorado nos demais métodos.
Se omitido, o vencimento padrão é de 3 dias úteis. Não pode ser data no passado. Máximo de 365 dias no futuro.
{"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":""},"chroma":{"liveDeploymentHistoryId":"6ae38625a9357d7601721d87","collectionId":"31706968-90f5-4999-bd01-a00483a901ca","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae38625a9357d7601721d87"},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6ae38625a9357d7601721d87","clientVersion":"0.0.4021","searchFilterCounts":[{"language":"default","tag":"Referência","count":72},{"language":"default","tag":"API Reference","count":32},{"language":"default","tag":"CLI","count":14},{"language":"default","tag":"Webhooks","count":14},{"language":"default","tag":"Vídeos","count":14},{"language":"default","tag":"Guias","count":11},{"language":"default","tag":"SDKs","count":11},{"language":"default","tag":"Assinaturas","count":10},{"language":"default","tag":"Checkout Transparente","count":10},{"language":"default","tag":"Para Lojistas","count":9}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"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":"byok-sep-25","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[{"filePath":"custom.css","content":"button:has-text(\"Try it\"),button[aria-label*=\"Try it\"],button[class*=try-it]{background-color:#9eea6c!important;color:#0a1b39!important}.mintlify-code button,.mintlify-code-block button[class*=try],button[data-testid=try-it-button],pre button[class*=try]{background-color:#9eea6c!important;color:#0a1b39!important}button[aria-label*=\"Try it\"]:hover,button[class*=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/create","slug":"/pages/payment/create","pageMetadata":{"title":"Criar um Checkout","openapi":"POST /checkouts/create","description":"Cria um Checkout para o cliente realizar o pagamento.","href":"/pages/payment/create"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Cria um Checkout para o cliente realizar o pagamento.\"\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`,..._provideComponents(),...props.components},{Card,CodeBlock,Note,Tip}=_components;if(!Card)_missingMdxReference(`Card`,true);if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Note)_missingMdxReference(`Note`,true);if(!Tip)_missingMdxReference(`Tip`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Gera uma página de pagamento hospedada. Você envia os produtos; a API devolve a `,_jsx(_components.code,{children:`url`}),` para redirecionar o cliente.`]}),`\n`,_jsx(Card,{horizontal:true,children:_jsxs(_components.p,{children:[`Requer a permissão `,_jsx(_components.code,{children:`CHECKOUT:CREATE`}),`.`]})}),`\n`,_jsx(Card,{title:`Obrigatório`,horizontal:true,children:_jsxs(_components.p,{children:[`Só `,_jsx(_components.code,{children:`items`}),` é obrigatório — lista com `,_jsx(_components.code,{children:`id`}),` do produto e `,_jsx(_components.code,{children:`quantity`}),`.`]})}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Exemplo mínimo:`})}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`5`,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:`5`,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:` \"items\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"prod_abc123xyz\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"quantity\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`1`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Exemplo completo:`})}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`14`,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:`14`,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:` \"items\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"prod_abc123xyz\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"quantity\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`1`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})]}),`\n`,_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:` \"externalId\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"pedido-123\"`}),_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:` \"returnUrl\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://seusite.com/voltar\"`}),_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:` \"completionUrl\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://seusite.com/sucesso\"`}),_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:` \"methods\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"PIX\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"CARD\"`}),_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:` \"card\"`}),_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:` \"maxInstallments\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`12`})]}),`\n`,_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:` \"metadata\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"origem\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"app-mobile\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Exemplo com upsell:`})}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`6`,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:`6`,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:` \"items\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"prod_abc123xyz\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"quantity\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`1`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})]}),`\n`,_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:` \"upSellProductId\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"prod_bump456xyz\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Exemplo com vencimento customizado (apenas BOLETO):`})}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`7`,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:`7`,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:` \"methods\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"BOLETO\"`}),_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:` \"dueDate\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2026-08-15\"`}),_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:` \"items\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"prod_abc123xyz\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"quantity\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`1`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Exemplo com multa e juros (apenas BOLETO):`})}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`9`,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:`9`,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:` \"methods\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"BOLETO\"`}),_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:` \"dueDate\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2026-08-15\"`}),_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:` \"items\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"prod_abc123xyz\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"quantity\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`1`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})]}),`\n`,_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:` \"interest\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"value\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`100`}),_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:` \"fine\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"value\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`200`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"PERCENTAGE\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Tip,{title:`Upsell`,horizontal:true,children:_jsxs(_components.p,{children:[`Use `,_jsx(_components.code,{children:`upSellProductId`}),` para oferecer um produto adicional ao cliente após a conclusão do pagamento. O produto deve ser `,_jsx(_components.strong,{children:`avulso`}),` (sem `,_jsx(_components.code,{children:`cycle`}),`) e estar com status `,_jsx(_components.code,{children:`ACTIVE`}),`. Veja a `,_jsx(_components.a,{href:`/pages/payment/reference#upsell`,children:`referência completa de upsell`}),`.`]})}),`\n`,_jsx(Tip,{title:`Vencimento do boleto`,horizontal:true,children:_jsxs(_components.p,{children:[`Use `,_jsx(_components.code,{children:`dueDate`}),` (`,_jsx(_components.code,{children:`YYYY-MM-DD`}),`) para definir a data de vencimento. Se omitido, o padrão é 3 dias úteis. Só se aplica a `,_jsx(_components.code,{children:`methods: [\"BOLETO\"]`}),`. Veja a `,_jsx(_components.a,{href:`/pages/payment/reference#data-de-vencimento-do-boleto`,children:`referência completa`}),`.`]})}),`\n`,_jsx(Tip,{title:`Multa e juros no boleto`,horizontal:true,children:_jsxs(_components.p,{children:[`Use `,_jsx(_components.code,{children:`interest`}),` e `,_jsx(_components.code,{children:`fine`}),` para configurar juros por atraso e multa caso o cliente pague depois do vencimento. Os campos só se aplicam a `,_jsx(_components.code,{children:`methods: [\"BOLETO\"]`}),` e são ignorados nos demais métodos. Veja a `,_jsx(_components.a,{href:`/pages/payment/reference#multa-e-juros-no-boleto`,children:`referência completa`}),`.`]})}),`\n`,_jsx(Tip,{title:`Parcelamento no cartão`,horizontal:true,children:_jsxs(_components.p,{children:[`Use `,_jsx(_components.code,{children:`card.maxInstallments`}),` (1–12) para permitir que o cliente parcele no cartão. O valor mínimo por parcela é R$ 10,00. Veja a `,_jsx(_components.a,{href:`/pages/payment/installments`,children:`doc completa de parcelamento`}),`.`]})}),`\n`,_jsx(Tip,{title:`Repasse da taxa do cartão`,horizontal:true,children:_jsxs(_components.p,{children:[`Use `,_jsx(_components.code,{children:`card.passFeesToCustomer: true`}),` para o cliente pagar a taxa do cartão e você receber o preço cheio. O acréscimo pago vem em `,_jsx(_components.code,{children:`customerFee`}),`. Veja `,_jsx(_components.a,{href:`/pages/payment/installments#repassar-a-taxa-ao-cliente`,children:`como funciona`}),`.`]})}),`\n`,_jsx(Tip,{title:`Use a url retornada`,horizontal:true,children:_jsxs(_components.p,{children:[`Redirecione o cliente para `,_jsx(_components.code,{children:`data.url`}),` — é lá que ele finaliza o pagamento.`]})}),`\n`,_jsx(Tip,{title:`Pular as etapas de dados do cliente`,horizontal:true,children:_jsxs(_components.p,{children:[`Acrescente `,_jsx(_components.code,{children:`?skip_customer=true`}),` à `,_jsx(_components.code,{children:`url`}),` para tirar a etapa de dados pessoais e `,_jsx(_components.code,{children:`skip_address=true`}),` para tirar a de endereço. Veja `,_jsx(_components.a,{href:`/pages/payment/reference#pular-as-etapas-de-dados-do-cliente`,children:`como fica cada forma de pagamento`}),`.`]})}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`Para cobranças recorrentes use `,_jsx(_components.a,{href:`/pages/subscriptions/create`,children:`Assinaturas`}),`. Para um link que múltiplos clientes podem pagar use `,_jsx(_components.a,{href:`/pages/payment-links/create`,children:`Links de pagamento`}),`.`]})})]})}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 Checkout","openapi":"POST /checkouts/create","description":"Cria um Checkout para o cliente realizar o pagamento.","href":"/pages/payment/create"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Criar um Checkout","description":"Cria um Checkout para o cliente realizar o pagamento.","security":["225b9110-0bb9-4125-a225-798b73d03ea5"],"requestBody":"f2139fa8-2e6b-4ada-ab97-421d89877bca","responses":{"200":"de0006a2-d249-40e4-b2a3-39099211cc02","401":"3bfe4cda-f1be-489d-8290-d099c38eed14"},"method":"post","type":"path","servers":["a19b1832-ebac-465a-86ce-584fa3ca8b9f"],"path":"/checkouts/create","baseUrlOptions":["https://api.abacatepay.com/v2"],"title":"Criar um Checkout","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["items"],"additionalProperties":false,"example":{"items":[{"id":"prod-1234","quantity":2}],"methods":["PIX","CARD"]},"properties":{"items":{"type":"array","description":"Lista de itens incluídos na cobrança.\nEste é o único campo obrigatório — o valor total é calculado a partir destes itens.\n","minItems":1,"items":{"type":"object","additionalProperties":false,"required":["id","quantity"],"properties":{"id":{"type":"string","description":"ID público do produto na sua loja.","example":"prod-1234","isRequired":true,"uniqueKey":"\\items.items.[INDEX].id","typeLabel":"string"},"quantity":{"type":"integer","description":"Quantidade deste item.","minimum":1,"example":2,"isRequired":true,"uniqueKey":"\\items.items.[INDEX].quantity","typeLabel":"integer"}},"uniqueKey":"\\items.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"\\items","typeLabel":"object[]"},"methods":{"type":"array","description":"Métodos de pagamento disponíveis. Padrão [\"PIX\", \"CARD\"].","items":{"type":"string","enum":["PIX","CARD","BOLETO"],"uniqueKey":"methods.items.[INDEX]","typeLabel":"enum\u003cstring>"},"minItems":1,"default":["PIX","CARD"],"x-mint":{"hidden":true},"uniqueKey":"methods","typeLabel":"enum\u003cstring>[]"},"returnUrl":{"type":"string","format":"uri","description":"URL para onde o cliente será redirecionado ao clicar em \"Voltar\" no checkout.","x-mint":{"hidden":true},"uniqueKey":"returnUrl","typeLabel":"string\u003curi>"},"completionUrl":{"type":"string","format":"uri","description":"URL para onde o cliente será redirecionado após o pagamento ser concluído.","x-mint":{"hidden":true},"uniqueKey":"completionUrl","typeLabel":"string\u003curi>"},"customerId":{"type":"string","description":"ID de um cliente já cadastrado na sua loja.\nSe informado, o checkout será pré-preenchido com os dados deste cliente.\n\n**Exemplo**: `\"cust_abcdefghij\"`\n","x-mint":{"hidden":true},"uniqueKey":"customerId","typeLabel":"string"},"coupons":{"type":"array","description":"Lista de cupons que podem ser utilizados nesta cobrança.\n\n**Exemplo**: `[\"ABKT10\", \"ABKT5\", \"PROMO10\"]`\n","items":{"type":"string","uniqueKey":"coupons.items.[INDEX]","typeLabel":"string"},"maxItems":50,"x-mint":{"hidden":true},"uniqueKey":"coupons","typeLabel":"string[]"},"externalId":{"type":"string","description":"ID da cobrança no seu sistema, caso queira manter uma referência própria.\n\n**Exemplo**: `\"seu_id_123\"`\n","x-mint":{"hidden":true},"uniqueKey":"externalId","typeLabel":"string"},"upSellProductId":{"type":"string","description":"ID de um produto avulso (sem `cycle`) a ser ofertado como upsell após a conclusão do pagamento.\n\nO produto deve estar com `status: ACTIVE` e **não pode ter `cycle`** — apenas produtos de pagamento único são aceitos.\n\n**Exemplo**: `\"prod_bump456xyz\"`\n","x-mint":{"hidden":true},"uniqueKey":"upSellProductId","typeLabel":"string"},"dueDate":{"type":"string","format":"date","description":"Data de vencimento do boleto no formato `YYYY-MM-DD` (ex: `\"2026-08-15\"`). Opcional. Só é válido quando `methods` inclui `BOLETO`; ignorado nos demais métodos.\n\nSe omitido, o vencimento padrão é de 3 dias úteis. Não pode ser data no passado. Máximo de 365 dias no futuro.\n","example":"2026-08-15","x-mint":{"hidden":true},"uniqueKey":"dueDate","typeLabel":"string\u003cdate>"},"interest":{"type":"object","description":"Juros por atraso, aplicados apenas quando `methods` inclui `BOLETO`. Ignorado para PIX/CARD.","required":["value"],"x-mint":{"hidden":true},"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":"interest.value","typeLabel":"integer"}},"additionalProperties":false,"uniqueKey":"interest","typeLabel":"object"},"fine":{"type":"object","description":"Multa por atraso, aplicada apenas quando `methods` inclui `BOLETO`. Ignorado para PIX/CARD.","required":["value","type"],"x-mint":{"hidden":true},"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":"fine.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":"fine.type","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"fine","typeLabel":"object"},"metadata":{"type":"object","description":"Metadados adicionais da cobrança. Campo livre para a sua aplicação.\n\n**Exemplo**:\n```json\n{\n \"source\": \"landing-page-black-friday\",\n \"campaign\": \"BF-2025\"\n}\n```\n","additionalProperties":true,"x-mint":{"hidden":true},"uniqueKey":"metadata","typeLabel":"object"},"card":{"type":"object","description":"Configuração do pagamento por cartão. Só tem efeito quando `methods` inclui `CARD`.","additionalProperties":false,"required":["maxInstallments"],"properties":{"maxInstallments":{"type":"integer","description":"Número máximo de parcelas oferecidas no checkout.","minimum":1,"maximum":12,"example":12,"isRequired":true,"uniqueKey":"card.maxInstallments","typeLabel":"integer"},"passFeesToCustomer":{"type":"boolean","description":"Repassa a taxa do cartão ao cliente: ele paga o preço mais o acréscimo, e você recebe o preço cheio. Requer `CARD` em `methods`. Não vale para assinaturas.","default":false,"example":true,"uniqueKey":"card.passFeesToCustomer","typeLabel":"boolean"}},"uniqueKey":"card","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"items":[{"id":"prod-1234","quantity":2}],"methods":["PIX","CARD"]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"de0006a2-d249-40e4-b2a3-39099211cc02":{"description":"Cobrança criada 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"},"3bfe4cda-f1be-489d-8290-d099c38eed14":{"description":"Não autorizado. Falha na autenticação.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"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"}},"security":{"225b9110-0bb9-4125-a225-798b73d03ea5":{"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":{"a19b1832-ebac-465a-86ce-584fa3ca8b9f":{"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 Checkout - AbacatePay","navMaps":{"firstHrefInVersion":{"v2":{"href":"/pages/payment/create","matchLevel":0},"v1":{"href":"/pages/v1/introduction","matchLevel":4}},"firstHrefInLanguage":{}},"lastModified":"2026-10-20T20:23:04.335Z","originalFileLocation":"pages/payment/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=\"Cria um Checkout para o cliente realizar o pagamento.\">\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 Checkout - AbacatePay\">\u003cmeta data-mint-head property=\"og:description\" content=\"Cria um Checkout para o cliente realizar o pagamento.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"AbacatePay\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.abacatepay.com/pages/payment/create\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://abacatepay.mintlify.app/_mintlify/api/og/v2?division=Cobrar+com+Checkout\u0026amp;title=Criar+um+Checkout\u0026amp;description=Cria+um+Checkout+para+o+cliente+realizar+o+pagamento.\u0026amp;theme=50c7415e24595ab8b55c789a\u0026amp;signature=1c585bea4e08040c9d7fd1f59c52176932a45ce23d77d1b7417ea41eab2c8977\">\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 Checkout - AbacatePay\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Cria um Checkout para o cliente realizar o pagamento.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://abacatepay.mintlify.app/_mintlify/api/og/v2?division=Cobrar+com+Checkout\u0026amp;title=Criar+um+Checkout\u0026amp;description=Cria+um+Checkout+para+o+cliente+realizar+o+pagamento.\u0026amp;theme=50c7415e24595ab8b55c789a\u0026amp;signature=1c585bea4e08040c9d7fd1f59c52176932a45ce23d77d1b7417ea41eab2c8977\">\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/create\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/pages/payment/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/payment/create#webpage\",\"url\":\"https://docs.abacatepay.com/pages/payment/create\",\"name\":\"Criar um Checkout\",\"description\":\"Cria um Checkout para o cliente realizar o pagamento.\",\"dateModified\":\"2026-10-20T20:23:04.335Z\",\"isPartOf\":{\"@id\":\"https://docs.abacatepay.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.abacatepay.com/pages/payment/create#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.abacatepay.com/pages/payment/create#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Cobrar com Checkout\",\"item\":\"https://docs.abacatepay.com/pages/payment/reference\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Criar um Checkout\",\"item\":\"https://docs.abacatepay.com/pages/payment/create\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.abacatepay.com/pages/payment/create#apireference\",\"headline\":\"Criar um Checkout\",\"name\":\"Criar um Checkout\",\"description\":\"Cria um Checkout para o cliente realizar o pagamento.\",\"url\":\"https://docs.abacatepay.com/pages/payment/create\",\"mainEntityOfPage\":{\"@id\":\"https://docs.abacatepay.com/pages/payment/create#webpage\"},\"dateModified\":\"2026-10-20T20:23:04.335Z\",\"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\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"AbacatePay","nav":{"global":null,"versions":[{"version":"v2","tag":"Current","tabs":[{"tab":"Comece aqui","pages":[{"title":"Comece aqui","href":"/pages/start/welcome"}]},{"tab":"Para Lojistas","pages":[{"title":"Para Lojistas","href":"/pages/concepts/overview"}]},{"tab":"Guias","pages":[{"title":"Guias","href":"/pages/authentication"}]},{"tab":"Webhooks","pages":[{"title":"Webhooks","href":"/pages/webhooks"}]},{"tab":"Referência","groups":[{"group":"Introdução","pages":[{"title":"Introdução","icon":"book-open","href":"/pages/reference/introduction"}]},{"group":"Cobrar com Checkout","pages":[{"title":"Referência","description":"Crie um checkout","icon":"book-open-cover","href":"/pages/payment/reference"},{"title":"Criar um Checkout","openapi":"POST /checkouts/create","href":"/pages/payment/create"},{"title":"Receber parcelado (Cartão)","description":"Permita que seus clientes paguem em até 12x no cartão de crédito.","icon":"credit-card","href":"/pages/payment/installments"},{"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":"Referência","icon":"book-open-cover","href":"/pages/payment-links/reference"},{"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":"Clientes","pages":[{"title":"Referência","icon":"book-open-cover","href":"/pages/client/reference"},{"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":"Referência","icon":"book-open-cover","href":"/pages/customer-portal/reference"},{"title":"Criar um link do portal","openapi":"POST /customer-portal/create","href":"/pages/customer-portal/create"}]},{"group":"Checkout Transparente","pages":[{"title":"Referência","icon":"book-open-cover","href":"/pages/transparents/reference"},{"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","api":"POST /transparents/create","href":"/pages/transparents/card"},{"title":"Chave pública (publicKey)","icon":"key","href":"/pages/transparents/public-key"},{"title":"abacatepay.js","icon":"js","href":"/pages/transparents/abacatepay-js"},{"title":"Listar Checkouts Transparentes","openapi":"GET /transparents/list","href":"/pages/transparents/list"},{"title":"Simular Pagamento","openapi":"POST /transparents/simulate-payment","href":"/pages/transparents/simulate-payment"},{"title":"Checar Status","openapi":"GET /transparents/check","href":"/pages/transparents/check"},{"title":"Reembolsar Checkout Transparente","openapi":"POST /transparents/refund","href":"/pages/transparents/refund"}]},{"group":"Cupons","pages":[{"title":"Referência","icon":"book-open-cover","href":"/pages/coupons/reference"},{"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":"Produtos","pages":[{"title":"Referência","icon":"book-open-cover","href":"/pages/products/reference"},{"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":"Webhooks","pages":[{"title":"Referência","icon":"book-open-cover","href":"/pages/webhooks/reference"},{"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"}]},{"group":"Assinaturas","pages":[{"title":"Referência","icon":"book-open-cover","href":"/pages/subscriptions/reference"},{"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":"Deletar 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":"Referência","icon":"book-open-cover","href":"/pages/payouts/reference"},{"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":"PIX","pages":[{"title":"Referência","icon":"book-open-cover","href":"/pages/pix/reference"},{"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":"Extrato","pages":[{"title":"Referência","icon":"book-open-cover","href":"/pages/bank-statement/reference"},{"title":"Listar extrato","openapi":"GET /bank-statement/list","href":"/pages/bank-statement/list"}]},{"group":"Loja","pages":[{"title":"Referência","icon":"store","href":"/pages/store/reference"},{"title":"Obter detalhes da loja","openapi":"GET /stores/get","href":"/pages/store/get"}]},{"group":"Public MRR","pages":[{"title":"Referência","icon":"book-open-cover","href":"/pages/trustMRR/reference"},{"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/get"},{"title":"Obter Receita por Período","openapi":"openapi.yaml GET /public-mrr/revenue","href":"/pages/trustMRR/list"}]}]},{"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"}]}]},"title":"Criar um Checkout - AbacatePay","buildId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","deploymentId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-26-lDe7V.js","utils-CWQmgYtH.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-4-Aw3rSD.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C2zjXYA5.js","snippetPresets-DFmpFA7C.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-FJpQavWq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D_GvPF7k.js","shallow-Bs2ZB0NO.js","getApiPlaygroundDisplay-DCcqJJk-.js","CodeSnippet-DzDxawVe.js","CodeSnippets-aUr7fU-7.js","Page-CT9uE8Ip.js","getPastedJson-Y1fKsj_I.js","icon-DI4zTsDr.js","MethodPill-C0nDlmSQ.js","DuplicateIcon-NUXbx2nQ.js","createIcon-BdTHrPAi.js","DynamicMarkdown-CtpgKJwj.js","SectionHeading-B3x35tOt.js","axios-vUo_bRtp.js","Markdown-3OmurJMP.js","clsx-DMKzROTp.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-1ms6tsT-.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Ke9xIMFx.js"]}