GET BALANCE

  REQUIRED


After following the steps in the introduction section, you can integrate this API client by following the steps below.


INTRODUCTION


To check your balance, you need your API keys from your PayDunya account. So log in to your existing PayDunya account and access your API keys via the details link located just to the right of the application you created. You can then use these keys to call the getBalance API and view your balances.


 Note


⚠️ The balance returned by the getBalance API is an approximation and may not be exact. To obtain the exact balance, please log in directly to your PayDunya account.

The API accepts as a parameter the account number for which you want to retrieve the balance. This parameter is optional: if it is not provided, the API will automatically return the balances of your country accounts.

API Endpoints Without Parameters

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

HTTP GET Request


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"

Expected Response

 
   {
        "success":true,
        "description":"The balance returned by the API is an approximation and may not be exact. Please log in to your account to get the exact balance.",
        "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"
   }

API Endpoints With Parameters

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

HTTP GET Request


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"

Expected Response

 
   {
        "success":true,
        "description":"The balance returned by the API is an approximation and may not be exact. Please log in to your account to get the exact balance.",
        "Balance SN":"738612.00 XOF",
   }

Failure Cases

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

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