Skip to main content

Eventos Disponíveis

Os webhooks podem ser configurados para notificar sobre os seguintes eventos:

pix-payment-in​

Notificação enviada quando cobrança pix emitida é paga.

Exemplo de Payload:

{
  "event": "pix-payment-in",
  "status": "CONFIRMED",
  "amount": 150.0,
  "transactionIdentification": "TXN123456789",
  "endToEndId": "E18236120202301041234567890AB123",
  "initiationType": "STATIC_QRCODE", // STATIC_QRCODE, DYNAMIC_QRCODE
  "description": "Pagamento recebido via PIX",
  "currentBalance": 5150.0,
  "oldBalance": 5000.0,
  "fee": 0.0,
  "debitParty": {
    "name": "João da Silva",
    "bank": "42403842",
    "bankName": "Banco 1",
    "documentNumber": "***.456.789-**"
  },
  "creditParty": {
    "name": "Empresa XYZ Ltda",
    "bank": "42403842",
    "bankName": "Banco 2",
    "documentNumber": "12.345.678/0001-90"
  }
}

pix-payment-out​

Notificação enviada quando um pagamento PIX é enviado/realizado da conta.

Exemplo de Payload:

{
  "event": "pix-payment-out",
  "status": "CONFIRMED",
  "amount": 250.0,
  "transactionIdentification": "TXN987654321",
  "endToEndId": "E18236120202301041234567890CD456",
  "initiationType": "DICT", // DICT, MANUAL, STATIC_QRCODE, DYNAMIC_QRCODE
  "description": "Pagamento para fornecedor",
  "currentBalance": 4750.0,
  "oldBalance": 5000.0,
  "fee": 0.0,
  "debitParty": {
    "name": "Empresa XYZ Ltda",
    "bank": "48274912",
    "bankName": "Banco 3",
    "documentNumber": "12.345.678/0001-90"
  },
  "creditParty": {
    "name": "Maria dos Santos",
    "bank": "42403842",
    "bankName": "Banco 1",
    "documentNumber": "***.456.789-**"
  }
}