Error Catalog

Introduction

The Error Catalog is a section dedicated to listing all the error codes that can be returned by our API's. It serves as a reference guide to help our client quickly identify potential errors during interaction with the API methods. By consulting the catalog, you will be able to understand the most common causes of errors and how to efficiently handle them.

This section is essential to ensure that, when using the API, users are prepared to handle validation failures, operational issues, and internal problems. Each error is identified by a unique code, and its error message provides detailed information about the nature of the problem.

Error Code Structure

Each error code in the API follows a standardized structure, which includes two main components:

1. Prefix: The prefix of the error code is EXE, indicating an operational error. This prefix helps distinguish the error as one related to the execution or processing of the request.
2. Error Number: The error number is a sequential identifier that distinguishes each specific error. It is used to uniquely identify the error code. The number is assigned in increasing order for each unique error.
   1. Example Format: EXE[nnnnn], where [nnnnn] is the numeric identifier.
      1. Example: EXE0001 for "Account creation not allowed."
      2. Example: EXE0030 for "Account already exists."
   2. Error Message: Along with the error code, a message is returned that describes the error in detail and provides context about the cause of the problem.

Understanding the Table

The table below has been organized to facilitate the consultation and understanding of each error. It is divided into the following columns:

• Error Code: A unique identifier for each error, following the structure EXE[nnnnn]. Example: EXE0001, EXE0030.
• Error Message: A description that clearly explains the cause of the error. Example: "Account creation not allowed."
• Methods: A list of the API methods where this error can occur. Example: NewAccount, CreateAccount.

Account Opening Errors

Methods: CreateAccount, CreateLockerAccount, CompanyLimitedAccount, LimitedAccount, NewAccount

The Account Opening Errors section includes failures that occur during the process of creating accounts and registering new customers. These errors are associated with methods responsible for creating and managing accounts within the system. Errors may arise due to issues with the provided data, such as missing required fields, invalid data, or permission problems for creating new accounts.

Errors in this category help identify failures in the registration process, providing information on what needs to be corrected in order to successfully complete the account creation.

Update Errors

Methods: UpdatePersonData, ChangePersonInfo

Update Errors occur when there are failures during the process of updating personal data or information of already existing accounts. These errors are related to methods that allow modifying customer or account details within the system. They can happen due to inconsistent data, authentication failures, or permission issues when attempting to perform updates.

Rate and Limits Errors

Methods: AccountRate, AccountRateBatch, ChangeAccountOperationLimit

The Rates and Limits Errors section covers errors that occur during the application of rates and limits on accounts. This includes setting and verifying rates, controlling operational limits, and updating limit configurations. Errors in this category are common when there are issues applying, altering, or checking account limits, or when the rates provided do not meet system requirements.

Get and Document Errors

Methods: GetAccount, SendDocument, GetAccountAddres, GetAccountOperationLimit

Get and Document Errors are related to methods used for retrieving account information and associated documents. This category of errors occurs when there are failures in accessing or retrieving specific account data or when sending documents, such as during the identity verification process or account limit inquiries.