HomeGuíasAPI ReferenceChangelog
Log In
API Reference

Registrar Payments

Registra pagos ya realizados sobre Invoices.

Se usa para informar pagos que ocurrieron fuera de Toku —transferencias, caja, efectivo— y para mantener sincronizados los pagos que Toku ya procesó. Acepta varios Payments en una sola llamada.

Cada Payment se referencia por el Invoice que salda, no por un identificador propio: envía invoice_external_id, o bien product_id y due_date para que Toku lo construya como {product_id}-{due_date}.

Si el Invoice ya tiene un pago registrado, la llamada lo actualiza con los datos nuevos en vez de agregar otro.

Cada Payment enviado se resuelve en uno de estos resultados:

  • success: el pago quedó registrado, o el Invoice ya estaba pagado a través de Toku y no hubo nada que registrar.
  • duplicates: el Payment repite la combinación product_id + due_date + invoice_external_id de otro elemento del mismo lote. Solo se procesa el primero.
  • not_found: no existe un Invoice que coincida con los identificadores enviados, o está anulado.
  • error: el Invoice tiene un cobro en curso a través de Toku, ya fue pagado por Toku, o el id_payment_intent enviado no corresponde a un cobro autorizado.

Los Payments no procesados se detallan en errors_detail, agrupados por motivo, con los identificadores que enviaste.

Que algunos elementos del lote fallen no convierte la respuesta en un error: se devuelve 200 con el recuento por resultado. Revisa esos contadores para saber qué pasó con cada Payment enviado.

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

Lote de Payments a registrar.

payments
array of objects
required

Payments a registrar. Los que repitan la combinación product_id + due_date + invoice_external_id dentro del mismo lote se cuentan como duplicados y solo se procesa el primero.

Payments*
Headers
string

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

Responses

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