HomeGuíasAPI ReferenceChangelog
Log In
API Reference

Crear Refund de Transaction

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Solicitud de devolución sobre una Transaction.

boolean
Defaults to false

Indica si se deshabilita el cobro automático de las Invoices asociadas a la Transaction.

string
required

Identificador de la Transaction a devolver.

invoice_refund_details
array of objects

Detalle de cuánto devolver por cada Invoice. Si se omite, la devolución se aplica sobre las Invoices que la Transaction había saldado.

Invoice Refund Details
boolean
Defaults to true

Indica si las Invoices quedan marcadas como no pagadas tras la devolución. Se envía en false al devolver un pago duplicado, para que la deuda no vuelva a quedar pendiente.

string
required

Motivo de la devolución.

number

Monto a devolver. Si se omite, se devuelve el monto total de la Transaction; cuando viene invoice_refund_details, se devuelve la suma de los montos indicados ahí.

boolean
Defaults to false

Indica si las Invoices asociadas a la Transaction quedan anuladas tras la devolución.

Headers
string

Llave de API de una Account, para operar sobre esa Account en lugar de la principal.

Responses

400

La 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.

403

La Transaction pertenece a otra organización, o su gateway no tiene habilitadas las devoluciones para tu organización.

404

La Transaction indicada no existe.

422

El cuerpo de la petición no pasó la validación.

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json