Jump to

• Request
• Response

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 preferred

  Default Value: false
• virtualAccountCcy: string
  Currency of the account
• virtualAccountNo: string
  Account Number for which balance check is done

Back to Top

Response

Supported Media Types

• application/json
• application/xml
• text/csv

201 Response

Returns message of success or failure

Body ()

Root Schema : BalanceWrapperServiceListDto

Type: object

Show Source

• data(optional): array data
• messages(optional): object BalanceServiceResponseDto

{
    "type":"object",
    "properties":{
        "messages":{
            "$ref":"#/definitions/BalanceServiceResponseDto"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/VamsTbAccountBalanceServiceDTO"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object VamsTbAccountBalanceServiceDTO

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/VamsTbAccountBalanceServiceDTO"
    }
}

Nested Schema : BalanceServiceResponseDto

Type: object

Show Source

• codes(optional): array codes
• status(optional): string

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "codes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/BalanceServiceResponseCode"
            }
        }
    }
}

Nested Schema : VamsTbAccountBalanceServiceDTO

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "lastUpdatedRefNo":{
            "type":"string"
        },
        "lastUpdatedBy":{
            "type":"string"
        },
        "lastUpdatedOn":{
            "type":"string",
            "format":"date"
        },
        "parentVirtualAccount":{
            "type":"string"
        },
        "amountBlocked":{
            "type":"number"
        },
        "unauthCr":{
            "type":"number"
        },
        "unauthDr":{
            "type":"number"
        },
        "unutilizedOdAmount":{
            "type":"number"
        },
        "currentBalance":{
            "type":"number"
        },
        "virtualAccountCcy":{
            "type":"string"
        },
        "virtualAccountNo":{
            "type":"string"
        },
        "effectiveBal":{
            "type":"number"
        },
        "version":{
            "type":"number"
        },
        "childBlock":{
            "type":"number"
        },
        "childContributions":{
            "type":"number"
        },
        "benifitFromPool":{
            "type":"number"
        },
        "availableBal":{
            "type":"number"
        },
        "availableLineAmount":{
            "type":"number"
        },
        "tankedBalance":{
            "type":"number"
        },
        "virtualAccountDesc":{
            "type":"string"
        },
        "unAuthAmtBlk":{
            "type":"number"
        },
        "uncollectedAmt":{
            "type":"number"
        },
        "contributionDtoList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ContributionDTO"
            }
        },
        "childContributionList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/CcyWiseContributionDTO"
            }
        },
        "blockedChildContributionList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/CcyWiseContributionDTO"
            }
        },
        "ccyWiseAmount":{
            "type":"object",
            "additionalProperties":{
                "$ref":"#/definitions/ChildAccountBalance"
            }
        }
    }
}

Nested Schema : blockedChildContributionList

Type: array

Show Source

• Array of: object CcyWiseContributionDTO
  Cross Currency Contribution Details

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/CcyWiseContributionDTO"
    }
}

Nested Schema : ccyWiseAmount

Type: object

Additional Properties Allowed

Show Source

• object ChildAccountBalance

{
    "type":"object",
    "additionalProperties":{
        "$ref":"#/definitions/ChildAccountBalance"
    }
}

Nested Schema : childContributionList

Type: array

Show Source

• Array of: object CcyWiseContributionDTO
  Cross Currency Contribution Details

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/CcyWiseContributionDTO"
    }
}

Nested Schema : contributionDtoList

Type: array

Show Source

• Array of: object ContributionDTO

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ContributionDTO"
    }
}

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

{
    "description":"Cross Currency Contribution Details",
    "type":"object",
    "properties":{
        "currency":{
            "description":"Child Currency",
            "type":"string"
        },
        "amount":{
            "description":"Child Contribution Amount",
            "type":"number"
        },
        "exchangeRate":{
            "description":"Exchange Rate for Child Currency to Account Currency",
            "type":"number"
        },
        "accountCurrency":{
            "description":"VirtualAccount Currency",
            "type":"string"
        },
        "amountInAccCurrency":{
            "description":"Amount in VirtualAccount Currency",
            "type":"number"
        }
    }
}

Nested Schema : ChildAccountBalance

Type: object

Show Source

• childBlock(optional): number
• childContribution(optional): number

{
    "type":"object",
    "properties":{
        "childContribution":{
            "type":"number"
        },
        "childBlock":{
            "type":"number"
        }
    }
}

Nested Schema : ContributionDTO

Type: object

Show Source

• amount(optional): number
• ccy(optional): string

{
    "type":"object",
    "properties":{
        "ccy":{
            "type":"string"
        },
        "amount":{
            "type":"number"
        }
    }
}

Nested Schema : codes

Type: array

Show Source

• Array of: object BalanceServiceResponseCode

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/BalanceServiceResponseCode"
    }
}

Nested Schema : BalanceServiceResponseCode

Type: object

Show Source

• Code(optional): string
• Desc(optional): string
• Language(optional): string
• Type(optional): string

{
    "type":"object",
    "properties":{
        "Code":{
            "type":"string"
        },
        "Desc":{
            "type":"string"
        },
        "Type":{
            "type":"string"
        },
        "Language":{
            "type":"string"
        }
    }
}

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.

Back to Top