Nós podemos enviar notificações via webhook para seu ambiente sempre que sua conta receber um pagamento, ou houver atualizações no status de pagamentos enviados.
Para receber essas notificações a cada atualização dos pagamentos é necessário informar a sua url de notificação para configuração. Assim sempre que houver um recebimento ou alteração no status de uma ordem de pagamento enviada, iremos enviar notificações para a URL de destino (método POST).
Corpo do requisição
Campo | Tipo | Descrição |
---|---|---|
identifier | UUID | Identificador da transação |
accountIdentifier | UUID | Identificador da conta |
qrCodeReference | String | TxId do QR code |
status | Enum | Status do pagamento. Ver tabela de estado para detalhes. |
type | Enum | Tipo da transação (RCVD/SENT). Ver tabela de tipo para detalhes. |
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. |
description | String | Descrição da transação (Campo aberto para o usuário) |
value | double | Valor da transação |
transactionDate | DateTime | Data e hora da transação |
origin | String | Origem da transação. Ver tabela de orgem para detalhes. |
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. |
endToEnd | String | End-to-end da transação |
endToEndOrigin | String | End-to-end de origem da transação em caso de devolução |
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 |