Get Hold Balance

Value of funds accrued to a courier position

This could be sum total of redeemed reservations or failed payouts credited back to courier wallet.

Cited method confirms what this value is.


 

Definition

https://api.cashvaultng.com/stagmerce/GetMerchantHoldBalance?


Parameters

Query Params
merchantId:
required
string

Biler code for courier

Headers
ClientID:
required
string

Authentication Parameter

ClientSecretKey:
required
string

Authentication Parameter

Examples

Merchant Hold Balance

                            
                                https://api.cashvaultng.com/stagmerce/GetMerchantHoldBalance?merchantId=A00001
                            
                        

Result Format

200 Success 401 Invalid Merchant

                                    
                                        {
                                            "ResponseCode": "00",
                                            "ResponseDescription": "OK",
                                            "HoldBalance": 50586.20
                                        }
                                    
                                
                                    
                                        {
                                            "ResponseCode": "09",
                                            "ResponseDescription": "Access Denied",
                                            "HoldBalance": null
                                        }