Relationship Between type and the data Object

Relationship Between type and the data Object

Every webhook sent by the platform follows a standard envelope structure, but the data object always contains the complete resource associated with the event.

This means:

  • If the event type is charge.*, the data object contains a Charge resource.

  • If the event type is payment-link.*, the data object contains a Payment Link resource.

  • If the event type is transaction.*, the data object contains a Transaction resource.

  • And so on for every supported product.

This ensures that your system can reliably deserialize the correct object type based solely on the event’s type value.

Event Type Prefix
Example Type
Data Object Description

charge.*

charge.pending

Contains a full Charge object.

payment-link.*

payment-link.pending

Contains a Payment Link object.

transaction.*

transaction.pending

Contains a Transaction object. (PIX information is included in the transaction events)

withdrawal.*

withdrawal.validated

Contains an withdrawal object.