Códigos de API

Aquí encontrarás los códigos TKxxxxx con los que Toku identifica cada error, y qué significa cada uno.

Hay dos vías por las que recibes alguno de estos errores:

• La respuesta de error de un endpoint de Customer, Subscription o Invoice, donde el código viaja en error.code.
• El reporte de una carga masiva, en la columna «Código Toku» de cada fila que falló.

En la respuesta de un endpoint

Cuando un endpoint de Customer, Subscription o Invoice rechaza una petición, el código viaja en error.code:

{
  "error": {
    "message": "Descripción legible de qué salió mal.",
    "code": "TK30402"
  }
}

📘

Otro endpoint puede devolver un error.code que no está en este listado

Este catálogo cubre los códigos de Customer, Subscription e Invoice. Otros endpoints pueden devolver estos mismos códigos u otros: si el que recibes no está acá, revisa los responses de error del endpoint en su documentación, junto con el status HTTP y el error.message.

En el reporte de una carga masiva

Al terminar una carga masiva, Toku entrega un archivo con el resultado de cada fila. Las que fallaron traen su código en la columna «Código Toku».

Estructura del código

El código se compone de TK seguido de tres partes: el tipo de error (1 dígito), la entidad sobre la que ocurrió (2 dígitos) y un correlativo dentro de esa combinación (2 dígitos). El diagrama muestra dónde cae cada parte; sus dígitos son de ejemplo.

Así, TK30402 es un error de validación (3) sobre un Customer (04), correlativo 02.

TK30700 y TK30701 son la excepción: caen en la entidad 07 pero no son errores de un Payment Method. Son del archivo de una carga masiva, antes de que Toku procese sus filas.

Listado de códigos

Agrupados por lo que origina el error.

Sin entidad

Country

Customer

Subscription

Invoice

PaymentMethod

Transaction

Archivo de una carga masiva

Los cobros y medios de pago traen además un código de resultado con su gravedad, que no es un TKxxxxx: ese detalle vive en Códigos de pago rechazado.