TRtrytoku
Payments

Eliminar Payments de una Account

Changed on

Elimina pagos registrados sobre Invoices indicando la Account en el cuerpo de la llamada.

Equivale a la eliminació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 revierten pagos en nombre de una Account determinada.

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/delete/bulk

Request

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

Request body

id_accountstring

Account bajo la cual se eliminan los Payments.

set_invoices_as_unpaidboolean

Si es true, los Invoices de los Payments eliminados vuelven a quedar impagos. Si es false, se elimina el Payment y el Invoice mantiene su estado.

Example request

{
  "id_account": "acc_2YPKc-NZPwxBYf6hnLsstaqG9JAZKxX4",
  "payments": [
    {
      "due_date": "202101",
      "invoice_external_id": "9897af7987d9245d-202101",
      "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