| Termo | O que representa |
|---|
| Partner | A sua conta de software house — quem integra. Dona do token. |
| Merchant | O lojista (estabelecimento). Agrupa terminais e é o recorte de cobrança. |
| Terminal | A maquininha Smart POS, vinculada a um lojista. |
| Transaction | Uma operação de pagamento: uma venda ou um estorno. |
| Webhook | Uma notificação automática que enviamos ao seu sistema quando algo muda. |
| Campo | O que representa |
|---|
transaction_id | Identificador único da transação no nosso sistema. |
kind | Natureza da transação: sale (venda) ou refund (estorno). Definido por nós. |
method | Meio de pagamento: credit, debit, pix ou voucher. |
amount | Valor em centavos. 15000 é R$ 150,00. |
installments | Número de parcelas. 1 é à vista. |
installment_mode | Quem paga o juro do parcelado. Veja a tabela abaixo. |
reference | O seu identificador da venda (ex. número da nota). Volta no retorno e nos webhooks. |
description | Texto livre para você identificar a cobrança. |
auto_print | Se true, a maquininha imprime a via do cliente ao aprovar. |
status | Estado atual da transação. Veja a página Status da transação. |
message | Mensagem legível, em português, sobre o resultado. |
Preenchidos quando a transação conclui:
| Campo | O que representa |
|---|
nsu | Número Sequencial Único da transação na adquirente. |
authorization_code | Código de autorização emitido pelo banco/emissor do cartão. |
brand | Bandeira do cartão (ex. MASTERCARD). |
cardholder_name | Nome do portador, quando disponível. |
authorized_at | Data e hora da autorização. |
| Valor | Significado |
|---|
credit | Crédito. |
debit | Débito. |
pix | Pix. |
voucher | Vale/benefício (ex. refeição). |
| Valor | Significado |
|---|
none | À vista (uma parcela). |
merchant | Parcelado com o juro absorvido pela loja. |
cardholder | Parcelado com o juro pago pelo cliente. |
| Termo | O que representa |
|---|
token | Credencial de autenticação enviada no header Authorization. |
merchant_key | Chave do lojista, usada para vincular terminais e transações a ele. |
activation_key | Código curto que o operador digita no app para ativar uma maquininha. |
terminal_id | Identificador de um terminal. |
Idempotency-Key | Chave que você envia para evitar que um reenvio crie uma cobrança duplicada. |
