Account Balance

This API method is used to retrieve Account balance

GET {base url}/api/v1/account/json/balance/

Headers

Name	Type	Description
Authorization*		Bearer {{secret key}}
Content-Type*	String	application/json

201: Created

Response

{
  "UGX": {
    "balance": 2710,
    "fee_sell": 2590,
    "reserved": 0,
    "gross_balance": 5300,
    "payout_balance": 1000,
    "payout_fee_sell": 0,
    "pending_payouts": 0,
    "payout_overdraft": 0,
    "pending_outgoing": 1500,
    "available_balance": 1210,
    "payout_gross_balance": 1000,
    "available_payout_balance": 1000
  }
}

Description

description:	Company Balance in a specific currency
gross_balance	Raw Company balance without any fees or reserved amounts subtracted
balance	Company gross balance with transaction fees subtracted
available_balance	Company balance currently available for withdrawal
reserved	Amount protected from withdrawal for an amount of time as per the brand configuration
pending_outgoing	Amount currently pending withdrawal
fee_sell	FeeSellinteger Fees applied to transactions