Devuelve el dinero de un pago, total o parcialmente.
Se usa para reversar un pago ya cobrado. Toku registra la devolución como una Transaction propia de tipo REVERSED, ligada al pago original, y la aplica sobre las Invoices que ese pago había saldado.
Si se omite refund_amount, se devuelve el monto total del pago. Para devolver solo una parte, indica el monto; y si el pago saldó varias Invoices, usa invoice_refund_details para precisar cuánto corresponde a cada una.
La operación no es idempotente: cada llamada crea una devolución nueva y las parciales se acumulan sobre el mismo pago, así que reenviar la misma petición vuelve a devolver el monto mientras quede saldo; cuando ya no queda, la petición es rechazada con estado 400.
Cuando la devolución se envía al gateway en línea, la respuesta ya trae el desenlace y el comprobante. En los productos que se devuelven por lote o de forma asíncrona, success llega en false con error en null: la devolución quedó iniciada y el gateway la confirma después.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
400La Transaction no admite la devolución: no es reembolsable, el monto no es válido —por ejemplo, excede lo que queda por devolver— o la devolución parcial requiere anular las deudas asociadas.
403La Transaction pertenece a otra organización, o su gateway no tiene habilitadas las devoluciones para tu organización.
404La Transaction indicada no existe.
422El cuerpo de la petición no pasó la validación.