Campos dos Webhooks

Nesta página, você verá os detalhes dos campos enviados em nossos Webhooks d

Os webhooks são enviados sempre que ocorre uma atualização em pedidos (ORDER), assinaturas (SUBSCRIPTION) ou transações físicas/pos (PHYSICAL_ORDER). Cada evento contém um conjunto de campos padronizados, que variam conforme o tipo de domínio e o status da transação.

---

Campos Comuns

Campo	Tipo	Descrição
uuid	string	Identificador único do pedido (ORDER), assinatura (SUBSCRIPTION) ou cobrança física (PHYSICAL_ORDER).
dateTime	string	Data e hora da ocorrência no formato ISO 8601 — YYYY-MM-DDTHH:MM:SS.
status	string	Status atual da cobrança ou assinatura. Veja Status possíveis.
domain	string	Tipo de evento: • ORDER → Cobrança pontual • SUBSCRIPTION → Assinatura recorrente • PHYSICAL_ORDER → Cobrança de maquininha
uuidBuyer	string	Identificador único do comprador. Pode ser usado para buscar mais detalhes via API /v2/buyers/{uuid}.
documentBuyer	string	CPF ou CNPJ do comprador.
emailBuyer	string	E-mail do comprador.
address	object	Objeto com os dados de endereço do comprador: country, state, city, district, street, zipCode, number, complement.
metadata	array	Lista de pares { key, value } contendo informações adicionais enviadas durante a criação da cobrança.
cnpjSeller	string	CNPJ do vendedor responsável pela transação.
idSeller	integer	Identificador interno do vendedor.
authorizationCode	string	Código de autorização da transação (quando aplicável).
authorizationNsu	string	NSU (Número Sequencial Único) da transação (quando aplicável).
cards	array	Lista de cartões associados à cobrança (quando disponível).
refunds	array	Lista de estornos associados à cobrança.

💡 Dica: O campo uuid pode ser utilizado nas rotas:

• GET /v2/subscriptions/{uuid} → Para consultar detalhes e cobranças da assinatura

• GET /v2/orders/{uuid} → Para consultar detalhes e cobranças de uma cobrança pontual

---

Campos Exclusivos de PHYSICAL_ORDER

Campo	Tipo	Descrição
amount	number	Valor total pago.
installments	integer	Quantidade de parcelas escolhidas.
first4_digits	string	Primeiros 4 dígitos do cartão.
last4_digits	string	Últimos 4 dígitos do cartão.
holderName	string	Nome do titular do cartão.
brand	string	Bandeira do cartão (ex: Visa, Elo, Mastercard).
authorization_code	string	Código de autorização da operadora.
authorization_nsu	string	NSU (Número Sequencial Único) da transação.
pos_id	string	Identificador do terminal (POS).
cnpj	string	CNPJ da empresa portadora da maquininha.
company_name	string	Nome da empresa portadora da maquininha.
serial_number	string	Número de série do terminal POS.
payment_type	string	Tipo de pagamento (ex: credit, debit).
rate	number	Taxa aplicada à transação.

---

Status Possíveis

🔸 Pedidos (ORDER/PHYSICAL_ORDER)

Status	Descrição
SENT	Pedido criado.
PAID	Pagamento confirmado.
PARTIALLY_PAID	Pagamento parcial recebido.
LATE	Pagamento atrasado.
ABANDONED	Pedido abandonado (ex: atraso superior a 90 dias).
CANCELED	Pedido cancelado.
REFUND	Pedido estornado.
CHARGEBACK	Pedido com chargeback.
PRE_AUTHORIZED	Pedido pré-autorizado.
DISPUTE	Pedido entrou em disputa.
DISPUTE_ALERT	Alerta de disputa recebido.

---

🔹 Assinaturas (SUBSCRIPTION)

Status	Descrição
PENDING	Assinatura criada, aguardando confirmação de pagamento.
ACTIVE	Assinatura ativa.
DEFAULTER	Assinatura inadimplente.
INACTIVE	Assinatura encerrada.

---

O campo address está presente em todos os domínios (ORDER, SUBSCRIPTION, PHYSICAL_ORDER) e segue o formato abaixo:

"address": {
  "country": "BR",
  "state": "SP",
  "city": "São Paulo",
  "district": "Pinheiros",
  "street": "Rua dos Pinheiros",
  "zipCode": "05422-001",
  "number": "850",
  "complement": "Sala 12"
}