Pix received Webhook

📘
To learn more about webhooks in our API, follow the link below:
About Webhooks

When a Pix is credited to your account, the best way to receive this information is using the webhook PIX_RECEIVED. As soon as the transaction is concluded the PIX_RECEIVED weboohk is sent.

Here's the simplest way to configure a PIX_RECEIVED webhook:

Headers

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

Body

{
  "eventType": "PIX_PAYMENT_UPDATED",
  "url": "https://example.com.br/webhooks/v1/pixreceived", // Add your own URL here
  "authorization": "NONE,
  "authorizationScheme": "NONE"
}

Now once a Pix is credited to your account here's what you are going to receive on the registered URL:

{
    "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"
            }
        }
    }
}

Here are the attributes that are passed by the PIX_RECEIVED webhook:

Name	Description
eventType	The type of event that triggered the webhook (e.g., "PIX_RECEIVED").
correlationId	A unique identifier for correlating the event with other related processes.
referenceId	An identifier provided for tracking the payment across systems.
endToEndId	A unique identifier for the PIX transaction, assigned by the payment system.
amount	The monetary value of the PIX transaction.
createdAt	The timestamp indicating when the PIX transaction was created.
proof	An object containing detailed proof information for the PIX transaction.
proof.eventType	The specific type of event within the proof context (e.g., "PIX_PAYMENT_EFFECTIVE").
proof.endToEndId	The unique identifier for the PIX transaction within the proof context.
proof.idempotencyKey	A unique key to ensure idempotency of the proof event processing.
proof.correlationId	The correlation ID associated with the proof event.
proof.status	The status of the PIX transaction within the proof context (e.g., "PIX_EFFECTIVE").
proof.amount	The monetary value of the PIX transaction within the proof context.
proof.payer	An object containing information about the payer of the PIX transaction.
proof.payer.number	The account number of the payer.
proof.payer.branch	The branch number of the payer's account.
proof.payer.type	The type of the payer's account (e.g., "PAYMENT").
proof.payer.participant	An object containing information about the financial institution of the payer.
proof.payer.participant.name	The name of the financial institution of the payer (e.g., "NU PAGAMENTOS - IP").
proof.payer.participant.ispb	The ISPB code of the payer's financial institution (e.g., "18236120").
proof.payer.holder	An object containing information about the holder of the payer's account.
proof.payer.holder.name	The name of the payer
proof.payer.holder.document	The document number of the payer (e.g., CPF or CNPJ).
proof.payer.holder.type	The type of payer (e.g., "NATURAL" or "LEGAL").
proof.beneficiary	An object containing information about the beneficiary of the PIX transaction.
proof.beneficiary.number	The account number of the beneficiary.
proof.beneficiary.branch	The branch number of the beneficiary's account.
proof.beneficiary.type	The type of the beneficiary's account (e.g., "CURRENT").
proof.beneficiary.participant	An object containing information about the financial institution of the beneficiary.
proof.beneficiary.participant.name	The name of the beneficiary's financial institution (e.g., "DELCRED SCD S.A.").
proof.beneficiary.participant.ispb	The ISPB code of the beneficiary's financial institution (e.g., "38224857").
proof.beneficiary.holder	An object containing information about the holder of the beneficiary's account.
proof.beneficiary.holder.document	The document number of the beneficiary (e.g., CPF or CNPJ).
proof.beneficiary.holder.type	The type of beneficiary (e.g., "LEGAL").
proof.payee	An object containing payee information (can be identical to beneficiary details).
proof.payee.number	The account number of the payee.
proof.payee.branch	The branch number of the payee's account.
proof.payee.type	The type of the payee's account (e.g., "CURRENT").
proof.payee.participant	An object containing information about the financial institution of the payee.
proof.payee.participant.name	The name of the payee's financial institution (e.g., "DELCRED SCD S.A.").
proof.payee.participant.ispb	The ISPB code of the payee's financial institution (e.g., "38224857").
proof.payee.holder	An object containing information about the holder of the payee's account.
proof.payee.holder.document	The document number of the payee (e.g., CPF or CNPJ).
proof.payee.holder.type	The type of payee (e.g., "LEGAL").