¿Cómo actualizar o anular un invoice en Toku?

Actualizar un Invoice

Para actualizar un invoice basta con realizar un POST /invoices, donde para un invoice ya existente en Toku, con el mismo id_producto y fecha de vencimiento, se reemplazan los parámetros existentes por los enviados en el nuevo POST.

Anular un Invoice

Anular un Invoice se puede hacer en Toku a través de una request POST a la API.

POST /invoices/{id}/void

Luego de creado un Invoice podriamos querer anularlo, en caso de que ya se haya subido mal por alguna razón. Para esto, debemos marcar is_void como true. Se debe incluir en el path el ID del Invoice obtenido al momento de su creación, de la forma:

https://api.trytoku.com/invoices/in_5tswGjwgAxrQm4ACZx0QjE84qKm8fgsw/void

Los parámetros necesarios para anular Invoice son:

Nombre

Tipo

Descripción

Requerido

id

string

Identificador único del Invoice.

:radio-button: Si

La respuesta recibida es de la forma:

{
  "customer": "cus_lq1wGjwgFyqQm4ACZx0QjE84qKm8fffa",
  "is_paid": false,
  "is_void": true,
  "amount": 1000,
  "product_id": "92792",
  "due_date": "2021-03-04",
  "link_payment": "https://portal.pagos.com/tu-empresa",
  "metadata": {
    "car_brand": "Toyota",
    "car_model": "Yaris"
  },
  "id": "in_5tswGjwgAxrQm4ACZx0QjE84qKm8fgsw"
}

Como vemos, el Invoice ahora aparece como anulado, con is_void = true.

Consultar un Invoice

Consultar el estado de un Invoice se logra a través de una request GET /invoices/{id} a la API.

Una vez creado un Invoice, podemos consultar su estado. Debemos incluir en el path el ID del Invoice obtenido al momento de su creación, de la forma:

https://api.trytoku.com/invoices/in_5tswGjwgAxrQm4ACZx0QjE84qKm8fgsw

Los parámetros necesarios para consultar el estado de un Invoice son:

Nombre

Tipo

Descripción

Requerido

id

string

Identificador único del Invoice.

:radio-button: Si

La respuesta recibida es de la forma:

{
  "customer": "cus_lq1wGjwgFyqQm4ACZx0QjE84qKm8fffa",
  "is_paid": false,
  "is_void": false,
  "amount": 1000,
  "product_id": "92792",
  "due_date": "2021-03-04",
  "link_payment": "https://portal.pagos.com/tu-empresa",
  "metadata": {
    "car_brand": "Toyota",
    "car_model": "Yaris"
  },
  "id": "in_5tswGjwgAxrQm4ACZx0QjE84qKm8fgsw"
}