| Term | Definition |
|---|---|
| Access token | Short-lived credential, issued from the API key and presented in authenticated requests. |
| Account | The payee’s registration on the platform, holder of the API key, the balance and the transactions. |
| Acquirer | Institution responsible for the capture, processing and settlement of card transactions. |
| API key | Credential composed of a public identifier and a secret, used to issue the access token. |
| Boleto | Brazilian payment slip, payable across the banking network. |
| BR Code | Brazilian QR Code standard for payment initiation. |
| Charge | Payment request created by the integrator, which gives rise to a transaction. |
| Chargeback | Reversal of a payment as a result of an upheld dispute. |
| CNPJ | Brazilian taxpayer registration number for legal entities. |
| CPF | Brazilian taxpayer registration number for individuals. |
| Digitable line | Numeric representation of the barcode of a boleto. |
endToEndId | End-to-end identifier of a Pix payment in the Instant Payment System. |
| Idempotency key | Identifier provided by the integrator so that repeating a request does not produce a duplicate effect. |
| Infraction | Record, in the Pix scheme, of a dispute relating to a transaction. |
| Integrator | Party responsible for the system that consumes the API. |
| Issuer | Institution that issues the card and maintains the relationship with the cardholder. |
| MED | Special Return Mechanism (Mecanismo Especial de Devolução), the Pix scheme procedure for returning amounts in cases of fraud or operational failure. |
| Notification | HTTP request sent by the platform to the integrator to communicate an event. |
| Payee | Holder of the account to which the amounts of the transactions are credited. |
| Payer | Individual or legal entity that makes the payment. |
| Pix | Instant payment scheme established by the Central Bank of Brazil. |
| Plan | Configuration of amount and billing interval that governs a subscription. |
| Precautionary block | Holding of an amount in the account balance as a result of an infraction under analysis. |
| Refund | Return in full of a paid transaction to the payer. |
| Reserve | Portion of the amount of a transaction held for a set period before release to the available balance. |
| Status | State of a transaction, infraction, subscription or transfer at a given time, reported in the status field. |
| Subscription | Recurring billing arrangement on credit card, with renewal performed by the platform. |
| Tokenization | Replacement of card data by a token of restricted use. |
| Transaction | Record of a payment, created from a charge. |
| Transfer | Movement of the available balance of the account to the payee. |
| Webhook | Notification endpoint registered by the integrator. |
Compliance
Glossary
Definitions of the terms used in this documentation.