Vue d'ensemble de l'API
L'API Owem Pay permet d'integrer les paiements PIX a votre systeme. Toutes les operations sont authentifiees via API Key + HMAC-SHA512.
URL de Base
| Environnement | URL |
|---|---|
| Production | https://api.owem.com.br |
Authentification
Toutes les requetes exigent :
- Auth Token -- JWT obtenu via
POST /api/v2/external/auth-token - HMAC-SHA512 -- Signature du body de la requete (obligatoire pour les endpoints transactionnels)
Consultez Auth Token et HMAC-SHA512 pour plus de details.
Format
| Champ | Format |
|---|---|
| Content-Type | application/json |
| Valeurs monetaires | Entier en centimes (R$ 100,00 = 10000) |
| Dates | ISO 8601 (2026-03-09T15:30:00Z) |
| IDs | UUID v4 ou chaine alphanumerique |
| E2E ID | E{ISPB}{YYYYMMDD}{HHMM}{6-digit-seq} |
Schema de Reponse
Succes
json
{
"worked": true,
"transaction_id": "PIXOUT20260309abcdef123456",
"status": "processing"
}Erreur
json
{
"worked": false,
"detail": "Saldo insuficiente"
}Codes HTTP
| Code | Signification |
|---|---|
| 200 | Succes |
| 400 | Parametres invalides |
| 401 | Token absent ou expire |
| 403 | HMAC invalide |
| 404 | Ressource introuvable |
| 422 | Validation echouee (solde insuffisant, cle invalide) |
| 429 | Limite de requetes depassee |
| 500 | Erreur interne |
Limitation de Debit
| Type | Limite |
|---|---|
| Par API Key | 120 requetes/minute |
| Par IP | 5 requetes/minute (sans authentification) |
En-tetes de reponse :
X-RateLimit-Limit: 120
X-RateLimit-Remaining: 117
X-RateLimit-Reset: 1709990520Idempotence
Les requetes d'ecriture (POST) acceptent l'en-tete Idempotency-Key pour eviter le traitement en double. Le resultat est mis en cache pendant 24 heures.
Idempotency-Key: unique-request-id-123Endpoints
| Methode | Endpoint | Description |
|---|---|---|
| POST | /api/v2/external/auth-token | Generer un token JWT |
| POST | /api/v2/external/pix/cash-out | Envoyer un PIX |
| POST | /api/v2/external/pix/cash-out/approve | Approuver un cash-out en attente |
| POST | /api/v2/external/pix/cash-in | Generer un QR Code pour reception |
| GET | /api/v2/external/transactions | Lister les transactions |
| GET | /api/v2/external/transactions/:id | Consulter une transaction par ID |
| GET | /api/v2/external/transactions/e2e/:e2e_id | Consulter par E2E ID |
| GET | /api/v2/external/transactions/tag/:tag | Consulter par tag |
| GET | /api/v2/external/transactions/:id/receipt | Recu |
| GET | /api/v2/external/balance | Solde du compte |
| GET | /api/v2/external/statement | Releve de compte |
| GET | /api/v2/external/pix/keys | Lister les cles PIX |
| POST | /api/v2/external/pix/refund | Remboursement PIX |
| GET | /api/v2/external/med | Lister les MEDs |
| GET | /api/v2/external/med/:id | Details MED |
| POST | /api/v2/external/cpf/validate | Valider un CPF |
| GET | /api/v2/external/webhooks | Lister les webhooks |
| POST | /api/v2/external/webhooks | Enregistrer un webhook |
| DELETE | /api/v2/external/webhooks/:id | Supprimer un webhook |