> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt
> Use this file to discover all available pages before exploring further.

# Usar o COB com o Pix Lerian

> Crie BR Codes estáticos e cobranças Pix imediatas ou com vencimento com o Pix Lerian.

O COB cria payloads de pagamento Pix e acompanha o estado das cobranças.

## Criar um BR Code estático

Use [Criar BR Code estático](https://docs.lerian.studio/pt/reference/interfaces/pix-lerian/cob/create-static-brcode.md) quando precisar de um BR Code reutilizável. O recurso retornado contém o payload de pagamento codificado. Guarde seu identificador e use [Obter BR Code estático](https://docs.lerian.studio/pt/reference/interfaces/pix-lerian/cob/get-static-brcode.md) ou [Listar BR Codes estáticos](https://docs.lerian.studio/pt/reference/interfaces/pix-lerian/cob/list-static-brcodes.md) para recuperá-lo depois.

Um BR Code estático não é um registro de liquidação. Use uma cobrança quando precisar acompanhar o ciclo de vida da cobrança.

## Decodificar um QR Code

[Decodificar QR Code](https://docs.lerian.studio/pt/reference/interfaces/pix-lerian/cob/decode-qrcode.md) lê um payload EMV. Em uma cobrança imediata, `amountChangeAllowed` é `true` quando o recebedor permite que o pagador altere o valor: o valor é então só uma sugestão. `hasRecurrence` é `true` quando o QR Code também oferece uma recorrência do Pix Automático, e `recurrenceLocation` traz a localização dela. Um QR Code só de recorrência é decodificado como `STATIC`, sem chave e sem valor, e não pode ser pago. Para autorizar a recorrência, envie o mesmo payload para [Criar solicitação de autorização a partir de QR code](https://docs.lerian.studio/pt/reference/interfaces/pix-lerian/pix-automatico/create-authorization-request-from-qr-code.md). O campo opcional `paymentDate` precifica uma cobrança com vencimento para aquele dia, e `budgetMs` limita o tempo que a leitura do recebedor pode levar.

## Criar uma cobrança imediata

1. Chame [Criar cobrança imediata](https://docs.lerian.studio/pt/reference/interfaces/pix-lerian/cob/create-immediate-collection.md) com um novo valor de idempotência.
2. Salve o identificador da cobrança, o payload do BR Code, a localização e a expiração retornados pela API.
3. Leia o recurso por meio de [Obter cobrança imediata](https://docs.lerian.studio/pt/reference/interfaces/pix-lerian/cob/get-immediate-collection.md) ou [Listar cobranças imediatas](https://docs.lerian.studio/pt/reference/interfaces/pix-lerian/cob/list-immediate-collections.md).
4. Com `MOCK_TEST_ENDPOINTS_ENABLED=true`, o provedor simulado pode simular um pagamento. O callback dele registra o pagamento somente quando o valor corresponde ao valor da cobrança imediata. Um callback idêntico é um replay seguro. Um callback com dados de pagamento conflitantes não é um replay seguro.
5. Se a cobrança precisar terminar sem pagamento, use [Cancelar cobrança imediata](https://docs.lerian.studio/pt/reference/interfaces/pix-lerian/cob/cancel-immediate-collection.md). Cancelar uma cobrança já cancelada retorna o resultado terminal existente.

## Criar uma cobrança com vencimento

Uma cobrança com vencimento exige o calendário de vencimento e os dados do devedor. Ela também pode conter modificadores de valor, como multa, juros, abatimento ou desconto.

1. Chame [Criar cobrança com vencimento](https://docs.lerian.studio/pt/reference/interfaces/pix-lerian/cob/create-due-date-collection.md). O plugin valida a chave Pix antes de criar a cobrança.
2. Salve o identificador e o payload de pagamento. Leia-o com [Obter cobrança com vencimento](https://docs.lerian.studio/pt/reference/interfaces/pix-lerian/cob/get-due-date-collection.md) ou encontre-o por meio de [Listar cobranças com vencimento](https://docs.lerian.studio/pt/reference/interfaces/pix-lerian/cob/list-due-date-collections.md).
3. Aplique somente o contrato documentado de revisão da cobrança com vencimento quando um modificador de valor permitido precisar mudar. Ele usa JSON Merge Patch. Não envie um corpo de substituição completa por padrão.
4. Cancele por meio de [Cancelar cobrança com vencimento](https://docs.lerian.studio/pt/reference/interfaces/pix-lerian/cob/cancel-due-date-collection.md) quando a cobrança não puder mais ser paga.

O callback da cobrança é interno ao plugin. Seu cliente confirma o pagamento lendo o recurso público da cobrança, não enviando um callback de pagamento.

## Evitar suposições não compatíveis

Esta página cobre BR Codes estáticos e cobranças. Para pagamentos agendados, consulte as operações de pagamentos agendados na referência da API SPI.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.