Webhooks

Suggest Edits

Webhooks are used to send real-time notifications about events related to Automatic Pix transactions. Below, we detail the different webhook methods available, including payload examples and descriptions of their fields.

NotifyRecurrencePixAutomatic

This webhook notifies when a Jorney of Recurrence.

{
    "Method": "NotifyRecurrencePixAutomatic",
    "BusinessUnitId": 3225,
    "RecurrenceId": "RN13203354202509127d62f060156",
    "Description": "Recorrência confirmada",
    "ContractId": "b6ad966a-54d9-4682-b5ae-bcc6f289752a",
    "Details": {
        "Status": "Canceled",
        "Receiver": {
            "Name": "BU Pix",
            "TaxNumber": "12345678912345"
        },
        "Payer": {
            "Name": "João da Silva",
            "TaxNumber": "***.488.500-**"
        },
        "Data": {
            "Frequency": 0,
            "InitialDate": "2025-09-15",
            "FinalDate": null
        },
        "Value": {
            "FinalValue": null,
            "MinimumValue": 2.00,
            "MaximumValue": null
        },
        "Journey": 1,
        "Retry": false,
        "Guidance": "Por favor, revise os dados do pagador"
    },
    "Timestamp": "2025-09-12T15:31:14.3557079-03:00"
}

Field	Description	Type	Mandatory
Method	Method or action of the webhook	String	Yes
BusinessUnitId	Business unit identifier	Integer	Yes
RecurrenceId	Recurrence identifier	String	Yes
Description	Description of the transaction or service	String	Yes
Details	Object with additional details	Object	Yes
Details.Status	Recurrence status
Details.Receiver	Object containing receiver information	Object	Yes
Details.Receiver.Name	Receiver's name	String	Yes
Details.Receiver.TaxNumber	Receiver's CPF/CNPJ	String	Yes
Details.Payer	Object containing payer information	Object	Yes
Details.Payer.Name	Payer's name	String	Yes
Details.Payer.TaxNumber	Payer's CPF/CNPJ	String	Yes
Details.Data	Object that contains date information	String	Yes
Details.Data.Frequency	Define the recurrence frequency	String	Yes
Details.Data.InitialDate	Define the start date	String	Yes
Details.Data.FinalDate	Define the end date	String	Yes
Details.Value.FinalValue	Transaction value	String	Yes
Details.Value.MinimumValue	Minimum allowed value for the transaction	String	Yes
Details.Value.MaximumValue	Maximum allowed value for the transaction (Field returned only to the Payer user)	String	No
Details.Journey	Provides the recurrence journey	String	Yes
Details.Retry	Indicates if the recurrence can have retries	Boolean	Yes
Details.Guidance	Guidance for user	String	Yes
Timestamp	Event date and time (ISO 8601 format)	String	Yes

Status:

Pending

NotifySchedulePixAutomatic

This webhook notifies when a scheduling.

{
    "Method": "NotifySchedulePixAutomatic",
    "BusinessUnitId": 2998,
    "RecurrenceId": "RR132033542025112823c3ba19c7b",
    "Description": "Pix Automático agendado",
    "Details": {
        "ScheduledId": "ab1b45c5d76b464fafa28b85c6cf7134",
        "EntityId": 7805391,
        "EndToEndId": "E132033542025113003004668DFEAE93",
        "Status": "Canceled",
        "Receiver": {
            "Name": "BU Pix",
            "TaxNumber": "45748851000155"
        },
        "Payer": {
            "Name": "João da Silva",
            "TaxNumber": "***.456***-12"
        },
        "Value": "21.00",
        "PaymentDate": "2025-11-30",
        "Guidance": null
    },
    "Timestamp": "2025-11-28T14:21:19.8028077-03:00"
}

Field	Description	Type	Mandatory
Method	Method or action of the webhook	String	Yes
BusinessUnitId	Business unit identifier	Integer	Yes
RecurrenceId	Recurrence identifier	String	Yes
Description	Event description	String	Yes
Details	Object with additional details	Object	Yes
Details.ScheduledId	Identifier for the scheduled transaction	String	Yes
Details.EntityId	Identifier Entity	String	Yes
Details.EndToEndId	Identifier End To End	String	Yes
Details.Status	Schedule status	String	Yes
Details.Receiver	Object with Receiver	Object	Yes
Details.Receiver.Name	Receiver's name	String	Yes
Details.Receiver..TaxNumber	Receiver's CNPJ	String	Yes
Details.Payer.Name	Payer's name	String	Yes
Details.Payer.TaxNumber	Payer's CNPJ	String	Yes
Details.Value	Transaction value	String	Yes
Details.PaymentDate	Payment date of the scheduling	String	Yes
Details.Guidance	Guidance for user	String	Yes
Timestamp	Event date and time (ISO 8601 format)	String	Yes

Status

Processed
Processing
Error

Updated 6 days ago