Pular para o conteúdo principal

Glossário

Esta página tem o objetivo de alinhar a compreensão de termos relacionados à API Pix.


location

Um location é a URL do tipo URL de capacidade que serve de endereço para uma cobrança. Em outras palavras, é através de um location que se torna possível resgatar as informações relacionadas a uma cobrança e, assim, realizar as movimentações.

payload

Payload é o nome dado ao segundo fragmento do objeto JWS (JSON Web Signature) que contém um JSON com os dados referentes a uma cobrança.

revisão

O campo "revisao" registra o número de alterações de uma cobrança. Uma cobrança nova sempre inicia com valor de revisão 0 (zero) e esse valor é incrementado uma unidade sempre que a cobrança sofrer alterações, exceto quando a alteração é o Location.

txid

Cada transação Pix possui um Identificador da Transação, chamado txid, que no contexto de representação de uma cobrança, é único por CPF/CNPJ da pessoa usuária recebedora.. Um txid é uma string alfanumérica com comprimentos mínimo de 26 e máximo de 35 caracteres. Um txid válido, portanto, deve obedecer à seguinte expressão regular (regex): ^[a-zA-Z0-9]{26,35}$. Você pode validar strings txid sob a regex aqui.

webhook

Nome da funcionalidade em que é possível cadastrar uma URL de callback para receber notificações sobre atualizações de transações que envolvem uma determinada chave do Dict.

Ilustração do funcionamento das cobranças cobv após a data de vencimento

dataDeVencimento: 2020-10-20, terça-feira.
validadeAposVencimento: 4

Tenta-se pagar no dia 2020-10-20, terça: aceito. (#)(*)
Tenta-se pagar no dia 2020-10-21, quarta: aceito. (1)
Tenta-se pagar no dia 2020-10-22, quinta: aceito. (2)
Tenta-se pagar no dia 2020-10-23, sexta: aceito. (3)
Tenta-se pagar no dia 2020-10-24, sábado: aceito.
Tenta-se pagar no dia 2020-10-25, domingo: aceito. (Feriado)
Tenta-se pagar no dia 2020-10-26, segunda: aceito. (4)
Tenta-se pagar no dia 2020-10-27, terça: negado.