Cobranças PIX

Geração, consulta e comportamento do fluxo após o pagamento

Ver como Markdown

Autenticação exigida

  • autenticação de sessão da camada de pagamentos;
  • credencial de integração da conta;
  • validação da origem operacional autorizada.

Informações essenciais da cobrança

  • valor a ser cobrado;
  • identificação do pagador;
  • referência de correlação do integrador;
  • definição do comportamento operacional do crédito;
  • vínculo com o customer correspondente.

Recomendação operacional

Mesmo quando o contrato técnico admite flexibilidade em alguns dados, trate como prática operacional obrigatória:

  • a identificação do customer para garantir conciliação correta;
  • a definição explícita do comportamento do crédito para evitar ambiguidade operacional.

O que acontece após o pagamento

Depois da confirmação do PIX, a plataforma executa o fluxo funcional:

  1. valida o pagamento recebido;
  2. localiza a cobrança correspondente;
  3. vincula a cobrança ao customer indicado;
  4. atualiza o status da cobrança;
  5. prepara o envio das notificações do fluxo aplicável;
  6. disponibiliza a cobrança atualizada para consulta.

Endpoints auxiliares

  • consulta da lista de cobranças do usuário autenticado;
  • consulta individual de uma cobrança específica.

Dados que devem ser persistidos pelo integrador

  • identificador interno da cobrança;
  • identificador transacional do PIX;
  • vínculo da cobrança com o customer;
  • referência de correlação do integrador, quando utilizada;
  • status atual e timestamps relevantes.

Onde ver os detalhes técnicos

Os formatos de envio, os parâmetros aceitos, os exemplos completos e os modelos de resposta ficam concentrados na área API Reference.