Payments

Registrar Payments de una Account

Changed on

Registra pagos ya realizados sobre Invoices indicando la Account en el cuerpo de la llamada.

Equivale a la creación de Payments, pero la Account no se toma de las credenciales sino del campo id_account. Se usa desde procesos internos de Toku que cargan pagos en nombre de una Account determinada.

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

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.

post/payments/bulk

Request

  • Base URL
    https://api.trytoku.com
  • URL
    https://api.trytoku.com/payments/bulk
  • Auth
    API key in header x-api-key

Request body

id_accountstring

Account bajo la cual se registran los Payments.

Example request

{
  "id_account": "acc_2YPKc-NZPwxBYf6hnLsstaqG9JAZKxX4",
  "payments": [
    {
      "due_date": "202101",
      "id_payment_intent": "pi_1YPKc-NZPwxBYf6hnLsstaqG9JAZKxX9",
      "invoice_external_id": "9897af7987d9245d-202101",
      "payment_amount": 1000,
      "product_id": "9897af7987d9245d"
    }
  ]
}

Response

Recuento por resultado del lote.

duplicatesinteger

Payments repetidos dentro del mismo lote. Se procesa la primera aparición y las siguientes se descartan.

errorinteger

Payments que no pudieron procesarse por un error de negocio.

format_errorinteger

Payments rechazados por el formato de los datos enviados.

not_foundinteger

Payments cuyo Invoice no existe o no está disponible.

successinteger

Payments procesados correctamente.

Changes