Pagamento por pix

Corpo do Webhook

Campo	Tipo	Descrição
`identifier`	UUID	Identificador da transação
`origin`	String	Origem da transação. Ver tabela de origem para detalhes.
`description`	String	Descrição da transação (Campo aberto para o usuário)
`accountIdentifier`	UUID	Identificador da conta
`type`	Enum	Tipo da transação (RCVD/SENT). Ver tabela de tipo para detalhes.
`transactionDate`	DateTime	Data e hora da transação
`sender`	Object	Dados do remetente
└── `ispb`	String	ISPB do remetente
└── `institution`	String	Instituição do remetente
└── `name`	String	Nome do remetente
└── `documentNumber`	String	Número do documento do remetente
└── `branch`	String	Agência do remetente
└── `number`	String	Número da conta do remetente
└── `type`	Enum	Tipo da conta recebedora. Ver tabela de tipos de conta para detalhes.
`transactionIdentifier`	String	TxId do QR code
`originalEndToEnd`	String	End-to-end de origem da transação em caso de devolução
`recipient`	Object	Dados do recebedor
└── `ispb`	String	ISPB do recebedor
└── `institution`	String	Instituição do recebedor
└── `name`	String	Nome do recebedor
└── `documentNumber`	String	Número do documento do recebedor
└── `branch`	String	Agência da conta recebedora
└── `number`	String	Número da conta recebedora
└── `type`	Enum	Tipo da conta recebedora. Ver tabela de tipos de conta para detalhes.
`endToEnd`	String	End-to-end da transação
`value`	double	Valor da transação
`status`	Enum	Status do pagamento. Ver tabela de estado para detalhes.

Descrição dos estados do pagamento

Status	Descrição
`PAID`	`Pagamento realizado com sucesso`
`SCHEDULED`	`Agendamento solicitado com sucesso`
`PENDING`	`Solicitação do pagamento está pendente`
`CANCELED`	`O pagamento foi cancelado`
`REQUESTED`	`Solicitação do pagamento realizada`
`RETURNED`	`O pagamento foi devolvido em sua totalidade`
`REJECTED`	`Pagamento foi rejeitado`
`ERROR`	`Houve erro na solicitação do pagamento`

Descrição dos tipos do pagamento

Status	Descrição
`RCVD`	`A ordem de pagamento foi recebida pela conta`
`SENT`	`A ordem de pagamento foi enviada pela conta`

Descrição das origens de ordens de pagamento

Status	Descrição
`QR_CODE`	`Ordem de pagamento originada por um QR Code`
`KEY`	`Ordem de pagamento originada por chave`
`BANK_ADDRESS`	`Ordem de pagamento originada por dados bancários`
`REFUND`	`Ordem de pagamento originada por uma devolução`

Exemplo da notificação webhook em JSON:

{
  "identifier": "6db2f724-e022-4fb9-8bf4-44887624029e",
  "origin": "BANK_ADDRESS",
  "description": "description_92cdbae68306",
  "accountIdentifier": "0b00d8dd-edd4-4767-aa56-e32431877585",
  "type": "type_f75af0d7f7fd",
  "transactionDate": "2025-10-28 10:38:02",
  "sender": {
    "ispb": "ispb_4072e5b59b40",
    "institution": "institution_63ca4c9561f1",
    "name": "name_2259a253eb8e",
    "documentNumber": "documentNumber_adc0aa931fe5",
    "branch": "branch_d63430fc3f0d",
    "number": "number_7b2c8c841b1e",
    "type": "CHECKING",
    "key": "key_2f281bbffb56"
  },
  "transactionIdentifier": "transactionIdentifier_62b692cb21ec",
  "originalEndToEnd": "originalEndToEnd_6e91aca2ae1c",
  "recipient": {
    "ispb": "ispb_735444b42ee6",
    "institution": "institution_8a1aba835eac",
    "name": "name_c1dd4845982e",
    "documentNumber": "documentNumber_9d0fae8b6499",
    "branch": "branch_a39f49f8b17c",
    "number": "number_533f092fdeca",
    "type": "CHECKING",
    "key": "key_7361d13900bb"
  },
  "endToEnd": "endToEnd_e0814a1aac70",
  "value": 0.00,
  "status": "PAID"
}

Pagamento por Boleto

Corpo do webhook

Campo	Tipo	Descrição
`identifier`	String	Identificador do boleto hibrido
`accountIdentifier`	String	identificador da conta associada ao boleto hibrido
`chargeType`	String	Tipo de cobrança
`amount`	Number	Valor do boleto hibrido
`ourNumber`	Number	Nosso numero
`status`	Enum	Status do boleto
`amount`	Number	Valor do pagamento do boleto
`amountSettled`	Number	Valor liquidado do pagamento do boleto
`fineAmount`	Number	Valor da multa
`interestAmount`	Number	Valor do juros
`discountAmount`	Number	Valor do desconto
`creationDate`	DateTime	Data da criação do boleto
`notificationDate`	DateTime	Data da notificação do pagamento
`chargedAmount`	Number	Valor da cobrança
`dueDate`	DateTime	Data do final do pagamento
`urlNotification`	String	Url de notificação de pagamento
`payer`	Object	Dados do pagador
└── `name`	String	Nome do pagador
└── `documentNumber`	String	Numero do documento do pagador

Status possíveis

Valor	Descrição
`PAID`	Pago através da rede bancária
`WRITE_OFF`	Não disponível para pagamento
`SETTLED`	Valor liquidado na conta
`CANCELED`	Boleto Cancelado
`OVERDUE`	Boleto Vencido
`OPEN`	Boleto em aberto
`REGISTERED`	Boleto registrado com sucesso

Exemplo json:

{
  "identifier": "1f8e196f-57b2-44c0-8930-cb2943c70968",
  "accountIdentifier": "b9d4b390-9ebb-447a-ac86-5334ce322a1d",
  "chargeType": "chargeType_4cf66b93499c",
  "ourNumber": 0,
  "status": "NEW",
  "amount": 0.00,
  "amountSettled": 0.00,
  "fineAmount": 0.00,
  "interestAmount": 0.00,
  "discountAmount": 0.00,
  "creationDate": "creationDate_7895a7631e5c",
  "notificationDate": "notificationDate_0ed5d3ab6105",
  "chargedAmount": 0.00,
  "dueDate": "dueDate_b0231f734d19",
  "urlNotification": "urlNotification_0aa92dd4e885",
  "payer": {
    "name": "name_458782e2ffc6",
    "documentNumber": "documentNumber_88296f3ebb4f"
  }
}