Pix recebido Webhook

📘
Para saber mais sobre webhooks em nossa API, siga o link abaixo:
Sobre Webhooks

Quando um Pix é creditado na sua conta, a melhor forma de receber essa informação é usando o webhook PIX_RECEIVED. Assim que a transação é concluída o webhook PIX_RECEIVED é enviado.

Aqui está a maneira mais simples de configurar um webhook PIX_RECEIVED:

Headers

Name	Description
x-delbank-api-key	Required. API key

Body

{
  "eventType": "PIX_PAYMENT_UPDATED",
  "url": "https://example.com.br/webhooks/v1/pixreceived", // Adicione seu próprio URL aqui
  "authorization": "NONE,
  "authorizationScheme": "NONE"
}

Assim que um Pix for creditado em sua conta, veja o que você receberá no URL registrado:

{
    "eventType": "PIX_RECEIVED",
    "correlationId": "S110211111111111111111111",
    "referenceId": "E182361202024041911111111111111",
    "endToEndId": "E182361202024041911111111111111",
    "amount": 100.0,
    "createdAt": "2024-04-19T16:20:22.274Z",
    "proof": {
        "eventType": "PIX_PAYMENT_EFFECTIVE",
        "endToEndId": "E182361202024041911111111111111",
        "idempotencyKey": "E182361202024041911111111111111",
        "correlationId": "S110211111111111111111111",
        "status": "PIX_EFFECTIVE",
        "amount": 100.0,
        "payer": {
            "number": "49041111116",
            "branch": "0001",
            "type": "PAYMENT",
            "participant": {
                "name": "NU PAGAMENTOS - IP",
                "ispb": "18236120"
            },
            "holder": {
                "name": "GUSTAVO EXEMPLO",
                "document": "94881558099",
                "type": "NATURAL"
            }
        },
        "beneficiary": {
            "number": "11111",
            "branch": "0001",
            "type": "CURRENT",
            "participant": {
                "name": "DELCRED SCD S.A.",
                "ispb": "38224857"
            },
            "holder": {
                "document": "48689840000130",
                "type": "LEGAL"
            }
        },
        "payee": {
            "number": "11111",
            "branch": "0001",
            "type": "CURRENT",
            "participant": {
                "name": "DELCRED SCD S.A.",
                "ispb": "38224857"
            },
            "holder": {
                "document": "48689840000130",
                "type": "LEGAL"
            }
        }
    }
}

Aqui estão os atributos que são passados pelo webhook PIX_RECEIVED:

Name	Description
eventType	O tipo de evento que acionou o webhook (ex.: "PIX_RECEIVED").
correlationId	Um identificador único para correlacionar o evento com outros processos relacionados.
referenceId	Um identificador fornecido para rastrear o pagamento entre sistemas.
endToEndId	Um identificador único para a transação PIX, atribuído pelo sistema de pagamento.
amount	O valor monetário da transação PIX.
createdAt	O timestamp indicando quando a transação PIX foi criada.
proof	Um objeto contendo informações detalhadas de comprovante para a transação PIX.
proof.eventType	O tipo específico de evento no contexto proof (ex.: "PIX_PAYMENT_EFFECTIVE").
proof.endToEndId	O identificador único da transação PIX no contexto proof.
proof.idempotencyKey	Uma chave única para garantir a idempotência do processamento do contexto proof.
proof.correlationId	O ID de correlação associado ao contexto proof.
proof.status	O status da transação PIX no contexto proof (ex.: "PIX_EFFECTIVE").
proof.amount	O valor monetário da transação PIX no contexto proof.
proof.payer	Um objeto contendo informações sobre o pagador da transação PIX.
proof.payer.number	O número da conta do pagador.
proof.payer.branch	O número da agência da conta do pagador.
proof.payer.type	O tipo da conta do pagador (ex.: "PAYMENT").
proof.payer.participant	Um objeto contendo informações sobre a instituição financeira do pagador.
proof.payer.participant.name	O nome da instituição financeira do pagador (ex.: "NU PAGAMENTOS - IP").
proof.payer.participant.ispb	O código ISPB da instituição financeira do pagador (ex.: "18236120").
proof.payer.holder	Um objeto contendo informações sobre o titular da conta do pagador.
proof.payer.holder.name	O nome do pagador.
proof.payer.holder.document	O número do documento do pagador (ex.: CPF ou CNPJ).
proof.payer.holder.type	O tipo de pagador (ex.: "NATURAL" ou "LEGAL").
proof.beneficiary	Um objeto contendo informações sobre o beneficiário da transação PIX.
proof.beneficiary.number	O número da conta do beneficiário.
proof.beneficiary.branch	O número da agência da conta do beneficiário.
proof.beneficiary.type	O tipo da conta do beneficiário (ex.: "CURRENT").
proof.beneficiary.participant	Um objeto contendo informações sobre a instituição financeira do beneficiário.
proof.beneficiary.participant.name	O nome da instituição financeira do beneficiário (ex.: "DELCRED SCD S.A.").
proof.beneficiary.participant.ispb	O código ISPB da instituição financeira do beneficiário (ex.: "38224857").
proof.beneficiary.holder	Um objeto contendo informações sobre o titular da conta do beneficiário.
proof.beneficiary.holder.document	O número do documento do beneficiário (ex.: CPF ou CNPJ).
proof.beneficiary.holder.type	O tipo de beneficiário (ex.: "LEGAL").
proof.payee	Um objeto contendo informações do recebedor (pode ser idêntico aos dados do beneficiário).
proof.payee.number	O número da conta do recebedor.
proof.payee.branch	O número da agência da conta do recebedor.
proof.payee.type	O tipo da conta do recebedor (ex.: "CURRENT").
proof.payee.participant	Um objeto contendo informações sobre a instituição financeira do recebedor.
proof.payee.participant.name	O nome da instituição financeira do recebedor (ex.: "DELCRED SCD S.A.").
proof.payee.participant.ispb	O código ISPB da instituição financeira do recebedor (ex.: "38224857").
proof.payee.holder	Um objeto contendo informações sobre o titular da conta do recebedor.
proof.payee.holder.document	O número do documento do recebedor (ex.: CPF ou CNPJ).
proof.payee.holder.type	O tipo de recebedor (ex.: "LEGAL").