Event Payloads

Event types the Webhooks API can deliver, with examples you can switch by status

Every delivery body has this envelope:

{
  "event": "funding",
  "payload": {}
}

event is the subscription event type. payload is the resource the event describes. For newer products, payload matches the corresponding GET response in the API Reference.

Pick an event type below. On each page, use the tabs to switch the example by payload.status.

Event types

funding and withdrawal are not aliases of payin and payout. Subscribe to the pair that matches the API you integrate. payin, payout, and payin_intent are the Unified Payments API events and the direction for new payment rails. funding and withdrawal continue to report Fundings and Withdrawals API activity.

Event typeAPIWhen it firesExamples
fundingFundingsA deposit (fid) on the Fundings API changes status.funding
withdrawalWithdrawalsA withdrawal (wid) on the Withdrawals API changes status.withdrawal
dynamic_qr_codePixA Pix dynamic QR code pay-in changes status.dynamic_qr_code
payoutUnified PaymentsA payout on the Unified Payments API changes status.payout
payinUnified PaymentsA pay-in on the Unified Payments API is credited, including compensatory deposits.payin
payin_intentUnified PaymentsA pay-in intent on the Unified Payments API changes status.payin_intent
payment_intentPayment IntentsA Pay with Bitso payment intent changes status.payment_intent
spei_paymentSPEI one-time paymentA SPEI one-time payment changes status.spei_payment
account_validationAccount ValidationA Mexican account validation reaches a terminal state.account_validation


Did this page help you?