public + secret
Credencial de longo prazo da sua empresa, gerada no painel. Usada para obter o token de acesso. Veja Autenticação.
JWT
Credencial de curta duração obtida no login, enviada no header
Authorization de cada chamada /v1/*.integer
Valor monetário em centavos.
10000 = R$ 100,00.string
O código “copia e cola” do PIX. O cliente cola no app do banco para pagar. Retornado no campo
pix.emv.string (base64)
Imagem PNG (em base64) que representa o BR Code, pronta para exibir. Retornada em
pix.qrCode.string
Identificador único de um pagamento PIX na rede do Banco Central. Aparece no payload do webhook quando o PIX é pago.
object
Dados de quem efetuou o pagamento PIX (nome, documento), retornados no webhook após a confirmação.
string
Token opaco que representa um cartão, gerado em
POST /v1/card-token. Usado na cobrança no lugar dos dados do cartão.PIX
cob é a cobrança PIX imediata; cobv é a cobrança PIX com vencimento (com multa, juros e desconto).integer
Taxa da transação, em centavos.
integer
Valor líquido que entra para a sua empresa após as taxas, em centavos.
string (URL)
URL informada no corpo de uma cobrança para receber os webhooks somente daquela transação.
string
Segredo de um webhook usado para calcular e validar a assinatura HMAC dos eventos.
conceito
Garantia de processar cada evento uma única vez. Use o
id da entrega do webhook para deduplicar.conceito
Mecanismo Especial de Devolução do PIX. Uma infração pode resultar na devolução do valor ao pagador. Notificada pelo evento
infraction.conceito
Contestação de uma cobrança no cartão pelo titular, que pode resultar em estorno.