Pagamento por Referência
Versão Legacy
Esta secção documenta a versão legacy da API IZI Pay Reference Payments & GPO. Destina-se a comerciantes e integrações que ainda não migraram para a versão mais recente da API. Implementações existentes podem continuar a usar esta versão enquanto planeiam o caminho de migração para a plataforma de API atual.
A API usa URLs previsíveis, aceita payloads JSON, devolve respostas JSON e segue códigos de estado HTTP padrão para sucesso e tratamento de erros.
Ambientes
Disponibilizamos dois ambientes para apoiar o seu fluxo de desenvolvimento:
- Produção:
https://pay.izipay.ao - Sandbox:
https://pay-sandbox.izipay.ao
Códigos de Retorno
A validação de campos ocorre antes de o recurso solicitado ser processado.
2xx- sucesso.4xx- erro de validação/autorização/pedido.5xx- erro interno da plataforma IZI Pay.
| Código | Estado | Definição |
|---|---|---|
| 200 | OK | O recurso solicitado foi processado e devolvido com sucesso. |
| 201 | Created | Recurso criado com sucesso; deve existir um cabeçalho Location a indicar o URI do novo recurso. |
| 204 | No Content | Recurso atualizado ou eliminado com sucesso. |
| 400 | Bad Request | O pedido não pôde ser interpretado. Verifique a sintaxe dos dados submetidos. |
| 401 | Unauthorized | O cliente está desativado, a assinatura está incorreta ou não foi fornecida corretamente. |
| 402 | Payment Required | A assinatura está correta, mas a conta foi bloqueada por falta de pagamento. |
| 403 | Forbidden | Foi tentada uma ligação sem encriptação (use HTTPS), ou foi tentado o acesso a um recurso sem as permissões necessárias. |
| 404 | Not Found | O recurso/endpoint solicitado não foi encontrado, ou o formato submetido não é aceite. |
| 422 | Unprocessable Entity | O pedido foi recebido, mas contém parâmetros inválidos ou violações de regras de negócio (consulte o atributo errors). |
| 429 | Too Many Requests | Limite de taxa de pedidos atingido. Verifique o cabeçalho Retry-After. |
| 500 | Internal Server Error | Ocorreu uma falha na API IZI Pay. |
Respostas de endpoints de consulta
Endpoints de consulta (GET) podem devolver 200 OK mesmo quando não existem resultados; nesse caso, o corpo da resposta devolve um array/objeto vazio.
Autenticação HMAC
Visão Geral
A autenticação é realizada através de uma assinatura HMAC no cabeçalho Authorization.
- Esquema de segurança:
apiKey - Cabeçalho:
Authorization - Transporte obrigatório:
HTTPS
Para cada aplicação (App), são fornecidas as seguintes credenciais:
AppId(client id)AppSecret(client secret)
Nunca exponha o AppSecret em código do lado do cliente ou repositórios públicos.
Como Criar a Assinatura
Construa a string MAC no seguinte formato:
AppId + HTTP_METHOD + URI + TIMESTAMP_UNIX + NONCE + BASE64_MD5_PAYLOAD
Em seguida:
- Gere
HMAC-SHA256usando oAppSecret. - Codifique o resultado em Base64.
- Monte o cabeçalho da seguinte forma:
ApiKey AppId:hash:nonce:timestamp