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 Payload Structures

The envelope data field contains the event payload. Structure depends on the type value.
Webhook payloads are not identical to GET API responses. Examples: transfers use transfer_id (not id) and transfer_created_at (not created_at).

Envelope

Every HTTP delivery uses the same envelope. See Envelope.

Payloads by event type

Transfers

CASHOUT.PIX.TRANSFERS.*

QR code created

CASHIN.PIX.QRCODES.CREATED

QR code paid

CASHIN.PIX.QRCODES.PAID

Deposit received

CASHIN.DEPOSITS.RECEIVED

Refund

CASHOUT.PIX.REFUNDS.*

Boleto

CASHOUT.BOLETO.PAYMENTS.*
Each page above renders the full OpenAPI schema with types, fields, and enums.