DocumentaçãoEstados HTTP
Consulte os estados HTTP padrão e a acção esperada pela integração.
Status HTTP
O status HTTP descreve o resultado do pedido à API. Não substitui o código próprio em error.code e não confirma, por si só, o estado financeiro da transacção.
Respostas de sucesso
| Status | Uso na API | O que confirma |
|---|---|---|
| 200 | Consulta concluída. | A API devolveu o recurso ou resultado pedido. |
| 201 | Cliente ou link criado. | O recurso foi registado na API. |
| 202 | Intenção de pagamento aceite para processamento. | A API recebeu a intenção. Não confirma aceitação pelo gateway nem liquidação. |
Respostas de erro
| Status | Significado | Acção inicial |
|---|---|---|
| 400 | Pedido ou formato inválido. | Leia error.code e corrija os dados do pedido. |
| 401 | Credencial ausente, inválida ou expirada. | Confirme a API key e o ambiente associado. |
| 403 | A conta ou a credencial não tem acesso permitido. | Confirme estado da conta e scopes atribuídos. |
| 404 | Rota ou recurso não encontrado no âmbito autorizado. | Confirme o caminho, ID, conta e ambiente. |
| 409 | Conflito de estado, referência ou idempotência. | Consulte o recurso. Para a mesma operação, reutilize a mesma chave de idempotência. |
| 422 | Os dados não passam uma validação de negócio. | Leia error.details e corrija os campos. |
| 429 | Limite de pedidos atingido. | Respeite Retry-After; não crie API keys adicionais para contornar o limite. |
| 500 | Falha interna da API. | Use meta.request_id ao contactar suporte. Numa escrita financeira, consulte o estado antes de repetir. |
| 503 | Serviço ou dependência temporariamente indisponível. | Aguarde a recuperação. Em escritas, mantenha a mesma chave e consulte o estado antes de iniciar outra operação. |
Status HTTP e estado financeiro
Um HTTP 2xx confirma apenas o resultado descrito pela rota. Em particular, 202 Accepted significa que a API guardou a intenção para processamento. Não apresente a transacção como paga sem confirmação final autenticada.