Rate limit
Todas as chamadas das APIs de autenticação possuem um rate limit de 10 requisições por segundo. As chamadas para as APIs de validação possuem um rate limit de 20 requisições por segundo. Caso esse limite seja atingido você receberá um retorno de um erro com HTTP status code 429.
Além disso, há um rate limit específico para validações de chaves Pix ou dados bancários, limitado a 12 tentativas por hora para a mesma chave ou conjunto de dados bancários completos. Se esse limite for ultrapassado, também será retornado um erro com o HTTP status code 429 e código de erro CCE_7.
Response de erro
Os erros listados abaixo são agrupados por contexto e pode ser apresentado em situações diversas. O erro contêm:
data: Informações adicionais.error: Descrição do erro.errorCode: Estes códigos e descrições do erro são listados abaixo conforme o contexto do produto (validações, Pix, Destination Bank Account...).field: Informações adicionais.message: Mensagem de erro.statusCode: Código do erro.
Exemplo de response:
{
"data": {
"maxLength": 8,
"minLength": 7
},
"error": "Bad Request",
"errorCode": "DBA_6",
"field": "account",
"message": "Account is required and must have between 7 and 8 numbers (Agency: 0001 / Account: 111111 / Value: 10)",
"statusCode": 400
}Validações
| Código | Mensagem |
|---|---|
| CCE_1 | Micro deposit is not allowed for your account * |
| CCE_2 | Specify the micro deposit value is not allowed for your account * |
| CCE_3 | Description is only allowed in Pix validations * |
| CCE_4 | Pix description can not be greater than 140 characters |
| CCE_5 | The Pix description cannot contain unsafe html tags |
| CCE_6 | Basic validation is not allowed for your account * |
| CCE_7 | Micro deposit validation limit exceeded for this bank account or Pix key |
Para habilitar este recurso é só entrar em contato com o nosso suporte pelo email [email protected]
Destination Bank Account (DBA)
Código | Mensagem |
|---|---|
DBA _ 1 | Dígito da agência é obrigatório e deve ser numérico ou x |
DBA _ 2 | Dígito da conta é obrigatório e deve ser numérico ou x |
DBA _ 3 | Agência deve ser 1 |
DBA _ 4 | Agência é obrigatória e deve conter no máximo {maxLength} números |
DBA _ 5 | Dígito da agência deve ter apenas 1 dígito |
DBA _ 6 | Conta é obrigatória e deve conter no máximo {maxLength} números |
DBA _ 7 | Conta é obrigatória e deve conter entre {minLength} e {maxLength} números |
DBA _ 8 | Dígito da Conta é obrigatório e deve ter apenas 1 dígito |
DBA _ 9 | Conta do banco é obrigatória e deve conter exatamente {exactLength} números |
DBA _ 10 | Tipo de conta inválido |
DBA _ 11 | Tipo de conta 'Entidade pública' é disponível somente para CNPJ Tipo de conta 'Entidade pública' só permite pessoa jurídica. |
DBA _ 12 | Documento do favorecido não é um CPF nem CNPJ Documento {document} não é um CPF ou CNPJ |
DBA _ 13 | O CPF ou CNPJ está bloqueado Documento {document} está bloqueado |
DBA _ 15 | O nome é obrigatório |
DBA _ 19 | Dígito da Agência não é válido |
DBA _ 20 | Conta ou dígito verificador da conta inválido. Dígito verificador da conta inválido. |
DBA _ 21 | Conta inválida. |
DBA _ 22 | Agência não existe |
DBA _ 23 | Documento não existe |
DBA _ 24 | Nome informado não coincide com o nome no Documento |
DBA _ 26 | Conta inválida. O inicio da conta {accountBeginning} não é reconhecido como um tipo válido. |
DBA _ 27 | CNPJ {document} inválido |
DBA _ 28 | CPF {document} inválido |
DBA _ 29 | Agência, tipo da conta, conta ou dígito verificador da conta inválido. |
DBA _ 30 | Agência, conta ou dígito verificador da conta inválido. |
DBA _ 33 | Bank Code is required and must have a maximum of 3 numbers |
DBA _ 34 | This banking institution is not eligible to receive payments |
DBA _ 35 | The name must have at least 3 characters |
DBA _ 41 | Bank ISPB is required and must have exactly 8 numbers |
DBA _ 42 | This banking institution is not eligible to receive payments |
DBA _ 44 | Destination Bank Account was provided with bank code and ISPB, please provide only one bank info |
DBA _ 45 | Bank code or ISPB are required |
DBA _ 48 | Inconsistency in the registration status of the document |
Chave Pix
| Código | Mensagem |
|---|---|
| PIX_1 | Invalid PIX key type |
| PIX_2 | The email must be valid |
| PIX_4 | The phone number must be valid |
| PIX_15 | Pix key not found |
| PIX_28 | Format of EVP key is invalid |
| PIX_29 | Inconsistency in the registration status of the document |
| PIX_33 | The document format is invalid |
| PIX_34 | Document does not exist |
| PIX_35 | Informed document is divergent from Pix key owner |
| PIX_36 | Invalid phone key area code |
HTTP status codes
Código | Descrição |
|---|---|
200 | OK |
201 | Created |
204 | No Content |
400 | Requisição inválida |
401 | Não autenticado |
403 | Não autorizado |
429 | Too Many Requests |
5xx | Ocorreu algum erro interno no servidor. |