Pular para o conteúdo principal

​
Estruturas de Payload de Webhook

O campo data do envelope contém o payload do evento. A estrutura depende do valor de type.
Os payloads de webhook não são idênticos às respostas GET da API. Exemplos: transferências usam transfer_id (não id) e transfer_created_at (não created_at).

​
Envelope

Toda entrega HTTP usa o mesmo envelope. Veja Envelope.

​
Payloads por tipo de evento

Transferências

CASHOUT.PIX.TRANSFERS.*

QR code criado

CASHIN.PIX.QRCODES.CREATED

QR code pago

CASHIN.PIX.QRCODES.PAID

Depósito recebido

CASHIN.DEPOSITS.RECEIVED

Estorno

CASHOUT.PIX.REFUNDS.*

Boleto

CASHOUT.BOLETO.PAYMENTS.*
Cada página acima renderiza o schema OpenAPI completo com tipos, campos e enums.