Balance Enquiry

The merchant can check the balance or balances for the various currencies they may have using the API.

POST https://transfer.dev.mypaygate.co/api/v1/wallets/balance

By currency, the endpoint retrieves the balance or balances. It returns the merchant account's currency wallets.

Query Parameters

Name	Type	Description
currency	String	The currency whose balances should be retrieved (Optional)

Headers

Name	Type	Description
x-api-key*	String	Base_64(merchant public key)

Sample Request (POST)

curl --location --request POST 'https://transfer.dev.mypaygate.co/api/v1/wallets/balance' --header 'x-api-key: {{BASE64(MERCHANT_PUBLIC_KEY)
}}'

Sample Response

200 OK: Provides an array of wallet balances for the specified currency.

{
  "isSuccessful": true,
  "responseCode": "00",
  "responseMessage": "Successful",
  "responseData": [
      {
          "balance": 160355.28,
          "countryCode": "NGA",
          "countryAvatar": "https://flagcdn.com/w320/ng.png",
          "currencyCode": "NGN",
          "currencyHtml": "U+020A6"
      },
      {
          "balance": 216790.00,
          "countryCode": "GHA",
          "countryAvatar": "https://flagcdn.com/w320/gh.png",
          "currencyCode": "GHS",
          "currencyHtml": "U+020B5"
      },
      {
          "balance": 200438.00,
          "countryCode": "CMR",
          "countryAvatar": "https://flagcdn.com/w320/cm.png",
          "currencyCode": "XAF",
          "currencyHtml": "&test;"
      },
      {
          "balance": 10015.00,
          "countryCode": "TZA",
          "countryAvatar": "https://flagcdn.com/w320/tz.png",
          "currencyCode": "TZS",
          "currencyHtml": "U+1234"
      },
      {
          "balance": 19902.00,
          "countryCode": "KEN",
          "countryAvatar": "https://flagcdn.com/w320/ke.png",
          "currencyCode": "KES",
          "currencyHtml": "&#75"
      },
      {
          "balance": 19455.00,
          "countryCode": "GMB",
          "countryAvatar": "https://flagcdn.com/w320/gm.png",
          "currencyCode": "GMD",
          "currencyHtml": "U+020A6"
      }
  ]
}

400 Bad Request: The server cannot process the request due to invalid syntax or malformed data.

{
  "isSuccessful": false,
  "responseCode": "58",
  "responseMessage": "Kindly ensure that your x-api-key was properly encoded"
}