Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.kiwify.com.br/llms.txt

Use this file to discover all available pages before exploring further.

​
Webhook Event Types

There are two levels of event types:
  1. Subscription categories — values you pass in event_types when creating a subscription (POST /v1/webhooks).
  2. Delivery types — values in the envelope type field received at your endpoint.

​
Subscription categories

ValueDescription
CASHIN.PIX.QRCODESDynamic PIX QR codes created or paid
CASHIN.DEPOSITSIncoming PIX transfers (excluding QR code payments)
CASHOUT.PIX.TRANSFERSOutgoing PIX transfers
CASHOUT.PIX.REFUNDSPIX refunds
CASHOUT.BOLETO.PAYMENTSBoleto payments
CASHOUT.PIX.QRCODE.PAYMENTSReserved — no delivery implemented
At least one category is required per endpoint.

​
Delivery types by subscription

SubscriptionDelivery type (envelope.type)Status
CASHIN.PIX.QRCODESCASHIN.PIX.QRCODES.CREATEDDelivered
CASHIN.PIX.QRCODESCASHIN.PIX.QRCODES.PAIDDelivered
CASHIN.DEPOSITSCASHIN.DEPOSITS.RECEIVEDDelivered
CASHOUT.PIX.TRANSFERSCASHOUT.PIX.TRANSFERS.SCHEDULEDDelivered
CASHOUT.PIX.TRANSFERSCASHOUT.PIX.TRANSFERS.COMPLETEDDelivered
CASHOUT.PIX.TRANSFERSCASHOUT.PIX.TRANSFERS.FAILEDDelivered
CASHOUT.PIX.TRANSFERSCASHOUT.PIX.TRANSFERS.SCHEDULED.FAILEDDelivered
CASHOUT.PIX.TRANSFERSCASHOUT.PIX.TRANSFERS.CREATEDPlanned
CASHOUT.PIX.REFUNDSCASHOUT.PIX.REFUNDS.COMPLETEDDelivered
CASHOUT.PIX.REFUNDSCASHOUT.PIX.REFUNDS.FAILEDDelivered
CASHOUT.BOLETO.PAYMENTSCASHOUT.BOLETO.PAYMENTS.SCHEDULEDDelivered
CASHOUT.BOLETO.PAYMENTSCASHOUT.BOLETO.PAYMENTS.COMPLETEDDelivered
CASHOUT.BOLETO.PAYMENTSCASHOUT.BOLETO.PAYMENTS.FAILEDDelivered
CASHOUT.BOLETO.PAYMENTSCASHOUT.BOLETO.PAYMENTS.SCHEDULED.FAILEDDelivered
CASHOUT.PIX.QRCODE.PAYMENTS—Not implemented
See Payload structures for the data field format of each type.