Códigos de status
A PagBank usa códigos de resposta HTTP convencionais para indicar o sucesso ou a falha de uma solicitação de API. Em geral: Os códigos no intervalo 2xx
indicam sucesso. Os códigos no intervalo 4xx
indicam um erro que falhou dadas as informações fornecidas (por exemplo, um parâmetro obrigatório foi omitido, uma cobrança falhou etc.). Os códigos no intervalo 5xx
indicam um erro com os servidores da PagBank.
A seguir você encontra os códigos de status utilizados nas APIs do PagBank com descrições sobre a possível origem dos problemas encontrados.
Código de status HTTP | Descrição | Cenário |
---|---|---|
400 | Bad Request | Quando ocorre um parâmetro mal formatado ou um valor inesperado na requisição, você receberá uma resposta com o HTTP Status 400. Esse status indica que não podemos prosseguir com a operação. É importante verificar o conteúdo enviado na requisição e corrigir o erro antes de fazer uma nova requisição. Esses erros normalmente são classificados em duas categorias: • Parâmetro obrigatório não informado (código: 40001). • Dado inválido (código: 40002). Para auxiliá-lo, o corpo da resposta incluirá informações sobre o erro encontrado e o tipo do erro. |
401 | Unauthorized | Requisições que retornam esse status de erros ocorrem devido a problemas na identificação do cliente que está utilizando a API. Pode ser causado pela falta do header Authorization ou por um valor inválido informado em um dos campos do header. É importante garantir que os dados de autenticação sejam fornecidos corretamente para evitar esse tipo de erro. |
403 | Forbidden | Esses erros são retornados quando o cliente ou integrador tenta acessar uma API ou recurso para o qual ainda não possui permissão de acesso. É importante destacar que o acesso em ambiente de produção é habilitado após o processo de homologação. |
404 | Not Found | Esse status é retornado principalmente em operações de consulta, quando o identificador informado não existe ou em casos em que ocorre um problema de sincronização da transação nos serviços do PagBank. |
406 | Not Acceptable | Esse status é retornado quando o método utilizado na requisição está incorreto. Por exemplo, utilizar o método POST em um endpoint que aceita apenas requisições do tipo GET. |
409 | Conflict | Erros desse tipo indicam que a chave de idempotência fornecida já está em uso dentro do período determinado pelo produto. Essa funcionalidade de idempotência evita a duplicação acidental de requisições, permitindo que a mesma solicitação seja executada apenas uma vez dentro do período estabelecido. |
500 | Internal Server Error | Esse status ocorre quando o webservice não consegue identificar o erro específico. Caso esteja recebendo esse erro, nos contacte e abra um chamado utilizando esse link |
Códigos de erro
Cada serviço disponibilizado pelas APIs do PagBank podem retornar códigos de erro únicos. Esses códigos são disponibilizados para que você consiga identificar de forma mais fácil e direta a causa do problema. Utilize os links disponibilizados a seguir para acessar cada uma das páginas de código de erro existentes:
Updated 11 months ago