Notificação Cobrança Pix Devolvida
(collection.reversed)
Quando um QrCode for revolvido, o sistema enviará uma notificação para o endereço fornecido pelo cliente, informando atualização de status do mesmo.
A URL que receberá as notificações deverá ser informada através do endpoint Cadastrar/Alterar Webhook
A notificação será enviada utilizando o método POST, e espera uma resposta do tipo HTTP 200.
Segue estrutura do JSON enviado como request body:
Request Body
{
"transaction_id": "QR14683160Oa32YyLM10mnkf5yiI1Y",
"client_ref": "Devolucao-1",
"amount": "0.1",
"qr_code_payload": "00026790014br.gov.bcb.pix2557qrcode.bank.com.br/cob/802BR5923MONEYGUARD6005NATAL620C13",
"status": "reversed”,
"beneficiary_name": null,
"beneficiary_document": null,
"paid_at": "2026-02-09T06:04:35.000-03:00",
"payer_full_name": “Jhon Doe”,
"payer_tax_id": “000000000”,
"e2e_id": "E18236120202602090904s0182b58c99”,
"payer": {
"participant_ispb": "18236120",
"account_branch": "1",
"account_number": "61672835",
"account_type": "TRAN",
"document_number": “000000000”,
"name": “Jhon Doe”
},
"recipient": {
"participant_ispb": "53822116",
"account_branch": "1",
"account_number": "33480",
"account_type": "TRAN",
"document_number": "62894998000172",
"name": "Moneyguard"
},
"event": "collection.reversed",
"timestamp": "2026-02-09T06:53:49.531-03:00",
"refunds": [
{
"amount": "0.1",
"e2e_id": "D53822116202602090953eLC3yVOZ13G",
"transaction_id": "f311a611-e2c8-47a5-b1b9-0a167485a8b1",
"refund_date": "2026-02-09T06:53:49.000-03:00"
}
]
}
Descrição dos Atributos
| ATRIBUTO | DESCRIÇÃO | TIPO |
|---|---|---|
| transaction_id (Obrigatório) | Código de referência único | STRING limite de 100 caracteres |
| client_ref (Opcional) | Referência externa informada na criação | STRING limite de 100 caracteres |
| amount (Obrigatório) | Valor da cobrança, em reais | DECIMAL Maior que zero |
| qr_code_payload (Obrigatório) | Conteúdo do QrCode. (Código copia e cola PIX) | STRING limite de 255 caracteres |
| status (Obrigatório) | Status da cobrança | ENUM pending (Cobrança criada, aguardando geração do QR Code) awaiting_payment (QR Code gerado, aguardando pagamento) paid (Pagamento recebido com sucesso) expired(Cobrança expirada) canceled(Corança cancelada) reversed (Pagamento devolvido) |
| beneficiary_name (Opcional) | Nome do gerador do qrcode. | STRING limite de 100 caracteres |
| beneficiary_document (Opcional) | CPF (11 dígitos) ou CNPJ (14 dígitos) do gerador do qrcode | STRING limite de 14 caracteres |
| paid_at (Opcional) | Data de pagamento da cobrança (quando pago) | STRING formato datetime YYYY-mm-ddTHH:MM:ss. z |
| payer_full_name (Opcional) | Documento do pagador (quando pago) | STRING limite de 100 caracteres |
| payer_tax_id (Opcional) | Documento do pagador (quando pago) | STRING limite de 100 caracteres |
| e2e_id (Opcional) | ID End-to-End do BACEN (quando pago) | STRING limite de 32 caracteres |
| payer (Obrigatório) | Objeto de dados do pagador da transferência. | OBJECT |
| payer.participant_ispb (Obrigatório) | Código do banco do pagador | STRING limite de 255 caracteres |
| payer.account_branch (Obrigatório) | Número da agência do banco do pagador | STRING limite de 255 caracteres |
| payer.account_number (Obrigatório) | Número da conta bancária do pagador | STRING limite de 255 caracteres |
| payer.account_type (Obrigatório) | Tipo de conta bancária do pagador | STRING limite de 255 caracteres |
| payer.document_number (Obrigatório) | Documento (CPM/CNPJ) do pagador | STRING limite de 255 caracteres |
| payer.name (Obrigatório) | Nome do pagador | STRING limite de 255 caracteres |
| recipient (Obrigatório) | Objeto de dados de quem recebeu a transferência. | OBJECT |
| recipient.participant_ispb (Obrigatório) | Código do banco do recebedor | STRING limite de 255 caracteres |
| recipient.account_branch (Obrigatório) | Número da agência do banco do recebedor | STRING limite de 255 caracteres |
| recipient.account_number (Obrigatório) | Número da conta bancária do recebedor | STRING limite de 255 caracteres |
| recipient.account_type (Obrigatório) | Tipo de conta bancária do recebedor | STRING limite de 255 caracteres |
| recipient.document_number (Obrigatório) | Documento (CPM/CNPJ) do recebedor | STRING limite de 255 caracteres |
| recipient.name (Obrigatório) | Nome do recebedor | STRING limite de 255 caracteres |
| event (Obrigatório) | Tipo do evento: collection.reversed | STRING limite de 100 caracteres |
| timestamp (Obrigatório) | Data/hora do envio da notificação (ISO 8601) | DATETIME formato datetime YYYY-mm-ddTHH:MM:ss. z |
| refunds (Obrigatório) | Objeto de dados da devolução. | OBJECT |
| refunds.amount (Obrigatório) | Valor da devoluçào | STRING limite de 255 caracteres |
| refunds.e2e_id (Obrigatório) | ID End-to-End do BACEN, da devolução | STRING limite de 255 caracteres |
| refunds.transaction_id (Obrigatório) | Código de referência único da mdevolução | STRING limite de 255 caracteres |
| refunds.refund_date (Obrigatório) | Data/hora da devolução (ISO 8601) | DATETIME formato datetime YYYY-mm-ddTHH:MM:ss. z |