What does this endpoint do?

The objective of this endpoint is to facilitate subscription for notifications regarding the payment flow (or withdrawal flow) within your integrated application. To create this subscription, it is essential to provide a target URL to which we will send these notifications.

We will notify you at every critical status change.

Please note that a withdrawal flow encompasses all types of payments made by the system to you or a simple debit transaction, which can also be referred to as a "pay-out."

Here is an example of a callback message:

{
    "PaymentGroupId": "testeste-7920-469f-a758-502e42a7d170",
    "AccountId": "000",
    "PaymentId": "testeste-9503-42f9-a59c-77f29d00695f",
    "Amount": 40.0,
    "AmountNet": 40.0,
    "ExternalId": "ABCD1234",
    "Currency": "BRL",
    "Blockchain": "None",
    "Name": "Ash Ketchum",
    "TaxId": "12345678910",
    "TaxIdCountry": 76,
    "PixKey": "12345678910",
    "PaymentStatus": "Processing"
}