Pular para o conteúdo principal

Notificação Cobrança Pix Devolvida

(collection.reversed)

Quando um QrCode for devolvido, 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",
"status": "reversed"
}
]
}

Descrição dos Atributos

ATRIBUTODESCRIÇÃOTIPO
transaction_id
(Obrigatório)
Código de referência únicoSTRING
limite de 100 caracteres
client_ref
(Opcional)
Referência externa informada na criaçãoSTRING
limite de 100 caracteres
amount
(Obrigatório)
Valor da cobrança, em reaisDECIMAL
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. Nesta notificação será reversed (devolução concluída) ou failed (a devolução falhou)ENUM
reversed (Pagamento devolvido)
failed (Devolução falhou)
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 qrcodeSTRING
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 pagadorSTRING
limite de 255 caracteres
payer.account_branch
(Obrigatório)
Número da agência do banco do pagadorSTRING
limite de 255 caracteres
payer.account_number
(Obrigatório)
Número da conta bancária do pagadorSTRING
limite de 255 caracteres
payer.account_type
(Obrigatório)
Tipo de conta bancária do pagadorSTRING
limite de 255 caracteres
payer.document_number
(Obrigatório)
Documento (CPF/CNPJ) do pagadorSTRING
limite de 255 caracteres
payer.name
(Obrigatório)
Nome do pagadorSTRING
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 recebedorSTRING
limite de 255 caracteres
recipient.account_branch
(Obrigatório)
Número da agência do banco do recebedorSTRING
limite de 255 caracteres
recipient.account_number
(Obrigatório)
Número da conta bancária do recebedorSTRING
limite de 255 caracteres
recipient.account_type
(Obrigatório)
Tipo de conta bancária do recebedorSTRING
limite de 255 caracteres
recipient.document_number
(Obrigatório)
Documento (CPF/CNPJ) do recebedorSTRING
limite de 255 caracteres
recipient.name
(Obrigatório)
Nome do recebedorSTRING
limite de 255 caracteres
event
(Obrigatório)
Tipo do evento: collection.reversedSTRING
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)
Lista de devoluções realizadas.LIST
refunds.amount
(Obrigatório)
Valor da devolução, em reaisDECIMAL
Maior que zero
refunds.e2e_id
(Obrigatório)
ID End-to-End do BACEN, da devoluçãoSTRING
limite de 255 caracteres
refunds.transaction_id
(Obrigatório)
Código de referência único da devoluçãoSTRING
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
refunds.status
(Obrigatório)
Status da devoluçãoENUM
pending (Devolução solicitada)
reversed (Devolução concluída)
error (Devolução falhou)
informação

Campos dos objetos payer e recipient que não tenham valor são omitidos do JSON (a chave não é enviada). Trate todos os campos internos desses objetos como opcionais.