Query float balance

Request

Parameter	Type	Description	Required
function	string	Function being invoked	yes
countryCode	string	Country ISO code letter, i.e., `KE`,`GH`,`TZ`	yes
payload	object
payload.credentials	object
payload.credentials.username	string	The user name you created on sign-in	yes
payload.credentials.password	string	The Password you created on signin	yes
payload.packet	array
payload.packet.serviceCode	string	This is the product code used in identifying the service the customer is consuming e.g. `TIGOAIRTIME`	yes
payload.packet.narration	string	Text to be appended to the request	no

{
    "function": "BEEP.queryFloatBalance",
    "countryCode": "KE",
    "payload": {
        "credentials": {
            "username": "sandboxUser",
            "password": "sandboxPassword!"
        },
        "packet": [
            {
                "serviceCode": "KE-REMITTANCE-BANK-PAYOUT",
                "narration": "Kenya remittance query float"
            }
        ]
    }
}

Response

Once the request has been received by the Beep Payment gateway, the BEEP.queryFloatBalance function will return a multidimensional array consisting of two parts, an authStatus, and a results section. The parameters returned are shown in the table below.

Parameter	Type	Description	Required
authStatus	Object
authStatus.authStatusCode	Integer	Authentication status code.	Yes
authStatus.authStatusDescription	String	A narration/ description for the status code above.	Yes
results	Array
results.statusCode	Integer	The status of this transaction within the Beep system	Yes
results.statusDescription	String	A narration/ description for the status code above	Yes
results.balance	Double	Float balance available.	Yes
results.floatAccountName	String	The name of the service float account	Yes
results.currencyCode	string	The ISO code for the transaction currency.	Yes

{
    "statusCode": 418,
    "success": true,
    "message": "Processing was successful",
    "data": {
        "floatAccountName": "Payouts Demo CFA",
        "balance": 45346.8,
        "currencyID": 70,
        "currencyCode": "KES"
    }
}