Ir al contenido

Webhooks (Brasil)

Cuando un cobro o pago cambia de estado, Rivopay envía un POST a tu webhookUrl de Brasil. La URL se configura en el panel por país: la de Brasil es independiente de la de Colombia.

HeaderDescripción
Content-Typeapplication/json
X-Webhook-EventNombre del evento
User-AgentPaymentGateway-Webhook/1.0
X-Webhook-TimestampISO 8601 — solo si configuraste una Clave
X-Webhook-Signaturesha256=<hex> sobre {timestamp}\n{body} — solo si configuraste una Clave

La firma HMAC es opcional y se verifica igual que en Colombia. Ver Verificación de firma.

Reintentos: 3 intentos (inmediato, +1 s, +5 s). Responde 2xx rápido y procesa en segundo plano.

EventoCuándo
payin.completedCobro pagado
payin.failedCobro rechazado
payin.expiredCobro vencido sin pago (status: "FAILED", con failureReason y expiredAt)
payout.completedPago acreditado
payout.failedPago rechazado (failureReason, p. ej. llave inexistente); el saldo retenido vuelve
payin.reversed / payout.reversedUn reverso (total o parcial) de un cobro o un payout devuelto. Uno por reverso. Ver Reversos
{
"txId": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
"reference": "ORD-20261005-0000000000001",
"type": "PAYIN",
"status": "COMPLETED",
"amount": 10000,
"currency": "BRL",
"feeCharged": 300,
"netAmount": 9700,
"e2eId": "E12345678202610051400000000001",
"updatedAt": "2026-10-05T15:02:30.000Z",
"debtor": { "…": "datos del pagador según la red" },
"creditor": { "…": "…" }
}
CampoDescripción
referenceTu txIdSource (cobro) o reference (pago), o null
feeCharged / netAmountEn centavos; valen 0 si FAILED
e2eIdIdentificador end-to-end de la red Pix
debtor / creditorOpcionales. Solo vienen cuando el cierre llega por notificación de la red

Misma estructura con type: "PAYOUT": txId, reference, status, amount, currency, feeCharged, failureReason (solo en failed), e2eId, updatedAt y opcionalmente debtor / creditor.

Se envía uno por cada reverso. txId es el de la transacción de reverso; la original va en originalTxId y sigue COMPLETED.

{
"txId": "3b6f0d2a9c8e4f1a7b5d2c9e8f1a4b6d",
"type": "REVERSAL",
"status": "COMPLETED",
"direction": "OUT",
"origin": "API",
"reference": "DEV-77-1",
"originalTxId": "50580a1772734a7fa094638bf7b724ce",
"originalType": "PAYIN",
"originalReference": "pedido-77",
"originalStatus": "COMPLETED",
"amount": 100,
"requestedAmount": 100,
"currency": "BRL",
"originalAmount": 300,
"totalReversedAmount": 100,
"remainingAmount": 200,
"partial": true,
"reversalState": "PARTIAL",
"reason": "customerRequest",
"description": "Devolución parcial pedido 77",
"failureReason": null,
"e2eId": "D17028875202610061753012739ec30b",
"originalE2eId": "E22896431202610061749ZQB81fe6828",
"occurredAt": "2026-10-06T17:53:02.393Z",
"createdAt": "2026-10-06T17:53:00.000Z",
"updatedAt": "2026-10-06T17:53:03.120Z",
"debtor": { "…": "…" },
"creditor": { "…": "…" }
}
CampoDescripción
statusCOMPLETED o FAILED (solo para reversos que pediste tú)
directionOUT = devolución de un cobro (sale dinero) · IN = payout devuelto (entra dinero)
originAPI (tú), ADMIN (Rivopay) o PROVIDER (banco / red)
referenceTu reference del reverso, o la de la transacción original
amountMonto efectivamente devuelto, en centavos (lo que informa la red)
totalReversedAmount / remainingAmountAcumulado de reversos sobre la original y lo que queda
partialtrue si la original aún no se devolvió completa
e2eId / originalE2eIdEnd-to-end del reverso (D…) y del Pix original (E…)
occurredAtMomento del movimiento en la red