Référence de l’API
L’API REST de Monerail : adresse de base, authentification et tous les points d’accès.
L’API Monerail est une API REST. Elle reçoit et renvoie du JSON, utilise les codes HTTP standard et s’authentifie par une clé secrète.
Adresse de base
https://api.monerail.com/v1Toutes les requêtes passent en HTTPS. Le mode (test ou production) dépend de la clé, pas de l’adresse.
Authentification
curl https://api.monerail.com/v1/balance \
-H "Authorization: Bearer mr_test_..."Voir Authentification pour les clés et les rôles.
Conventions
| Sujet | Règle |
|---|---|
| Corps | JSON, avec Content-Type: application/json. Les paramètres inconnus sont refusés. |
| Identifiants | UUID, par exemple 3b8f6c1e-2a47-4d1b-9e35-7c0a9d2f4e61. |
| Montants | Entiers en unités mineures (détails). |
| Dates | ISO 8601 en UTC. |
| Listes | Pagination par curseur (détails). |
| Requêtes POST | Acceptent une Idempotency-Key (détails). |
| Erreurs | Objet error avec type, code, message (détails). |
Le fichier OpenAPI 3.1 de l’API est disponible ici : openapi.json. Pour essayer l’API sans écrire de code, importez la collection Postman ; pour générer un client typé, voir Bibliothèques clientes.
Points d’accès
Solde
Encaissements
POST
/v1/collectionsCréer un encaissementGET/v1/collections/{id}Consulter un encaissementGET/v1/collectionsLister les encaissementsPOST/v1/collections/{id}/authorizeValider avec un codePOST/v1/collections/{id}/resend_otpRenvoyer le codePaiements
POST
/v1/payoutsCréer un paiementGET/v1/payouts/{id}Consulter un paiementGET/v1/payoutsLister les paiementsReversements
POST
/v1/settlementsCréer un reversementGET/v1/settlements/{id}Consulter un reversementGET/v1/settlementsLister les reversementsTransactions
Titulaires
POST
/v1/cardholdersCréer un titulairePOST/v1/cardholders/{id}/verificationEnvoyer la vérification d’identitéGET/v1/cardholders/{id}Consulter un titulaireGET/v1/cardholdersLister les titulairesCartes
POST
/v1/cardsCréer une carteGET/v1/cards/{id}Consulter une carteGET/v1/cardsLister les cartesPOST/v1/cards/{id}/fundRecharger une cartePOST/v1/cards/{id}/withdrawRetirer d’une cartePOST/v1/cards/{id}/freezeBloquer une cartePOST/v1/cards/{id}/unfreezeDébloquer une cartePOST/v1/cards/{id}/terminateRésilier une cartePoints de terminaison
POST
/v1/webhook_endpointsCréer un point de terminaisonGET/v1/webhook_endpoints/{id}Consulter un point de terminaisonGET/v1/webhook_endpointsLister les points de terminaisonDELETE/v1/webhook_endpoints/{id}Supprimer un point de terminaisonÉvénements
GET
/v1/eventsLister les événementsGET/v1/events/{id}Consulter un événementPOST/v1/events/{id}/retryRenvoyer un événement