Notificação Cobrança Pix Paga

(collection.paid)

Quando um QrCode for pago, 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

{
        "event": "collection.paid",
        "transaction_id": "QR-abc123def456",
        "client_ref": "PEDIDO-12345",
        "amount": 150.00,
        "qr_code_payload": "00020126580014br.gov.bcb.pix0136a1b2c3d4-e5f6-7890...",
        "status": "paid",
        "beneficiary_name": "Loja Exemplo",
        "beneficiary_document": "12345678901234",
        "paid_at": "2024-01-15T14:30:00.000Z",
        "payer_full_name": "Joao da Silva",
        "payer_tax_id": "98765432100",
        "e2e_id": "E12345678202401151430abc123def456",
        "payer": {
            "participant_ispb": "394116",
            "account_branch": "0001",
            "account_number": "359680",
            "account_type": "TRAN",
            "document_number": "63854969650172",
            "name": "Jane Doe"
        },
        "recipient": {
            "participant_ispb": "18589120",
                "account_branch": "1",
                "account_number": "833135885",
                "account_type": "TRAN",
                "document_number": "33858304892",
                "name": "John Doe"
        },
        "timestamp": "2024-01-15T14:30:05.000Z"
}

Descrição dos Atributos

ATRIBUTO	DESCRIÇÃO	TIPO
event (Obrigatório)	Tipo do evento: collection.paid	STRING limite de 100 caracteres
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
timestamp (Obrigatório)	Data/hora do envio da notificação (ISO 8601)	DATETIME formato datetime YYYY-mm-ddTHH:MM:ss. z