Códigos de erro
Código de erro apresentado sob a forma [PREFIXO]_[CODE] onde:
| [PREFIXO] | define a camada aplicativa na qual ocorreu o erro |
| [CÓDIGO] | é o código numérico do erro. |
Há diferentes prefixos:
| PREFIXO | Descrição | EXEMPLO DE ERRO |
|---|---|---|
| ACQ | Erro na parte adquirente | ACQ_001 |
| AUTH | Erro de autenticação | AUTH_149 |
| CLIENT | Aplicação JavaScript (no navegador do comprador) | CLIENT_003 |
| INT | Erro de integração (na parte Estabelecimento Comercial) | INT_007 |
| PSP | Erro na parte PSP | PSP_001 |
Os erros são retornados via 4 parâmetros:
{
"errorCode": "INT_015",
"errorMessage": "invalid customer email",
"detailedErrorCode": null,
"detailedErrorMessage": "Invalid input value [name=customer.email, value=fake-email]"
}| Parâmetro | TYPE DESCRIPTION | FORMATO | Comprimento máximo (LENGTH) |
|---|---|---|---|
| errorCode | string Código de erro (no formato [PREFIXO]_[CÓDIGO]) | String | 7 |
| errorMessage | string Mensagem de erro | String | 127 |
| detailedErrorCode | string Código de erro detalhado (ou null) | String | 127 |
| detailedErrorMessage | string Mensagem detalhada (ou null) | String | 127 |
Os códigos de erro seguintes são descritos aqui:
Novos códigos de erro poderão ser adicionados no futuro. Sua implementação deve obrigatoriamente levar esta possibilidade em conta.