Envelope - Kiwify API

{
  "created_at": "2026-05-28T14:30:00Z",
  "data": {},
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "version": "1.0"
}

The wrapper around every HTTP delivery. The data field varies by type — see the schema pages below for each payload type.

created_at

string<date-time>

required

Example:

"2026-05-28T14:30:00Z"

data

object

required

string

required

Example:

"550e8400-e29b-41d4-a716-446655440000"

type

enum<string>

required

Available options:

CASHOUT.PIX.TRANSFERS.COMPLETED,

CASHOUT.PIX.TRANSFERS.CREATED,

CASHOUT.PIX.TRANSFERS.SCHEDULED,

CASHOUT.PIX.TRANSFERS.FAILED,

CASHOUT.PIX.TRANSFERS.SCHEDULED.FAILED,

CASHIN.PIX.QRCODES.CREATED,

CASHIN.PIX.QRCODES.PAID,

CASHIN.DEPOSITS.RECEIVED,

CASHOUT.PIX.REFUNDS.COMPLETED,

CASHOUT.PIX.REFUNDS.FAILED,

CASHOUT.BOLETO.PAYMENTS.COMPLETED,

CASHOUT.BOLETO.PAYMENTS.FAILED,

CASHOUT.BOLETO.PAYMENTS.SCHEDULED,

CASHOUT.BOLETO.PAYMENTS.SCHEDULED.FAILED

version

string

required

Example:

"1.0"