MonCashAPIby FedtopupSe connecter

Documentation de MonCashAPI

MonCashAPI permet à un site, une application ou un serveur d’encaisser des paiements MonCash en Haïti, puis de retirer l’argent reçu vers un numéro MonCash ou NatCash.

L’API est de type REST : des adresses prévisibles, des corps de requête et de réponse en JSON, des codes HTTP habituels, et une forme d’erreur unique.

Adresse de base

https://moncashapi.fedtopup.com/api/v1

La même API répond aussi sur l’hôte qui lui est dédié : https://api.moncashapi.fedtopup.com/v1. Les deux adresses sont équivalentes.

Toutes les requêtes se font en HTTPS. Les montants sont en gourdes (code HTG), en nombres entiers à la création. Les dates sont au format ISO 8601, en UTC.

Les objets

ChampTypeDescription
projectprojetUn site ou une application. Il porte un solde, des clés API et des webhooks. Voir Projets.
paymentpaiementUne somme qu’un client doit régler sur MonCash. Voir Paiements.
withdrawalretraitUne demande d’envoi de votre solde vers MonCash ou NatCash. Voir Retraits.
transactiontransactionUn paiement ou un retrait, vus dans une même liste. Voir Transactions.
webhook_endpointwebhookL’adresse de votre serveur qui reçoit les événements. Voir Webhooks.

Tous les points d’accès

GET/v1/accountle compte et sa licence
GET/v1/balancele solde du projet
POST/v1/paymentscréer un paiement
GET/v1/paymentslister les paiements
GET/v1/payments/:idlire un paiement
POST/v1/withdrawalsdemander un retrait
GET/v1/withdrawalslister les retraits
GET/v1/withdrawals/:idlire un retrait
GET/v1/transactionslister les transactions
GET/v1/transactions/:idlire une transaction
GET/v1/projectslister les projets
POST/v1/projectscréer un projet
GET/v1/projects/:idlire un projet
GET/v1/webhookslister les webhooks
POST/v1/webhooksenregistrer un webhook
DELETE/v1/webhooks/:idsupprimer un webhook
GET/v1/api-logsjournal des appels

Frais

Paiement reçu : 2,9 %, ajoutés au montant et réglés par le client. Retrait : 5 %, débités de votre solde en plus du montant envoyé.

Pour commencer tout de suite : Démarrage rapide.

Une question sur l’intégration ?