{
"id": "ord_Xc4Vb7Nm2As5Df8G",
"object": "invoice",
"subscription": "sub_4Hn8Qw2Rt6Yp1Zx3",
"number": 1,
"status": "processing",
"currency": "brl",
"original_amount": 10000,
"original_currency": "brl",
"exchange_rate": null,
"amount": 9000,
"attempts": 123,
"items": [
{
"code": "SKU-SUB",
"description": "Assinatura",
"quantity": 1,
"amount": 10000,
"amount_total": 10000
}
],
"discounts": [
{
"type": "fixed",
"value": 1000,
"invoice_number": 1,
"amount_applied": 1000
}
],
"increments": [
{
"type": "fixed",
"value": 1000,
"invoice_number": 1,
"amount_applied": 1000
}
],
"payments": [
{
"id": "cha_8Kq2Lm9XvB3nT7pZ",
"object": "payment_intent",
"status": "requires_action",
"amount": 10000,
"amount_refunded": 0,
"currency": "brl",
"original_amount": 10000,
"original_currency": "brl",
"exchange_rate": null,
"payment_method_details": {
"type": "card",
"card": {
"brand": "visa",
"first_six": "411111",
"last_four": "1111",
"holder_name": "João Silva",
"exp_month": 12,
"exp_year": 2030
},
"pix": {
"qr_code": "00020126580014br.gov.bcb.pix0136a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"qr_code_url": "https://pix.exemplo.com.br/qr/cha_8Kq2Lm9XvB3nT7pZ",
"expires_at": "2026-09-14 16:00:00"
}
}
}
],
"next_action": {
"type": "pix_display_qr_code",
"pix": {
"qr_code": "00020126580014br.gov.bcb.pix0136a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"qr_code_url": "https://pix.exemplo.com.br/qr/cha_8Kq2Lm9XvB3nT7pZ",
"expires_at": "2026-09-14 16:00:00"
},
"otp": {
"confirmation_id": "5f1c2a9e-7b3d-4e8f-9a6c-1d2e3f4a5b6c",
"expires_at": "2026-09-14T12:15:00.000000Z"
}
},
"created_at": "<string>",
"failure_reason": {
"code": "card_declined",
"message": "O cartão não possui saldo suficiente para concluir o pagamento.",
"customer_message": "Não foi possível concluir o pagamento. Revise os dados informados ou tente outro meio de pagamento.",
"merchant_message": "O pagamento não foi concluído. Oriente o comprador a revisar os dados informados ou tentar outro meio de pagamento."
}
}
{
"error": {
"type": "authentication_error",
"code": "invalid_api_secret",
"message": "A chave de API informada é inválida."
}
}
{
"error": {
"type": "invalid_request_error",
"code": "account_requests_blocked",
"message": "As requisições desta conta estão bloqueadas.",
"customer_message": "Não foi possível concluir sua transação. Tente novamente mais tarde."
}
}
{
"error": {
"type": "invalid_request_error",
"code": "api_rate_limited",
"message": "Muitas requisições em pouco tempo. Tente novamente em alguns instantes."
}
}
Faturas
Consultar fatura
Consulta uma fatura de assinatura pelo id. O status da fatura reflete o último pagamento: uma fatura recusada pode ser paga de novo com POST /v2/invoices/{id}/pay.
{
"id": "ord_Xc4Vb7Nm2As5Df8G",
"object": "invoice",
"subscription": "sub_4Hn8Qw2Rt6Yp1Zx3",
"number": 1,
"status": "processing",
"currency": "brl",
"original_amount": 10000,
"original_currency": "brl",
"exchange_rate": null,
"amount": 9000,
"attempts": 123,
"items": [
{
"code": "SKU-SUB",
"description": "Assinatura",
"quantity": 1,
"amount": 10000,
"amount_total": 10000
}
],
"discounts": [
{
"type": "fixed",
"value": 1000,
"invoice_number": 1,
"amount_applied": 1000
}
],
"increments": [
{
"type": "fixed",
"value": 1000,
"invoice_number": 1,
"amount_applied": 1000
}
],
"payments": [
{
"id": "cha_8Kq2Lm9XvB3nT7pZ",
"object": "payment_intent",
"status": "requires_action",
"amount": 10000,
"amount_refunded": 0,
"currency": "brl",
"original_amount": 10000,
"original_currency": "brl",
"exchange_rate": null,
"payment_method_details": {
"type": "card",
"card": {
"brand": "visa",
"first_six": "411111",
"last_four": "1111",
"holder_name": "João Silva",
"exp_month": 12,
"exp_year": 2030
},
"pix": {
"qr_code": "00020126580014br.gov.bcb.pix0136a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"qr_code_url": "https://pix.exemplo.com.br/qr/cha_8Kq2Lm9XvB3nT7pZ",
"expires_at": "2026-09-14 16:00:00"
}
}
}
],
"next_action": {
"type": "pix_display_qr_code",
"pix": {
"qr_code": "00020126580014br.gov.bcb.pix0136a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"qr_code_url": "https://pix.exemplo.com.br/qr/cha_8Kq2Lm9XvB3nT7pZ",
"expires_at": "2026-09-14 16:00:00"
},
"otp": {
"confirmation_id": "5f1c2a9e-7b3d-4e8f-9a6c-1d2e3f4a5b6c",
"expires_at": "2026-09-14T12:15:00.000000Z"
}
},
"created_at": "<string>",
"failure_reason": {
"code": "card_declined",
"message": "O cartão não possui saldo suficiente para concluir o pagamento.",
"customer_message": "Não foi possível concluir o pagamento. Revise os dados informados ou tente outro meio de pagamento.",
"merchant_message": "O pagamento não foi concluído. Oriente o comprador a revisar os dados informados ou tentar outro meio de pagamento."
}
}
{
"error": {
"type": "authentication_error",
"code": "invalid_api_secret",
"message": "A chave de API informada é inválida."
}
}
{
"error": {
"type": "invalid_request_error",
"code": "account_requests_blocked",
"message": "As requisições desta conta estão bloqueadas.",
"customer_message": "Não foi possível concluir sua transação. Tente novamente mais tarde."
}
}
{
"error": {
"type": "invalid_request_error",
"code": "api_rate_limited",
"message": "Muitas requisições em pouco tempo. Tente novamente em alguns instantes."
}
}
O id da fatura aparece em latest_invoice.id da assinatura e na listagem de faturas.
Esta rota encontra apenas faturas de assinaturas. O identificador de um pedido avulso retorna 404 (resource_missing). Para pedidos, use Consultar pedido.
Quando status é failed, a resposta traz o motivo em failure_reason. Quando o cliente precisa agir, next_action traz o QR Code PIX ou os dados do código de verificação.
Chave de API (secret key) da conta, no formato sk_live_... (produção) ou sk_test_... (Ambiente de Sandbox). Envie no header Authorization: Bearer <chave>. Autentica todas as rotas da API v2 e as rotas de Análise de Fraude. A chave identifica a conta, então a API v2 não usa o header account. Uma chave só é aceita no ambiente em que foi criada. Gere a sua no dashboard em Configurações → Chaves de API.
Identificador do recurso (o campo id devolvido pela API)
Response
Fatura encontrada
Fatura de um ciclo da assinatura. processing: em processamento. requires_action: PIX aguardando pagamento ou verificação por código (veja next_action). paid: paga. failed: recusada (veja failure_reason). canceled: cancelada. refunded e partially_refunded: estornada. chargeback: contestada.
Cotação usada: 1 unidade da moeda original = exchange_rate reais. null quando a moeda é BRL. Única por fatura: uma nova tentativa reaproveita a cotação da primeira cobrança.
Valor cobrado, em centavos de real, já com descontos e acréscimos. Fecha ao centavo com Σ items[].amount_total − Σ discounts[].amount_applied + Σ increments[].amount_applied. Somar items[].amount × quantity não tem essa garantia.
Itens da fatura. amount é o valor unitário, em centavos de real, convertido pela exchange_rate. amount_total é o total bruto da linha, em centavos de real, conciliado com o amount da fatura.
Descontos da fatura. value é o valor declarado: em fixed, centavos de real convertidos pela exchange_rate; em percentage, o percentual, sem conversão. amount_applied é o valor efetivamente descontado, em centavos de real.
Acréscimos da fatura, com os mesmos campos de discounts. amount_applied é o valor efetivamente acrescido, em centavos de real. Acréscimos não têm limite.
O que precisa acontecer para o pagamento seguir. pix_display_qr_code: exiba o QR Code para o pagador. otp_confirmation: a análise de fraude pediu verificação — nada é cobrado até o código ser confirmado na rota /confirm.
Motivo da recusa. Presente só quando o status é failed
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"4SeletPay","colors":{"primary":"#007AFF","light":"#0A84FF","dark":"#0056B3"},"logo":{"light":"https://mintcdn.com/4selet-1a9bfa9b/AoymSTBvUJFLYdIf/logo/logo.png?fit=max\u0026auto=format\u0026n=AoymSTBvUJFLYdIf\u0026q=85\u0026s=16da9497a7389abca443032d35b63e76","dark":"https://mintcdn.com/4selet-1a9bfa9b/AoymSTBvUJFLYdIf/logo/logo.png?fit=max\u0026auto=format\u0026n=AoymSTBvUJFLYdIf\u0026q=85\u0026s=16da9497a7389abca443032d35b63e76"},"favicon":"https://mintcdn.com/4selet-1a9bfa9b/AoymSTBvUJFLYdIf/favicon.ico?fit=max\u0026auto=format\u0026n=AoymSTBvUJFLYdIf\u0026q=85\u0026s=7c1498fab479f449a80d48e59dab01aa","api":{},"appearance":{"default":"dark","strict":false},"navbar":{"links":[{"href":"https://docs.4seletpay.com.br/llms.txt","label":"llms.txt"},{"href":"mailto:suporte@4selet.com.br","label":"Suporte"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.4seletpay.com.br"}},"footer":{"socials":{"website":"https://4seletpay.com.br"}},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"4selet-1a9bfa9b","hasAudioNarration":false,"actualSubdomain":"4selet-1a9bfa9b","customDomains":["docs.4seletpay.com.br"],"gitSource":{"type":"github","owner":"4st-cardoso","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"entitlements":{},"buildId":"6ac8f95ee8838694528cec2c","clientVersion":"0.0.4111","searchFilterCounts":[{"language":"default","tag":"Referência","count":72},{"language":"default","tag":"Webhooks","count":19},{"language":"default","tag":"Comece aqui","count":18},{"language":"default","tag":"Assinaturas","count":17},{"language":"default","tag":"Pedidos","count":11},{"language":"default","tag":"Eventos","count":10},{"language":"default","tag":"Cartões","count":9},{"language":"default","tag":"Cobranças","count":9},{"language":"default","tag":"Faturas","count":7},{"language":"default","tag":"Links de Pagamento","count":6}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"custom.css","content":"button[class*=\"try-it\"],button[aria-label*=\"Try it\"],button:has-text(\"Try it\"){background-color:#007AFF!important;color:#FFFFFF!important}button[data-testid=\"try-it-button\"],.mintlify-code-block button[class*=\"try\"],pre button[class*=\"try\"],.mintlify-code button{background-color:#007AFF!important;color:#FFFFFF!important}button[class*=\"try-it\"]:hover,button[aria-label*=\"Try it\"]:hover{background-color:#0056B3!important}[class*=\"TryIt\"] button,[class*=\"try-it\"] button,button:contains(\"Try it\"){background-color:#007AFF!important;color:#FFFFFF!important}"}],"page":{"pagePath":"pages/v2/faturas/get","slug":"/pages/v2/faturas/get","pageMetadata":{"title":"Consultar fatura","openapi":"GET /v2/invoices/{id}","description":"Consulta uma fatura de assinatura pelo `id`. O status da fatura reflete o último pagamento: uma fatura recusada pode ser paga de novo com `POST /v2/invoices/{id}/pay`.\n","href":"/pages/v2/faturas/get"},"description":{"compiledSource":"\"use strict\";\nconst {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(_components.p, {\n children: [\"Consulta uma fatura de assinatura pelo \", _jsx(_components.code, {\n children: \"id\"\n }), \". O status da fatura reflete o último pagamento: uma fatura recusada pode ser paga de novo com \", _jsx(_components.code, {\n children: \"POST /v2/invoices/{id}/pay\"\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`,..._provideComponents(),...props.components},{Info,Note,Tip}=_components;if(!Info)_missingMdxReference(`Info`,true);if(!Note)_missingMdxReference(`Note`,true);if(!Tip)_missingMdxReference(`Tip`,true);return _jsxs(_Fragment,{children:[_jsx(Note,{children:_jsxs(_components.p,{children:[`O `,_jsx(_components.code,{children:`id`}),` da fatura aparece em `,_jsx(_components.code,{children:`latest_invoice.id`}),` da assinatura e na `,_jsx(_components.a,{href:`/pages/v2/assinaturas/invoices`,children:`listagem de faturas`}),`.`]})}),`\n`,_jsx(Info,{children:_jsxs(_components.p,{children:[`Esta rota encontra apenas faturas de assinaturas. O identificador de um pedido avulso retorna `,_jsx(_components.code,{children:`404`}),` (`,_jsx(_components.code,{children:`resource_missing`}),`). Para pedidos, use `,_jsx(_components.a,{href:`/pages/v2/pedidos/get`,children:`Consultar pedido`}),`.`]})}),`\n`,_jsx(Tip,{children:_jsxs(_components.p,{children:[`Quando `,_jsx(_components.code,{children:`status`}),` é `,_jsx(_components.code,{children:`failed`}),`, a resposta traz o motivo em `,_jsx(_components.code,{children:`failure_reason`}),`. Quando o cliente precisa agir, `,_jsx(_components.code,{children:`next_action`}),` traz o QR Code PIX ou os dados do código de verificação.`]})})]})}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":"Consultar fatura","openapi":"GET /v2/invoices/{id}","description":"Consulta uma fatura de assinatura pelo `id`. O status da fatura reflete o último pagamento: uma fatura recusada pode ser paga de novo com `POST /v2/invoices/{id}/pay`.\n","href":"/pages/v2/faturas/get"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Faturas (v2)"],"summary":"Consultar fatura","description":"Consulta uma fatura de assinatura pelo `id`. O status da fatura reflete o último pagamento: uma fatura recusada pode ser paga de novo com `POST /v2/invoices/{id}/pay`.\n","operationId":"v2RetrieveInvoice","security":["e880d821-3f7f-45e3-960d-25801a1862d9"],"parameters":["52e3676e-9f85-4061-9b49-b4f818d36184"],"responses":{"200":"90532a11-a3d6-4902-9eb4-719b5c830a15","401":"20a4f49c-e007-418e-bf48-86e2e2c9215b","403":"fa9df052-7fd9-49a0-aba0-3a555eebfa89","404":"078d7a13-f28f-45de-a4e0-a89d8bf96336","429":"9e2d96cc-fed9-49c2-a075-fe483df46312"},"method":"get","type":"path","servers":["4c3dfa86-2ed5-4f58-9a07-b7d334d46949"],"path":"/v2/invoices/{id}","baseUrlOptions":["https://sandbox.4seletpay.com.br/api"],"title":"Consultar fatura","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"52e3676e-9f85-4061-9b49-b4f818d36184":{"name":"id","in":"path","required":true,"description":"Identificador do recurso (o campo `id` devolvido pela API)","schema":{"type":"string","isRequired":true,"description":"Identificador do recurso (o campo `id` devolvido pela API)","uniqueKey":"","typeLabel":"string"}}},"responses":{"90532a11-a3d6-4902-9eb4-719b5c830a15":{"description":"Fatura encontrada","content":{"application/json":{"schema":{"type":"object","description":"Fatura de um ciclo da assinatura. `processing`: em processamento. `requires_action`: PIX aguardando pagamento ou verificação por código (veja `next_action`). `paid`: paga. `failed`: recusada (veja `failure_reason`). `canceled`: cancelada. `refunded` e `partially_refunded`: estornada. `chargeback`: contestada.\n","properties":{"id":{"type":"string","example":"ord_Xc4Vb7Nm2As5Df8G","uniqueKey":"id","typeLabel":"string"},"object":{"type":"string","enum":["invoice"],"uniqueKey":"object","typeLabel":"enum\u003cstring>"},"subscription":{"type":"string","example":"sub_4Hn8Qw2Rt6Yp1Zx3","uniqueKey":"subscription","typeLabel":"string"},"number":{"type":"integer","description":"Número da fatura na assinatura","example":1,"uniqueKey":"number","typeLabel":"integer"},"status":{"type":"string","enum":["processing","requires_action","paid","failed","canceled","refunded","partially_refunded","chargeback"],"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"currency":{"type":"string","enum":["brl"],"description":"Sempre `brl`","example":"brl","uniqueKey":"currency","typeLabel":"enum\u003cstring>"},"original_amount":{"type":"integer","description":"Valor da fatura na moeda da assinatura, em centavos. Igual a `amount` em BRL","example":10000,"uniqueKey":"original_amount","typeLabel":"integer"},"original_currency":{"type":"string","description":"Moeda enviada, em minúsculas","example":"brl","uniqueKey":"original_currency","typeLabel":"string"},"exchange_rate":{"oneOf":[{"type":"number","description":"Cotação usada: 1 unidade da moeda original = `exchange_rate` reais. `null` quando a moeda é BRL. Única por fatura: uma nova tentativa reaproveita a cotação da primeira cobrança.\n","example":null,"uniqueKey":"exchange_rate.oneOf.0","typeLabel":"number"},{"type":"null","description":"Cotação usada: 1 unidade da moeda original = `exchange_rate` reais. `null` quando a moeda é BRL. Única por fatura: uma nova tentativa reaproveita a cotação da primeira cobrança.\n","example":null,"uniqueKey":"exchange_rate.oneOf.1","typeLabel":"null"}],"uniqueKey":"exchange_rate","typeLabel":"number | null"},"amount":{"type":"integer","description":"Valor cobrado, em centavos de real, já com descontos e acréscimos. Fecha ao centavo com Σ `items[].amount_total` − Σ `discounts[].amount_applied` + Σ `increments[].amount_applied`. Somar `items[].amount × quantity` não tem essa garantia.\n","example":9000,"uniqueKey":"amount","typeLabel":"integer"},"attempts":{"type":"integer","description":"Tentativas de cobrança","uniqueKey":"attempts","typeLabel":"integer"},"items":{"type":"array","description":"Itens da fatura. `amount` é o valor unitário, em centavos de real, convertido pela `exchange_rate`. `amount_total` é o total bruto da linha, em centavos de real, conciliado com o `amount` da fatura.\n","items":{"type":"object","required":["code","description","quantity","amount"],"properties":{"code":{"type":"string","maxLength":255,"example":"SKU-SUB","isRequired":true,"uniqueKey":"\\items.items.[INDEX].code","typeLabel":"string"},"description":{"type":"string","maxLength":255,"example":"Assinatura","isRequired":true,"uniqueKey":"\\items.items.[INDEX].description","typeLabel":"string"},"quantity":{"type":"integer","minimum":1,"example":1,"isRequired":true,"uniqueKey":"\\items.items.[INDEX].quantity","typeLabel":"integer"},"amount":{"type":"integer","minimum":1,"description":"Valor unitário, em centavos","example":10000,"isRequired":true,"uniqueKey":"\\items.items.[INDEX].amount","typeLabel":"integer"},"amount_total":{"type":"integer","description":"Total bruto da linha (valor unitário × quantidade), em centavos de real, conciliado com o `amount` da fatura","example":10000,"uniqueKey":"\\items.items.[INDEX].amount_total","typeLabel":"integer"}},"uniqueKey":"\\items.items.[INDEX]","typeLabel":"object"},"uniqueKey":"\\items","typeLabel":"object[]"},"discounts":{"type":"array","description":"Descontos da fatura. `value` é o valor declarado: em `fixed`, centavos de real convertidos pela `exchange_rate`; em `percentage`, o percentual, sem conversão. `amount_applied` é o valor efetivamente descontado, em centavos de real.\n","items":{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["fixed","percentage"],"isRequired":true,"uniqueKey":"discounts.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"value":{"type":"number","exclusiveMinimum":0,"description":"Em `fixed`, valor inteiro em centavos. Em `percentage`, percentual (em descontos, no máximo 100).\n","example":1000,"isRequired":true,"uniqueKey":"discounts.items.[INDEX].value","typeLabel":"number"},"invoice_number":{"oneOf":[{"type":"integer","minimum":1,"description":"Número da fatura a que o ajuste se aplica. Sem valor, vale para todas as faturas","example":1,"uniqueKey":"discounts.items.[INDEX].invoice_number.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":1,"description":"Número da fatura a que o ajuste se aplica. Sem valor, vale para todas as faturas","example":1,"uniqueKey":"discounts.items.[INDEX].invoice_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"discounts.items.[INDEX].invoice_number","typeLabel":"integer | null"},"amount_applied":{"type":"integer","description":"Valor efetivamente aplicado, em centavos de real, inclusive em `percentage`. Nos descontos, o total aplicado é limitado ao valor dos itens e repartido na proporção do valor declarado de cada desconto; por isso pode ser menor que `value`. Nos acréscimos, não há limite.\n","example":1000,"uniqueKey":"discounts.items.[INDEX].amount_applied","typeLabel":"integer"}},"uniqueKey":"discounts.items.[INDEX]","typeLabel":"object"},"uniqueKey":"discounts","typeLabel":"object[]"},"increments":{"type":"array","description":"Acréscimos da fatura, com os mesmos campos de `discounts`. `amount_applied` é o valor efetivamente acrescido, em centavos de real. Acréscimos não têm limite.\n","items":{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["fixed","percentage"],"isRequired":true,"uniqueKey":"increments.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"value":{"type":"number","exclusiveMinimum":0,"description":"Em `fixed`, valor inteiro em centavos. Em `percentage`, percentual (em descontos, no máximo 100).\n","example":1000,"isRequired":true,"uniqueKey":"increments.items.[INDEX].value","typeLabel":"number"},"invoice_number":{"oneOf":[{"type":"integer","minimum":1,"description":"Número da fatura a que o ajuste se aplica. Sem valor, vale para todas as faturas","example":1,"uniqueKey":"increments.items.[INDEX].invoice_number.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":1,"description":"Número da fatura a que o ajuste se aplica. Sem valor, vale para todas as faturas","example":1,"uniqueKey":"increments.items.[INDEX].invoice_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"increments.items.[INDEX].invoice_number","typeLabel":"integer | null"},"amount_applied":{"type":"integer","description":"Valor efetivamente aplicado, em centavos de real, inclusive em `percentage`. Nos descontos, o total aplicado é limitado ao valor dos itens e repartido na proporção do valor declarado de cada desconto; por isso pode ser menor que `value`. Nos acréscimos, não há limite.\n","example":1000,"uniqueKey":"increments.items.[INDEX].amount_applied","typeLabel":"integer"}},"uniqueKey":"increments.items.[INDEX]","typeLabel":"object"},"uniqueKey":"increments","typeLabel":"object[]"},"payments":{"type":"array","items":{"type":"object","description":"Um meio de pagamento dentro de um pedido ou fatura. O `id` é o mesmo da cobrança (`GET /v2/charges/{id}`).\n","properties":{"id":{"type":"string","example":"cha_8Kq2Lm9XvB3nT7pZ","uniqueKey":"payments.items.[INDEX].id","typeLabel":"string"},"object":{"type":"string","enum":["payment_intent"],"uniqueKey":"payments.items.[INDEX].object","typeLabel":"enum\u003cstring>"},"status":{"type":"string","enum":["requires_action","requires_capture","processing","paid","failed","canceled","refund_processing","partially_refunded","refunded","chargeback"],"description":"`requires_action`: PIX aguardando pagamento ou verificação por código. `requires_capture`: cartão autorizado, aguardando captura. `processing`: em processamento. `paid`: pago. `failed`: recusado. `canceled`: cancelado. `refund_processing`: estorno em processamento. `partially_refunded` e `refunded`: estornado em parte ou totalmente. `chargeback`: contestado pelo portador.\n","uniqueKey":"payments.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"amount":{"type":"integer","description":"Valor cobrado, em centavos de real","example":10000,"uniqueKey":"payments.items.[INDEX].amount","typeLabel":"integer"},"amount_refunded":{"type":"integer","description":"Valor estornado, em centavos","example":0,"uniqueKey":"payments.items.[INDEX].amount_refunded","typeLabel":"integer"},"currency":{"type":"string","enum":["brl"],"description":"Sempre `brl`","example":"brl","uniqueKey":"payments.items.[INDEX].currency","typeLabel":"enum\u003cstring>"},"original_amount":{"type":"integer","description":"Valor na moeda enviada, em centavos. Igual a `amount` em BRL","example":10000,"uniqueKey":"payments.items.[INDEX].original_amount","typeLabel":"integer"},"original_currency":{"type":"string","description":"Moeda enviada, em minúsculas","example":"brl","uniqueKey":"payments.items.[INDEX].original_currency","typeLabel":"string"},"exchange_rate":{"oneOf":[{"type":"number","description":"Cotação usada: 1 unidade da moeda original = `exchange_rate` reais. `null` quando a moeda é BRL.\n","example":null,"uniqueKey":"payments.items.[INDEX].exchange_rate.oneOf.0","typeLabel":"number"},{"type":"null","description":"Cotação usada: 1 unidade da moeda original = `exchange_rate` reais. `null` quando a moeda é BRL.\n","example":null,"uniqueKey":"payments.items.[INDEX].exchange_rate.oneOf.1","typeLabel":"null"}],"uniqueKey":"payments.items.[INDEX].exchange_rate","typeLabel":"number | null"},"payment_method_details":{"type":"object","properties":{"type":{"type":"string","enum":["card","pix","boleto"],"uniqueKey":"payments.items.[INDEX].payment_method_details.type","typeLabel":"enum\u003cstring>"},"card":{"type":"object","description":"Cartão vinculado à cobrança. Só aparece quando a cobrança tem um cartão vinculado: sem cartão, a chave `card` não é enviada (ela não vem com `null`). O `id` do cartão não é devolvido em pedidos nem em cobranças. O número completo e o código de segurança nunca são devolvidos.\n","properties":{"brand":{"type":"string","example":"visa","uniqueKey":"payments.items.[INDEX].payment_method_details.card.brand","typeLabel":"string"},"first_six":{"oneOf":[{"type":"string","example":"411111","uniqueKey":"payments.items.[INDEX].payment_method_details.card.first_six.oneOf.0","typeLabel":"string"},{"type":"null","example":"411111","uniqueKey":"payments.items.[INDEX].payment_method_details.card.first_six.oneOf.1","typeLabel":"null"}],"uniqueKey":"payments.items.[INDEX].payment_method_details.card.first_six","typeLabel":"string | null"},"last_four":{"oneOf":[{"type":"string","example":"1111","uniqueKey":"payments.items.[INDEX].payment_method_details.card.last_four.oneOf.0","typeLabel":"string"},{"type":"null","example":"1111","uniqueKey":"payments.items.[INDEX].payment_method_details.card.last_four.oneOf.1","typeLabel":"null"}],"uniqueKey":"payments.items.[INDEX].payment_method_details.card.last_four","typeLabel":"string | null"},"holder_name":{"type":"string","example":"João Silva","uniqueKey":"payments.items.[INDEX].payment_method_details.card.holder_name","typeLabel":"string"},"exp_month":{"oneOf":[{"type":"integer","example":12,"uniqueKey":"payments.items.[INDEX].payment_method_details.card.exp_month.oneOf.0","typeLabel":"integer"},{"type":"null","example":12,"uniqueKey":"payments.items.[INDEX].payment_method_details.card.exp_month.oneOf.1","typeLabel":"null"}],"uniqueKey":"payments.items.[INDEX].payment_method_details.card.exp_month","typeLabel":"integer | null"},"exp_year":{"oneOf":[{"type":"integer","example":2030,"uniqueKey":"payments.items.[INDEX].payment_method_details.card.exp_year.oneOf.0","typeLabel":"integer"},{"type":"null","example":2030,"uniqueKey":"payments.items.[INDEX].payment_method_details.card.exp_year.oneOf.1","typeLabel":"null"}],"uniqueKey":"payments.items.[INDEX].payment_method_details.card.exp_year","typeLabel":"integer | null"}},"uniqueKey":"payments.items.[INDEX].payment_method_details.card","typeLabel":"object"},"pix":{"type":"object","properties":{"qr_code":{"type":"string","description":"Código PIX copia e cola","example":"00020126580014br.gov.bcb.pix0136a1b2c3d4-e5f6-7890-abcd-ef1234567890","uniqueKey":"payments.items.[INDEX].payment_method_details.pix.qr_code","typeLabel":"string"},"qr_code_url":{"type":"string","description":"Link do QR Code","example":"https://pix.exemplo.com.br/qr/cha_8Kq2Lm9XvB3nT7pZ","uniqueKey":"payments.items.[INDEX].payment_method_details.pix.qr_code_url","typeLabel":"string"},"expires_at":{"type":"string","description":"Data e hora de expiração do QR Code, no formato `AAAA-MM-DD HH:MM:SS`, sem indicação de fuso","example":"2026-09-14 16:00:00","uniqueKey":"payments.items.[INDEX].payment_method_details.pix.expires_at","typeLabel":"string"}},"uniqueKey":"payments.items.[INDEX].payment_method_details.pix","typeLabel":"object"}},"uniqueKey":"payments.items.[INDEX].payment_method_details","typeLabel":"object"}},"uniqueKey":"payments.items.[INDEX]","typeLabel":"object"},"uniqueKey":"payments","typeLabel":"object[]"},"next_action":{"oneOf":[{"type":"object","description":"O que precisa acontecer para o pagamento seguir. `pix_display_qr_code`: exiba o QR Code para o pagador. `otp_confirmation`: a análise de fraude pediu verificação — nada é cobrado até o código ser confirmado na rota `/confirm`.\n","properties":{"type":{"type":"string","enum":["pix_display_qr_code","otp_confirmation"],"uniqueKey":"next_action.oneOf.0.type","typeLabel":"enum\u003cstring>"},"pix":{"type":"object","properties":{"qr_code":{"type":"string","description":"Código PIX copia e cola","example":"00020126580014br.gov.bcb.pix0136a1b2c3d4-e5f6-7890-abcd-ef1234567890","uniqueKey":"next_action.oneOf.0.pix.qr_code","typeLabel":"string"},"qr_code_url":{"type":"string","description":"Link do QR Code","example":"https://pix.exemplo.com.br/qr/cha_8Kq2Lm9XvB3nT7pZ","uniqueKey":"next_action.oneOf.0.pix.qr_code_url","typeLabel":"string"},"expires_at":{"type":"string","description":"Data e hora de expiração do QR Code, no formato `AAAA-MM-DD HH:MM:SS`, sem indicação de fuso","example":"2026-09-14 16:00:00","uniqueKey":"next_action.oneOf.0.pix.expires_at","typeLabel":"string"}},"uniqueKey":"next_action.oneOf.0.pix","typeLabel":"object"},"otp":{"type":"object","description":"Presente quando `type` é `otp_confirmation`","properties":{"confirmation_id":{"type":"string","example":"5f1c2a9e-7b3d-4e8f-9a6c-1d2e3f4a5b6c","uniqueKey":"next_action.oneOf.0.otp.confirmation_id","typeLabel":"string"},"expires_at":{"type":"string","description":"Data e hora de expiração do código, em UTC (ISO 8601)","example":"2026-09-14T12:15:00.000000Z","uniqueKey":"next_action.oneOf.0.otp.expires_at","typeLabel":"string"}},"uniqueKey":"next_action.oneOf.0.otp","typeLabel":"object"}},"uniqueKey":"next_action.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"next_action.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_action","typeLabel":"object | null"},"created_at":{"type":"string","uniqueKey":"created_at","typeLabel":"string"},"failure_reason":{"type":"object","description":"Motivo da recusa. Presente só quando o status é `failed`","required":["code","message","customer_message","merchant_message"],"properties":{"code":{"type":"string","enum":["card_declined","insufficient_funds","expired_card","incorrect_cvc","incorrect_number","card_not_supported","fraud_suspected","invalid_request","acquirer_error","processing_error"],"isRequired":true,"uniqueKey":"failure_reason.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Texto técnico. Não exiba ao pagador","example":"O cartão não possui saldo suficiente para concluir o pagamento.","isRequired":true,"uniqueKey":"failure_reason.message","typeLabel":"string"},"customer_message":{"type":"string","description":"Texto para exibir ao pagador","example":"Não foi possível concluir o pagamento. Revise os dados informados ou tente outro meio de pagamento.","isRequired":true,"uniqueKey":"failure_reason.customer_message","typeLabel":"string"},"merchant_message":{"type":"string","description":"Texto para você ou a sua equipe de atendimento","example":"O pagamento não foi concluído. Oriente o comprador a revisar os dados informados ou tentar outro meio de pagamento.","isRequired":true,"uniqueKey":"failure_reason.merchant_message","typeLabel":"string"}},"uniqueKey":"failure_reason","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"ord_Xc4Vb7Nm2As5Df8G","object":"invoice","subscription":"sub_4Hn8Qw2Rt6Yp1Zx3","number":1,"status":"processing","currency":"brl","original_amount":10000,"original_currency":"brl","exchange_rate":null,"amount":9000,"attempts":123,"items":[{"code":"SKU-SUB","description":"Assinatura","quantity":1,"amount":10000,"amount_total":10000}],"discounts":[{"type":"fixed","value":1000,"invoice_number":1,"amount_applied":1000}],"increments":[{"type":"fixed","value":1000,"invoice_number":1,"amount_applied":1000}],"payments":[{"id":"cha_8Kq2Lm9XvB3nT7pZ","object":"payment_intent","status":"requires_action","amount":10000,"amount_refunded":0,"currency":"brl","original_amount":10000,"original_currency":"brl","exchange_rate":null,"payment_method_details":{"type":"card","card":{"brand":"visa","first_six":"411111","last_four":"1111","holder_name":"João Silva","exp_month":12,"exp_year":2030},"pix":{"qr_code":"00020126580014br.gov.bcb.pix0136a1b2c3d4-e5f6-7890-abcd-ef1234567890","qr_code_url":"https://pix.exemplo.com.br/qr/cha_8Kq2Lm9XvB3nT7pZ","expires_at":"2026-09-14 16:00:00"}}}],"next_action":{"type":"pix_display_qr_code","pix":{"qr_code":"00020126580014br.gov.bcb.pix0136a1b2c3d4-e5f6-7890-abcd-ef1234567890","qr_code_url":"https://pix.exemplo.com.br/qr/cha_8Kq2Lm9XvB3nT7pZ","expires_at":"2026-09-14 16:00:00"},"otp":{"confirmation_id":"5f1c2a9e-7b3d-4e8f-9a6c-1d2e3f4a5b6c","expires_at":"2026-09-14T12:15:00.000000Z"}},"created_at":"\u003cstring>","failure_reason":{"code":"card_declined","message":"O cartão não possui saldo suficiente para concluir o pagamento.","customer_message":"Não foi possível concluir o pagamento. Revise os dados informados ou tente outro meio de pagamento.","merchant_message":"O pagamento não foi concluído. Oriente o comprador a revisar os dados informados ou tentar outro meio de pagamento."}}}},"exampleType":"generated"}},"exampleType":"generated"},"20a4f49c-e007-418e-bf48-86e2e2c9215b":{"description":"Chave de API ausente, inválida, revogada ou de outro ambiente","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro da API v2","required":["error"],"properties":{"error":{"type":"object","required":["type","code","message"],"properties":{"type":{"type":"string","enum":["invalid_request_error","idempotency_error","authentication_error","api_error"],"description":"Categoria do erro","isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","description":"Código estável do erro. Use este campo na sua lógica","example":"validation_error","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Texto técnico, para log e depuração. Não exiba ao pagador","example":"The payments field is required.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"param":{"type":"string","description":"Campo que causou o erro, em notação de ponto. Presente só quando se aplica","example":"payments","uniqueKey":"error.param","typeLabel":"string"},"customer_message":{"type":"string","description":"Texto para exibir ao pagador. Presente só quando se aplica","uniqueKey":"error.customer_message","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"type":"authentication_error","code":"invalid_api_secret","message":"A chave de API informada é inválida."}},"examples":{"Example":{"title":"Example","value":{"error":{"type":"authentication_error","code":"invalid_api_secret","message":"A chave de API informada é inválida."}}}},"exampleType":"examples"}},"exampleType":"examples"},"fa9df052-7fd9-49a0-aba0-3a555eebfa89":{"description":"As requisições da conta estão bloqueadas. A resposta traz `customer_message`","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro da API v2","required":["error"],"properties":{"error":{"type":"object","required":["type","code","message"],"properties":{"type":{"type":"string","enum":["invalid_request_error","idempotency_error","authentication_error","api_error"],"description":"Categoria do erro","isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","description":"Código estável do erro. Use este campo na sua lógica","example":"validation_error","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Texto técnico, para log e depuração. Não exiba ao pagador","example":"The payments field is required.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"param":{"type":"string","description":"Campo que causou o erro, em notação de ponto. Presente só quando se aplica","example":"payments","uniqueKey":"error.param","typeLabel":"string"},"customer_message":{"type":"string","description":"Texto para exibir ao pagador. Presente só quando se aplica","uniqueKey":"error.customer_message","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"type":"invalid_request_error","code":"account_requests_blocked","message":"As requisições desta conta estão bloqueadas.","customer_message":"Não foi possível concluir sua transação. Tente novamente mais tarde."}},"examples":{"Example":{"title":"Example","value":{"error":{"type":"invalid_request_error","code":"account_requests_blocked","message":"As requisições desta conta estão bloqueadas.","customer_message":"Não foi possível concluir sua transação. Tente novamente mais tarde."}}}},"exampleType":"examples"}},"exampleType":"examples"},"078d7a13-f28f-45de-a4e0-a89d8bf96336":{"description":"Fatura não encontrada nesta conta","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro da API v2","required":["error"],"properties":{"error":{"type":"object","required":["type","code","message"],"properties":{"type":{"type":"string","enum":["invalid_request_error","idempotency_error","authentication_error","api_error"],"description":"Categoria do erro","isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","description":"Código estável do erro. Use este campo na sua lógica","example":"validation_error","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Texto técnico, para log e depuração. Não exiba ao pagador","example":"The payments field is required.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"param":{"type":"string","description":"Campo que causou o erro, em notação de ponto. Presente só quando se aplica","example":"payments","uniqueKey":"error.param","typeLabel":"string"},"customer_message":{"type":"string","description":"Texto para exibir ao pagador. Presente só quando se aplica","uniqueKey":"error.customer_message","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"type":"invalid_request_error","code":"resource_missing","message":"Recurso \"invoice\" não encontrado."}},"examples":{"Example":{"title":"Example","value":{"error":{"type":"invalid_request_error","code":"resource_missing","message":"Recurso \"invoice\" não encontrado."}}}},"exampleType":"examples"}},"exampleType":"examples"},"9e2d96cc-fed9-49c2-a075-fe483df46312":{"description":"Limite geral de requisições excedido (120 por minuto por chave de API e por conta). Usa o envelope `error` da API v2, com `code` `api_rate_limited`. O `type` é `invalid_request_error`, como em outros erros de requisição: identifique o estrangulamento pelo `code`, não pelo `type`.\n","headers":{"X-RateLimit-Limit":{"description":"Limite de requisições da janela","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requisições restantes na janela","schema":{"type":"integer"}},"Retry-After":{"description":"Segundos até a próxima tentativa","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro da API v2","required":["error"],"properties":{"error":{"type":"object","required":["type","code","message"],"properties":{"type":{"type":"string","enum":["invalid_request_error","idempotency_error","authentication_error","api_error"],"description":"Categoria do erro","isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","description":"Código estável do erro. Use este campo na sua lógica","example":"validation_error","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Texto técnico, para log e depuração. Não exiba ao pagador","example":"The payments field is required.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"param":{"type":"string","description":"Campo que causou o erro, em notação de ponto. Presente só quando se aplica","example":"payments","uniqueKey":"error.param","typeLabel":"string"},"customer_message":{"type":"string","description":"Texto para exibir ao pagador. Presente só quando se aplica","uniqueKey":"error.customer_message","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"type":"invalid_request_error","code":"api_rate_limited","message":"Muitas requisições em pouco tempo. Tente novamente em alguns instantes."}},"examples":{"Example":{"title":"Example","value":{"error":{"type":"invalid_request_error","code":"api_rate_limited","message":"Muitas requisições em pouco tempo. Tente novamente em alguns instantes."}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"e880d821-3f7f-45e3-960d-25801a1862d9":{"secretKeyAuth":{"type":"http","scheme":"bearer","description":"Chave de API (secret key) da conta, no formato `sk_live_...` (produção) ou `sk_test_...` (Ambiente de Sandbox). Envie no header `Authorization: Bearer \u003cchave>`. Autentica todas as rotas da API v2 e as rotas de Análise de Fraude. A chave identifica a conta, então a API v2 não usa o header `account`. Uma chave só é aceita no ambiente em que foi criada. Gere a sua no dashboard em Configurações → Chaves de API.\n","scopes":[],"schemeName":"secretKeyAuth"}}},"servers":{"4c3dfa86-2ed5-4f58-9a07-b7d334d46949":{"url":"https://sandbox.4seletpay.com.br/api","description":"Servidor de Sandbox"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Chave de API (secret key) da conta, no formato `sk_live_...` (produção) ou `sk_test_...` (Ambiente de Sandbox). Envie no header `Authorization: Bearer \u003cchave>`. Autentica todas as rotas da API v2 e as rotas de Análise de Fraude. A chave identifica a conta, então a API v2 não usa o header `account`. Uma chave só é aceita no ambiente em que foi criada. Gere a sua no dashboard em Configurações → Chaves de API.\n","scopes":[],"schemeName":"secretKeyAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Chave de API (secret key) da conta, no formato `sk_live_...` (produção) ou `sk_test_...` (Ambiente de Sandbox). Envie no header `Authorization: Bearer \u003cchave>`. Autentica todas as rotas da API v2 e as rotas de Análise de Fraude. A chave identifica a conta, então a API v2 não usa o header `account`. Uma chave só é aceita no ambiente em que foi criada. Gere a sua no dashboard em Configurações → Chaves de API.\n","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"secretKeyAuth","name":"Authorization"}],"title":"secretKeyAuth"}]},"originalFileLocation":"openapi.yaml"},"subdomain":"4selet-1a9bfa9b","siteName":"4SeletPay","title":"Consultar fatura - 4SeletPay","navMaps":{"firstHrefInVersion":{"v2":{"href":"/pages/v2/faturas/get","matchLevel":0},"v1":{"href":"/pages/faturas/reference","matchLevel":2}},"firstHrefInLanguage":{}},"lastModified":"2026-09-14T17:53:22.824Z","originalFileLocation":"pages/v2/faturas/get.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"dark\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Consulta uma fatura de assinatura pelo id. O status da fatura reflete o último pagamento: uma fatura recusada pode ser paga de novo com POST /v2/invoices/{id}/pay.\">\u003cmeta data-mint-head name=\"application-name\" content=\"4SeletPay\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/4selet-1a9bfa9b/Cx20MerxjKZBNPbF/_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/4selet-1a9bfa9b/Cx20MerxjKZBNPbF/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/4selet-1a9bfa9b/Cx20MerxjKZBNPbF/_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/4selet-1a9bfa9b/Cx20MerxjKZBNPbF/_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/4selet-1a9bfa9b/Cx20MerxjKZBNPbF/_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/4selet-1a9bfa9b/Cx20MerxjKZBNPbF/_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/4selet-1a9bfa9b/Cx20MerxjKZBNPbF/_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/4selet-1a9bfa9b/Cx20MerxjKZBNPbF/_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/4selet-1a9bfa9b/Cx20MerxjKZBNPbF/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Consultar fatura - 4SeletPay\">\u003cmeta data-mint-head property=\"og:description\" content=\"Consulta uma fatura de assinatura pelo id. O status da fatura reflete o último pagamento: uma fatura recusada pode ser paga de novo com POST /v2/invoices/{id}/pay.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"4SeletPay\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.4seletpay.com.br/pages/v2/faturas/get\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://4selet-1a9bfa9b.mintlify.site/_mintlify/api/og/v2?division=Faturas\u0026amp;title=Consultar+fatura\u0026amp;description=Consulta+uma+fatura+de+assinatura+pelo+%60id%60.+O+status+da+fatura+reflete+o+%C3%BAltimo+pagamento%3A+uma+fatura+recusada+pode+ser+paga+de+novo+com+%60POST+%2Fv2%2Finvoices%2F%7Bid\u0026amp;theme=e946cf76f4ab5d90a4344f4d\u0026amp;signature=442f56424ec6b8d6de2d8f94b6c99d2cd52d1b2bada12c5584ac58c83feabb44\">\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=\"Consultar fatura - 4SeletPay\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Consulta uma fatura de assinatura pelo id. O status da fatura reflete o último pagamento: uma fatura recusada pode ser paga de novo com POST /v2/invoices/{id}/pay.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://4selet-1a9bfa9b.mintlify.site/_mintlify/api/og/v2?division=Faturas\u0026amp;title=Consultar+fatura\u0026amp;description=Consulta+uma+fatura+de+assinatura+pelo+%60id%60.+O+status+da+fatura+reflete+o+%C3%BAltimo+pagamento%3A+uma+fatura+recusada+pode+ser+paga+de+novo+com+%60POST+%2Fv2%2Finvoices%2F%7Bid\u0026amp;theme=e946cf76f4ab5d90a4344f4d\u0026amp;signature=442f56424ec6b8d6de2d8f94b6c99d2cd52d1b2bada12c5584ac58c83feabb44\">\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/4selet-1a9bfa9b/Cx20MerxjKZBNPbF/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"4SeletPay\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#007AFF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.4seletpay.com.br/pages/v2/faturas/get\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/pages/v2/faturas/get.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.4seletpay.com.br/#organization\",\"name\":\"4SeletPay\",\"url\":\"https://docs.4seletpay.com.br\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/4selet-1a9bfa9b/AoymSTBvUJFLYdIf/logo/logo.png?fit=max\u0026auto=format\u0026n=AoymSTBvUJFLYdIf\u0026q=85\u0026s=16da9497a7389abca443032d35b63e76\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.4seletpay.com.br#website\",\"name\":\"4SeletPay\",\"url\":\"https://docs.4seletpay.com.br\",\"publisher\":{\"@id\":\"https://docs.4seletpay.com.br/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.4seletpay.com.br/pages/v2/faturas/get#webpage\",\"url\":\"https://docs.4seletpay.com.br/pages/v2/faturas/get\",\"name\":\"Consultar fatura\",\"description\":\"Consulta uma fatura de assinatura pelo id. O status da fatura reflete o último pagamento: uma fatura recusada pode ser paga de novo com POST /v2/invoices/{id}/pay.\",\"dateModified\":\"2026-09-14T17:53:22.824Z\",\"isPartOf\":{\"@id\":\"https://docs.4seletpay.com.br#website\"},\"breadcrumb\":{\"@id\":\"https://docs.4seletpay.com.br/pages/v2/faturas/get#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.4seletpay.com.br/pages/v2/faturas/get#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Faturas\",\"item\":\"https://docs.4seletpay.com.br/pages/v2/faturas/reference\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Consultar fatura\",\"item\":\"https://docs.4seletpay.com.br/pages/v2/faturas/get\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.4seletpay.com.br/pages/v2/faturas/get#apireference\",\"headline\":\"Consultar fatura\",\"name\":\"Consultar fatura\",\"description\":\"Consulta uma fatura de assinatura pelo id. O status da fatura reflete o último pagamento: uma fatura recusada pode ser paga de novo com POST /v2/invoices/{id}/pay.\",\"url\":\"https://docs.4seletpay.com.br/pages/v2/faturas/get\",\"mainEntityOfPage\":{\"@id\":\"https://docs.4seletpay.com.br/pages/v2/faturas/get#webpage\"},\"dateModified\":\"2026-09-14T17:53:22.824Z\",\"publisher\":{\"@id\":\"https://docs.4seletpay.com.br/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.4seletpay.com.br#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"4SeletPay\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"4SeletPay\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/pages/v2/faturas/get.md","siteName":"4SeletPay","nav":{"global":null,"versions":[{"version":"v2","tag":"Atual","tabs":[{"tab":"Comece aqui","pages":[{"title":"Comece aqui","href":"/pages/v2/start/home"}]},{"tab":"Referência","groups":[{"group":"Pedidos","pages":[{"title":"Pedidos","icon":"receipt","href":"/pages/v2/pedidos/reference"},{"title":"Criar pedido","openapi":"POST /v2/orders","href":"/pages/v2/pedidos/create"},{"title":"Consultar pedido","openapi":"GET /v2/orders/{id}","href":"/pages/v2/pedidos/get"},{"title":"Capturar pedido","openapi":"POST /v2/orders/{id}/capture","href":"/pages/v2/pedidos/capture"},{"title":"Cancelar pedido","openapi":"POST /v2/orders/{id}/cancel","href":"/pages/v2/pedidos/cancel"},{"title":"Confirmar pedido","openapi":"POST /v2/orders/{id}/confirm","href":"/pages/v2/pedidos/confirm"},{"title":"Reenviar código de verificação","openapi":"POST /v2/orders/{id}/confirm/resend","href":"/pages/v2/pedidos/resend-confirmation"}]},{"group":"Cobranças","pages":[{"title":"Cobranças","icon":"money-bill","href":"/pages/v2/cobrancas/reference"},{"title":"Consultar cobrança","openapi":"GET /v2/charges/{id}","href":"/pages/v2/cobrancas/get"},{"title":"Estornar cobrança","openapi":"POST /v2/charges/{id}/refund","href":"/pages/v2/cobrancas/refund"}]},{"group":"Cartões","pages":[{"title":"Cartões","icon":"wallet","href":"/pages/v2/cartoes/reference"},{"title":"Salvar cartão","openapi":"POST /v2/cards","href":"/pages/v2/cartoes/create"},{"title":"Consultar cartão","openapi":"GET /v2/cards/{id}","href":"/pages/v2/cartoes/get"}]},{"group":"Assinaturas","pages":[{"title":"Assinaturas","icon":"arrows-rotate","href":"/pages/v2/assinaturas/reference"},{"title":"Criar assinatura","openapi":"POST /v2/subscriptions","href":"/pages/v2/assinaturas/create"},{"title":"Consultar assinatura","openapi":"GET /v2/subscriptions/{id}","href":"/pages/v2/assinaturas/get"},{"title":"Cancelar assinatura","openapi":"POST /v2/subscriptions/{id}/cancel","href":"/pages/v2/assinaturas/cancel"},{"title":"Alterar meio de pagamento","openapi":"PUT /v2/subscriptions/{id}/payment-method","href":"/pages/v2/assinaturas/payment-method"},{"title":"Atualizar item da assinatura","openapi":"PATCH /v2/subscriptions/{id}/items/{code}","href":"/pages/v2/assinaturas/update-item"},{"title":"Alterar data da próxima cobrança","openapi":"PUT /v2/subscriptions/{id}/next-billing-date","href":"/pages/v2/assinaturas/next-billing-date"},{"title":"Listar faturas da assinatura","openapi":"GET /v2/subscriptions/{id}/invoices","href":"/pages/v2/assinaturas/invoices"}]},{"group":"Faturas","pages":[{"title":"Faturas","description":"As cobranças de cada ciclo de uma assinatura na API v2.","icon":"file-invoice","href":"/pages/v2/faturas/reference"},{"title":"Consultar fatura","openapi":"GET /v2/invoices/{id}","href":"/pages/v2/faturas/get"},{"title":"Pagar fatura","openapi":"POST /v2/invoices/{id}/pay","description":"Cobra uma fatura que ainda não foi paga, por exemplo uma fatura recusada ou em atraso, com um cartão novo, um cartão salvo ou PIX. Se o pagamento for recusado, a resposta é 402 com `failure_reason`.\n\n**PayPal.** O PayPal processa apenas cobranças em `BRL`: uma fatura com `currency` diferente de `BRL` cobrada por ele é recusada, mesmo com a conversão para real, com 402 e `failure_reason`, não com erro de requisição.\n","href":"/pages/v2/faturas/pay"},{"title":"Confirmar código de verificação da fatura","openapi":"POST /v2/invoices/{id}/confirm","href":"/pages/v2/faturas/confirm"},{"title":"Reenviar código de verificação da fatura","openapi":"POST /v2/invoices/{id}/confirm/resend","href":"/pages/v2/faturas/resend-confirmation"}]},{"group":"Contestações","pages":[{"title":"Contestações","icon":"shield-halved","tag":"Em breve","href":"/pages/v2/contestacoes/reference"}]},{"group":"Links de pagamento","pages":[{"title":"Links de Pagamento","icon":"link","tag":"Em breve","href":"/pages/links-de-pagamento/reference"},{"title":"Criar Link de Pagamento","openapi":"POST /v1/payment-links","tag":"Em breve","href":"/pages/links-de-pagamento/create"},{"title":"Listar Links de Pagamento","openapi":"GET /v1/payment-links","tag":"Em breve","href":"/pages/links-de-pagamento/list"},{"title":"Consultar Link de Pagamento","openapi":"GET /v1/payment-links/{code}","tag":"Em breve","href":"/pages/links-de-pagamento/get"},{"title":"Cancelar Link de Pagamento","openapi":"POST /v1/payment-links/{code}/cancel","tag":"Em breve","href":"/pages/links-de-pagamento/cancel"},{"title":"Excluir Link de Pagamento","openapi":"DELETE /v1/payment-links/{code}","tag":"Em breve","href":"/pages/links-de-pagamento/delete"}]},{"group":"Análise de fraude","pages":[{"title":"Análise de Fraude","icon":"shield-check","href":"/pages/analise-de-fraude/reference"},{"title":"Analisar risco","openapi":"POST /v1/fraud/risk-analyses","href":"/pages/analise-de-fraude/create"},{"title":"Dados de teste","icon":"flask","tag":"Em breve","href":"/pages/analise-de-fraude/dados-de-teste"}]}]},{"tab":"Webhooks","pages":[{"title":"Webhooks","href":"/pages/v2/webhooks/reference"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/pages/changelog"}]}]},{"version":"v1","tag":"Legado","pages":[{"title":"v1","href":"/pages/faturas/reference"}]}]},"basePath":"","title":"Consultar fatura - 4SeletPay","buildId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","deploymentId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CybtLBIt.js","utils-BMLj2fvV.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-B6In562Y.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dr8Mfhp9.js","snippetPresets-2rmQvMVl.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-WMqJYdZj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CJ-MlPHu.js","shallow-dY3TMRCk.js","getApiPlaygroundDisplay-v-1B2bKm.js","CodeSnippet-BDhiTB7U.js","CodeSnippets-D9hnzQcS.js","Page-C4GwDT3_.js","getPastedJson-Th2V45jI.js","icon-BQXch1W9.js","MethodPill-BCqUneP3.js","DuplicateIcon-Q_-bhurZ.js","createIcon-DUjLHRqp.js","DynamicMarkdown-B-f2cqXQ.js","SectionHeading-Da5NsV4v.js","axios-vUo_bRtp.js","Markdown-D13FWkIM.js","clsx-D3Isdib3.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-C-XZBk9h.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink--qIqmmVG.js"]}