HomeGuíasAPI ReferenceChangelog
Log In
API Reference

Crear Refund de Invoice

Devuelve el dinero con que se pagó una deuda, total o parcialmente.

Se usa cuando el punto de partida es la Invoice y no el pago: Toku busca el pago que la saldó y crea la devolución sobre esa Transaction.

Solo aplica a Invoices saldadas en un único pago. Si la Invoice fue pagada en más de una Transaction, la petición es rechazada y la devolución debe pedirse sobre la Transaction.

Si se omite refund_amount, se devuelve el monto total del pago que saldó la Invoice.

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.

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

Solicitud de devolución sobre una Invoice.

boolean
Defaults to false

Indica si se deshabilita el cobro automático de la Invoice tras la devolución.

string
required

Identificador de la Invoice a devolver.

string
required

Motivo de la devolución.

number

Monto a devolver. Si se omite, se devuelve el monto total de la Transaction que pagó la Invoice.

boolean
Defaults to false

Indica si la Invoice queda anulada 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 Invoice fue pagada en más de una Transaction: en ese caso la devolución se pide sobre la Transaction, no sobre la Invoice.

403

La Invoice pertenece a otra organización, o el gateway del pago no tiene habilitadas las devoluciones para tu organización.

404

La Invoice indicada no existe, o no tiene ningún pago que devolver.

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