Pular para o conteúdo principal

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.

​
Tipos de Evento de Webhook

Existem dois níveis de tipos de evento:
  1. Categorias de assinatura — valores que você passa em event_types ao criar a assinatura (POST /v1/webhooks).
  2. Tipos de entrega — valores no campo type do envelope recebido no seu endpoint.

​
Categorias de assinatura

ValorDescrição
CASHIN.PIX.QRCODESQR codes PIX dinâmicos criados ou pagos
CASHIN.DEPOSITSTransferências PIX recebidas (exceto pagamentos via QR code)
CASHOUT.PIX.TRANSFERSTransferências PIX de saída
CASHOUT.PIX.REFUNDSEstornos PIX
CASHOUT.BOLETO.PAYMENTSPagamentos de boleto
CASHOUT.PIX.QRCODE.PAYMENTSReservado — sem entrega implementada
É necessário assinar pelo menos uma categoria por endpoint.

​
Tipos de entrega por assinatura

AssinaturaTipo de entrega (envelope.type)Status
CASHIN.PIX.QRCODESCASHIN.PIX.QRCODES.CREATEDEntregue
CASHIN.PIX.QRCODESCASHIN.PIX.QRCODES.PAIDEntregue
CASHIN.DEPOSITSCASHIN.DEPOSITS.RECEIVEDEntregue
CASHOUT.PIX.TRANSFERSCASHOUT.PIX.TRANSFERS.SCHEDULEDEntregue
CASHOUT.PIX.TRANSFERSCASHOUT.PIX.TRANSFERS.COMPLETEDEntregue
CASHOUT.PIX.TRANSFERSCASHOUT.PIX.TRANSFERS.FAILEDEntregue
CASHOUT.PIX.TRANSFERSCASHOUT.PIX.TRANSFERS.SCHEDULED.FAILEDEntregue
CASHOUT.PIX.TRANSFERSCASHOUT.PIX.TRANSFERS.CREATEDPlanejado
CASHOUT.PIX.REFUNDSCASHOUT.PIX.REFUNDS.COMPLETEDEntregue
CASHOUT.PIX.REFUNDSCASHOUT.PIX.REFUNDS.FAILEDEntregue
CASHOUT.BOLETO.PAYMENTSCASHOUT.BOLETO.PAYMENTS.SCHEDULEDEntregue
CASHOUT.BOLETO.PAYMENTSCASHOUT.BOLETO.PAYMENTS.COMPLETEDEntregue
CASHOUT.BOLETO.PAYMENTSCASHOUT.BOLETO.PAYMENTS.FAILEDEntregue
CASHOUT.BOLETO.PAYMENTSCASHOUT.BOLETO.PAYMENTS.SCHEDULED.FAILEDEntregue
CASHOUT.PIX.QRCODE.PAYMENTS—Não implementado
Veja Estruturas de payload para o formato do campo data de cada tipo.