GET BALANCE

  OBLIGATOIRE


Après avoir suivi les étapes se trouvant dans la partie introduction, vous pouvez intégrer dès lors ce client API en suivant les étapes ci-dessous.


INTRODUCTION


Pour vérifier votre solde, vous avez besoin de vos clés API dans votre compte PayDunya. Connectez-vous donc à votre compte PayDunya déjà créé et accédez à vos clés d'API via le lien détails situé juste à droite de l'application que vous avez créée. Vous pourrez ensuite utiliser ces clés pour effectuer un appel à l'API getBalance et consulter vos soldes.


 Note


⚠️ Le solde renvoyé par l'API getBalance est une approximation et peut ne pas être exact. Pour obtenir le solde exact, merci de vous connecter directement à votre compte PayDunya.

L'API accepte en paramètre le numéro de compte dont vous souhaitez récupérer le solde. Ce paramètre est optionnel : s’il n’est pas renseigné, l’API retournera automatiquement les soldes de vos comptes pays.

Endpoints de l’API sans paramètres

https://app.paydunya.com/api/v2/disburse/check-balance

Requête GET HTTP


curl -H "Content-Type: application/json" \
-H "PAYDUNYA-MASTER-KEY: wQzk9ZwR-Qq9m-0hD0-zpud-je5coGC3FHKW" \
-H "PAYDUNYA-PRIVATE-KEY: test_private_rMIdJM3PLLhLjyArx9tF3VURAF5" \
-H "PAYDUNYA-TOKEN: kdzhgrugeyegruzf" \
-X GET \
"https://app.paydunya.com/api/v2/disburse/check-balance"

Réponse attendue

 
   {
        "success":true,
        "description":"Le solde envoy\u00e9 par l'API est une approximation, il n'est pas exact. Merci de vous connecter \u00e0 votre compte pour avoir le solde exact.",
        "Balance SN":"738612.00 XOF",
        "Balance CI":"202.00 XOF",
        "Balance BJ":"632329.00 XOF",
        "Balance TG":"195.00 XOF",
        "Balance ML":"0.00 XOF",
        "Balance BF":"0.00 XOF"
   }

Endpoints de l’API avec paramètres

https://app.paydunya.com/api/v2/disburse/check-balance/BSN000000000000

Requête GET HTTP


curl -H "Content-Type: application/json" \
-H "PAYDUNYA-MASTER-KEY: wQzk9ZwR-Qq9m-0hD0-zpud-je5coGC3FHKW" \
-H "PAYDUNYA-PRIVATE-KEY: test_private_rMIdJM3PLLhLjyArx9tF3VURAF5" \
-H "PAYDUNYA-TOKEN: kdzhgrugeyegruzf" \
-X GET \
"https://app.paydunya.com/api/v2/disburse/check-balance/BSN000000000000"

Réponse attendue

 
   {
        "success":true,
        "description":"Le solde envoy\u00e9 par l'API est une approximation, il n'est pas exact. Merci de vous connecter \u00e0 votre compte pour avoir le solde exact.",
        "Balance SN":"738612.00 XOF",
   }

Cas d'échec

 
   {
        "success": false,
        "message": "User not found"
   }

 
   {
        "success": false,
        "message": "Account user not found"
   }