Código de status HTTP
Os códigos do padrão HTTP, retornados como resposta à requisição feita para a API, informam se as informações enviadas à API estão obtendo sucesso ao atingir nossos endpoints.
| Código | Status | Descrição | Exemplo de situações em que pode ocorrer |
|---|---|---|---|
| 200 | OK | Operação realizada com sucesso | Cobrança recorrente revisada Dados da cobrança recorrente Lista de cobranças recorrentes Lista de cobranças imediatas Lista dos Pix recebidos de acordo com o critério de busca Lista dos locations cadastrados de acordo com o critério de busca Dados da location do Payload Entidade representada pelo recurso informado desvinculada com sucesso Dados da recorrência Recorrência revisada Dados da solicitação da recorrência Cobrança imediata revisada. A revisão deve ser incrementada em 1. Dados da cobrança imediata. Dados da devolução Webhook para notificações acerca de Pix recebidos associados a um txid. Dados do webhook. Webhook para notificações. |
| 201 | Created | A solicitação foi realizada, resultando na criação de um novo recurso | Access Token Criado Cobrança imediata recorrente Cobrança recorrente criada Cobrança recorrente Dados da location do Payload Recorrência criada Dados da solicitação da recorrência Solicitação de recorrência atualizada Cobrança imediata criada Dados da devolução |
| 204 | Empty | Operação realizada com sucesso, mas nenhuma resposta foi retornada | Webhook para notificações foi cancelado. |
| 400 | Bad Request | A requisição possui parâmetro(s) inválido(s) | Requisição com formato inválido |
| 401 | Unauthorized | O token de acesso não foi informado ou não possui acesso às APIs | Erro credencial inválida |
| 403 | Forbidden | O acesso ao rescurso foi negado | Requisição de participante autenticado que viola alguma regra de autorização |
| 404 | Not Found | O recurso informado no request não foi encontrado | Recurso solicitado não foi encontrado |
| 503 | Service unavailable | Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento | Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento. |