Skip to main content

Glossary

This page is intended to align the understanding of terms related to the Pix API.


location​

A location is a URL of the capability URL type that serves as address for a charge. In other words, it is through a location that it is possible to retrieve information related to a charge and, thus, carry out the transactions.

payload​

Payload is the name given to the second fragment of the JWS object(JSON Web Signature) that contains a JSON with data related to a charge.

revisão​

The "revisao" field records the number of changes to a charge. A new charge always starts with revision value of 0 (zero),and this value is incremented one unit whenever the charge changes, except when the change is the Location.

txid​

Each Pix transaction has a Transaction Identifier, called txid, which in the context of representing a charge, is unique per CPF/CNPJ of the receiving user. A txid is an alphanumeric string with a minimum length of 26 and a maximum of 35 characters. A valid txid therefore, must obey the following regular expression (regex): ^[a-zA-Z0-9]{26,35}$. You can to validate txid strings under the regex here.

webhook​

Name of the functionality in which it is possible to register a callback URL to receive notifications about updates of transactions involving a certain Dict key.

Illustration of how cobv charges work after the due date​

dueDate: 2020-10-20, Tuesday.
validityAfterDue: 4

Attempt to pay on 2020-10-20, Tuesday: accepted. (#)(*)
Attempt to pay on 2020-10-21, Wednesday: accepted. (1)
Attempt to pay on 2020-10-22, Thursday: accepted. (2)
Attempt to pay on 2020-10-23, Friday: accepted. (3)
Attempt to pay on 2020-10-24, Saturday: accepted.
Attempt to pay on 2020-10-25, Sunday: accepted. (Holiday)
Attempt to pay on 2020-10-26, Monday: accepted. (4)
Attempt to pay on 2020-10-27, Tuesday: denied.

Last updated on