HomeGuíasAPI ReferenceChangelog
Log In
API Reference

Modificar Payment

Modifica los datos de un pago ya registrado sobre un Invoice.

Se usa para corregir el monto, la fecha o el medio de pago de un Payment informado antes. El Payment se identifica por el Invoice que salda, y ese Invoice debe tener un pago registrado: si no lo tiene, la llamada responde 404.

El monto no se puede modificar cuando el Invoice ya tiene un comprobante emitido; en ese caso la llamada responde 400. Los demás campos sí se pueden corregir.

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

Pago ya realizado sobre un Invoice: cuánto se pagó, cuándo y por qué medio.

Un Payment puede ser un cobro procesado por Toku o un pago que el deudor hizo por fuera (transferencia, caja, efectivo) y que se registra para dejar el Invoice como pagado.

Un Payment no se referencia por un identificador propio, sino por el Invoice que salda: con invoice_external_id, o con product_id y due_date, que juntos lo componen. Los campos enviados como texto vacío se tratan como ausentes.

Identificador del documento que respalda el pago en tu sistema, por ejemplo el número de la orden o del comprobante.

length ≤ 32

Identificador del periodo adeudado. Es texto libre, no necesariamente una fecha, y es obligatorio cuando no envías invoice_external_id.

Identificador del cobro de Toku que originó el pago. Si lo envías, el Invoice se determina a partir de ese cobro y no de product_id / due_date, y debe corresponder a un cobro autorizado.

Identificador del comprobante asociado al pago, cuando corresponde.

Identificador del Invoice que salda el Payment. Si lo omites, se construye como {product_id}-{due_date}.

≥ 0

Monto pagado del Invoice. No puede ser negativo.

Fecha en que se realizó el pago, en formato ISO 8601. Acepta solo la fecha (2020-08-26) o fecha y hora (2020-08-26T12:06:34Z); si envías solo la fecha, se toma a las 00:00. Si lo omites al registrar el pago, se usa el momento en que Toku recibe la solicitud.

length ≤ 64

Medio de pago con el que se pagó, como texto libre.

length between 1 and 256

Identificador con el que reconoces el producto o servicio adeudado. Es obligatorio cuando no envías invoice_external_id.

Headers
string

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

Responses

400

El id_payment_intent enviado no corresponde a un cobro autorizado, o se intentó modificar el monto de un Payment cuyo Invoice ya tiene un comprobante emitido.

404

No existe un Invoice que coincida con los identificadores enviados, o ese Invoice no tiene un pago registrado.

500

La modificación no pudo completarse.

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