Criar um BR Code estático
Use Criar BR Code estático 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 ou Listar BR Codes estáticos 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 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. 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
- Chame Criar cobrança imediata com um novo valor de idempotência.
- Salve o identificador da cobrança, o payload do BR Code, a localização e a expiração retornados pela API.
- Leia o recurso por meio de Obter cobrança imediata ou Listar cobranças imediatas.
- 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. - Se a cobrança precisar terminar sem pagamento, use Cancelar cobrança imediata. 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.- Chame Criar cobrança com vencimento. O plugin valida a chave Pix antes de criar a cobrança.
- Salve o identificador e o payload de pagamento. Leia-o com Obter cobrança com vencimento ou encontre-o por meio de Listar cobranças com vencimento.
- 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.
- Cancele por meio de Cancelar cobrança com vencimento quando a cobrança não puder mais ser paga.