Skip to main content

​
Webhooks

Se o pagamento for criado com webhookUrl, a API envia webhooks:
  • payment.created: enviado após criação do pagamento.
  • payment.status_changed: enviado em transições de status do pagamento.

​
Payload de Webhook

Campos enviados em ambos os eventos:
CampoTipoDescrição
idstringID do pagamento
statusstringStatus atual do pagamento
amountnumberValor do pagamento (BRL)
storeIdstringID da loja
createdAtstringISO datetime de criação
webhookUrlstring?URL configurada para o webhook (se houver)
observationstring?Observação do pagamento
emailstringE‑mail associado ao pagamento
qrCodeUrlstring?URL do QR Code
qrCopyPastestring?Conteúdo do QR Copia e Cola
Campo adicional em payment.status_changed:
CampoTipoDescrição
previousStatusstringStatus anterior do pago
Exemplo payment.created: 
{
  "event": "payment.created",
  "id": "pay_123",
  "status": "pending",
  "amount": 150.0,
  "storeId": "store_abc",
  "createdAt": "2025-12-16T15:00:00.000Z",
  "webhookUrl": "https://example.com/webhook",
  "observation": "Pedido #9876",
  "email": "cliente@example.com",
  "qrCodeUrl": "https://.../qrcode.png",
  "qrCopyPaste": "000201010212..."
}
Exemplo payment.status_changed: 
{
  "event": "payment.status_changed",
  "id": "pay_123",
  "status": "approved",
  "previousStatus": "pending",
  "amount": 150.0,
  "storeId": "store_abc",
  "createdAt": "2025-12-16T15:00:00.000Z",
  "webhookUrl": "https://example.com/webhook",
  "observation": "Pedido #9876",
  "email": "cliente@example.com",
  "qrCodeUrl": "https://.../qrcode.png",
  "qrCopyPaste": "000201010212..."
}