Payload Pay-Out
payout.completed
Sección titulada «payout.completed»{ "eventType": "payout.completed", "txId": "b2c3d4e5f6a7", "type": "PAYOUT", "status": "COMPLETED", "amount": 5000, "currency": "BRL", "feeCharged": 200, "e2eId": "E12345678202603241402000000001", "updatedAt": "2026-03-24T14:00:12.000Z", "debtor": { "document": "11.222.333/0001-44", "name": "Acme Corp", "accountType": "PAYMENT", "ispb": "18236120", "branch": "0001", "account": "98765-4" }, "creditor": { "document": "987.654.321-00", "name": "Maria Souza", "accountType": "CHECKING", "ispb": "60746948", "branch": "0002", "account": "54321-0" }}payout.failed
Sección titulada «payout.failed»{ "eventType": "payout.failed", "txId": "b2c3d4e5f6a7", "type": "PAYOUT", "status": "FAILED", "amount": 5000, "currency": "BRL", "feeCharged": 0, "e2eId": null, "failureReason": "Chave Pix não encontrada", "updatedAt": "2026-03-24T14:00:30.000Z"}payout.reversed
Sección titulada «payout.reversed»{ "eventType": "payout.reversed", "txId": "reversal-txid-abc", "type": "PAYOUT", "status": "REVERSED", "amount": 5000, "currency": "BRL", "feeCharged": 200, "reason": "bankError", "e2eId": "E12345678202603241410000000001", "reversedAt": "2026-03-24T14:10:00.000Z", "debtor": { "document": "11.222.333/0001-44", "name": "Acme Corp", "accountType": "PAYMENT", "ispb": "18236120", "branch": "0001", "account": "98765-4" }, "creditor": { "document": "987.654.321-00", "name": "Maria Souza", "accountType": "CHECKING", "ispb": "60746948", "branch": "0002", "account": "54321-0" }, "metadata": { "reason": "bankError", "triggerTransactionId": "E12345678202603241402000000001" }}Campos comunes
Sección titulada «Campos comunes»| Campo | Descripción |
|---|---|
eventType | Nombre del evento (payout.completed, payout.failed, payout.reversed) |
txId | ID de la transacción |
type | Siempre PAYOUT |
status | Estado: COMPLETED, FAILED, REVERSED |
amount | Monto enviado en centavos |
feeCharged | Fee cobrado en centavos (0 si la transferencia falló) |
e2eId | ID de extremo a extremo del sistema PIX (null si falló) |
debtor | Tu cuenta (quien envió) — disponible en completed y reversed |
creditor | Cuenta del beneficiario — disponible en completed y reversed |
failureReason | Razón del fallo en portugués (solo en payout.failed) |
reason | Motivo del reverso (solo en reversed) |
reversedAt | Timestamp del reverso (solo en reversed) |
metadata.triggerTransactionId | e2eId de la transacción original que disparó el reverso |