Catálogo de Erros
Formatação dos erros
Todas APIs da integração de escrituração retornam os erros de API formatados segundo a descrição a seguir:
Error Response Body
{
"title": "HTTP Status code name",
"description": "An english description of the error",
"translation": "Uma descrição em português do erro",
"code": "ERROR_UNIQUE_CODE"
}
Tabela de erros possíveis no processo de homologação do emissor
| Código HTTP | Código do Erro | Título | Descrição (eng) | Tradução (pt-BR) |
|---|---|---|---|---|
| 400 | ISS000003 | Bad Request | Issuer already exists in database. | Emissor já existe na base de dados. |
| 404 | ISS000004 | Not Found | Issuer representative not found. | Representante do emissor não encontrado. |
| 404 | ISS000005 | Not Found | Bank account not found. | Conta bancária não encontrada. |
| 404 | ISS000006 | Not Found | Issuer document not found. | Documento do emissor não encontrado. |
| 404 | ISS000007 | Not Found | Issuer representative document not found. | Documento do representante do emissor não encontrado. |
| 404 | ISS000008 | Not Found | Issuer contact information not found. | Contato do emissor não encontrado. |
| 404 | ISS000009 | Not Found | Issuer not found. | Emissor não encontrado. |
| 404 | ISS0000010 | Not Found | Signer Group not found. | Grupo de assinantes não encontrado. |
| 400 | ISS0000011 | Bad Request | Issuer must be in status in_filling to allow this action. | Emissor deve estar no estado in_filling para permitir esta ação. |
| 400 | ISS0000018 | Bad Request | Document sent is invalid or quality is low. | Documento enviado é inválido ou de baixa qualidade. |
| 400 | ISS0000012 | Bad Request | Deleting the main account is not allowed, please set a new main account first. | Não é permitido deletar a conta principal, defina uma nova conta principal primeiro. |
| 400 | ISS0000013 | Bad Request | Deleting the main contact is not allowed, please set a new main contact first. | Não é permitido deletar o contato principal, defina um novo contato principal primeiro. |
| 400 | ISS0000014 | Bad Request | Issuer must have at least one contact information. | Emissor precisa ter ao menos uma informação de contato. |
| 400 | ISS0000015 | Bad Request | Tenant already has access to this issuer. | Acesso aos dados do emissor já foi concedido. |
| 400 | ISS0000016 | Bad Request | Failed trying to contact issuer, please retry. | Falha ao enviar mensagem ao emissor, tente novamente. |
| 400 | ISS0000017 | Bad Request | Invalid link. | Link inválido. |
Tabela de erros possíveis no processo de homologação do investidor
| Código HTTP | Código do Erro | Título | Descrição (eng) | Tradução (pt-BR) |
|---|---|---|---|---|
| 400 | INV000003 | Bad Request | Investor already exists in database. | Emissor já existe na base de dados. |
| 404 | INV000004 | Not Found | Investor representative not found. | Representante do emissor não encontrado. |
| 404 | INV000005 | Not Found | Bank account not found. | Conta bancária não encontrada. |
| 404 | INV000006 | Not Found | Investor document not found. | Documento do emissor não encontrado. |
| 404 | INV000007 | Not Found | Investor representative document not found. | Documento do representante do emissor não encontrado. |
| 404 | INV000008 | Not Found | Investor contact information not found. | Contato do emissor não encontrado. |
| 404 | INV000009 | Not Found | Investor not found. | Emissor não encontrado. |
| 404 | INV0000010 | Not Found | Signer Group not found. | Grupo de assinantes não encontrado. |
| 400 | INV0000011 | Bad Request | Investor must be in status in_filling to allow this action. | Emissor deve estar no estado in_filling para permitir esta ação. |
| 400 | INV0000018 | Bad Request | Document sent is invalid or quality is low. | Documento enviado é inválido ou de baixa qualidade. |
| 400 | INV0000012 | Bad Request | Deleting the main account is not allowed, please set a new main account first. | Não é permitido deletar a conta principal, defina uma nova conta principal primeiro. |
| 400 | INV0000013 | Bad Request | Deleting the main contact is not allowed, please set a new main contact first. | Não é permitido deletar o contato principal, defina um novo contato principal primeiro. |
| 400 | INV0000014 | Bad Request | Investor must have at least one contact information. | Emissor precisa ter ao menos uma informação de contato. |
| 400 | INV0000015 | Bad Request | Tenant already has access to this investor. | Acesso aos dados do emissor já foi concedido. |
| 400 | INV0000016 | Bad Request | Failed trying to contact investor, please retry. | Falha ao enviar mensagem ao emissor, tente novamente. |
| 400 | INV0000017 | Bad Request | Invalid link. | Link inválido. |
Tabela de erros possíveis no processo de emissão da nota comercial
| Código HTTP | Código do Erro | Título | Descrição (eng) | Tradução (pt-BR) |
|---|---|---|---|---|
| 400 | COM000001 | Bad Request | Document is not valid. | Documento fornecido não é válido. |
| 400 | COM000002 | Bad Request | Tenant must be configured before use this endpoint. | Tenant precisa ser configurado antes de utilizar este endpoint. |
| 409 | COM000003 | Conflict | Tenant configuration already exists. | Configuração para este tenant já existe. |
| 400 | COM000004 | Bad Request | Investor with key (investor_key) is not allowed. Please check. | Investidor com a chave (investor_key) não permitido. Cheque o cadastro. |
| 400 | COM000005 | Bad Request | Issuer with key (issuer_key) is not allowed. Please check. | Emissor com a chave (issuer_key) não permitido. Cheque o cadastro. |
| 400 | COM000006 | Bad Request | Operation with more than one investor functionality not available yet. | Operação com mais de um investidor não disponível ainda. |
| 404 | COM000007 | Not Found | Operation (operation_key) not found. | Operação (operation_key) não encontrada. |
| 403 | COM000008 | Forbidden | Operation (operation_key) does not belong to tenant. | Operação (operation_key) não pertence ao tenant. |
| 400 | COM000010 | Bad Request | Operations cannot be updated outside of in_filling status. | Operação não pode ser atualizada fora do status in_filling. |
| 404 | COM000011 | Not Found | Related party not found. | Parte relacionada não encontrada. |
| 400 | COM000012 | Bad Request | Related party (related_party_key) is not associated with operation (operation_key). | A parte relacionada (related_party_key) não está associada com a operação (operation_key). |
| 404 | COM000013 | Not Found | Signer Group not found. | Grupo de assinantes não encontrado. |
| 400 | COM000014 | Bad Request | Signer group (signer_group_key) is not associated with related party (related_party_key). | O grupo de assinantes (signer_group_key) não está associado com a parte relacionada (related_party_key). |
| 400 | COM000015 | Bad Request | Signer list does not match minimum required signers field. | Lista de assinantes não é compatível com o mínimo de assinantes enviado. |
| 404 | COM000016 | Not Found | Document not found. | Documento não encontrado. |
| 400 | COM000017 | Bad Request | Document (document_key) is not associated with related party (related_party_key). | O documento (document_key) não está associado com a parte relacionada (related_party_key). |
| 400 | COM000018 | Bad Request | Document sent is invalid or quality is low. | Documento enviado é inválido ou de baixa qualidade. |
| 400 | COM000019 | Bad Request | Delete issuer or investor is not allowed. | Não é possível deletar o emissor ou investidor. |
| 400 | COM000020 | Bad Request | Operation is in a final status and cannot be modified. | Operação já está em um estado final e não pode ser atualizada. |
| 400 | COM000021 | Bad Request | Operation is not in analysis. | Operação não está em análise. |
| 400 | COM000022 | Bad Request | Document not signed yet. | Documento ainda não foi assinado. |
| 400 | COM000023 | Bad Request | Document not available yet. | Documento ainda não foi gerado. |
| 400 | COM000024 | Bad Request | Failed to send document to signature, please retry. | Falha ao enviar documento para assinatura, tente novamente. |
| 404 | COM000025 | Not Found | Collateral not found. | Garantia não encontrada. |
| 400 | COM000026 | Bad Request | Collateral (collateral_key) is not associated with operation (operation_key). | A garantia (collateral_key) não está associada com a operação (operation_key). |
| 400 | COM000027 | Bad Request | Metadata not found. | Metadado não encontrado. |
| 400 | COM000028 | Bad Request | Operation is canceled and cannot be modified. | Operação está cancelada e não pode ser atualizada. |
Tabela de erros possíveis no processo de integralização de cotas
| Código HTTP | Código do Erro | Título | Descrição (eng) | Tradução (pt-BR) |
|---|---|---|---|---|
| 400 | INT000001 | Bad Request | Document is not valid. | Documento fornecido não é válido. |
| 404 | INT000002 | Not Found | Integralization process (integralizaion_key) not found. | Processo de integralização (integralizaion_key) não encontrado. |
| 403 | INT000003 | Forbidden | Integralization process (integralizaion_key) does not belong to tenant. | Processo de integralização (integralizaion_key) não pertence ao tenant. |
| 404 | INT000004 | Not Found | Subscription (subscription_key) not found. | Subscrição (subscription_key) não encontrada. |
| 400 | INT000005 | Bad Request | Subscription (subscription_key) is not associated with integralization process (integralizaion_key). | A subscrição (subscription_key) não está associada com o processo de integralização (integralizaion_key). |
| 404 | INT000006 | Not Found | Subscription payment not found. | Pagamento de subscrição não encontrado. |
| 400 | INT000007 | Bad Request | Subscription payment (subscription_payment_key) is not associated with subscription (subscription_key). | O pagamento de subscrição (subscription_payment_key) não está associado com a subscrição (subscription_key). |
| 400 | INT000008 | Bad Request | Subscription payment already analyzed. | Pagamento de subscrição já foi analisado. |
| 409 | INT000009 | Conflict | Integralization process for (operation_key) already exists. | Já existe um processo de integralização para a operação (operation_key). |
| 400 | INT000010 | Bad Request | Subscripted quantity (subscripted_quantity) is bigger than the available quantity (available_quantity). | A quantidade de cotas subscritas (subscripted_quantity) é maior do que a quantidade disponível (available_quantity). |
| 400 | INT000011 | Bad Request | Subscription is not waiting payment yet. | Subscrição ainda não está aguardando pagamento. |
| 400 | INT000012 | Bad Request | Subscription is in a final state and cannot be canceled. | Subscrição já está em um status final e não pode ser cancelada. |
| 400 | INT000013 | Bad Request | Subscription is not waiting payment yet. | Subscrição não está aguardando pagamento ainda. |
| 400 | INT000014 | Bad Request | Document not signed yet. | Documento ainda não foi assinado. |
| 400 | INT000015 | Bad Request | Integralization canceled. | Integralização cancelada. |
| 400 | INT000016 | Bad Request | Integralization cancellation denied. There are integralized quantities. | Cancelamento de integralização negado. Existem cotas integralizadas. |
| 400 | INT000017 | Bad Request | Creation of subscriptions for an ongoing operation is not available yet. | Ainda não é possível criar subscrições para operações em andamento. |
| 400 | INT000018 | Bad Request | To create a signature with data different from the original, you must define a recalculation method using the recalculation_method field. | Para criar uma subscrição com data diferente da original é preciso definir um método de recálculo através do campo recalculation_method. |