Webhook Events
Here, we present the current events that you may receive through your registered Webhook, as described in the previous section. These events include the following:
| Events | Description |
|---|---|
| TICKET | A ticket event refers to any updates related to a created ticket (money) within your Account. Naturally, it may also involve a subAccount. This event can have multiple statuses, such as TICKET-CREATED, DEPOSIT-PROCESSING, among others. |
| Coming Soon! |
Ticket
The Ticket Event always reflects an update related to any updates related to a created ticket within your account. In other words, for each type of transaction (as defined inside the quote field of a ticket), a ticket is generated.
Each ticket has a specific type, which determines the nature of the transaction, and during the lifecycle of that ticket, you’ll receive multiple status updates reflecting its current state.
These updates will be sent to your registered Webhook as the ticket progresses through its execution steps.
Ticket Event's Status
| Status Name | Description |
|---|---|
| TICKET-CREATED | The ticket has been successfully created—this occurs when the transaction hits the endpoint. |
| DEPOSIT-PROCESSING | The deposit phase has started and is currently being processed. |
| DEPOSIT-SUCCESS | The deposit was completed successfully. |
| DEPOSIT-FAILED | The deposit attempt has failed. |
| DELIVERY-PROCESSING | The delivery phase (e.g., transfer of tokens or funds) is now in progress. |
| DELIVERY-SUCCESS | The delivery was completed successfully. |
| DELIVERY-FAILED | The delivery attempt has failed. |
| TICKET-COMPLETE | The entire ticket lifecycle has been completed, regardless of the outcome. |
If a deposit is made to the Main Account without a previously created Ticket, a Ticket Event will still be triggered, starting with the status TICKET-CREATED
Any type of error will also return a REASON field, providing details about why the specific step could not be completed.
An additional note for when the Ticket represents a Pay Out—either via PIX or BrCode
When the Ticket represents a Pay Out via PIX or BrCode, the delivery status may fail. In such cases, a new status will be generated, followed by a refund of the original input amount.
Ticket Event's Status Pay Out Failure
| Status Name | Description |
|---|---|
| DELIVERY-PROCESSING | The delivery phase (e.g., transfer of tokens or funds) is now in progress. |
| DELIVERY-PARTIAL-FAILED | Failure to complete Pay Out delivery |
Understanding the Data Returned in a Webhook
Ticket Events follow a standardized structure, where:
{
"type": "TYPE OF TICKET EVENT",
"ticket": "INFORMATION INSIDE A TICKET"
}
Check the detailed breakdown of the fields that make up a ticket