Overview

Webhooks

Nossa API envia webhooks para informar mudanças importantes nos pagamentos via PIX. Abaixo estão os eventos atualmente disponíveis.


Eventos disponíveis

EventoDescrição
PIX_PAYMENT_AWAITING_FEE_CONFIRMATIONO pagamento foi recebido, mas está aguardando confirmação de taxa.
PIX_PAYMENT_PAIDO pagamento foi confirmado com sucesso.

Exemplo padrão de Payload

{
  "event": "string",
  "createdAt": 1747133592363,
  "data": {
    any
  }
}
json

Evento: PIX_PAYMENT_AWAITING_FEE_CONFIRMATION

{
  "event": "PIX_PAYMENT_AWAITING_FEE_CONFIRMATION",
  "createdAt": 1747133592363,
  "data": {
    "id": "1a919bb7-2d37-4336-bb89-951e24b0a401",
    "paymentId": "xIHGJcwfmZl8qWMj1UB",
    "externalId": null,
    "status": "AWAITING_FEE_CONFIRMATION",
    "amount": 3,
    "netAmount": 1,
    "createdAt": "2025-05-13T10:51:48.547Z",
    "updatedAt": "2025-05-13T10:53:12.211Z"
  }
}
json

Evento: PIX_PAYMENT_PAID

{
  "event": "PIX_PAYMENT_AWAITING_FEE_CONFIRMATION",
  "createdAt": 1747133592363,
  "data": {
    "id": "1a919bb7-2d37-4336-bb89-951e24b0a401",
    "paymentId": "xIHGJcwfmZl8qWMj1UB",
    "externalId": null,
    "status": "PIX_PAYMENT_PAID",
    "amount": 3,
    "netAmount": 1,
    "createdAt": "2025-05-13T10:51:48.547Z",
    "updatedAt": "2025-05-13T10:53:12.211Z"
  }
}
json