HUhub2
Balance

Check Merchant Balance

Changed on

Returns a summary of a merchant accounts balances (collection, transfer, transfer irt and cross-border accounts). Use the accountType filter to restrict the response to specific accounts; omit it to get them all.

get/balance

Request

  • The document declares no server URL.
  • Auth
    none declared. Required headers: ApiKey, MerchantId, Environment

Query parameters

datestring
Example:2020-10-15T12:16:26.128Z

Get balance at Datetime in UTC timezone. Follows the Datetime ISO.

currencystring
Example:XOF

Three-letter ISO currency code.

accountTypestring[]

Restrict the response to specific accounts. Repeat the parameter or pass a comma-separated list, e.g. ?accountType=collection&accountType=cross-border or ?accountType=collection,cross-border. Omit it to get every account the merchant holds.

[
  "cross-border"
]

Headers

ApiKeystring required

Your api key. To create a key, please get into our dashboard. If you don't have access to it, please reach the Support team.

MerchantIdstring required

Your merchant ID. This information is available in our dashboard. If you don't have access to it, please reach the Support team.

Environment'live' | 'sandbox' required

Allow you to choose between the sandbox mode to perform some tests or the live mode for real world transactions.

Response

Example response

{
  "collectionAccount": [
    {
      "amount": 100,
      "availableBalance": 100,
      "currency": "XOF",
      "date": "2020-10-15T12:16:26.128Z"
    }
  ],
  "transferAccount": [
    {
      "availableBalance": 100,
      "reservedBalance": 100,
      "currency": "XOF",
      "date": "2020-10-15T12:16:26.128Z",
      "amount": 100
    }
  ],
  "transferIrtAccount": [
    {
      "availableBalance": 100,
      "reservedBalance": 100,
      "currency": "XOF",
      "date": "2020-10-15T12:16:26.128Z",
      "amount": 100
    }
  ],
  "crossBorderAccount": [
    {
      "availableBalance": 100,
      "reservedBalance": 100,
      "currency": "XOF",
      "date": "2020-10-15T12:16:26.128Z",
      "amount": 100
    }
  ]
}

Changes

  • f6d3f87df5e0Revision changes
    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • info

      added the new optional query request parameter accountType

    • info

      added the optional property to the response with the status

    • info

      added the required property // to the response with the status