Documentação para possíveis erros encontrados na emissão de boletos.
Repostas da requisição
Modelos de retorno existentes:
{
"status": 400,
"message": "{dueDate=Você não pode utilizar uma data de expiração menor que a data de hoje.}",
"path": "/api/bill-issuance/"
}
{
"status": 400,
"message": "Erro no momento de criação do boleto. Id do boleto não foi encontrado no nosso banco de dados.",
"path": "..."
}
{
"code": 0,
"message": "Estabelecimento não encontrado!"
}
Códigos de resposta
| Código de Status | Descrição |
|---|---|
| 0 | Estabelecimento não encontrado |
| 200 | Boleto simulado ou emitido e registrado com sucesso |
| 202 | Operação em andamento, consulte seu boleto em instantes |
| 204 | Emissão de cobrança realizada com sucesso |
| 400 | Parâmetros incorretos |
| 401 | Não Autorizado |
| 403 | Acesso Proibido |
| 404 | Recurso inexistente |
| 405 | Método não permitido |
| 422 | Dados informados estão fora do escopo definido para o campo |
| 428 | Pré-requisito necessário |
| 500 | Erro inesperado |
| 501 | Não implementado |
| 503 | Serviço indisponível |
| 504 | Time Out, consulte em instantes se seu boleto foi emitido |
Lista de erros
| HHTP Status | Mensagem de erro | Cenário |
|---|---|---|
| 400 | O valor mínimo para criação de um boleto é de R$5,00 em centavos. | Campo valueCents enviado com um valor menor que o permitido |
| 400 | Você precisa enviar o atributo "valueCents". | Campo valueCents não enviado |
| 400 | Você precisa enviar a data de vencimento. | Campo dueDate não enviado |
| 400 | Você não pode utilizar uma data de expiração menor que a data de hoje. | Campo dueDate enviado com uma data menor que o dia atual |
| 400 | Você precisa enviar os dados do cliente/pagador. | Objeto payer não foi enviado |
| 400 | Você precisa enviar o id de referência da venda. | Campo referenceId não foi enviado |
| 400 | O atributo "name" deve ser enviado e não pode ser vazio. | Um ou mais campos name não foram enviados ou estão sem informações |
| 400 | O atributo "email" deve ser enviado e não pode ser vazio. | Um ou mais campos email não foram enviados ou estão sem informações |
| 400 | O atributo "legalDocument" deve ser enviado e não pode ser vazio. | Um ou mais campos legalDocument não foram enviados ou estão sem informações |
| 400 | Erro no momento de criação do boleto. Você precisa enviar o atributo "address" do pagador. | Objetos address do pagador não foi enviado |
| 400 | O atributo "street" deve ser enviado e não pode ser vazio. | Um ou mais campos street não foram enviados ou estão sem informações |
| 400 | O atributo "number" deve ser enviado e não pode ser vazio. | Um ou mais campos number (número da residência) não foram enviados ou estão sem informações |
| 400 | O atributo "locality" deve ser enviado e não pode ser vazio. | Um ou mais campos locality não foram enviados ou estão sem informações |
| 400 | O atributo "city" deve ser enviado e não pode ser vazio. | Um ou mais campos city não foram enviados ou estão sem informações |
| 400 | O atributo "state" deve ser enviado e não pode ser vazio. | Um ou mais campos state não foram enviados ou estão sem informações |
| 400 | O atributo "postalCode" deve ser enviado e não pode ser vazio. | Um ou mais campos postalCode não foram enviados ou estão sem informações |
| 400 | Erro no momento de criação do boleto. Id do boleto não foi encontrado no nosso banco de dados. | Houve um problema ao resgatar os detalhes deste boleto após a criação no banco |
| 400 | Estabelecimento não encontrado! | O documento legal do beneficiário ( atributo legalDocument) não foi enviado, possui erros ou não está cadastrado em nossa base de dados |
| 400 | Nome/Razão social do pagador. Máximo caracteres: 50. | O nome completo ou razão social do pagador/sacado é maior do que 50 caracteres permitido. |
| 400 | Nome Fantasia do pagador. Máximo caracteres: 50 | O nome completo ou nome fantasia do pagador/sacado é maior do que 50 caracteres permitido. |
| 400 | Nome/Razão social do beneficiário. Máximo caracteres: 50. | O nome completo ou razão social do beneficiário/avalista é maior do que 50 caracteres permitido. |
| 400 | Nome do logradouro, número e complemento. Máximo caracteres: 45 | O campo de endereço do pagador/sacado é maior do que 45 caracteres permitido. |
| 400 | Nome do logradouro, número e complemento. Máximo caracteres: 45 | O campo de endereço do beneficiário/avalista é maior do que 45 caracteres permitido. |
| 400 | Nome do bairro. Máximo caracteres: 15 | O campo de bairro do pagador/sacado é maior do que 15 caracteres permitido. |
| 400 | Nome do bairro. Máximo caracteres: 15 | O campo de bairro do beneficiário/avalista é maior do que 15 caracteres permitido. |
| 400 | Nome da cidade. Máximo caracteres: 20 | O campo de cidade do pagador/sacado é maior do que 20 caracteres permitido. |
| 400 | Nome da cidade. Máximo caracteres: 20 | O campo de cidade do beneficiário/avalista é maior do que 20 caracteres permitido. |
| 400 | Sigla da UF. Máximo caracteres: 2 | O campo de UF/Estado do pagador/sacado é maior do que 2 caracteres permitido. |
| 400 | Sigla da UF. Máximo caracteres: 2 | O campo de UF/Estado do beneficiário/avalista é maior do que 2 caracteres permitido. |
| 400 | CEP / Código postal. Formato: 8 números, sem pontos e traços | O campo de CEP do pagador/sacado é maior do que 8 caracteres permitido. |
| 400 | CEP / Código postal. Formato: 8 números, sem pontos e traços | O campo de CEP do beneficiário/avalista é maior do que 8 caracteres permitido. |