Documentação
API e integração com o VonekaPay
Base URL
https://pay.get.co.mz/api/v1
Autenticação
A maioria dos endpoints exige um token Bearer. Obtenha-o com POST /auth/login ou POST /auth/register.
- Header:
Authorization: Bearer <token> - Alternativa:
X-Authorization: Bearer <token> - Query:
?api_token=<token>
Exemplo de login
POST https://pay.get.co.mz/api/v1/auth/login
Content-Type: application/json
Accept: application/json
{
"email": "seu@email.com",
"password": "sua_senha"
}
// Resposta: { "success": true, "data": { "user": {...}, "token": "..." } }
Esqueci a senha
POST /auth/forgot-password com {"email":"seu@email.com"}. Envia um link por email. POST /auth/reset-password com token, email e nova senha (mín. 8 caracteres, letras e números).
Criar pagamento (API Key da aplicação)
Use a API Key da aplicação no header Authorization: Bearer API_KEY e X-Application-Code: CODIGO-APP.
POST https://pay.get.co.mz/api/v1/payments
Authorization: Bearer API_KEY_DA_APLICACAO
X-Application-Code: CODIGO-APP
Content-Type: application/json
{"application_code":"CODIGO-APP","organization_id":"ORG-001","payment_method":"mpesa","invoice_number":"INV-001","amount":100,"destination_amount":100,"phone":"841234567"}
Consultar: GET /payments/{reference}. Exportar: GET /payments/export?export=csv (com auth). Para e-Mola use payment_method: "emola" e phone (telefone 9 dígitos, prefixo 86 ou 87). Callback C2B: POST /webhooks/emola/callback.
Endpoints principais
| Método | Endpoint | Descrição |
|---|---|---|
POST | /auth/register | Registar novo utilizador |
POST | /auth/login | Login (obter token) |
GET | /auth/me | Utilizador actual (requer auth) |
PUT | /auth/profile | Actualizar perfil (nome, email) |
POST | /auth/forgot-password | Pedir link redefinir senha |
POST | /auth/reset-password | Redefinir senha |
PUT | /auth/password | Alterar senha |
GET | /dashboard/stats | Estatísticas |
GET | /applications | Listar aplicações |
GET | /organizations | Listar organizações |
GET | /payments | Listar pagamentos (paginado) |
GET | /payments/export | Exportar CSV |
POST | /payments | Criar pagamento (API Key) |
GET | /accounts | Listar contas |
GET | /credentials | Listar credenciais |
GET | /webhooks | Histórico webhooks |
GET | /payment-methods | Métodos de pagamento (público) |
Códigos de erro comuns
- 400 – Requisição inválida
- 401 – Não autenticado
- 403 – Acesso negado
- 404 – Recurso não encontrado
- 422 – Validação (ex.: invoice_number duplicado, credencial duplicada aplicação+método)
Mais detalhes em SECURITY.md e README.md.