> ## Documentation Index > Fetch the complete documentation index at: https://docs.beinfi.com/llms.txt > Use this file to discover all available pages before exploring further. # Cobrar uma fatura > Cria uma cobrança para uma fatura em aberto no meio de pagamento escolhido. A resposta traz o que você precisa para quem vai pagar: o código Pix (`pixPayload`, `pixQrImage`), a página de pagamento (`invoiceUrl`) ou os dados para confirmar o cartão no navegador (`nextAction`). Esses campos só vêm nesta resposta; guarde o que for exibir. ## OpenAPI ````yaml /api-reference/openapi.pt-BR.json post /billing/invoices/{invoiceID}/charge openapi: 3.1.0 info: title: Infi API version: 0.0.1 description: > A API REST do Infi: catálogo, clientes, medição de uso, assinaturas, faturas, pagamentos e checkout. **Autenticação.** Envie a chave secreta em `Authorization: Bearer sk_test_…` (sandbox) ou `sk_live_…` (produção). O prefixo da chave decide o ambiente. As rotas de checkout (`/pay/*`) e `/public/*` não levam chave: rodam no navegador de quem paga. **Idempotência.** Toda requisição que altera dados exige o header `Idempotency-Key`. Uma repetição com a mesma chave devolve a resposta original em vez de executar de novo. **Valores.** Dinheiro e quantidades trafegam como texto decimal (`"150.00"`, `"0.0001"`), nunca como número de ponto flutuante. **Erros.** O corpo traz `error_code` (estável, use para decidir), `message` (para pessoas) e `tracer_id` (envie ao suporte). Erros de limite de requisições e de idempotência vêm aninhados em `error`, com `code` e `request_id`. servers: - url: https://api-sandbox.beinfi.com description: Sandbox - url: https://api.beinfi.com description: Produção security: - bearerAuth: [] tags: - name: Catálogo - name: Clientes - name: Medição de uso - name: Assinaturas - name: Faturas - name: Pagamentos - name: Checkout - name: Cupons - name: Cobrança - name: Conta - name: Webhooks - name: Conta de teste - name: Rail - name: Lojas paths: /billing/invoices/{invoiceID}/charge: parameters: - $ref: '#/components/parameters/InvoiceID' post: tags: - Pagamentos summary: Cobrar uma fatura description: > Cria uma cobrança para uma fatura em aberto no meio de pagamento escolhido. A resposta traz o que você precisa para quem vai pagar: o código Pix (`pixPayload`, `pixQrImage`), a página de pagamento (`invoiceUrl`) ou os dados para confirmar o cartão no navegador (`nextAction`). Esses campos só vêm nesta resposta; guarde o que for exibir. operationId: chargeInvoice parameters: - $ref: '#/components/parameters/IdempotencyKey' requestBody: required: true content: application/json: schema: type: object required: - method properties: method: type: string enum: - pix - boleto - card - crypto description: Meio de pagamento da cobrança. responses: '201': content: application/json: schema: $ref: '#/components/schemas/Payment' description: Cobrança criada. '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '409': content: application/json: schema: $ref: '#/components/schemas/Error' description: >- A fatura não está em aberto para pagamento (ainda é rascunho, já foi paga ou foi cancelada). '422': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: >- Os mesmos códigos da cobrança pelo checkout, entre eles `amount_below_minimum` (em reais, uma cobrança abaixo de R$ 5,00 pode ser recusada; o mínimo que vale para esta cobrança vem em `errors[]`, no campo `amount`) e `customer_tax_id_required` (cadastre o CPF ou CNPJ do cliente e tente de novo). components: parameters: InvoiceID: name: invoiceID in: path required: true schema: type: string format: uuid description: ID da fatura. IdempotencyKey: name: Idempotency-Key in: header required: false schema: type: string description: >- Chave única por operação (um UUID serve). Repetir com a mesma chave devolve a resposta original. schemas: Payment: type: object properties: id: type: string format: uuid invoiceId: type: string format: uuid provider: type: string description: Processador por onde a cobrança passou. Em sandbox, `sandbox`. providerId: type: - string - 'null' description: Referência da cobrança no processador, útil para suporte. method: type: string enum: - pix - boleto - card - crypto amount: type: string description: Valor cobrado, em texto decimal. currency: type: string status: type: string enum: - pending - confirmed - failed - refunded - charged_back description: >- `pending` aguarda pagamento; `confirmed` foi pago; `failed` não foi pago (veja `failureCode`); `refunded` foi reembolsado por inteiro; `charged_back` foi contestado pelo comprador no banco. refundedAmount: type: string description: >- Total já reembolsado, em texto decimal. Ausente quando nada foi reembolsado. Um reembolso parcial mantém o `status` em `confirmed`; só o reembolso do valor inteiro muda para `refunded`. Use este campo, e não o `status`, para saber quanto voltou. failureCode: type: - string - 'null' enum: - insufficient_funds - do_not_honor - card_declined - authentication_required - card_expired - card_stolen - card_invalid - mandate_revoked - mandate_refused - brand_changed - provider_error - provider_timeout - superseded - null description: >- Por que a cobrança falhou. `superseded` não é recusa: o comprador trocou de meio de pagamento para pagar a mesma fatura. Nulo quando o pagamento não falhou ou quando o motivo não foi registrado. Novos códigos podem surgir; trate um valor desconhecido como falha genérica. failedAt: type: - string - 'null' format: date-time description: Quando a cobrança passou para `failed`. createdAt: type: string format: date-time payer: type: - object - 'null' properties: id: type: string format: uuid name: type: - string - 'null' email: type: - string - 'null' description: >- Quem pagou. Em fatura avulsa, `id` é o ID do cliente; em fatura de assinatura, é o ID da inscrição do cliente no produto. Vem só em `GET /billing/payments` e `GET /billing/payments/{paymentID}`, e é nulo quando a fatura não identifica o cliente. invoiceUrl: type: string description: >- Página de pagamento hospedada. Vem só na resposta da criação da cobrança. chargeToken: type: string description: >- Token de uso único do widget de pagamento cripto. Vem só na resposta de uma cobrança cripto. network: type: string enum: - main - test description: 'Ambiente do widget cripto desta cobrança: `main` (real) ou `test`.' settlementAsset: type: string enum: - USDC description: Ativo em que a cobrança cripto é liquidada. settlementNetwork: type: string enum: - base - solana description: Rede em que a cobrança cripto é liquidada. pixPayload: type: string description: >- Código Pix copia e cola. Gere o QR a partir dele. Continua disponível nas consultas seguintes do pagamento. pixQrImage: type: string description: >- O QR do Pix em PNG, codificado em base64 (sem o prefixo `data:`), para quem prefere não gerar o QR. providerPixPayload: type: string description: >- Só em sandbox: o código Pix que o processador de teste gerou, para inspeção. Não é pagável. Em sandbox, `pixPayload` traz o link de confirmação de teste. sandboxConfirmUrl: type: string description: >- Só em sandbox: página que marca esta cobrança como paga, sem pagar de verdade. Decida pela presença deste campo, não pelo formato de `pixPayload`. Para exibir, não é preciso: `pixPayload` vira QR nos dois ambientes. pixExpiresAt: type: - string - 'null' format: date-time description: Quando o código Pix expira (só cobranças Pix). clientSecret: type: string description: >- Segredo temporário para confirmar a cobrança de cartão no navegador. Vem só na resposta da criação da cobrança. publishableKey: type: string description: >- Chave pública que acompanha `clientSecret`. Vem só na resposta da criação da cobrança. nextAction: $ref: '#/components/schemas/PaymentNextAction' description: >- Dados para concluir uma cobrança de cartão no navegador. Vem só na resposta da criação da cobrança. switchable: type: boolean description: >- Se esta cobrança ainda pode ser abandonada para pagar a mesma fatura de outro jeito: `true` enquanto está `pending`, `false` depois de paga ou falhada. Vem só na resposta da criação da cobrança; trate ausência como `false`. description: >- Uma tentativa de cobrança contra uma fatura. Uma fatura pode ter vários pagamentos. Error: type: object required: - message - error_code - tracer_id properties: message: type: string description: Frase legível para pessoas. error_code: $ref: '#/components/schemas/ErrorCode' description: Código estável do erro. Use-o para decidir o que fazer. tracer_id: type: string description: Identificador da requisição. Informe-o ao falar com o suporte. description: >- O corpo de erro padrão. É plano (sem o envelope `error`) e o identificador de rastreio é `tracer_id`. ValidationError: type: object required: - message - error_code - tracer_id - errors properties: message: type: string error_code: $ref: '#/components/schemas/ErrorCode' tracer_id: type: string errors: type: array items: type: object required: - field - value - constraint - description properties: field: type: string value: type: string constraint: type: string description: type: string description: >- Detalhe por campo (`field`, `description`). Sempre presente num `422`; pode vir vazio. description: >- Corpo de um `422`. Mesmo formato de `Error`, mais `errors[]` com o detalhe por campo. É ali que está a frase que diz o que corrigir (por exemplo, "product has no published version"). PaymentNextAction: oneOf: - $ref: '#/components/schemas/CardSessionAction' - $ref: '#/components/schemas/CardPaymentAction' discriminator: propertyName: type mapping: adyen_session: $ref: '#/components/schemas/CardSessionAction' stripe_payment_intent: $ref: '#/components/schemas/CardPaymentAction' description: >- Dados temporários para o navegador concluir a cobrança. Decida pelo campo `type`. Use só na mesma sessão; não reaproveite nem aceite esses valores de volta do navegador. NotFoundError: type: object required: - message - error_code - tracer_id - resource properties: message: type: string error_code: $ref: '#/components/schemas/ErrorCode' tracer_id: type: string resource: type: string ErrorCode: type: string examples: - internal_error - validation_failed - bad_request - unauthorized - forbidden - not_found - conflict - rate_limited description: >- Código estável do erro. A lista não é fechada: além dos códigos genéricos, cada área tem os seus (`coupon_expired`, `insufficient_balance`, `version_not_draft`, `idempotency_key_reused`…). Um código que você não conhece deve ser tratado pelo status HTTP, mostrando `message`; não falhe ao ler a resposta. CardSessionAction: type: object additionalProperties: false required: - type - session - clientKey - environment - countryCode - locale - amount properties: type: type: string const: adyen_session session: type: object additionalProperties: false required: - id - sessionData properties: id: type: string sessionData: type: string description: >- Sessão de checkout a abrir no navegador. Não guarde nem registre em log. clientKey: type: string description: Chave pública, segura para o navegador. environment: type: string enum: - live - live-us - live-au - live-nea - live-in description: Ambiente em que o formulário deve ser carregado. countryCode: type: string const: BR locale: type: string const: pt-BR amount: $ref: '#/components/schemas/ClientActionAmount' description: Valor da cobrança. description: Sessão de pagamento para o formulário de cartão no navegador. CardPaymentAction: type: object additionalProperties: false required: - type - clientSecret - publishableKey properties: type: type: string const: stripe_payment_intent clientSecret: type: string description: Segredo temporário para confirmar a cobrança no navegador. publishableKey: type: string description: Chave pública, segura para o navegador. description: Dados para confirmar a cobrança de cartão no navegador. ClientActionAmount: type: object additionalProperties: false required: - value - currency properties: value: type: integer format: int64 minimum: 0 description: Valor na menor unidade da moeda (centavos, no caso do real). currency: type: string example: BRL responses: Unauthorized: content: application/json: schema: $ref: '#/components/schemas/Error' description: Chave ausente ou inválida. NotFound: content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: Recurso não encontrado. securitySchemes: bearerAuth: type: http scheme: bearer description: >- Chave secreta da conta: `Authorization: Bearer sk_test_…` ou `sk_live_…`. Use só no servidor. ````