Skip to main content
O COB cria payloads de pagamento Pix e acompanha o estado das cobranças. Use-o com o provedor simulado fornecido para testes de integração da v1.0.0.

​
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.

​
Criar uma cobrança imediata

  1. Chame Criar cobrança imediata 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 ou Listar cobranças imediatas.
  4. O callback do provedor simulado registra o pagamento somente quando o valor corresponde ao valor da cobrança imediata. Um callback idêntico é um replay seguro; dados de pagamento conflitantes não são.
  5. 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.
  1. Chame Criar cobrança com vencimento. 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 ou encontre-o por meio de Listar cobranças com vencimento.
  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 quando a cobrança não puder mais ser paga.
O callback da cobrança é interno ao plugin. Seu cliente de teste confirma o pagamento lendo o recurso público da cobrança depois do resultado do mock, 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. Ela não estabelece um caminho de provedor de produção nem a integração de mensageria nativa do SPI.