Cria uma nova cobrança (pedido de pagamento). Suporta os métodos de pagamento: CreditCard, PIX. Requer o header account com o código da conta. Passa por validações de fraude, bloqueio de clientes e rate limiting.
Possíveis cenários de resposta:
201 — Cobrança processada com sucesso (aprovada ou aguardando pagamento PIX)
202 — Transação desafiada (requer confirmação adicional via OTP)
400 — Fraude detectada ou erro no processamento do gateway
Requer o header account com o código da conta. Passa por validações de fraude, bloqueio de clientes e rate limiting por cliente.
Clientes bloqueados por IP, e-mail, CPF ou BIN do cartão terão a cobrança rejeitada automaticamente.
Para cobrar um cartão já salvo, envie apenas payment.card.card_token (o token retornado ao salvar o cartão / no evento card.token_created) no lugar dos dados completos do cartão. Continue enviando payment.card.installments. O card_token só é aceito para cartões da mesma conta da cobrança.
O billing address do cartão não é tokenizado. Ao cobrar com card_token, informe o billing address (client.address) na própria requisição.
Dados completos de uma cobrança retornados pelo ConsultCharge
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/cobrancas/create","slug":"/pages/cobrancas/create","pageMetadata":{"title":"Criar Cobrança","openapi":"POST /v1/charge","description":"Cria uma nova cobrança (pedido de pagamento). Suporta os métodos de pagamento: **CreditCard**, **PIX**. Requer o header `account` com o código da conta. Passa por validações de fraude, bloqueio de clientes e rate limiting.\n\nPossíveis cenários de resposta:\n- **201** — Cobrança processada com sucesso (aprovada ou aguardando pagamento PIX)\n- **202** — Transação desafiada (requer confirmação adicional via OTP)\n- **400** — Fraude detectada ou erro no processamento do gateway\n- **422** — Erro de validação dos dados enviados\n","href":"/pages/cobrancas/create"},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n li: \"li\",\n p: \"p\",\n strong: \"strong\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [\"Cria uma nova cobrança (pedido de pagamento). Suporta os métodos de pagamento: \", _jsx(_components.strong, {\n children: \"CreditCard\"\n }), \", \", _jsx(_components.strong, {\n children: \"PIX\"\n }), \". Requer o header \", _jsx(_components.code, {\n children: \"account\"\n }), \" com o código da conta. Passa por validações de fraude, bloqueio de clientes e rate limiting.\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"Possíveis cenários de resposta:\"\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"201\"\n }), \" — Cobrança processada com sucesso (aprovada ou aguardando pagamento PIX)\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"202\"\n }), \" — Transação desafiada (requer confirmação adicional via OTP)\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"400\"\n }), \" — Fraude detectada ou erro no processamento do gateway\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"422\"\n }), \" — Erro de validação dos dados enviados\"]\n }), \"\\n\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,strong:`strong`,..._provideComponents(),...props.components},{Note,Tip,Warning}=_components;if(!Note)_missingMdxReference(`Note`,true);if(!Tip)_missingMdxReference(`Tip`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(Note,{children:_jsxs(_components.p,{children:[`Requer o header `,_jsx(_components.code,{children:`account`}),` com o código da conta. Passa por validações de fraude, bloqueio de clientes e rate limiting por cliente.`]})}),`\n`,_jsx(Warning,{children:_jsx(_components.p,{children:`Clientes bloqueados por IP, e-mail, CPF ou BIN do cartão terão a cobrança rejeitada automaticamente.`})}),`\n`,_jsx(Tip,{children:_jsxs(_components.p,{children:[`Para cobrar um `,_jsx(_components.strong,{children:`cartão já salvo`}),`, envie apenas `,_jsx(_components.code,{children:`payment.card.card_token`}),` (o token retornado ao salvar o cartão / no evento `,_jsx(_components.code,{children:`card.token_created`}),`) no lugar dos dados completos do cartão. Continue enviando `,_jsx(_components.code,{children:`payment.card.installments`}),`. O `,_jsx(_components.code,{children:`card_token`}),` só é aceito para cartões da `,_jsx(_components.strong,{children:`mesma conta`}),` da cobrança.`]})}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[`O billing address do cartão `,_jsx(_components.strong,{children:`não`}),` é tokenizado. Ao cobrar com `,_jsx(_components.code,{children:`card_token`}),`, informe o billing address (`,_jsx(_components.code,{children:`client.address`}),`) na própria requisiçã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":"Criar Cobrança","openapi":"POST /v1/charge","description":"Cria uma nova cobrança (pedido de pagamento). Suporta os métodos de pagamento: **CreditCard**, **PIX**. Requer o header `account` com o código da conta. Passa por validações de fraude, bloqueio de clientes e rate limiting.\n\nPossíveis cenários de resposta:\n- **201** — Cobrança processada com sucesso (aprovada ou aguardando pagamento PIX)\n- **202** — Transação desafiada (requer confirmação adicional via OTP)\n- **400** — Fraude detectada ou erro no processamento do gateway\n- **422** — Erro de validação dos dados enviados\n","href":"/pages/cobrancas/create"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Cobranças"],"summary":"Criar cobrança","description":"Cria uma nova cobrança (pedido de pagamento). Suporta os métodos de pagamento: **CreditCard**, **PIX**. Requer o header `account` com o código da conta. Passa por validações de fraude, bloqueio de clientes e rate limiting.\n\nPossíveis cenários de resposta:\n- **201** — Cobrança processada com sucesso (aprovada ou aguardando pagamento PIX)\n- **202** — Transação desafiada (requer confirmação adicional via OTP)\n- **400** — Fraude detectada ou erro no processamento do gateway\n- **422** — Erro de validação dos dados enviados\n","operationId":"createCharge","security":["8a2f4888-f0b7-4d7a-b303-2cf6e5982396"],"parameters":["257300fa-0bf7-4087-af7b-1036577c49f6"],"requestBody":"b790fbe0-aec7-44dd-8613-4ec02c6e6e6d","responses":{"201":"de58ed16-04ba-4b48-bb33-b75b22a4bbbf","202":"79f9b2e3-873f-4c9b-a656-e282018177ff","400":"1b5fae94-da5e-4100-a5ff-06a36c15b081","401":"bc1c97f3-529e-4225-8b14-e60e84ca2706","422":"f8bbe4b7-04d1-424a-aa82-e7c9892cb704","500":"6d7638ee-6dbd-43cd-bf16-b268e8d1e932"},"method":"post","type":"path","servers":["4c3dfa86-2ed5-4f58-9a07-b7d334d46949"],"path":"/v1/charge","baseUrlOptions":["https://sandbox.4seletpay.com.br/api"],"title":"Criar cobrança","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"257300fa-0bf7-4087-af7b-1036577c49f6":{"name":"account","in":"header","required":true,"description":"Código da conta à qual a operação se aplica","schema":{"type":"string","example":"acc_abc123xyz","isRequired":true,"description":"Código da conta à qual a operação se aplica","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["client","payment","items"],"properties":{"client":{"type":"object","required":["name","email","phone"],"properties":{"name":{"type":"string","description":"Nome completo do cliente (obrigatório, máx. 255 caracteres)","example":"João Silva","isRequired":true,"uniqueKey":"client.name","typeLabel":"string"},"email":{"type":"string","format":"email","description":"E-mail do cliente (obrigatório)","example":"joao@exemplo.com.br","isRequired":true,"uniqueKey":"client.email","typeLabel":"string\u003cemail>"},"phone":{"type":"object","required":["ddi","ddd","number"],"properties":{"ddi":{"type":"string","description":"Código do país (DDI) — obrigatório","example":"55","isRequired":true,"uniqueKey":"client.phone.ddi","typeLabel":"string"},"ddd":{"type":"string","description":"Código de área (DDD) — obrigatório","example":"11","isRequired":true,"uniqueKey":"client.phone.ddd","typeLabel":"string"},"number":{"type":"string","description":"Número do telefone sem DDD — obrigatório","example":"999999999","isRequired":true,"uniqueKey":"client.phone.number","typeLabel":"string"}},"isRequired":true,"uniqueKey":"client.phone","typeLabel":"object"},"gender":{"type":"string","description":"Gênero do cliente (opcional)","enum":["Male","Female","Other","Undefined"],"example":"Male","uniqueKey":"client.gender","typeLabel":"enum\u003cstring>"},"birthdate":{"type":"string","format":"date","description":"Data de nascimento no formato YYYY-MM-DD (opcional)","example":"1990-01-15","uniqueKey":"client.birthdate","typeLabel":"string\u003cdate>"},"document":{"type":"object","properties":{"type":{"type":"string","description":"Tipo do documento (opcional para checkout, obrigatório para assinaturas)","enum":["CPF","CNPJ","passport","undefined"],"example":"CPF","uniqueKey":"client.document.type","typeLabel":"enum\u003cstring>"},"number":{"type":"string","description":"Número do documento (opcional para checkout, obrigatório para assinaturas)","example":"123.456.789-09","uniqueKey":"client.document.number","typeLabel":"string"}},"uniqueKey":"client.document","typeLabel":"object"},"address":{"type":"object","description":"Endereço do cliente (obrigatório se o objeto address for enviado)","properties":{"zipcode":{"type":"string","description":"CEP (obrigatório quando address é enviado)","example":"01310-100","uniqueKey":"client.address.zipcode","typeLabel":"string"},"street":{"type":"string","description":"Logradouro (obrigatório quando address é enviado)","example":"Avenida Paulista","uniqueKey":"client.address.street","typeLabel":"string"},"number":{"type":"integer","description":"Número do endereço (obrigatório quando address é enviado)","example":1000,"uniqueKey":"client.address.number","typeLabel":"integer"},"neighborhood":{"type":"string","description":"Bairro (obrigatório quando address é enviado, máx. 255 caracteres)","example":"Bela Vista","uniqueKey":"client.address.neighborhood","typeLabel":"string"},"complement":{"type":"string","description":"Complemento (obrigatório quando address é enviado, máx. 255 caracteres)","example":"Apto 42","uniqueKey":"client.address.complement","typeLabel":"string"},"city":{"type":"string","description":"Cidade (obrigatório quando address é enviado, máx. 255 caracteres)","example":"São Paulo","uniqueKey":"client.address.city","typeLabel":"string"},"state":{"type":"string","description":"UF com 2 letras (obrigatório quando address é enviado)","maxLength":2,"example":"SP","uniqueKey":"client.address.state","typeLabel":"string"},"country":{"type":"string","description":"País (opcional, máx. 255 caracteres)","example":"Brasil","uniqueKey":"client.address.country","typeLabel":"string"}},"uniqueKey":"client.address","typeLabel":"object"}},"isRequired":true,"uniqueKey":"client","typeLabel":"object"},"payment":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Método de pagamento (obrigatório)","enum":["CreditCard","PIX"],"example":"CreditCard","isRequired":true,"uniqueKey":"payment.type","typeLabel":"enum\u003cstring>"},"pix_expiration":{"type":"integer","description":"Tempo de expiração do PIX em segundos (opcional, mín. 1)","minimum":1,"example":3600,"uniqueKey":"payment.pix_expiration","typeLabel":"integer"},"card":{"type":"object","description":"Dados do cartão. Envie os dados completos do cartão OU apenas `card_token` (cartão salvo). Quando `card_token` é informado, `number`, `name`, `month`, `year` e `security_code` tornam-se opcionais.\n\nO `card_token` **não** carrega o billing address. Ao cobrar com um cartão salvo, informe o billing address (`client.address`) na própria requisição.\n","properties":{"card_token":{"oneOf":[{"type":"string","description":"Token de um cartão salvo (o `card_token` retornado ao salvar o cartão e no evento `card.token_created`). Alternativa aos dados do cartão. Só é aceito se o cartão pertencer à mesma conta da cobrança (cartões de outra conta são rejeitados).\n","example":"9b2f5c8e-3a1d-4f7b-8c6e-2d9a1b4c5e6f","uniqueKey":"payment.card.card_token.oneOf.0","typeLabel":"string"},{"type":"null","description":"Token de um cartão salvo (o `card_token` retornado ao salvar o cartão e no evento `card.token_created`). Alternativa aos dados do cartão. Só é aceito se o cartão pertencer à mesma conta da cobrança (cartões de outra conta são rejeitados).\n","example":"9b2f5c8e-3a1d-4f7b-8c6e-2d9a1b4c5e6f","uniqueKey":"payment.card.card_token.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment.card.card_token","typeLabel":"string | null"},"number":{"type":"string","description":"Número do cartão (obrigatório quando `card_token` não é enviado, mín. 13 dígitos)","example":"4111111111111111","uniqueKey":"payment.card.number","typeLabel":"string"},"name":{"type":"string","description":"Nome impresso no cartão (obrigatório quando `card_token` não é enviado)","example":"JOAO SILVA","uniqueKey":"payment.card.name","typeLabel":"string"},"month":{"type":"string","description":"Mês de validade MM (obrigatório quando `card_token` não é enviado)","example":"12","uniqueKey":"payment.card.month","typeLabel":"string"},"year":{"type":"string","description":"Ano de validade YY (obrigatório quando `card_token` não é enviado)","example":"27","uniqueKey":"payment.card.year","typeLabel":"string"},"security_code":{"type":"string","description":"Código de segurança CVV (obrigatório quando `card_token` não é enviado)","example":"123","uniqueKey":"payment.card.security_code","typeLabel":"string"},"installments":{"type":"integer","description":"Número de parcelas para CreditCard (mín. 1). Envie mesmo ao usar `card_token`.","minimum":1,"example":1,"uniqueKey":"payment.card.installments","typeLabel":"integer"},"soft_descriptor":{"oneOf":[{"type":"string","description":"Descrição que aparecerá na fatura do cartão (opcional, 3-50 caracteres)","minLength":3,"maxLength":50,"example":"MINHA LOJA","uniqueKey":"payment.card.soft_descriptor.oneOf.0","typeLabel":"string"},{"type":"null","description":"Descrição que aparecerá na fatura do cartão (opcional, 3-50 caracteres)","minLength":3,"maxLength":50,"example":"MINHA LOJA","uniqueKey":"payment.card.soft_descriptor.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment.card.soft_descriptor","typeLabel":"string | null"}},"uniqueKey":"payment.card","typeLabel":"object"}},"isRequired":true,"uniqueKey":"payment","typeLabel":"object"},"items":{"type":"array","description":"Lista de itens da compra (obrigatório, mín. 1 item)","items":{"type":"object","required":["id","description","amount","quantity"],"properties":{"id":{"type":"string","description":"Referência externa do item (obrigatório)","example":"produto_001","isRequired":true,"uniqueKey":"\\items.items.[INDEX].id","typeLabel":"string"},"description":{"type":"string","description":"Descrição do item (obrigatório, máx. 255 caracteres)","maxLength":255,"example":"Camiseta Premium","isRequired":true,"uniqueKey":"\\items.items.[INDEX].description","typeLabel":"string"},"amount":{"type":"number","format":"float","description":"Valor unitário do item (obrigatório). Para testes em PIX, valores acima de R$ 300,00 pode resultar em erro.","example":99.9,"isRequired":true,"uniqueKey":"\\items.items.[INDEX].amount","typeLabel":"number\u003cfloat>"},"quantity":{"type":"integer","description":"Quantidade do item (obrigatório)","minimum":1,"example":2,"isRequired":true,"uniqueKey":"\\items.items.[INDEX].quantity","typeLabel":"integer"}},"uniqueKey":"\\items.items.[INDEX]","typeLabel":"object"},"example":[{"id":"produto_001","description":"Camiseta Premium","amount":99.9,"quantity":2}],"isRequired":true,"uniqueKey":"\\items","typeLabel":"object[]"},"international":{"oneOf":[{"type":"boolean","description":"Indica se é uma transação internacional (opcional, padrão false)","example":false,"uniqueKey":"international.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Indica se é uma transação internacional (opcional, padrão false)","example":false,"uniqueKey":"international.oneOf.1","typeLabel":"null"}],"uniqueKey":"international","typeLabel":"boolean | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"cartao_credito":{"title":"cartao_credito","value":{"international":false,"client":{"name":"João Silva","email":"joao@exemplo.com.br","gender":"Male","birthdate":"1990-01-15","phone":{"ddi":"55","ddd":"11","number":"999999999"},"document":{"type":"CPF","number":"123.456.789-09"},"address":{"zipcode":"01310-100","street":"Avenida Paulista","number":1000,"neighborhood":"Bela Vista","complement":"Apto 42","city":"São Paulo","state":"SP","country":"Brasil"}},"payment":{"type":"CreditCard","card":{"number":"4111111111111111","name":"JOAO SILVA","month":"12","year":"27","security_code":"123","installments":1,"soft_descriptor":"MINHA LOJA"}},"items":[{"id":"produto_001","description":"Camiseta Premium","amount":99.9,"quantity":2}]}},"cartao_credito_salvo":{"title":"cartao_credito_salvo","value":{"client":{"name":"João Silva","email":"joao@exemplo.com.br","phone":{"ddi":"55","ddd":"11","number":"999999999"},"document":{"type":"CPF","number":"123.456.789-09"}},"payment":{"type":"CreditCard","card":{"card_token":"9b2f5c8e-3a1d-4f7b-8c6e-2d9a1b4c5e6f","installments":1}},"items":[{"id":"produto_001","description":"Camiseta Premium","amount":99.9,"quantity":2}]}},"pix":{"title":"pix","value":{"international":false,"client":{"name":"Maria Santos","email":"maria@exemplo.com.br","phone":{"ddi":"55","ddd":"21","number":"988887777"},"document":{"type":"CPF","number":"987.654.321-00"}},"payment":{"type":"PIX","pix_expiration":3600},"items":[{"id":"curso_001","description":"Curso Online","amount":297,"quantity":1}]}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"de58ed16-04ba-4b48-bb33-b75b22a4bbbf":{"description":"Cobrança processada com sucesso","content":{"application/json":{"schema":{"type":"object","description":"Resposta da criação de cobrança (envelope APIReturnUtil + dados ConsultCharge)","properties":{"mensagem":{"type":"string","example":"Cobrança realizada com sucesso.","uniqueKey":"mensagem","typeLabel":"string"},"erro":{"type":"boolean","example":false,"uniqueKey":"erro","typeLabel":"boolean"},"mensagenserro":{"type":"array","items":{"type":"string","uniqueKey":"mensagenserro.items.[INDEX]","typeLabel":"string"},"example":[],"uniqueKey":"mensagenserro","typeLabel":"string[]"},"codigoretorno":{"type":"integer","example":201,"uniqueKey":"codigoretorno","typeLabel":"integer"},"id":{"type":"string","description":"ID da cobrança criada","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","uniqueKey":"id","typeLabel":"string"},"data":{"type":"object","description":"Dados completos de uma cobrança retornados pelo ConsultCharge","properties":{"charge_id":{"type":"string","format":"uuid","description":"ID interno da cobrança","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","uniqueKey":"data.charge_id","typeLabel":"string\u003cuuid>"},"charge_created_at":{"type":"string","description":"Data de criação da cobrança (formatada)","example":"11/03/2026 10:00:00","uniqueKey":"data.charge_created_at","typeLabel":"string"},"account_id":{"type":"integer","description":"ID interno da conta","example":1,"uniqueKey":"data.account_id","typeLabel":"integer"},"code":{"type":"string","description":"Código da compra (purchase code)","example":"pur_abc123xyz","uniqueKey":"data.code","typeLabel":"string"},"value":{"type":"number","format":"float","description":"Valor total da compra","example":199.8,"uniqueKey":"data.value","typeLabel":"number\u003cfloat>"},"charge_value":{"type":"number","format":"float","description":"Valor da cobrança","example":199.8,"uniqueKey":"data.charge_value","typeLabel":"number\u003cfloat>"},"coin":{"type":"string","description":"Moeda da transação","example":"BRL","uniqueKey":"data.coin","typeLabel":"string"},"status":{"type":"string","description":"Status da compra","enum":["Pending","Challenged","Approved","Declined","Refunded","Canceled"],"example":"Approved","uniqueKey":"data.status","typeLabel":"enum\u003cstring>"},"client":{"type":"object","description":"Dados do cliente associado à cobrança","properties":{"code":{"type":"string","description":"Código do cliente","example":"cli_abc123","uniqueKey":"data.client.code","typeLabel":"string"},"name":{"type":"string","description":"Nome do cliente","example":"João Silva","uniqueKey":"data.client.name","typeLabel":"string"},"email":{"type":"string","format":"email","description":"E-mail do cliente","example":"joao@exemplo.com.br","uniqueKey":"data.client.email","typeLabel":"string\u003cemail>"},"documents":{"type":"array","description":"Documentos do cliente (filtrado pelo documento padrão)","items":{"type":"object","properties":{"type":{"type":"string","example":"CPF","uniqueKey":"data.client.documents.items.[INDEX].type","typeLabel":"string"},"number":{"type":"string","example":"123.456.789-09","uniqueKey":"data.client.documents.items.[INDEX].number","typeLabel":"string"},"default":{"type":"boolean","example":true,"uniqueKey":"data.client.documents.items.[INDEX].default","typeLabel":"boolean"}},"uniqueKey":"data.client.documents.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.client.documents","typeLabel":"object[]"},"phone":{"type":"array","description":"Telefones do cliente (filtrado pelo telefone padrão)","items":{"type":"object","properties":{"ddi":{"type":"string","example":"55","uniqueKey":"data.client.phone.items.[INDEX].ddi","typeLabel":"string"},"ddd":{"type":"string","example":"11","uniqueKey":"data.client.phone.items.[INDEX].ddd","typeLabel":"string"},"number":{"type":"string","example":"999999999","uniqueKey":"data.client.phone.items.[INDEX].number","typeLabel":"string"},"default":{"type":"boolean","example":true,"uniqueKey":"data.client.phone.items.[INDEX].default","typeLabel":"boolean"}},"uniqueKey":"data.client.phone.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.client.phone","typeLabel":"object[]"},"addresss":{"type":"array","description":"Endereços do cliente (filtrado pelo endereço padrão)","items":{"type":"object","properties":{"zipcode":{"type":"string","example":"01310-100","uniqueKey":"data.client.addresss.items.[INDEX].zipcode","typeLabel":"string"},"street":{"type":"string","example":"Avenida Paulista","uniqueKey":"data.client.addresss.items.[INDEX].street","typeLabel":"string"},"number":{"type":"string","example":"1000","uniqueKey":"data.client.addresss.items.[INDEX].number","typeLabel":"string"},"neighborhood":{"type":"string","example":"Bela Vista","uniqueKey":"data.client.addresss.items.[INDEX].neighborhood","typeLabel":"string"},"city":{"type":"string","example":"São Paulo","uniqueKey":"data.client.addresss.items.[INDEX].city","typeLabel":"string"},"state":{"type":"string","example":"SP","uniqueKey":"data.client.addresss.items.[INDEX].state","typeLabel":"string"}},"uniqueKey":"data.client.addresss.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.client.addresss","typeLabel":"object[]"}},"uniqueKey":"data.client","typeLabel":"object"},"orders":{"type":"array","items":{"type":"object","description":"Dados do pedido associado à cobrança","properties":{"code":{"type":"string","description":"Código do pedido","example":"ord_abc123xyz","uniqueKey":"data.orders.items.[INDEX].code","typeLabel":"string"},"status":{"type":"string","description":"Status do pedido","enum":["Pending","Challenged","Approved","Declined","Refunded","Canceled"],"example":"Approved","uniqueKey":"data.orders.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"value":{"type":"number","format":"float","description":"Valor do pedido","example":199.8,"uniqueKey":"data.orders.items.[INDEX].value","typeLabel":"number\u003cfloat>"},"error_message":{"oneOf":[{"type":"string","description":"Mensagem de erro do gateway (null se não houver)","example":null,"uniqueKey":"data.orders.items.[INDEX].error_message.oneOf.0","typeLabel":"string"},{"type":"null","description":"Mensagem de erro do gateway (null se não houver)","example":null,"uniqueKey":"data.orders.items.[INDEX].error_message.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.orders.items.[INDEX].error_message","typeLabel":"string | null"},"items":{"type":"array","description":"Itens do pedido","items":{"type":"object","properties":{"code":{"type":"string","description":"Código do item","example":"produto_001","uniqueKey":"data.orders.items.[INDEX].\\items.items.[INDEX].code","typeLabel":"string"},"name":{"type":"string","description":"Nome do item","example":"Camiseta Premium","uniqueKey":"data.orders.items.[INDEX].\\items.items.[INDEX].name","typeLabel":"string"},"unitary_value":{"type":"number","format":"float","description":"Valor unitário do item","example":99.9,"uniqueKey":"data.orders.items.[INDEX].\\items.items.[INDEX].unitary_value","typeLabel":"number\u003cfloat>"},"quantity":{"type":"integer","description":"Quantidade","example":2,"uniqueKey":"data.orders.items.[INDEX].\\items.items.[INDEX].quantity","typeLabel":"integer"}},"uniqueKey":"data.orders.items.[INDEX].\\items.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.orders.items.[INDEX].\\items","typeLabel":"object[]"},"charges":{"type":"array","description":"Cobranças associadas ao pedido","items":{"type":"object","description":"Dados detalhados de uma cobrança dentro de um pedido","properties":{"code":{"type":"string","description":"Código da cobrança","example":"chg_abc123","uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].code","typeLabel":"string"},"status":{"type":"string","description":"Status da cobrança","enum":["Pending","Challenged","Approved","Declined","Refunded","Canceled"],"example":"Approved","uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"value":{"type":"number","format":"float","description":"Valor cobrado","example":199.8,"uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].value","typeLabel":"number\u003cfloat>"},"canceled_amount":{"oneOf":[{"type":"number","format":"float","description":"Valor já estornado","example":0,"uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].canceled_amount.oneOf.0","typeLabel":"number\u003cfloat>"},{"type":"null","format":"float","description":"Valor já estornado","example":0,"uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].canceled_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].canceled_amount","typeLabel":"number\u003cfloat> | null"},"nsu":{"oneOf":[{"type":"string","description":"NSU (Número Sequencial Único) da transação","example":"123456789","uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].nsu.oneOf.0","typeLabel":"string"},{"type":"null","description":"NSU (Número Sequencial Único) da transação","example":"123456789","uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].nsu.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].nsu","typeLabel":"string | null"},"installments":{"type":"integer","description":"Número de parcelas","example":1,"uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].installments","typeLabel":"integer"},"attempts":{"type":"integer","description":"Número de tentativas de cobrança","example":1,"uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].attempts","typeLabel":"integer"},"payment":{"type":"object","description":"Dados do pagamento","properties":{"code":{"oneOf":[{"type":"string","description":"Código do pagamento (ex. código PIX)","example":null,"uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].payment.code.oneOf.0","typeLabel":"string"},{"type":"null","description":"Código do pagamento (ex. código PIX)","example":null,"uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].payment.code.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].payment.code","typeLabel":"string | null"},"copy_paste":{"oneOf":[{"type":"string","description":"Código copia e cola do PIX","example":null,"uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].payment.copy_paste.oneOf.0","typeLabel":"string"},{"type":"null","description":"Código copia e cola do PIX","example":null,"uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].payment.copy_paste.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].payment.copy_paste","typeLabel":"string | null"},"expiration":{"oneOf":[{"type":"string","description":"Data/hora de expiração do pagamento","example":null,"uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].payment.expiration.oneOf.0","typeLabel":"string"},{"type":"null","description":"Data/hora de expiração do pagamento","example":null,"uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].payment.expiration.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].payment.expiration","typeLabel":"string | null"},"payment_type":{"type":"string","description":"Tipo de pagamento utilizado","enum":["CreditCard","PIX"],"example":"CreditCard","uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].payment.payment_type","typeLabel":"enum\u003cstring>"},"installments":{"type":"integer","description":"Número de parcelas","example":1,"uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].payment.installments","typeLabel":"integer"}},"uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].payment","typeLabel":"object"},"last_transaction":{"oneOf":[{"type":"object","description":"Dados da última transação no gateway","properties":{"transaction_id":{"type":"string","example":"txn_abc123","uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].last_transaction.oneOf.0.transaction_id","typeLabel":"string"},"type":{"type":"string","example":"Authorization","uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].last_transaction.oneOf.0.type","typeLabel":"string"},"status_code":{"type":"string","example":"00","uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].last_transaction.oneOf.0.status_code","typeLabel":"string"},"nsu":{"type":"string","example":"123456789","uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].last_transaction.oneOf.0.nsu","typeLabel":"string"},"tid":{"type":"string","example":"tid_abc123","uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].last_transaction.oneOf.0.tid","typeLabel":"string"},"event_date":{"type":"string","format":"date-time","example":"2026-03-11T10:00:00.000000Z","uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].last_transaction.oneOf.0.event_date","typeLabel":"string\u003cdate-time>"},"order_code":{"type":"string","example":"ord_abc123xyz","uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].last_transaction.oneOf.0.order_code","typeLabel":"string"},"message_acquisition":{"type":"string","example":"Transação autorizada","uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].last_transaction.oneOf.0.message_acquisition","typeLabel":"string"},"return_code":{"type":"string","example":"00","uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].last_transaction.oneOf.0.return_code","typeLabel":"string"},"return_message":{"type":"string","example":"Sucesso","uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].last_transaction.oneOf.0.return_message","typeLabel":"string"},"amount":{"oneOf":[{"type":"number","example":19980,"uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].last_transaction.oneOf.0.amount.oneOf.0","typeLabel":"number"},{"type":"null","example":19980,"uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].last_transaction.oneOf.0.amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].last_transaction.oneOf.0.amount","typeLabel":"number | null"}},"uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].last_transaction.oneOf.0","typeLabel":"object"},{"type":"null","description":"Dados da última transação no gateway","properties":{"transaction_id":{"type":"string","example":"txn_abc123"},"type":{"type":"string","example":"Authorization"},"status_code":{"type":"string","example":"00"},"nsu":{"type":"string","example":"123456789"},"tid":{"type":"string","example":"tid_abc123"},"event_date":{"type":"string","format":"date-time","example":"2026-03-11T10:00:00.000000Z"},"order_code":{"type":"string","example":"ord_abc123xyz"},"message_acquisition":{"type":"string","example":"Transação autorizada"},"return_code":{"type":"string","example":"00"},"return_message":{"type":"string","example":"Sucesso"},"amount":{"oneOf":[{"type":"number","example":19980},{"type":"null","example":19980}]}},"uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].last_transaction.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].last_transaction","typeLabel":"object | null"},"historics":{"type":"array","description":"Histórico de transações da cobrança","items":{"type":"object","properties":{"transaction_id":{"type":"string","uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].historics.items.[INDEX].transaction_id","typeLabel":"string"},"type":{"type":"string","uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].historics.items.[INDEX].type","typeLabel":"string"},"status_code":{"type":"string","uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].historics.items.[INDEX].status_code","typeLabel":"string"},"nsu":{"type":"string","uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].historics.items.[INDEX].nsu","typeLabel":"string"},"tid":{"type":"string","uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].historics.items.[INDEX].tid","typeLabel":"string"},"event_date":{"type":"string","format":"date-time","uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].historics.items.[INDEX].event_date","typeLabel":"string\u003cdate-time>"},"order_code":{"type":"string","uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].historics.items.[INDEX].order_code","typeLabel":"string"},"message_acquisition":{"type":"string","uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].historics.items.[INDEX].message_acquisition","typeLabel":"string"},"return_code":{"type":"string","uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].historics.items.[INDEX].return_code","typeLabel":"string"},"return_message":{"type":"string","uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].historics.items.[INDEX].return_message","typeLabel":"string"},"operation_type":{"type":"string","uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].historics.items.[INDEX].operation_type","typeLabel":"string"},"amount":{"oneOf":[{"type":"number","uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].historics.items.[INDEX].amount.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].historics.items.[INDEX].amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].historics.items.[INDEX].amount","typeLabel":"number | null"}},"uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].historics.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].historics","typeLabel":"object[]"},"card":{"oneOf":[{"type":"object","description":"Dados do cartão utilizado (mascarado)","properties":{"id":{"type":"string","format":"uuid","example":"card_abc123","uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].card.oneOf.0.id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","description":"Nome no cartão","example":"JOAO SILVA","uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].card.oneOf.0.name","typeLabel":"string"},"type":{"type":"string","description":"Tipo do cartão","example":"credit","uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].card.oneOf.0.type","typeLabel":"string"},"number":{"type":"string","description":"Número mascarado do cartão","example":"411111****1111","uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].card.oneOf.0.number","typeLabel":"string"},"flag":{"type":"string","description":"Bandeira do cartão","example":"visa","uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].card.oneOf.0.flag","typeLabel":"string"}},"uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].card.oneOf.0","typeLabel":"object"},{"type":"null","description":"Dados do cartão utilizado (mascarado)","properties":{"id":{"type":"string","format":"uuid","example":"card_abc123"},"name":{"type":"string","description":"Nome no cartão","example":"JOAO SILVA"},"type":{"type":"string","description":"Tipo do cartão","example":"credit"},"number":{"type":"string","description":"Número mascarado do cartão","example":"411111****1111"},"flag":{"type":"string","description":"Bandeira do cartão","example":"visa"}},"uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].card.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].card","typeLabel":"object | null"}},"uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.orders.items.[INDEX].charges","typeLabel":"object[]"},"confirmation_codes":{"type":"array","description":"Códigos de confirmação pendentes (para pedidos com status Challenged)","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"conf_xyz789","uniqueKey":"data.orders.items.[INDEX].confirmation_codes.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","example":"OTP","uniqueKey":"data.orders.items.[INDEX].confirmation_codes.items.[INDEX].type","typeLabel":"string"},"status":{"type":"string","example":"Pending","uniqueKey":"data.orders.items.[INDEX].confirmation_codes.items.[INDEX].status","typeLabel":"string"},"expires_at":{"type":"string","format":"date-time","example":"2026-03-11T10:15:00.000000Z","uniqueKey":"data.orders.items.[INDEX].confirmation_codes.items.[INDEX].expires_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"data.orders.items.[INDEX].confirmation_codes.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.orders.items.[INDEX].confirmation_codes","typeLabel":"object[]"}},"uniqueKey":"data.orders.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.orders","typeLabel":"object[]"}},"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"mensagem":"Cobrança realizada com sucesso.","erro":false,"mensagenserro":[],"codigoretorno":201,"id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","data":{"charge_id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","charge_created_at":"11/03/2026 10:00:00","account_id":1,"code":"pur_abc123xyz","value":199.8,"charge_value":199.8,"coin":"BRL","status":"Approved","client":{"code":"cli_abc123","name":"João Silva","email":"joao@exemplo.com.br"},"orders":[{"code":"ord_abc123xyz","status":"Approved","value":199.8,"charges":[{"code":"chg_abc123","status":"Approved","value":199.8,"installments":1,"payment":{"payment_type":"CreditCard","installments":1,"card_token":"9b2f5c8e-3a1d-4f7b-8c6e-2d9a1b4c5e6f"}}]}]}},"examples":{"Example":{"title":"Example","value":{"mensagem":"Cobrança realizada com sucesso.","erro":false,"mensagenserro":[],"codigoretorno":201,"id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","data":{"charge_id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","charge_created_at":"11/03/2026 10:00:00","account_id":1,"code":"pur_abc123xyz","value":199.8,"charge_value":199.8,"coin":"BRL","status":"Approved","client":{"code":"cli_abc123","name":"João Silva","email":"joao@exemplo.com.br"},"orders":[{"code":"ord_abc123xyz","status":"Approved","value":199.8,"charges":[{"code":"chg_abc123","status":"Approved","value":199.8,"installments":1,"payment":{"payment_type":"CreditCard","installments":1,"card_token":"9b2f5c8e-3a1d-4f7b-8c6e-2d9a1b4c5e6f"}}]}]}}}},"exampleType":"examples"}},"exampleType":"examples"},"79f9b2e3-873f-4c9b-a656-e282018177ff":{"description":"Transação desafiada — requer confirmação adicional (OTP)","content":{"application/json":{"schema":{"type":"object","description":"Resposta da criação de cobrança (envelope APIReturnUtil + dados ConsultCharge)","properties":{"mensagem":{"type":"string","example":"Cobrança realizada com sucesso.","uniqueKey":"mensagem","typeLabel":"string"},"erro":{"type":"boolean","example":false,"uniqueKey":"erro","typeLabel":"boolean"},"mensagenserro":{"type":"array","items":{"type":"string","uniqueKey":"mensagenserro.items.[INDEX]","typeLabel":"string"},"example":[],"uniqueKey":"mensagenserro","typeLabel":"string[]"},"codigoretorno":{"type":"integer","example":201,"uniqueKey":"codigoretorno","typeLabel":"integer"},"id":{"type":"string","description":"ID da cobrança criada","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","uniqueKey":"id","typeLabel":"string"},"data":{"type":"object","description":"Dados completos de uma cobrança retornados pelo ConsultCharge","properties":{"charge_id":{"type":"string","format":"uuid","description":"ID interno da cobrança","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","uniqueKey":"data.charge_id","typeLabel":"string\u003cuuid>"},"charge_created_at":{"type":"string","description":"Data de criação da cobrança (formatada)","example":"11/03/2026 10:00:00","uniqueKey":"data.charge_created_at","typeLabel":"string"},"account_id":{"type":"integer","description":"ID interno da conta","example":1,"uniqueKey":"data.account_id","typeLabel":"integer"},"code":{"type":"string","description":"Código da compra (purchase code)","example":"pur_abc123xyz","uniqueKey":"data.code","typeLabel":"string"},"value":{"type":"number","format":"float","description":"Valor total da compra","example":199.8,"uniqueKey":"data.value","typeLabel":"number\u003cfloat>"},"charge_value":{"type":"number","format":"float","description":"Valor da cobrança","example":199.8,"uniqueKey":"data.charge_value","typeLabel":"number\u003cfloat>"},"coin":{"type":"string","description":"Moeda da transação","example":"BRL","uniqueKey":"data.coin","typeLabel":"string"},"status":{"type":"string","description":"Status da compra","enum":["Pending","Challenged","Approved","Declined","Refunded","Canceled"],"example":"Approved","uniqueKey":"data.status","typeLabel":"enum\u003cstring>"},"client":{"type":"object","description":"Dados do cliente associado à cobrança","properties":{"code":{"type":"string","description":"Código do cliente","example":"cli_abc123","uniqueKey":"data.client.code","typeLabel":"string"},"name":{"type":"string","description":"Nome do cliente","example":"João Silva","uniqueKey":"data.client.name","typeLabel":"string"},"email":{"type":"string","format":"email","description":"E-mail do cliente","example":"joao@exemplo.com.br","uniqueKey":"data.client.email","typeLabel":"string\u003cemail>"},"documents":{"type":"array","description":"Documentos do cliente (filtrado pelo documento padrão)","items":{"type":"object","properties":{"type":{"type":"string","example":"CPF","uniqueKey":"data.client.documents.items.[INDEX].type","typeLabel":"string"},"number":{"type":"string","example":"123.456.789-09","uniqueKey":"data.client.documents.items.[INDEX].number","typeLabel":"string"},"default":{"type":"boolean","example":true,"uniqueKey":"data.client.documents.items.[INDEX].default","typeLabel":"boolean"}},"uniqueKey":"data.client.documents.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.client.documents","typeLabel":"object[]"},"phone":{"type":"array","description":"Telefones do cliente (filtrado pelo telefone padrão)","items":{"type":"object","properties":{"ddi":{"type":"string","example":"55","uniqueKey":"data.client.phone.items.[INDEX].ddi","typeLabel":"string"},"ddd":{"type":"string","example":"11","uniqueKey":"data.client.phone.items.[INDEX].ddd","typeLabel":"string"},"number":{"type":"string","example":"999999999","uniqueKey":"data.client.phone.items.[INDEX].number","typeLabel":"string"},"default":{"type":"boolean","example":true,"uniqueKey":"data.client.phone.items.[INDEX].default","typeLabel":"boolean"}},"uniqueKey":"data.client.phone.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.client.phone","typeLabel":"object[]"},"addresss":{"type":"array","description":"Endereços do cliente (filtrado pelo endereço padrão)","items":{"type":"object","properties":{"zipcode":{"type":"string","example":"01310-100","uniqueKey":"data.client.addresss.items.[INDEX].zipcode","typeLabel":"string"},"street":{"type":"string","example":"Avenida Paulista","uniqueKey":"data.client.addresss.items.[INDEX].street","typeLabel":"string"},"number":{"type":"string","example":"1000","uniqueKey":"data.client.addresss.items.[INDEX].number","typeLabel":"string"},"neighborhood":{"type":"string","example":"Bela Vista","uniqueKey":"data.client.addresss.items.[INDEX].neighborhood","typeLabel":"string"},"city":{"type":"string","example":"São Paulo","uniqueKey":"data.client.addresss.items.[INDEX].city","typeLabel":"string"},"state":{"type":"string","example":"SP","uniqueKey":"data.client.addresss.items.[INDEX].state","typeLabel":"string"}},"uniqueKey":"data.client.addresss.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.client.addresss","typeLabel":"object[]"}},"uniqueKey":"data.client","typeLabel":"object"},"orders":{"type":"array","items":{"type":"object","description":"Dados do pedido associado à cobrança","properties":{"code":{"type":"string","description":"Código do pedido","example":"ord_abc123xyz","uniqueKey":"data.orders.items.[INDEX].code","typeLabel":"string"},"status":{"type":"string","description":"Status do pedido","enum":["Pending","Challenged","Approved","Declined","Refunded","Canceled"],"example":"Approved","uniqueKey":"data.orders.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"value":{"type":"number","format":"float","description":"Valor do pedido","example":199.8,"uniqueKey":"data.orders.items.[INDEX].value","typeLabel":"number\u003cfloat>"},"error_message":{"oneOf":[{"type":"string","description":"Mensagem de erro do gateway (null se não houver)","example":null,"uniqueKey":"data.orders.items.[INDEX].error_message.oneOf.0","typeLabel":"string"},{"type":"null","description":"Mensagem de erro do gateway (null se não houver)","example":null,"uniqueKey":"data.orders.items.[INDEX].error_message.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.orders.items.[INDEX].error_message","typeLabel":"string | null"},"items":{"type":"array","description":"Itens do pedido","items":{"type":"object","properties":{"code":{"type":"string","description":"Código do item","example":"produto_001","uniqueKey":"data.orders.items.[INDEX].\\items.items.[INDEX].code","typeLabel":"string"},"name":{"type":"string","description":"Nome do item","example":"Camiseta Premium","uniqueKey":"data.orders.items.[INDEX].\\items.items.[INDEX].name","typeLabel":"string"},"unitary_value":{"type":"number","format":"float","description":"Valor unitário do item","example":99.9,"uniqueKey":"data.orders.items.[INDEX].\\items.items.[INDEX].unitary_value","typeLabel":"number\u003cfloat>"},"quantity":{"type":"integer","description":"Quantidade","example":2,"uniqueKey":"data.orders.items.[INDEX].\\items.items.[INDEX].quantity","typeLabel":"integer"}},"uniqueKey":"data.orders.items.[INDEX].\\items.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.orders.items.[INDEX].\\items","typeLabel":"object[]"},"charges":{"type":"array","description":"Cobranças associadas ao pedido","items":{"type":"object","description":"Dados detalhados de uma cobrança dentro de um pedido","properties":{"code":{"type":"string","description":"Código da cobrança","example":"chg_abc123","uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].code","typeLabel":"string"},"status":{"type":"string","description":"Status da cobrança","enum":["Pending","Challenged","Approved","Declined","Refunded","Canceled"],"example":"Approved","uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"value":{"type":"number","format":"float","description":"Valor cobrado","example":199.8,"uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].value","typeLabel":"number\u003cfloat>"},"canceled_amount":{"oneOf":[{"type":"number","format":"float","description":"Valor já estornado","example":0,"uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].canceled_amount.oneOf.0","typeLabel":"number\u003cfloat>"},{"type":"null","format":"float","description":"Valor já estornado","example":0,"uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].canceled_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].canceled_amount","typeLabel":"number\u003cfloat> | null"},"nsu":{"oneOf":[{"type":"string","description":"NSU (Número Sequencial Único) da transação","example":"123456789","uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].nsu.oneOf.0","typeLabel":"string"},{"type":"null","description":"NSU (Número Sequencial Único) da transação","example":"123456789","uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].nsu.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].nsu","typeLabel":"string | null"},"installments":{"type":"integer","description":"Número de parcelas","example":1,"uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].installments","typeLabel":"integer"},"attempts":{"type":"integer","description":"Número de tentativas de cobrança","example":1,"uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].attempts","typeLabel":"integer"},"payment":{"type":"object","description":"Dados do pagamento","properties":{"code":{"oneOf":[{"type":"string","description":"Código do pagamento (ex. código PIX)","example":null,"uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].payment.code.oneOf.0","typeLabel":"string"},{"type":"null","description":"Código do pagamento (ex. código PIX)","example":null,"uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].payment.code.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].payment.code","typeLabel":"string | null"},"copy_paste":{"oneOf":[{"type":"string","description":"Código copia e cola do PIX","example":null,"uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].payment.copy_paste.oneOf.0","typeLabel":"string"},{"type":"null","description":"Código copia e cola do PIX","example":null,"uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].payment.copy_paste.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].payment.copy_paste","typeLabel":"string | null"},"expiration":{"oneOf":[{"type":"string","description":"Data/hora de expiração do pagamento","example":null,"uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].payment.expiration.oneOf.0","typeLabel":"string"},{"type":"null","description":"Data/hora de expiração do pagamento","example":null,"uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].payment.expiration.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].payment.expiration","typeLabel":"string | null"},"payment_type":{"type":"string","description":"Tipo de pagamento utilizado","enum":["CreditCard","PIX"],"example":"CreditCard","uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].payment.payment_type","typeLabel":"enum\u003cstring>"},"installments":{"type":"integer","description":"Número de parcelas","example":1,"uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].payment.installments","typeLabel":"integer"}},"uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].payment","typeLabel":"object"},"last_transaction":{"oneOf":[{"type":"object","description":"Dados da última transação no gateway","properties":{"transaction_id":{"type":"string","example":"txn_abc123","uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].last_transaction.oneOf.0.transaction_id","typeLabel":"string"},"type":{"type":"string","example":"Authorization","uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].last_transaction.oneOf.0.type","typeLabel":"string"},"status_code":{"type":"string","example":"00","uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].last_transaction.oneOf.0.status_code","typeLabel":"string"},"nsu":{"type":"string","example":"123456789","uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].last_transaction.oneOf.0.nsu","typeLabel":"string"},"tid":{"type":"string","example":"tid_abc123","uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].last_transaction.oneOf.0.tid","typeLabel":"string"},"event_date":{"type":"string","format":"date-time","example":"2026-03-11T10:00:00.000000Z","uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].last_transaction.oneOf.0.event_date","typeLabel":"string\u003cdate-time>"},"order_code":{"type":"string","example":"ord_abc123xyz","uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].last_transaction.oneOf.0.order_code","typeLabel":"string"},"message_acquisition":{"type":"string","example":"Transação autorizada","uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].last_transaction.oneOf.0.message_acquisition","typeLabel":"string"},"return_code":{"type":"string","example":"00","uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].last_transaction.oneOf.0.return_code","typeLabel":"string"},"return_message":{"type":"string","example":"Sucesso","uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].last_transaction.oneOf.0.return_message","typeLabel":"string"},"amount":{"oneOf":[{"type":"number","example":19980,"uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].last_transaction.oneOf.0.amount.oneOf.0","typeLabel":"number"},{"type":"null","example":19980,"uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].last_transaction.oneOf.0.amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].last_transaction.oneOf.0.amount","typeLabel":"number | null"}},"uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].last_transaction.oneOf.0","typeLabel":"object"},{"type":"null","description":"Dados da última transação no gateway","properties":{"transaction_id":{"type":"string","example":"txn_abc123"},"type":{"type":"string","example":"Authorization"},"status_code":{"type":"string","example":"00"},"nsu":{"type":"string","example":"123456789"},"tid":{"type":"string","example":"tid_abc123"},"event_date":{"type":"string","format":"date-time","example":"2026-03-11T10:00:00.000000Z"},"order_code":{"type":"string","example":"ord_abc123xyz"},"message_acquisition":{"type":"string","example":"Transação autorizada"},"return_code":{"type":"string","example":"00"},"return_message":{"type":"string","example":"Sucesso"},"amount":{"oneOf":[{"type":"number","example":19980},{"type":"null","example":19980}]}},"uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].last_transaction.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].last_transaction","typeLabel":"object | null"},"historics":{"type":"array","description":"Histórico de transações da cobrança","items":{"type":"object","properties":{"transaction_id":{"type":"string","uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].historics.items.[INDEX].transaction_id","typeLabel":"string"},"type":{"type":"string","uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].historics.items.[INDEX].type","typeLabel":"string"},"status_code":{"type":"string","uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].historics.items.[INDEX].status_code","typeLabel":"string"},"nsu":{"type":"string","uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].historics.items.[INDEX].nsu","typeLabel":"string"},"tid":{"type":"string","uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].historics.items.[INDEX].tid","typeLabel":"string"},"event_date":{"type":"string","format":"date-time","uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].historics.items.[INDEX].event_date","typeLabel":"string\u003cdate-time>"},"order_code":{"type":"string","uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].historics.items.[INDEX].order_code","typeLabel":"string"},"message_acquisition":{"type":"string","uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].historics.items.[INDEX].message_acquisition","typeLabel":"string"},"return_code":{"type":"string","uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].historics.items.[INDEX].return_code","typeLabel":"string"},"return_message":{"type":"string","uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].historics.items.[INDEX].return_message","typeLabel":"string"},"operation_type":{"type":"string","uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].historics.items.[INDEX].operation_type","typeLabel":"string"},"amount":{"oneOf":[{"type":"number","uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].historics.items.[INDEX].amount.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].historics.items.[INDEX].amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].historics.items.[INDEX].amount","typeLabel":"number | null"}},"uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].historics.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].historics","typeLabel":"object[]"},"card":{"oneOf":[{"type":"object","description":"Dados do cartão utilizado (mascarado)","properties":{"id":{"type":"string","format":"uuid","example":"card_abc123","uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].card.oneOf.0.id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","description":"Nome no cartão","example":"JOAO SILVA","uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].card.oneOf.0.name","typeLabel":"string"},"type":{"type":"string","description":"Tipo do cartão","example":"credit","uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].card.oneOf.0.type","typeLabel":"string"},"number":{"type":"string","description":"Número mascarado do cartão","example":"411111****1111","uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].card.oneOf.0.number","typeLabel":"string"},"flag":{"type":"string","description":"Bandeira do cartão","example":"visa","uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].card.oneOf.0.flag","typeLabel":"string"}},"uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].card.oneOf.0","typeLabel":"object"},{"type":"null","description":"Dados do cartão utilizado (mascarado)","properties":{"id":{"type":"string","format":"uuid","example":"card_abc123"},"name":{"type":"string","description":"Nome no cartão","example":"JOAO SILVA"},"type":{"type":"string","description":"Tipo do cartão","example":"credit"},"number":{"type":"string","description":"Número mascarado do cartão","example":"411111****1111"},"flag":{"type":"string","description":"Bandeira do cartão","example":"visa"}},"uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].card.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX].card","typeLabel":"object | null"}},"uniqueKey":"data.orders.items.[INDEX].charges.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.orders.items.[INDEX].charges","typeLabel":"object[]"},"confirmation_codes":{"type":"array","description":"Códigos de confirmação pendentes (para pedidos com status Challenged)","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"conf_xyz789","uniqueKey":"data.orders.items.[INDEX].confirmation_codes.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","example":"OTP","uniqueKey":"data.orders.items.[INDEX].confirmation_codes.items.[INDEX].type","typeLabel":"string"},"status":{"type":"string","example":"Pending","uniqueKey":"data.orders.items.[INDEX].confirmation_codes.items.[INDEX].status","typeLabel":"string"},"expires_at":{"type":"string","format":"date-time","example":"2026-03-11T10:15:00.000000Z","uniqueKey":"data.orders.items.[INDEX].confirmation_codes.items.[INDEX].expires_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"data.orders.items.[INDEX].confirmation_codes.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.orders.items.[INDEX].confirmation_codes","typeLabel":"object[]"}},"uniqueKey":"data.orders.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.orders","typeLabel":"object[]"}},"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"mensagem":"A transação necessita de confirmação...","erro":false,"mensagenserro":[],"codigoretorno":202,"id":"00000000-0000-0000-0000-000000000000","data":{"charge_id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","status":"Challenged","orders":[{"code":"ord_abc123xyz","status":"Challenged","confirmation_codes":[{"id":"conf_xyz789","type":"OTP","status":"Pending","expires_at":"2026-03-11T10:15:00.000000Z"}]}]}},"examples":{"Example":{"title":"Example","value":{"mensagem":"A transação necessita de confirmação...","erro":false,"mensagenserro":[],"codigoretorno":202,"id":"00000000-0000-0000-0000-000000000000","data":{"charge_id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","status":"Challenged","orders":[{"code":"ord_abc123xyz","status":"Challenged","confirmation_codes":[{"id":"conf_xyz789","type":"OTP","status":"Pending","expires_at":"2026-03-11T10:15:00.000000Z"}]}]}}}},"exampleType":"examples"}},"exampleType":"examples"},"1b5fae94-da5e-4100-a5ff-06a36c15b081":{"description":"Fraude detectada ou erro no gateway","content":{"application/json":{"schema":{"type":"object","properties":{"mensagem":{"type":"string","example":"Um erro inesperado acabou de acontecer.","uniqueKey":"mensagem","typeLabel":"string"},"erro":{"type":"boolean","example":true,"uniqueKey":"erro","typeLabel":"boolean"},"mensagenserro":{"type":"array","items":{"type":"string","uniqueKey":"mensagenserro.items.[INDEX]","typeLabel":"string"},"example":["Detalhe do erro ocorrido."],"uniqueKey":"mensagenserro","typeLabel":"string[]"},"codigoretorno":{"type":"integer","example":400,"uniqueKey":"codigoretorno","typeLabel":"integer"},"id":{"type":"string","example":"00000000-0000-0000-0000-000000000000","uniqueKey":"id","typeLabel":"string"},"data":{"type":"array","example":[],"uniqueKey":"data","typeLabel":"array"}},"uniqueKey":"","typeLabel":"object"},"example":{"mensagem":"Não foi possível concluir sua transação.","erro":true,"mensagenserro":["Verifique as informações e tente novamente."],"codigoretorno":400,"id":"00000000-0000-0000-0000-000000000000","data":[]},"examples":{"Example":{"title":"Example","value":{"mensagem":"Não foi possível concluir sua transação.","erro":true,"mensagenserro":["Verifique as informações e tente novamente."],"codigoretorno":400,"id":"00000000-0000-0000-0000-000000000000","data":[]}}},"exampleType":"examples"}},"exampleType":"examples"},"bc1c97f3-529e-4225-8b14-e60e84ca2706":{"description":"Não autorizado — token inválido ou ausente","content":{"application/json":{"schema":{"type":"object","properties":{"mensagem":{"type":"string","example":"Um erro inesperado acabou de acontecer.","uniqueKey":"mensagem","typeLabel":"string"},"erro":{"type":"boolean","example":true,"uniqueKey":"erro","typeLabel":"boolean"},"mensagenserro":{"type":"array","items":{"type":"string","uniqueKey":"mensagenserro.items.[INDEX]","typeLabel":"string"},"example":["Detalhe do erro ocorrido."],"uniqueKey":"mensagenserro","typeLabel":"string[]"},"codigoretorno":{"type":"integer","example":400,"uniqueKey":"codigoretorno","typeLabel":"integer"},"id":{"type":"string","example":"00000000-0000-0000-0000-000000000000","uniqueKey":"id","typeLabel":"string"},"data":{"type":"array","example":[],"uniqueKey":"data","typeLabel":"array"}},"uniqueKey":"","typeLabel":"object"},"example":{"mensagem":"Unauthenticated.","erro":true,"mensagenserro":[],"codigoretorno":401,"id":"00000000-0000-0000-0000-000000000000","data":[]},"examples":{"Example":{"title":"Example","value":{"mensagem":"Unauthenticated.","erro":true,"mensagenserro":[],"codigoretorno":401,"id":"00000000-0000-0000-0000-000000000000","data":[]}}},"exampleType":"examples"}},"exampleType":"examples"},"f8bbe4b7-04d1-424a-aa82-e7c9892cb704":{"description":"Erro de validação dos dados enviados","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"The given data was invalid.","uniqueKey":"message","typeLabel":"string"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"errors.additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.additionalProperties","typeLabel":"string[]"},"example":{"client.email":["O campo client.email é obrigatório."],"payment.type":["O campo payment.type é obrigatório."]},"uniqueKey":"errors","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"message":"The given data was invalid.","errors":{"client.email":["O campo client.email é obrigatório."]}},"examples":{"Example":{"title":"Example","value":{"message":"The given data was invalid.","errors":{"client.email":["O campo client.email é obrigatório."]}}}},"exampleType":"examples"}},"exampleType":"examples"},"6d7638ee-6dbd-43cd-bf16-b268e8d1e932":{"description":"Erro interno do servidor","content":{"application/json":{"schema":{"type":"object","properties":{"mensagem":{"type":"string","example":"Um erro inesperado acabou de acontecer.","uniqueKey":"mensagem","typeLabel":"string"},"erro":{"type":"boolean","example":true,"uniqueKey":"erro","typeLabel":"boolean"},"mensagenserro":{"type":"array","items":{"type":"string","uniqueKey":"mensagenserro.items.[INDEX]","typeLabel":"string"},"example":["Detalhe do erro ocorrido."],"uniqueKey":"mensagenserro","typeLabel":"string[]"},"codigoretorno":{"type":"integer","example":400,"uniqueKey":"codigoretorno","typeLabel":"integer"},"id":{"type":"string","example":"00000000-0000-0000-0000-000000000000","uniqueKey":"id","typeLabel":"string"},"data":{"type":"array","example":[],"uniqueKey":"data","typeLabel":"array"}},"uniqueKey":"","typeLabel":"object"},"example":{"mensagem":"Um erro aconteceu.","erro":true,"mensagenserro":["Erro interno. Tente novamente mais tarde."],"codigoretorno":500,"id":"00000000-0000-0000-0000-000000000000","data":[]},"examples":{"Example":{"title":"Example","value":{"mensagem":"Um erro aconteceu.","erro":true,"mensagenserro":["Erro interno. Tente novamente mais tarde."],"codigoretorno":500,"id":"00000000-0000-0000-0000-000000000000","data":[]}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"8a2f4888-f0b7-4d7a-b303-2cf6e5982396":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Token JWT obtido via `POST /v1/login`. Envie no header `Authorization: Bearer \u003ctoken>`.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"4c3dfa86-2ed5-4f58-9a07-b7d334d46949":{"url":"https://sandbox.4seletpay.com.br/api","description":"Servidor de Sandbox"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Token JWT obtido via `POST /v1/login`. Envie no header `Authorization: Bearer \u003ctoken>`.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Token JWT obtido via `POST /v1/login`. Envie no header `Authorization: Bearer \u003ctoken>`.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi.yaml"},"subdomain":"4selet-1a9bfa9b","siteName":"4SeletPay","title":"Criar Cobrança - 4SeletPay","navMaps":{"firstHrefInVersion":{"v2":{"href":"/pages/links-de-pagamento/create","matchLevel":1},"v1":{"href":"/pages/cobrancas/create","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-08-14T14:26:11.387Z","originalFileLocation":"pages/cobrancas/create.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=\"Cria uma nova cobrança (pedido de pagamento). Suporta os métodos de pagamento: CreditCard, PIX. Requer o header account com o código da conta. Passa por validações de fraude, bloqueio de clientes e rate limiting. Possíveis cenários de resposta: - 201 — Cobrança processada com sucesso (aprovada ou aguardando pagamento PIX) - 202 — Transação desafiada (requer confirmação adicional via OTP) - 400 — Fraude detectada ou erro no processamento do gateway - 422 — Erro de validação dos dados enviados\">\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=\"Criar Cobrança - 4SeletPay\">\u003cmeta data-mint-head property=\"og:description\" content=\"Cria uma nova cobrança (pedido de pagamento). Suporta os métodos de pagamento: CreditCard, PIX. Requer o header account com o código da conta. Passa por validações de fraude, bloqueio de clientes e rate limiting. Possíveis cenários de resposta: - 201 — Cobrança processada com sucesso (aprovada ou aguardando pagamento PIX) - 202 — Transação desafiada (requer confirmação adicional via OTP) - 400 — Fraude detectada ou erro no processamento do gateway - 422 — Erro de validação dos dados enviados\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"4SeletPay\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.4seletpay.com.br/pages/cobrancas/create\">\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=Cobran%C3%A7as\u0026amp;title=Criar+Cobran%C3%A7a\u0026amp;description=Cria+uma+nova+cobran%C3%A7a+%28pedido+de+pagamento%29.+Suporta+os+m%C3%A9todos+de+pagamento%3A+**CreditCard**%2C+**PIX**.+Requer+o+header+%60account%60+com+o+c%C3%B3digo+da+conta.+Passa+p\u0026amp;theme=e946cf76f4ab5d90a4344f4d\u0026amp;signature=6900691542345f8e1ff9a0668412d61e24613910b9aa42af8e90eaced2a39d51\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Criar Cobrança - 4SeletPay\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Cria uma nova cobrança (pedido de pagamento). Suporta os métodos de pagamento: CreditCard, PIX. Requer o header account com o código da conta. Passa por validações de fraude, bloqueio de clientes e rate limiting. Possíveis cenários de resposta: - 201 — Cobrança processada com sucesso (aprovada ou aguardando pagamento PIX) - 202 — Transação desafiada (requer confirmação adicional via OTP) - 400 — Fraude detectada ou erro no processamento do gateway - 422 — Erro de validação dos dados enviados\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://4selet-1a9bfa9b.mintlify.site/_mintlify/api/og/v2?division=Cobran%C3%A7as\u0026amp;title=Criar+Cobran%C3%A7a\u0026amp;description=Cria+uma+nova+cobran%C3%A7a+%28pedido+de+pagamento%29.+Suporta+os+m%C3%A9todos+de+pagamento%3A+**CreditCard**%2C+**PIX**.+Requer+o+header+%60account%60+com+o+c%C3%B3digo+da+conta.+Passa+p\u0026amp;theme=e946cf76f4ab5d90a4344f4d\u0026amp;signature=6900691542345f8e1ff9a0668412d61e24613910b9aa42af8e90eaced2a39d51\">\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/cobrancas/create\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/pages/cobrancas/create.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/cobrancas/create#webpage\",\"url\":\"https://docs.4seletpay.com.br/pages/cobrancas/create\",\"name\":\"Criar Cobrança\",\"description\":\"Cria uma nova cobrança (pedido de pagamento). Suporta os métodos de pagamento: CreditCard, PIX. Requer o header account com o código da conta. Passa por validações de fraude, bloqueio de clientes e rate limiting. Possíveis cenários de resposta: - 201 — Cobrança processada com sucesso (aprovada ou aguardando pagamento PIX) - 202 — Transação desafiada (requer confirmação adicional via OTP) - 400 — Fraude detectada ou erro no processamento do gateway - 422 — Erro de validação dos dados enviados\",\"dateModified\":\"2026-08-14T14:26:11.387Z\",\"isPartOf\":{\"@id\":\"https://docs.4seletpay.com.br#website\"},\"breadcrumb\":{\"@id\":\"https://docs.4seletpay.com.br/pages/cobrancas/create#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.4seletpay.com.br/pages/cobrancas/create#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Cobranças\",\"item\":\"https://docs.4seletpay.com.br/pages/cobrancas/reference\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Criar Cobrança\",\"item\":\"https://docs.4seletpay.com.br/pages/cobrancas/create\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.4seletpay.com.br/pages/cobrancas/create#apireference\",\"headline\":\"Criar Cobrança\",\"name\":\"Criar Cobrança\",\"description\":\"Cria uma nova cobrança (pedido de pagamento). Suporta os métodos de pagamento: CreditCard, PIX. Requer o header account com o código da conta. Passa por validações de fraude, bloqueio de clientes e rate limiting. Possíveis cenários de resposta: - 201 — Cobrança processada com sucesso (aprovada ou aguardando pagamento PIX) - 202 — Transação desafiada (requer confirmação adicional via OTP) - 400 — Fraude detectada ou erro no processamento do gateway - 422 — Erro de validação dos dados enviados\",\"url\":\"https://docs.4seletpay.com.br/pages/cobrancas/create\",\"mainEntityOfPage\":{\"@id\":\"https://docs.4seletpay.com.br/pages/cobrancas/create#webpage\"},\"dateModified\":\"2026-08-14T14:26:11.387Z\",\"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/cobrancas/create.md","siteName":"4SeletPay","nav":{"global":null,"versions":[{"version":"v2","tag":"Atual","pages":[{"title":"v2","href":"/pages/links-de-pagamento/create"}]},{"version":"v1","tag":"Legado","tabs":[{"tab":"Comece aqui","pages":[{"title":"Comece aqui","href":"/pages/start/welcome"}]},{"tab":"Referência","groups":[{"group":"Autenticação","pages":[{"title":"Autenticação","icon":"lock","href":"/pages/autenticacao/reference"},{"title":"Realizar Login","openapi":"POST /v1/login","href":"/pages/autenticacao/login"},{"title":"Chave de API (secret key)","icon":"key","href":"/pages/autenticacao/chave-de-api"}]},{"group":"Cobranças","pages":[{"title":"Cobranças","description":"Criação e gerenciamento de cobranças (pagamentos únicos) na plataforma 4Selet Pay.","icon":"credit-card","href":"/pages/cobrancas/reference"},{"title":"Criar Cobrança","openapi":"POST /v1/charge","href":"/pages/cobrancas/create"},{"title":"Listar Cobranças","openapi":"GET /v1/charge","description":"Retorna a lista paginada de cobranças da conta informada no header `account`. A resposta segue o formato padrão de paginação do Laravel (não é envelopada pelo formato APIReturnUtil).\n","href":"/pages/cobrancas/list"},{"title":"Consultar Cobrança","openapi":"GET /v1/charge/{code}","href":"/pages/cobrancas/get"},{"title":"Cancelar Cobrança","openapi":"POST /v1/charge/cancel/{code}","href":"/pages/cobrancas/cancel"},{"title":"Estornar Cobrança","openapi":"POST /v1/charge/refund/{code}","href":"/pages/cobrancas/refund"}]},{"group":"Checkout.js","pages":[{"title":"Checkout.js e 3D Secure","icon":"code","tag":"Em breve","href":"/pages/checkout-js/reference"}]},{"group":"Pedidos","pages":[{"title":"Pedidos","icon":"bag-shopping","href":"/pages/pedidos/reference"},{"title":"Listar Confirmações","openapi":"GET /v1/orders/{order_code}/confirmations","href":"/pages/pedidos/confirmations"},{"title":"Verificar Confirmação","openapi":"POST /v1/orders/{order_code}/confirmations/{confirmation_id}/verify","href":"/pages/pedidos/verify"},{"title":"Reenviar Confirmação","openapi":"POST /v1/orders/{order_code}/confirmations/{confirmation_id}/resend","href":"/pages/pedidos/resend"}]},{"group":"Cartões","pages":[{"title":"Cartões","icon":"credit-card","href":"/pages/cartoes/reference"},{"title":"Salvar Cartão","openapi":"POST /v1/clients/{clientCode}/cards/tokens","href":"/pages/cartoes/create-token"},{"title":"Listar Cartões","openapi":"GET /v1/clients/{clientCode}/cards","href":"/pages/cartoes/list"},{"title":"Consultar Cartão","openapi":"GET /v1/clients/{clientCode}/cards/{cardId}","href":"/pages/cartoes/get"},{"title":"Atualizar Cartão","openapi":"PUT /v1/clients/{clientCode}/cards/{cardId}","href":"/pages/cartoes/update"},{"title":"Excluir Cartão","openapi":"DELETE /v1/clients/{clientCode}/cards/{cardId}","href":"/pages/cartoes/delete"}]},{"group":"Assinaturas","pages":[{"title":"Assinaturas","icon":"arrows-rotate","href":"/pages/assinaturas/reference"},{"title":"Criar Assinatura","openapi":"POST /v1/subscriptions","href":"/pages/assinaturas/create"},{"title":"Cancelar Assinatura","openapi":"PUT /v1/subscriptions/cancel/{subscription_code}","href":"/pages/assinaturas/cancel"},{"title":"Alterar Cartão","openapi":"PUT /v1/subscriptions/change-card/{subscription_code}","href":"/pages/assinaturas/change-card"},{"title":"Alterar Método de Pagamento","openapi":"PUT /v1/subscriptions/change-payment-method/{subscription_code}","href":"/pages/assinaturas/change-payment-method"},{"title":"Listar Faturas","openapi":"GET /v1/subscriptions/{subscription_code}/invoices","href":"/pages/assinaturas/invoices"},{"title":"Listar Itens","openapi":"GET /v1/subscriptions/{subscription_code}/items","href":"/pages/assinaturas/items"},{"title":"Atualizar Item","openapi":"PUT /v1/subscriptions/{subscription_code}/items/{item_code}","href":"/pages/assinaturas/update-item"},{"title":"Alterar Próxima Cobrança","tag":"Em breve","href":"/pages/assinaturas/next-charge-date"}]},{"group":"Faturas","pages":[{"title":"Faturas","icon":"file-lines","href":"/pages/faturas/reference"},{"title":"Pagar Fatura em Atraso","openapi":"POST /v1/invoices/{invoice_code}/pay-overdue","href":"/pages/faturas/pay-overdue"}]},{"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"}]},{"group":"Webhooks","pages":[{"title":"Endpoints de Webhook","icon":"webhook","href":"/pages/webhook-endpoints/reference"},{"title":"Criar Endpoint","openapi":"POST /v1/webhook-endpoints","href":"/pages/webhook-endpoints/create"},{"title":"Listar Endpoints","openapi":"GET /v1/webhook-endpoints","href":"/pages/webhook-endpoints/list"},{"title":"Atualizar Endpoint","openapi":"PUT /v1/webhook-endpoints/{id}","href":"/pages/webhook-endpoints/update"},{"title":"Remover Endpoint","openapi":"DELETE /v1/webhook-endpoints/{id}","href":"/pages/webhook-endpoints/delete"}]}]},{"tab":"Webhooks","pages":[{"title":"Webhooks","href":"/pages/webhooks/reference"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/pages/changelog"}]}]}]},"basePath":"","title":"Criar Cobrança - 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"]}