Confira a assinatura antes de agir. Quem tem o segredo consegue forjar este evento, e um
sistema que libera produto ao recebê-lo entregaria de graça.
Ver Verificar a assinatura.
É aqui que você libera acesso, fatura ou dá baixa no pedido.
Chave secreta do vendedor, criada no painel em Desenvolvedores.
O valor em claro existe uma única vez, na criação. Guardamos só o
hash SHA-256 - nem o suporte consegue recuperá-lo, o que é o ponto:
um dump do nosso banco não permite cobrar em nome de ninguém.
A chave vai no servidor. Colocá-la no navegador do comprador a
entrega a qualquer pessoa que abra a página.
Assinatura da entrega, no formato t=<timestamp>,v1=<hmac>, onde
hmac é HMAC-SHA256("<timestamp>.<corpo bruto>", <segredo>).
Duas regras ao conferir:
Calcule sobre o corpo bruto, antes de desserializar.
Reserializar muda espaçamento e ordem, e o HMAC deixa de bater.
Recuse timestamps com mais de 5 minutos. É isso que impede
alguém que interceptou uma entrega de charge.paid de reenviá-la
quantas vezes quiser, com assinatura perfeitamente válida.
Recebido. Qualquer 2xx encerra a entrega. Responda rápido e
processe depois: demorar vira retentativa, e retentativa em
fluxo de dinheiro é como um pagamento acaba contabilizado duas
vezes.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Vext","colors":{"primary":"#1A7A14","light":"#4FFC46","dark":"#14640F"},"logo":{"light":"https://mintcdn.com/vext/kcwCRAttQYaZqJCy/logo/light.svg?fit=max\u0026auto=format\u0026n=kcwCRAttQYaZqJCy\u0026q=85\u0026s=fb9b46dfbd546322b281376800e5d841","dark":"https://mintcdn.com/vext/kcwCRAttQYaZqJCy/logo/dark.svg?fit=max\u0026auto=format\u0026n=kcwCRAttQYaZqJCy\u0026q=85\u0026s=b5d7910037e70bdeaabd3c84a89ba3b8"},"favicon":"https://mintcdn.com/vext/OcFZC8TCCCNiFjKO/favicon.svg?fit=max\u0026auto=format\u0026n=OcFZC8TCCCNiFjKO\u0026q=85\u0026s=e0dfe4ab440758e15218c96ed34fe259","api":{"playground":{"display":"interactive"},"examples":{"defaults":"required","languages":["curl","php","javascript","python"]}},"appearance":{"default":"system"},"navbar":{"links":[{"href":"https://wa.me/5511936185272","label":"Suporte"}]},"footer":{"links":[{"header":"Documentação","items":[{"label":"Primeira cobrança","href":"/quickstart"},{"label":"Referência da API","href":"/api-reference/introducao"},{"label":"Webhooks","href":"/webhooks/visao-geral"}]},{"header":"Vext","items":[{"label":"Suporte","href":"https://wa.me/5511936185272"}]}]},"search":{"prompt":"Buscar na documentação da Vext"},"icons":{"library":"lucide"},"contextual":{"options":["copy","view","claude","chatgpt","mcp"],"display":"header"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"vext","hasAudioNarration":false,"actualSubdomain":"vext","customDomains":["docs.usevext.com"],"gitSource":{"type":"github","owner":"brendooliveira","repo":"documentation","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae0ead2400e864d11faf0ec","clientVersion":"0.0.4094","searchFilterCounts":[{"language":"default","tag":"Referência da API","count":30},{"language":"default","tag":"Guias","count":26},{"language":"default","tag":"Cobranças","count":5},{"language":"default","tag":"Eventos de cobrança","count":5},{"language":"default","tag":"Convenções da API","count":5},{"language":"default","tag":"Cartão","count":5},{"language":"default","tag":"Depois da venda","count":5},{"language":"default","tag":"Cartões","count":4},{"language":"default","tag":"Objetos","count":4},{"language":"default","tag":"Cartão no navegador","count":3}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/webhooks/charge-paid","slug":"/api-reference/webhooks/charge-paid","pageMetadata":{"title":"charge.paid","description":"Enviado quando o PIX é confirmado. É o evento sobre o qual o seu sistema deve agir.","icon":"badge-check","openapi":"api-reference/openapi.yaml webhook charge.paid","href":"/api-reference/webhooks/charge-paid"},"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: \"Enviado quando o PIX é confirmado. É o evento sobre o qual o seu sistema deve agir.\"\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`,p:`p`,strong:`strong`,..._provideComponents(),...props.components},{Warning}=_components;if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(Warning,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Confira a assinatura antes de agir.`}),` Quem tem o segredo consegue forjar este evento, e um\nsistema que libera produto ao recebê-lo entregaria de graça.\nVer `,_jsx(_components.a,{href:`/webhooks/assinatura`,children:`Verificar a assinatura`}),`.`]})}),`\n`,_jsx(_components.p,{children:`É aqui que você libera acesso, fatura ou dá baixa no pedido.`})]})}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":"charge.paid","description":"Enviado quando o PIX é confirmado. É o evento sobre o qual o seu sistema deve agir.","icon":"badge-check","openapi":"api-reference/openapi.yaml webhook charge.paid","href":"/api-reference/webhooks/charge-paid"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Cobrança paga","operationId":"webhookChargePaid","description":"Enviado quando o PIX é confirmado. É o evento sobre o qual o seu sistema deve agir.","parameters":["e7b80584-9973-4ecd-ac95-b9224523efa0","730c0520-2a32-4415-a23a-b5824462f7ab","9128892b-3680-4c3a-9730-eff9d5632cfe"],"requestBody":"d4b3c6e1-2aa4-4944-95d5-e9ef3d140065","responses":{"200":"d9f9f9c0-0551-48ba-83de-68e3cc040eb9","default":"9a44c2e3-9445-4b41-87a0-283dd17a7b9d"},"method":"post","type":"webhook","servers":["ed9958ae-3134-4ef6-8d55-2744b0263cea"],"security":["35d11aa8-2563-49be-9ebf-815534166e0f"],"path":"charge.paid","baseUrlOptions":["https://api.usevext.com"],"title":"Cobrança paga","codeSamples":[],"requestExampleLanguages":["bash","php","javascript","python"],"requiredOnlyExamples":true,"requestExamples":[{"language":"json","filename":"paga","code":"{\n \"id\": \"evt_01k1y6r7z2m4n6p8q0r2s4t6u8\",\n \"type\": \"charge.paid\",\n \"created_at\": \"2026-08-04T14:03:12+00:00\",\n \"data\": {\n \"charge\": {\n \"object\": \"charge\",\n \"id\": \"ch_01k1y6r6m6q2x0p3d9v4t7c8n2\",\n \"status\": \"paid\",\n \"payment_method\": \"pix\",\n \"amount\": 10000,\n \"currency\": \"BRL\",\n \"platform_fee\": 798,\n \"net_amount\": 9103,\n \"refunded_amount\": 0,\n \"description\": \"Curso de Vue 3\",\n \"reference\": \"pedido-1042\",\n \"metadata\": {\n \"carrinho\": \"cart_88f21\",\n \"campanha\": \"black-friday\"\n },\n \"customer\": {\n \"name\": \"João Comprador\",\n \"email\": \"joao@exemplo.com.br\",\n \"document\": \"111.***.***-35\"\n },\n \"pix\": {\n \"qr_code\": \"00020101021226840014br.gov.bcb.pix2562qrcodepix.example.com/v2/abcd1234\",\n \"expires_at\": \"2026-08-04T15:00:00+00:00\",\n \"end_to_end_id\": \"E12345678202608041200\"\n },\n \"created_at\": \"2026-08-04T14:00:00+00:00\",\n \"paid_at\": \"2026-08-04T14:03:11+00:00\",\n \"expired_at\": null,\n \"refunded_at\": null\n }\n }\n}"}],"requestExampleType":"webhook","responseExampleType":"generated"},"dependencies":{"parameters":{"e7b80584-9973-4ecd-ac95-b9224523efa0":{"name":"X-Vext-Signature","in":"header","required":true,"description":"Assinatura da entrega, no formato `t=\u003ctimestamp>,v1=\u003chmac>`, onde\n`hmac` é `HMAC-SHA256(\"\u003ctimestamp>.\u003ccorpo bruto>\", \u003csegredo>)`.\n\nDuas regras ao conferir:\n\n1. Calcule sobre o **corpo bruto**, antes de desserializar.\n Reserializar muda espaçamento e ordem, e o HMAC deixa de bater.\n2. **Recuse timestamps com mais de 5 minutos.** É isso que impede\n alguém que interceptou uma entrega de `charge.paid` de reenviá-la\n quantas vezes quiser, com assinatura perfeitamente válida.\n","schema":{"type":"string","pattern":"^t=[0-9]+,v1=[0-9a-f]{64}$","isRequired":true,"description":"Assinatura da entrega, no formato `t=\u003ctimestamp>,v1=\u003chmac>`, onde\n`hmac` é `HMAC-SHA256(\"\u003ctimestamp>.\u003ccorpo bruto>\", \u003csegredo>)`.\n\nDuas regras ao conferir:\n\n1. Calcule sobre o **corpo bruto**, antes de desserializar.\n Reserializar muda espaçamento e ordem, e o HMAC deixa de bater.\n2. **Recuse timestamps com mais de 5 minutos.** É isso que impede\n alguém que interceptou uma entrega de `charge.paid` de reenviá-la\n quantas vezes quiser, com assinatura perfeitamente válida.\n","uniqueKey":"","typeLabel":"string"},"example":"t=1785931392,v1=8f3c1d0a5b7e9042c6a1b3d5e7f9012345678901abcdef234567890abcdef1234"},"730c0520-2a32-4415-a23a-b5824462f7ab":{"name":"X-Vext-Event","in":"header","required":true,"description":"Tipo do evento, repetido fora do corpo. Redundante com o payload e\nútil mesmo assim: permite filtrar no seu log sem desserializar nada.\n","schema":{"type":"string","isRequired":true,"description":"Tipo do evento, repetido fora do corpo. Redundante com o payload e\nútil mesmo assim: permite filtrar no seu log sem desserializar nada.\n","uniqueKey":"","typeLabel":"string"},"example":"charge.paid"},"9128892b-3680-4c3a-9730-eff9d5632cfe":{"name":"X-Vext-Delivery","in":"header","required":true,"description":"Identificador da entrega. Cite-o ao abrir um chamado - é por ele que\nlocalizamos a tentativa, a resposta do seu servidor e o horário.\n","schema":{"type":"string","isRequired":true,"description":"Identificador da entrega. Cite-o ao abrir um chamado - é por ele que\nlocalizamos a tentativa, a resposta do seu servidor e o horário.\n","uniqueKey":"","typeLabel":"string"},"example":"4821"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","type","created_at","data"],"properties":{"id":{"type":"string","description":"Identificador do evento. Estável entre as retentativas da mesma\nentrega - use-o para deduplicar do seu lado.\n","example":"evt_01k1y6r7z2m4n6p8q0r2s4t6u8","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"type":{"type":"string","enum":["charge.paid","charge.failed","charge.in_analysis","charge.refunded","charge.chargedback","withdrawal.paid","med.opened","med.approved","med.rejected"],"isRequired":true,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"created_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"data":{"type":"object","required":["charge"],"properties":{"charge":{"oneOf":[{"type":"object","description":"A cobrança dentro de um evento. Quase sempre o objeto `Charge`\ncompleto; `ChargeMinimal` no caminho degradado descrito nele.\n","required":["object","id","status","payment_method","amount","currency","platform_fee","net_amount","refunded_amount","description","reference","metadata","customer","pix","card","boleto","created_at","paid_at","expired_at","refunded_at"],"properties":{"object":{"type":"string","const":"charge","isRequired":true,"uniqueKey":"data.charge.oneOf.0.object","typeLabel":"string"},"id":{"type":"string","description":"Código público da cobrança. Nunca é a chave primária: expor o\nautoincremento diria a qualquer cliente quantas vendas a\nplataforma inteira processou.\n","example":"ch_01k1y6r6m6q2x0p3d9v4t7c8n2","isRequired":true,"uniqueKey":"data.charge.oneOf.0.id","typeLabel":"string"},"status":{"type":"string","description":"Situação da cobrança. Só os estados de trânsito - `pending`,\n`processing` e `in_analysis` - ainda mudam sozinhos; os demais são\nterminais, exceto os que ainda admitem estorno.\n\n`processing` e `in_analysis` são do cartão: a autorização é\ndecidida na mesma requisição, mas pode parar na análise de fraude\nantes de virar `paid` ou `failed`. No PIX a cobrança vai direto de\n`pending` para o desfecho.\n\n`partially_refunded` é estado próprio, e não um `refunded` com\nasterisco: tratar uma venda devolvida pela metade como estornada\nfaria seu relatório descontar o valor inteiro.\n\n`chargedback` é definitivo: o dinheiro voltou pelo caminho da\nbandeira, e nem cancelamento nem estorno são mais possíveis.\n","enum":["pending","processing","in_analysis","paid","expired","canceled","partially_refunded","refunded","failed","chargedback"],"x-labels":{"pending":"Aguardando pagamento","processing":"Processando","in_analysis":"Em análise","paid":"Pago","expired":"Expirado","canceled":"Cancelado","partially_refunded":"Estornado em parte","refunded":"Estornado","failed":"Falhou","chargedback":"Chargeback"},"isRequired":true,"uniqueKey":"data.charge.oneOf.0.status","typeLabel":"enum\u003cstring>"},"payment_method":{"type":"string","enum":["pix","credit_card","boleto"],"description":"O meio pelo qual esta cobrança foi criada. Omitir o campo na\ncriação continua significando `pix` - é o que toda integração\nque existe hoje espera, e mudar isso as quebraria todas de uma\nvez.\n","isRequired":true,"uniqueKey":"data.charge.oneOf.0.payment_method","typeLabel":"enum\u003cstring>"},"amount":{"type":"integer","description":"**O que o comprador paga**, em centavos inteiros.\n\nCuidado com a assimetria, porque ela é a pegadinha desta API: no\n`POST` você manda o PREÇO DO PRODUTO, e aqui volta o TOTAL. No\nPix e no cartão à vista os dois são iguais; no cartão parcelado\neste é maior, porque inclui o juro que o comprador pagou.\n\nO preço do produto, de volta, é `amount - interest`.\n","format":"int64","isRequired":true,"uniqueKey":"data.charge.oneOf.0.amount","typeLabel":"integer\u003cint64>"},"currency":{"type":"string","const":"BRL","isRequired":true,"uniqueKey":"data.charge.oneOf.0.currency","typeLabel":"string"},"platform_fee":{"type":"integer","description":"Nossa taxa, em centavos inteiros. Congelada na criação: reflete\no contrato que valia quando a venda aconteceu, não o de hoje.\n\nEla incide sobre o **preço do produto** (`amount - interest`), e\nnão sobre o total pago. É o que faz parcelar não custar nada a\nvocê - ver `net_amount`.\n","format":"int64","isRequired":true,"uniqueKey":"data.charge.oneOf.0.platform_fee","typeLabel":"integer\u003cint64>"},"net_amount":{"type":"integer","description":"O que fica com o vendedor, em centavos inteiros.\n\n**Não é `amount - platform_fee`.** Essa conta dá um número maior,\ne a diferença é o JURO do parcelamento: ele está dentro do\n`amount` porque o comprador o pagou, mas não é receita de\nninguém aqui - atravessa até o arranjo de pagamento.\n\nA identidade que fecha, e que o banco confere em toda cobrança:\n\n```\namount = net_amount + platform_fee + interest + co-produção\n```\n\nNo Pix e no cartão à vista o juro é zero, e aí\n`amount - platform_fee` fecha.\n","format":"int64","isRequired":true,"uniqueKey":"data.charge.oneOf.0.net_amount","typeLabel":"integer\u003cint64>"},"refunded_amount":{"type":"integer","description":"Total já devolvido ao comprador, em centavos inteiros. Acumulado\nentre estornos parciais.\n","format":"int64","isRequired":true,"uniqueKey":"data.charge.oneOf.0.refunded_amount","typeLabel":"integer\u003cint64>"},"description":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.charge.oneOf.0.description.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.charge.oneOf.0.description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.charge.oneOf.0.description","typeLabel":"string | null"},"reference":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.charge.oneOf.0.reference.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.charge.oneOf.0.reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.charge.oneOf.0.reference","typeLabel":"string | null"},"metadata":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"data.charge.oneOf.0.metadata.additionalProperties","typeLabel":"string"},"description":"O que você enviou na criação. **Sempre um objeto**, `{}` quando\nnão houve nada - nunca `null`, para o seu código não ter dois\ncasos a tratar.\n","example":{"carrinho":"cart_88f21","campanha":"black-friday"},"isRequired":true,"uniqueKey":"data.charge.oneOf.0.metadata","typeLabel":"object"},"customer":{"oneOf":[{"type":"object","description":"`null` na cobrança que não tem comprador vinculado. A chave em\nsi nunca falta.\n","required":["name","email","document"],"properties":{"name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.charge.oneOf.0.customer.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.charge.oneOf.0.customer.oneOf.0.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.charge.oneOf.0.customer.oneOf.0.name","typeLabel":"string | null"},"email":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.charge.oneOf.0.customer.oneOf.0.email.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.charge.oneOf.0.customer.oneOf.0.email.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.charge.oneOf.0.customer.oneOf.0.email","typeLabel":"string | null"},"document":{"oneOf":[{"type":"string","description":"Mascarado. Você já enviou o documento; devolvê-lo inteiro em\ntoda consulta espalharia o dado sem nenhum ganho.\n","example":"111.***.***-35","isRequired":true,"uniqueKey":"data.charge.oneOf.0.customer.oneOf.0.document.oneOf.0","typeLabel":"string"},{"type":"null","description":"Mascarado. Você já enviou o documento; devolvê-lo inteiro em\ntoda consulta espalharia o dado sem nenhum ganho.\n","example":"111.***.***-35","isRequired":true,"uniqueKey":"data.charge.oneOf.0.customer.oneOf.0.document.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.charge.oneOf.0.customer.oneOf.0.document","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"data.charge.oneOf.0.customer.oneOf.0","typeLabel":"object"},{"type":"null","description":"`null` na cobrança que não tem comprador vinculado. A chave em\nsi nunca falta.\n","isRequired":true,"uniqueKey":"data.charge.oneOf.0.customer.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.charge.oneOf.0.customer","typeLabel":"object | null"},"pix":{"type":"object","description":"Presente em toda cobrança, inclusive nas de cartão - onde os\ntrês campos vêm `null`. Um objeto sempre presente evita o\n`if (charge.pix)` antes de cada leitura.\n","required":["qr_code","expires_at","end_to_end_id"],"properties":{"qr_code":{"oneOf":[{"type":"string","description":"Payload copia-e-cola do PIX. Gere a imagem do QR a partir\ndele - não devolvemos PNG.\n","isRequired":true,"uniqueKey":"data.charge.oneOf.0.pix.qr_code.oneOf.0","typeLabel":"string"},{"type":"null","description":"Payload copia-e-cola do PIX. Gere a imagem do QR a partir\ndele - não devolvemos PNG.\n","isRequired":true,"uniqueKey":"data.charge.oneOf.0.pix.qr_code.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.charge.oneOf.0.pix.qr_code","typeLabel":"string | null"},"expires_at":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"data.charge.oneOf.0.pix.expires_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"data.charge.oneOf.0.pix.expires_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.charge.oneOf.0.pix.expires_at","typeLabel":"string\u003cdate-time> | null"},"end_to_end_id":{"oneOf":[{"type":"string","description":"Identificador da transação no Sistema de Pagamentos\nBrasileiro. Aparece depois do pagamento e é o que o banco do\ncomprador reconhece.\n","isRequired":true,"uniqueKey":"data.charge.oneOf.0.pix.end_to_end_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Identificador da transação no Sistema de Pagamentos\nBrasileiro. Aparece depois do pagamento e é o que o banco do\ncomprador reconhece.\n","isRequired":true,"uniqueKey":"data.charge.oneOf.0.pix.end_to_end_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.charge.oneOf.0.pix.end_to_end_id","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"data.charge.oneOf.0.pix","typeLabel":"object"},"card":{"type":"object","description":"Presente em toda cobrança, inclusive nas de PIX - onde os campos\nvêm `null`. Mesma regra do `pix` acima, e pelo mesmo motivo.\n\nO que **não** está aqui, e não vai estar: os seis primeiros\ndígitos, o código de retorno da adquirente e a nota do\nantifraude. Os dois primeiros são diagnóstico nosso; a nota numa\nresposta pública seria um oráculo de risco para quem testa\ncartão em lote. O código de recusa sai numa recusa, em\n`error.details.decline_code`, onde quem lê é o seu servidor.\n","required":["brand","last_four","holder_name","installments","recurrence_cycle","interest","three_d_secure","authorized_at"],"properties":{"brand":{"oneOf":[{"type":"string","description":"A bandeira que a **Pagar.me** reconheceu, e não a que o\nnavegador leu do BIN. Elas divergem, e a que vale é esta.\n","enum":["visa","mastercard","elo","hipercard","amex","diners","discover","aura",null],"isRequired":true,"uniqueKey":"data.charge.oneOf.0.card.brand.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"A bandeira que a **Pagar.me** reconheceu, e não a que o\nnavegador leu do BIN. Elas divergem, e a que vale é esta.\n","enum":["visa","mastercard","elo","hipercard","amex","diners","discover","aura",null],"isRequired":true,"uniqueKey":"data.charge.oneOf.0.card.brand.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.charge.oneOf.0.card.brand","typeLabel":"enum\u003cstring> | null"},"last_four":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.charge.oneOf.0.card.last_four.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.charge.oneOf.0.card.last_four.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.charge.oneOf.0.card.last_four","typeLabel":"string | null"},"holder_name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.charge.oneOf.0.card.holder_name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.charge.oneOf.0.card.holder_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.charge.oneOf.0.card.holder_name","typeLabel":"string | null"},"installments":{"oneOf":[{"type":"integer","description":"`null` no PIX. A coluna tem default `1`, mas \"uma parcela\"\nnuma cobrança que não parcela é um número que convida a\nconta errada.\n","isRequired":true,"uniqueKey":"data.charge.oneOf.0.card.installments.oneOf.0","typeLabel":"integer"},{"type":"null","description":"`null` no PIX. A coluna tem default `1`, mas \"uma parcela\"\nnuma cobrança que não parcela é um número que convida a\nconta errada.\n","isRequired":true,"uniqueKey":"data.charge.oneOf.0.card.installments.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.charge.oneOf.0.card.installments","typeLabel":"integer | null"},"recurrence_cycle":{"oneOf":[{"type":"string","enum":["first","subsequent",null],"description":"O ciclo declarado na criação, de volta - e `null` em toda\ncobrança que não faz parte de uma série, que é a esmagadora\nmaioria.\n\nÉ por ele que você responde \"quais destas cobranças foram de\nassinatura?\" ao conciliar, e é ele que explica a ausência do\ncomprador na tela numa contestação.\n","isRequired":true,"uniqueKey":"data.charge.oneOf.0.card.recurrence_cycle.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["first","subsequent",null],"description":"O ciclo declarado na criação, de volta - e `null` em toda\ncobrança que não faz parte de uma série, que é a esmagadora\nmaioria.\n\nÉ por ele que você responde \"quais destas cobranças foram de\nassinatura?\" ao conciliar, e é ele que explica a ausência do\ncomprador na tela numa contestação.\n","isRequired":true,"uniqueKey":"data.charge.oneOf.0.card.recurrence_cycle.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.charge.oneOf.0.card.recurrence_cycle","typeLabel":"enum\u003cstring> | null"},"interest":{"type":"integer","description":"Os juros do parcelamento, em centavos inteiros, e `0` nas\nparcelas sem juros. Eles viajam à Pagar.me como um ITEM à\nparte - ela deriva o valor do pedido da soma dos itens, e um\npedido que não fecha é recusado inteiro.\n","format":"int64","isRequired":true,"uniqueKey":"data.charge.oneOf.0.card.interest","typeLabel":"integer\u003cint64>"},"three_d_secure":{"type":"object","required":["status","transaction_id"],"properties":{"status":{"oneOf":[{"type":"string","description":"O `transStatus` do protocolo. `Y` é autenticado, `A` é\ntentativa comprovada - os dois carregam o liability\nshift em Visa e Mastercard.\n","enum":["Y","A","N","C","U","R","I",null],"isRequired":true,"uniqueKey":"data.charge.oneOf.0.card.three_d_secure.status.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"O `transStatus` do protocolo. `Y` é autenticado, `A` é\ntentativa comprovada - os dois carregam o liability\nshift em Visa e Mastercard.\n","enum":["Y","A","N","C","U","R","I",null],"isRequired":true,"uniqueKey":"data.charge.oneOf.0.card.three_d_secure.status.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.charge.oneOf.0.card.three_d_secure.status","typeLabel":"enum\u003cstring> | null"},"transaction_id":{"oneOf":[{"type":"string","description":"O identificador da autenticação. É ele que se apresenta\nà bandeira numa contestação.\n","isRequired":true,"uniqueKey":"data.charge.oneOf.0.card.three_d_secure.transaction_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"O identificador da autenticação. É ele que se apresenta\nà bandeira numa contestação.\n","isRequired":true,"uniqueKey":"data.charge.oneOf.0.card.three_d_secure.transaction_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.charge.oneOf.0.card.three_d_secure.transaction_id","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"data.charge.oneOf.0.card.three_d_secure","typeLabel":"object"},"authorized_at":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"data.charge.oneOf.0.card.authorized_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"data.charge.oneOf.0.card.authorized_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.charge.oneOf.0.card.authorized_at","typeLabel":"string\u003cdate-time> | null"}},"isRequired":true,"uniqueKey":"data.charge.oneOf.0.card","typeLabel":"object"},"boleto":{"type":"object","description":"Presente em toda cobrança, inclusive nas de PIX e de cartão -\nonde os campos vêm `null`. Mesma regra do `pix` e do `card`, e\npelo mesmo motivo.\n\nBoleto é oferecido apenas a lojas em conta de split na Pagar.me.\nNuma loja fora desse arranjo, `POST /v1/charges` com\n`payment_method: boleto` responde 422 com\n`boleto_not_available`.\n","required":["line","barcode","url","pdf","nosso_numero","due_at"],"properties":{"line":{"oneOf":[{"type":"string","description":"Linha digitável - o equivalente do copia-e-cola do PIX, e o\núnico campo que o pagador realmente usa. É o que indica que\no boleto existe: quando ela vem `null`, o provedor recusou a\nemissão e a cobrança nasce `failed`.\n","example":"34191.79001 01043.510047 91020.150008 1 92230000050000","isRequired":true,"uniqueKey":"data.charge.oneOf.0.boleto.line.oneOf.0","typeLabel":"string"},{"type":"null","description":"Linha digitável - o equivalente do copia-e-cola do PIX, e o\núnico campo que o pagador realmente usa. É o que indica que\no boleto existe: quando ela vem `null`, o provedor recusou a\nemissão e a cobrança nasce `failed`.\n","example":"34191.79001 01043.510047 91020.150008 1 92230000050000","isRequired":true,"uniqueKey":"data.charge.oneOf.0.boleto.line.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.charge.oneOf.0.boleto.line","typeLabel":"string | null"},"barcode":{"oneOf":[{"type":"string","description":"Endereço da imagem do código de barras na Pagar.me. Não\nservimos o arquivo - como no QR do PIX, devolvemos o\nendereço.\n","isRequired":true,"uniqueKey":"data.charge.oneOf.0.boleto.barcode.oneOf.0","typeLabel":"string"},{"type":"null","description":"Endereço da imagem do código de barras na Pagar.me. Não\nservimos o arquivo - como no QR do PIX, devolvemos o\nendereço.\n","isRequired":true,"uniqueKey":"data.charge.oneOf.0.boleto.barcode.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.charge.oneOf.0.boleto.barcode","typeLabel":"string | null"},"url":{"oneOf":[{"type":"string","description":"Página do boleto, para o pagador visualizar.","isRequired":true,"uniqueKey":"data.charge.oneOf.0.boleto.url.oneOf.0","typeLabel":"string"},{"type":"null","description":"Página do boleto, para o pagador visualizar.","isRequired":true,"uniqueKey":"data.charge.oneOf.0.boleto.url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.charge.oneOf.0.boleto.url","typeLabel":"string | null"},"pdf":{"oneOf":[{"type":"string","description":"O mesmo documento em PDF.","isRequired":true,"uniqueKey":"data.charge.oneOf.0.boleto.pdf.oneOf.0","typeLabel":"string"},{"type":"null","description":"O mesmo documento em PDF.","isRequired":true,"uniqueKey":"data.charge.oneOf.0.boleto.pdf.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.charge.oneOf.0.boleto.pdf","typeLabel":"string | null"},"nosso_numero":{"oneOf":[{"type":"string","description":"Identificador do boleto na conta do emissor. É o número que\no banco devolve no arquivo de retorno, e é por ele que se\nencontra à mão um pagamento cujo webhook não chegou.\n","isRequired":true,"uniqueKey":"data.charge.oneOf.0.boleto.nosso_numero.oneOf.0","typeLabel":"string"},{"type":"null","description":"Identificador do boleto na conta do emissor. É o número que\no banco devolve no arquivo de retorno, e é por ele que se\nencontra à mão um pagamento cujo webhook não chegou.\n","isRequired":true,"uniqueKey":"data.charge.oneOf.0.boleto.nosso_numero.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.charge.oneOf.0.boleto.nosso_numero","typeLabel":"string | null"},"due_at":{"oneOf":[{"type":"string","format":"date-time","description":"**Vencimento, não expiração.** O banco aceita boleto depois\ndesta data, e por isso não varremos boleto vencido para\n`expired` - quem tratar esta data como fim encerraria venda\nque ainda pode ser paga. Normalizada pelo provedor para o\nfim do dia.\n","isRequired":true,"uniqueKey":"data.charge.oneOf.0.boleto.due_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"**Vencimento, não expiração.** O banco aceita boleto depois\ndesta data, e por isso não varremos boleto vencido para\n`expired` - quem tratar esta data como fim encerraria venda\nque ainda pode ser paga. Normalizada pelo provedor para o\nfim do dia.\n","isRequired":true,"uniqueKey":"data.charge.oneOf.0.boleto.due_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.charge.oneOf.0.boleto.due_at","typeLabel":"string\u003cdate-time> | null"}},"isRequired":true,"uniqueKey":"data.charge.oneOf.0.boleto","typeLabel":"object"},"created_at":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"data.charge.oneOf.0.created_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"data.charge.oneOf.0.created_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.charge.oneOf.0.created_at","typeLabel":"string\u003cdate-time> | null"},"paid_at":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"data.charge.oneOf.0.paid_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"data.charge.oneOf.0.paid_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.charge.oneOf.0.paid_at","typeLabel":"string\u003cdate-time> | null"},"expired_at":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"data.charge.oneOf.0.expired_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"data.charge.oneOf.0.expired_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.charge.oneOf.0.expired_at","typeLabel":"string\u003cdate-time> | null"},"refunded_at":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"data.charge.oneOf.0.refunded_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"data.charge.oneOf.0.refunded_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.charge.oneOf.0.refunded_at","typeLabel":"string\u003cdate-time> | null"}},"isRequired":true,"uniqueKey":"data.charge.oneOf.0","typeLabel":"object"},{"type":"object","description":"A cobrança dentro de um evento. Quase sempre o objeto `Charge`\ncompleto; `ChargeMinimal` no caminho degradado descrito nele.\n","required":["object","id","status","payment_method","amount","currency","metadata"],"properties":{"object":{"type":"string","const":"charge","isRequired":true,"uniqueKey":"data.charge.oneOf.1.object","typeLabel":"string"},"id":{"type":"string","example":"ch_01k1y6r6m6q2x0p3d9v4t7c8n2","isRequired":true,"uniqueKey":"data.charge.oneOf.1.id","typeLabel":"string"},"status":{"type":"string","description":"Situação da cobrança. Só os estados de trânsito - `pending`,\n`processing` e `in_analysis` - ainda mudam sozinhos; os demais são\nterminais, exceto os que ainda admitem estorno.\n\n`processing` e `in_analysis` são do cartão: a autorização é\ndecidida na mesma requisição, mas pode parar na análise de fraude\nantes de virar `paid` ou `failed`. No PIX a cobrança vai direto de\n`pending` para o desfecho.\n\n`partially_refunded` é estado próprio, e não um `refunded` com\nasterisco: tratar uma venda devolvida pela metade como estornada\nfaria seu relatório descontar o valor inteiro.\n\n`chargedback` é definitivo: o dinheiro voltou pelo caminho da\nbandeira, e nem cancelamento nem estorno são mais possíveis.\n","enum":["pending","processing","in_analysis","paid","expired","canceled","partially_refunded","refunded","failed","chargedback"],"x-labels":{"pending":"Aguardando pagamento","processing":"Processando","in_analysis":"Em análise","paid":"Pago","expired":"Expirado","canceled":"Cancelado","partially_refunded":"Estornado em parte","refunded":"Estornado","failed":"Falhou","chargedback":"Chargeback"},"isRequired":true,"uniqueKey":"data.charge.oneOf.1.status","typeLabel":"enum\u003cstring>"},"payment_method":{"type":"string","enum":["pix","credit_card","boleto"],"isRequired":true,"uniqueKey":"data.charge.oneOf.1.payment_method","typeLabel":"enum\u003cstring>"},"amount":{"type":"integer","description":"Valor cobrado, em centavos inteiros.","format":"int64","isRequired":true,"uniqueKey":"data.charge.oneOf.1.amount","typeLabel":"integer\u003cint64>"},"currency":{"type":"string","const":"BRL","isRequired":true,"uniqueKey":"data.charge.oneOf.1.currency","typeLabel":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"data.charge.oneOf.1.metadata.additionalProperties","typeLabel":"string"},"description":"Vai até no corpo reduzido: é por ela que você reencontra o\npedido do seu lado, e um evento sem ela anunciaria um pagamento\nsem dizer a que se refere.\n","isRequired":true,"uniqueKey":"data.charge.oneOf.1.metadata","typeLabel":"object"}},"isRequired":true,"uniqueKey":"data.charge.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"data.charge","typeLabel":"object"}},"isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"paga":{"title":"paga","value":{"id":"evt_01k1y6r7z2m4n6p8q0r2s4t6u8","type":"charge.paid","created_at":"2026-08-04T14:03:12+00:00","data":{"charge":{"object":"charge","id":"ch_01k1y6r6m6q2x0p3d9v4t7c8n2","status":"paid","payment_method":"pix","amount":10000,"currency":"BRL","platform_fee":798,"net_amount":9103,"refunded_amount":0,"description":"Curso de Vue 3","reference":"pedido-1042","metadata":{"carrinho":"cart_88f21","campanha":"black-friday"},"customer":{"name":"João Comprador","email":"joao@exemplo.com.br","document":"111.***.***-35"},"pix":{"qr_code":"00020101021226840014br.gov.bcb.pix2562qrcodepix.example.com/v2/abcd1234","expires_at":"2026-08-04T15:00:00+00:00","end_to_end_id":"E12345678202608041200"},"created_at":"2026-08-04T14:00:00+00:00","paid_at":"2026-08-04T14:03:11+00:00","expired_at":null,"refunded_at":null}}}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"d9f9f9c0-0551-48ba-83de-68e3cc040eb9":{"description":"Recebido. Qualquer 2xx encerra a entrega. Responda rápido e\nprocesse depois: demorar vira retentativa, e retentativa em\nfluxo de dinheiro é como um pagamento acaba contabilizado duas\nvezes.\n","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"9a44c2e3-9445-4b41-87a0-283dd17a7b9d":{"description":"Qualquer resposta fora da faixa 2xx agenda nova tentativa.\n","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"35d11aa8-2563-49be-9ebf-815534166e0f":{"apiKey":{"type":"http","scheme":"bearer","bearerFormat":"sk_live_… | sk_test_…","description":"Chave secreta do vendedor, criada no painel em **Desenvolvedores**.\n\nO valor em claro existe uma única vez, na criação. Guardamos só o\nhash SHA-256 - nem o suporte consegue recuperá-lo, o que é o ponto:\num dump do nosso banco não permite cobrar em nome de ninguém.\n\nA chave vai no **servidor**. Colocá-la no navegador do comprador a\nentrega a qualquer pessoa que abra a página.\n","scopes":[],"schemeName":"apiKey"}}},"servers":{"ed9958ae-3134-4ef6-8d55-2744b0263cea":{"url":"https://api.usevext.com","description":"Produção"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"sk_live_… | sk_test_…","description":"Chave secreta do vendedor, criada no painel em **Desenvolvedores**.\n\nO valor em claro existe uma única vez, na criação. Guardamos só o\nhash SHA-256 - nem o suporte consegue recuperá-lo, o que é o ponto:\num dump do nosso banco não permite cobrar em nome de ninguém.\n\nA chave vai no **servidor**. Colocá-la no navegador do comprador a\nentrega a qualquer pessoa que abra a página.\n","scopes":[],"schemeName":"apiKey"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Chave secreta do vendedor, criada no painel em **Desenvolvedores**.\n\nO valor em claro existe uma única vez, na criação. Guardamos só o\nhash SHA-256 - nem o suporte consegue recuperá-lo, o que é o ponto:\num dump do nosso banco não permite cobrar em nome de ninguém.\n\nA chave vai no **servidor**. Colocá-la no navegador do comprador a\nentrega a qualquer pessoa que abra a página.\n","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"apiKey","name":"Authorization"}],"title":"apiKey"}]},"originalFileLocation":"api-reference/openapi.yaml"},"subdomain":"vext","siteName":"Vext","title":"charge.paid - Vext","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-08-06T13:04:38.698Z","originalFileLocation":"api-reference/webhooks/charge-paid.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=\"system\"}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=\"Enviado quando o PIX é confirmado. É o evento sobre o qual o seu sistema deve agir.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Vext\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/vext/1ynttjJ_6FW1Z8CJ/_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/vext/1ynttjJ_6FW1Z8CJ/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/vext/1ynttjJ_6FW1Z8CJ/_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/vext/1ynttjJ_6FW1Z8CJ/_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/vext/1ynttjJ_6FW1Z8CJ/_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/vext/1ynttjJ_6FW1Z8CJ/_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/vext/1ynttjJ_6FW1Z8CJ/_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/vext/1ynttjJ_6FW1Z8CJ/_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/vext/1ynttjJ_6FW1Z8CJ/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"charge.paid - Vext\">\u003cmeta data-mint-head property=\"og:description\" content=\"Enviado quando o PIX é confirmado. É o evento sobre o qual o seu sistema deve agir.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Vext\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.usevext.com/api-reference/webhooks/charge-paid\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://vext.mintlify.site/_mintlify/api/og/v2?division=Eventos+de+cobran%C3%A7a\u0026amp;title=charge.paid\u0026amp;description=Enviado+quando+o+PIX+%C3%A9+confirmado.+%C3%89+o+evento+sobre+o+qual+o+seu+sistema+deve+agir.\u0026amp;theme=5fdce344cf730a9d43aa6618\u0026amp;signature=9e086f7d2bc22ce7dec2ad6390ccd554cc16acf51d7dff3e13281a91e7d7d41c\">\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=\"charge.paid - Vext\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Enviado quando o PIX é confirmado. É o evento sobre o qual o seu sistema deve agir.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://vext.mintlify.site/_mintlify/api/og/v2?division=Eventos+de+cobran%C3%A7a\u0026amp;title=charge.paid\u0026amp;description=Enviado+quando+o+PIX+%C3%A9+confirmado.+%C3%89+o+evento+sobre+o+qual+o+seu+sistema+deve+agir.\u0026amp;theme=5fdce344cf730a9d43aa6618\u0026amp;signature=9e086f7d2bc22ce7dec2ad6390ccd554cc16acf51d7dff3e13281a91e7d7d41c\">\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/vext/1ynttjJ_6FW1Z8CJ/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Vext\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1A7A14\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.usevext.com/api-reference/webhooks/charge-paid\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/webhooks/charge-paid.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.usevext.com/#organization\",\"name\":\"Vext\",\"url\":\"https://docs.usevext.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/vext/kcwCRAttQYaZqJCy/logo/light.svg?fit=max\u0026auto=format\u0026n=kcwCRAttQYaZqJCy\u0026q=85\u0026s=fb9b46dfbd546322b281376800e5d841\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.usevext.com#website\",\"name\":\"Vext\",\"url\":\"https://docs.usevext.com\",\"publisher\":{\"@id\":\"https://docs.usevext.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.usevext.com/api-reference/webhooks/charge-paid#webpage\",\"url\":\"https://docs.usevext.com/api-reference/webhooks/charge-paid\",\"name\":\"charge.paid\",\"description\":\"Enviado quando o PIX é confirmado. É o evento sobre o qual o seu sistema deve agir.\",\"dateModified\":\"2026-08-06T13:04:38.698Z\",\"isPartOf\":{\"@id\":\"https://docs.usevext.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.usevext.com/api-reference/webhooks/charge-paid#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.usevext.com/api-reference/webhooks/charge-paid#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Vext\",\"item\":\"https://docs.usevext.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"charge.paid\",\"item\":\"https://docs.usevext.com/api-reference/webhooks/charge-paid\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.usevext.com/api-reference/webhooks/charge-paid#apireference\",\"headline\":\"charge.paid\",\"name\":\"charge.paid\",\"description\":\"Enviado quando o PIX é confirmado. É o evento sobre o qual o seu sistema deve agir.\",\"url\":\"https://docs.usevext.com/api-reference/webhooks/charge-paid\",\"mainEntityOfPage\":{\"@id\":\"https://docs.usevext.com/api-reference/webhooks/charge-paid#webpage\"},\"dateModified\":\"2026-08-06T13:04:38.698Z\",\"publisher\":{\"@id\":\"https://docs.usevext.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.usevext.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Vext\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Vext","nav":{"global":null,"tabs":[{"tab":"Guias","pages":[{"title":"Guias","href":""}]},{"tab":"Referência da API","groups":[{"group":"Visão geral","pages":[{"title":"Visão geral","icon":"terminal","href":"/api-reference/introducao"}]},{"group":"Objetos","pages":[{"title":"Cobrança","icon":"receipt","href":"/api-reference/objetos/cobranca"},{"title":"Cartão guardado","icon":"vault","href":"/api-reference/objetos/cartao-guardado"},{"title":"Comprador","icon":"user","href":"/api-reference/objetos/comprador"},{"title":"Saque","icon":"banknote","href":"/api-reference/objetos/saque"}]},{"group":"Cobranças","pages":[{"title":"Criar cobrança","icon":"circle-dollar-sign","openapi":"api-reference/openapi.yaml POST /v1/charges","href":"/api-reference/cobrancas/criar"},{"title":"Listar cobranças","icon":"list","openapi":"api-reference/openapi.yaml GET /v1/charges","href":"/api-reference/cobrancas/listar"},{"title":"Consultar cobrança","icon":"file-search","openapi":"api-reference/openapi.yaml GET /v1/charges/{code}","href":"/api-reference/cobrancas/consultar"},{"title":"Estornar cobrança","icon":"rotate-ccw","openapi":"api-reference/openapi.yaml POST /v1/charges/{code}/refund","href":"/api-reference/cobrancas/estornar"},{"title":"Grade de parcelas","icon":"table","openapi":"api-reference/openapi.yaml GET /v1/installments","href":"/api-reference/cobrancas/parcelas"}]},{"group":"Cartão no navegador","pages":[{"title":"A biblioteca vext.js","sidebarTitle":"vext.js","icon":"code","openapi":"api-reference/openapi.yaml GET /v1/vext.js","href":"/api-reference/cartao/vext-js"},{"title":"Configuração para o navegador","sidebarTitle":"client_config","icon":"browser","openapi":"api-reference/openapi.yaml GET /v1/client_config","href":"/api-reference/cartao/client-config"},{"title":"Emitir token de autenticação","icon":"shield-check","openapi":"api-reference/openapi.yaml POST /v1/three_ds_tokens","href":"/api-reference/cartao/three-ds-token"}]},{"group":"Cartões","pages":[{"title":"Guardar cartão","icon":"vault","openapi":"api-reference/openapi.yaml POST /v1/cards","href":"/api-reference/cartoes/guardar"},{"title":"Listar cartões guardados","icon":"credit-card","openapi":"api-reference/openapi.yaml GET /v1/cards","href":"/api-reference/cartoes/listar"},{"title":"Consultar cartão guardado","icon":"file-search","openapi":"api-reference/openapi.yaml GET /v1/cards/{code}","href":"/api-reference/cartoes/consultar"},{"title":"Remover cartão guardado","icon":"trash-2","openapi":"api-reference/openapi.yaml DELETE /v1/cards/{code}","href":"/api-reference/cartoes/remover"}]},{"group":"Saldo","pages":[{"title":"Consultar saldo","icon":"wallet","openapi":"api-reference/openapi.yaml GET /v1/balance","href":"/api-reference/saldo/consultar"}]},{"group":"Saques","pages":[{"title":"Solicitar saque","icon":"banknote","openapi":"api-reference/openapi.yaml POST /v1/withdrawals","href":"/api-reference/saques/solicitar"},{"title":"Listar saques","icon":"list","openapi":"api-reference/openapi.yaml GET /v1/withdrawals","href":"/api-reference/saques/listar"},{"title":"Consultar saque","description":"Um saque pelo código, com o status e o motivo da falha.","icon":"search","openapi":"api-reference/openapi.yaml GET /v1/withdrawals/{code}","href":"/api-reference/saques/consultar"}]},{"group":"Eventos de cobrança","pages":[{"title":"charge.paid","icon":"badge-check","openapi":"api-reference/openapi.yaml webhook charge.paid","href":"/api-reference/webhooks/charge-paid"},{"title":"charge.failed","description":"Enviado quando a operadora do cartão recusa o pagamento, ou quando a análise de fraude o reprova.","icon":"circle-x","openapi":"api-reference/openapi.yaml webhook charge.failed","href":"/api-reference/webhooks/charge-failed"},{"title":"charge.in_analysis","icon":"search","openapi":"api-reference/openapi.yaml webhook charge.in_analysis","href":"/api-reference/webhooks/charge-in-analysis"},{"title":"charge.refunded","icon":"undo-2","openapi":"api-reference/openapi.yaml webhook charge.refunded","href":"/api-reference/webhooks/charge-refunded"},{"title":"charge.chargedback","icon":"gavel","openapi":"api-reference/openapi.yaml webhook charge.chargedback","href":"/api-reference/webhooks/charge-chargedback"}]},{"group":"Eventos de contestação (MED)","pages":[{"title":"med.opened","icon":"shield-alert","openapi":"api-reference/openapi.yaml webhook med.opened","href":"/api-reference/webhooks/med-opened"},{"title":"med.approved","icon":"thumbs-down","openapi":"api-reference/openapi.yaml webhook med.approved","href":"/api-reference/webhooks/med-approved"},{"title":"med.rejected","icon":"thumbs-up","openapi":"api-reference/openapi.yaml webhook med.rejected","href":"/api-reference/webhooks/med-rejected"}]},{"group":"Eventos de saque","pages":[{"title":"withdrawal.paid","icon":"banknote","openapi":"api-reference/openapi.yaml webhook withdrawal.paid","href":"/api-reference/webhooks/withdrawal-paid"}]}]}]},"basePath":"","title":"charge.paid - Vext","buildId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","deploymentId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C-hEh3I2.js","utils-CnF4QiUD.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C7PVNbel.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-8ytevL2A.js","snippetPresets-BT1alx3v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BLXC0i_W.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CyLIGI9_.js","shallow-DC0lGVIW.js","getApiPlaygroundDisplay-CgDQ85tN.js","CodeSnippet-6-I-Gpv9.js","CodeSnippets-BAk1kDdu.js","Page-C945cI-W.js","getPastedJson-B276RuWN.js","icon-BqP8etTm.js","MethodPill-DM6sbxG1.js","DuplicateIcon-PyJglOaE.js","createIcon-CMeOMAc_.js","DynamicMarkdown-BoyYAA8K.js","SectionHeading-DAYv3gvZ.js","axios-vUo_bRtp.js","Markdown-BhTTmazV.js","clsx-CR-RHrVC.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CBUH0-zX.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BmARFYNC.js"]}