Get the balance for all the virtual accounts of a structure
get
/service/structureaccountbalances
This endpoint is used to get the balance for all the virtual accounts of a structure.
Request
Supported Media Types
- application/json
- application/xml
Query Parameters
-
sync(optional): boolean
Specify true/false if sync/async processing is preferredDefault Value:
false
-
virtualAccountCcy: string
Currency of the account
-
virtualAccountNo: string
Account Number for which balance check is done
Response
Supported Media Types
- application/json
- application/xml
- text/csv
201 Response
Returns message of success or failure
Nested Schema : VamsTbAccountBalanceServiceDTO
Type:
Show Source
object
-
amountBlocked(optional):
number
-
availableBal(optional):
number
-
availableLineAmount(optional):
number
-
benifitFromPool(optional):
number
-
blockedChildContributionList(optional):
array blockedChildContributionList
-
ccyWiseAmount(optional):
object ccyWiseAmount
Additional Properties Allowed: ChildAccountBalance
-
childBlock(optional):
number
-
childContributionList(optional):
array childContributionList
-
childContributions(optional):
number
-
contributionDtoList(optional):
array contributionDtoList
-
currentBalance(optional):
number
-
effectiveBal(optional):
number
-
lastUpdatedBy(optional):
string
-
lastUpdatedOn(optional):
string(date)
-
lastUpdatedRefNo(optional):
string
-
parentVirtualAccount(optional):
string
-
tankedBalance(optional):
number
-
unAuthAmtBlk(optional):
number
-
unauthCr(optional):
number
-
unauthDr(optional):
number
-
uncollectedAmt(optional):
number
-
unutilizedOdAmount(optional):
number
-
version(optional):
number
-
virtualAccountCcy(optional):
string
-
virtualAccountDesc(optional):
string
-
virtualAccountNo(optional):
string
Nested Schema : blockedChildContributionList
Type:
Show Source
array
-
Array of:
object CcyWiseContributionDTO
Cross Currency Contribution Details
Nested Schema : childContributionList
Type:
Show Source
array
-
Array of:
object CcyWiseContributionDTO
Cross Currency Contribution Details
Nested Schema : CcyWiseContributionDTO
Type:
object
Cross Currency Contribution Details
Show Source
-
accountCurrency(optional):
string
VirtualAccount Currency
-
amount(optional):
number
Child Contribution Amount
-
amountInAccCurrency(optional):
number
Amount in VirtualAccount Currency
-
currency(optional):
string
Child Currency
-
exchangeRate(optional):
number
Exchange Rate for Child Currency to Account Currency
202 Response
Error message or validations that occur
401 Response
Unauthorized request error, invalid credentials
403 Response
Request denied, no permission to access the request.
405 Response
Request denied, invalid input.
500 Response
Internal server error.