Catálogo de Errores

Listado de códigos de error con su respectiva descripción que puede retornar la API de Toku.

La API de Toku responderá con errores que siguen una estructura definida para los recursos de Customers, Subscriptions e Invoices. Los mensajes de error tendrán el siguiente formato:

JSON

{  
   "error":{  
      "message":"Some descriptive message.",  
      "code":"TKXXXX"  
   }  
}

El propósito de esta sección es comprender la estructura del campo code dentro de la respuesta de la API, proporcionando un catálogo que enumera los posibles códigos que la API puede devolver junto con sus correspondientes descripciones.

Estructura del código de error

Los errores tendrán la siguiente sintáxis

Con las siguientes fuentes

Type	Code
No Explicit Type	0
Expected	1
Database	2
Validation	3

Entity	Code
No entity	00
Country	01
Organization	02
Account	03
Customer	04
Subscription	05
Invoice	06
PaymentMethod	07
Payment	09

Listado de códigos (por entidad)

No Entity

Toku Code	Description
TK30000	Validation error, the request validation failed.

Country

Toku Code	Description
TK30100	Country is not supported for government id validation.

Customer

Toku Code	Description
TK20400	Customer not found on database.
TK30400	Customer payload is missing its external identifier.
TK30401	Customer’s external_id does not match the organization's customer_external_id_parameter.
TK30402	Customer government_id is invalid.
TK30403	Customer phone preference is invalid.
TK30404	A customer’s phone number field is invalid.
TK30405	A customer’s email field is invalid syntactically.
TK30406	A customer’s email field is blacklisted.
TK30407	Customer had a logic conflict in its delete flow.
TK30408	Customer's phone_number country code is not supported by Toku.
TK30409	Customer was not found by its external_id.
TK30410	Customer already exists in an operation where it is not allowed.

Subscriptions

Toku Code	Description
TK20500	Subscription not found on database.
TK20501	Subscription not found for a given customer.
TK30500	Subscription had a logic conflict while attempting to delete it.
TK30501	Subscription had an attempt to be transferred to a different customer.
TK30502	Subscription had a logic conflict while attempting to edit it.
TK30503	Subscription doesn't have all required fields present.
TK30504	Subscription had a logic error while attempting to create it.
TK30504	Subscription already exists in an operation where it is not allowed.

Invoices

Toku Code	Description
TK20600	Invoice not found on database.
TK20601	Invoice not found for a specific customer.
TK30600	Invoice had a logic conflict while attempting to delete it.
TK30601	Invoice had a logic conflict while attempting to create it.
TK30602	Invoice had a logic conflict while attempting to void it.
TK30603	Invoice had a logic conflict while attempting to edit it.
TK30604	Invoice already exists in an operation where it is not allowed.