Códigos de API

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

Cuando la API rechaza una petición, el código viaja en error.code:

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

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.

Tipo	Código
Sin tipo explícito	`0`
Esperado	`1`
Base de datos	`2`
Validación	`3`

Entidad	Código
Sin entidad	`00`
Country	`01`
Organization	`02`
Account	`03`
Customer	`04`
Subscription	`05`
Invoice	`06`
PaymentMethod	`07`
Payment	`09`

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

Listado de códigos

Agrupados por la entidad que los origina.

Sin entidad

Código Toku	Descripción
`TK30000`	La validación de la petición falló.

Country

Código Toku	Descripción
`TK30100`	El país no está soportado para la validación del `government_id`.

Customer

Código Toku	Descripción
`TK20400`	El Customer no existe en la base de datos.
`TK30400`	El payload del Customer no incluye su identificador externo.
`TK30401`	El `external_id` del Customer no coincide con el parámetro `customer_external_id_parameter` de la organización.
`TK30402`	El `government_id` del Customer es inválido.
`TK30403`	La preferencia de teléfono del Customer es inválida.
`TK30404`	El número de teléfono del Customer es inválido.
`TK30405`	El email del Customer tiene una sintaxis inválida.
`TK30406`	El email del Customer está en una lista negra.
`TK30407`	Conflicto lógico al intentar eliminar el Customer.
`TK30408`	El código de país del número telefónico del Customer no es soportado por Toku.
`TK30409`	No se encontró el Customer por su `external_id`.
`TK30410`	El Customer ya existe en una operación donde no está permitido.
`TK00499`	Error interno al intentar guardar el Customer.

Subscription

Código Toku	Descripción
`TK20500`	La Subscription no existe en la base de datos.
`TK20501`	No se encontró una Subscription para el Customer indicado.
`TK30500`	Conflicto lógico al intentar eliminar la Subscription.
`TK30501`	Se intentó transferir la Subscription a otro Customer.
`TK30502`	Conflicto lógico al intentar editar la Subscription.
`TK30503`	La Subscription no tiene todos los campos requeridos.
`TK30504`	Conflicto lógico al intentar crear la Subscription.
`TK30505`	La Subscription ya existe en una operación donde no está permitido.
`TK00599`	Error interno al intentar guardar la Subscription.

Invoice

Código Toku	Descripción
`TK20600`	El Invoice no existe en la base de datos.
`TK20601`	No se encontró un Invoice para el Customer indicado.
`TK30600`	Conflicto lógico al intentar eliminar el Invoice.
`TK30601`	Conflicto lógico al intentar crear el Invoice.
`TK30602`	Conflicto lógico al intentar anular el Invoice.
`TK30603`	Conflicto lógico al intentar editar el Invoice.
`TK30604`	El Invoice ya existe en una operación donde no está permitido.
`TK00699`	Error interno al intentar guardar el Invoice.

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.