Webhook Event Types

There are two levels of event types:

Subscription categories — values you pass in event_types when creating a subscription (POST /v1/webhooks).
Delivery types — values in the envelope type field received at your endpoint.

Subscription categories

Value	Description
`CASHIN.PIX.QRCODES`	Dynamic PIX QR codes created or paid
`CASHIN.DEPOSITS`	Incoming PIX transfers (excluding QR code payments)
`CASHOUT.PIX.TRANSFERS`	Outgoing PIX transfers
`CASHOUT.PIX.REFUNDS`	PIX refunds
`CASHOUT.BOLETO.PAYMENTS`	Boleto payments
`CASHOUT.PIX.QRCODE.PAYMENTS`	Reserved — no delivery implemented

At least one category is required per endpoint.

Delivery types by subscription

Subscription	Delivery type (`envelope.type`)	Status
`CASHIN.PIX.QRCODES`	`CASHIN.PIX.QRCODES.CREATED`	Delivered
`CASHIN.PIX.QRCODES`	`CASHIN.PIX.QRCODES.PAID`	Delivered
`CASHIN.DEPOSITS`	`CASHIN.DEPOSITS.RECEIVED`	Delivered
`CASHOUT.PIX.TRANSFERS`	`CASHOUT.PIX.TRANSFERS.SCHEDULED`	Delivered
`CASHOUT.PIX.TRANSFERS`	`CASHOUT.PIX.TRANSFERS.COMPLETED`	Delivered
`CASHOUT.PIX.TRANSFERS`	`CASHOUT.PIX.TRANSFERS.FAILED`	Delivered
`CASHOUT.PIX.TRANSFERS`	`CASHOUT.PIX.TRANSFERS.SCHEDULED.FAILED`	Delivered
`CASHOUT.PIX.TRANSFERS`	`CASHOUT.PIX.TRANSFERS.CREATED`	Planned
`CASHOUT.PIX.REFUNDS`	`CASHOUT.PIX.REFUNDS.COMPLETED`	Delivered
`CASHOUT.PIX.REFUNDS`	`CASHOUT.PIX.REFUNDS.FAILED`	Delivered
`CASHOUT.BOLETO.PAYMENTS`	`CASHOUT.BOLETO.PAYMENTS.SCHEDULED`	Delivered
`CASHOUT.BOLETO.PAYMENTS`	`CASHOUT.BOLETO.PAYMENTS.COMPLETED`	Delivered
`CASHOUT.BOLETO.PAYMENTS`	`CASHOUT.BOLETO.PAYMENTS.FAILED`	Delivered
`CASHOUT.BOLETO.PAYMENTS`	`CASHOUT.BOLETO.PAYMENTS.SCHEDULED.FAILED`	Delivered
`CASHOUT.PIX.QRCODE.PAYMENTS`	—	Not implemented

See Payload structures for the data field format of each type.

Receiving Webhooks Webhook Payload Structures