Jump to

• Request
• Response

Fetches currency wise balance for virtual account numbers for real customer number

get

/service/currencyWiseBalance

This endpoint is used to fetch the currency wise balance for virtual account numbers for a real customer number.

Request

Supported Media Types

• application/json

Query Parameters

• currency(optional): string
  Currency Code
• realCustomerNo: string
  Customer Number
• virtualEntityId(optional): string
  Virtual Entity ID

Header Parameters

• sourceCode: string
  Source from which request is initiated

Back to Top

Response

Supported Media Types

• application/json

200 Response

Returns list of currencies, count of virtual accounts and corresponding sum of current balances

Headers

• Location: string

Body ()

Root Schema : CurrencyWiseBalanceCollection

Type: object

Collection of currencies, count of virtual accounts and corresponding sum of current balances

Show Source

• data(optional): array data
• paging(optional): object PagingDto

{
    "description":"Collection of currencies, count of virtual accounts and corresponding sum of current balances",
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/CurrencyWiseBalanceDTO"
            }
        },
        "paging":{
            "$ref":"#/definitions/PagingDto"
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object CurrencyWiseBalanceDTO

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

Nested Schema : PagingDto

Type: object

Show Source

• totalResults(optional): integer

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer"
        }
    }
}

Nested Schema : CurrencyWiseBalanceDTO

Type: object

Show Source

• currency(optional): string
  Virtual Account Currency
• currentBalances(optional): number
  Sum of Current Balance of Virtual Accounts
• virtualAccountCount(optional): integer
  Count of Virtual Accounts

{
    "type":"object",
    "properties":{
        "currency":{
            "type":"string",
            "description":"Virtual Account Currency"
        },
        "virtualAccountCount":{
            "type":"integer",
            "description":"Count of Virtual Accounts"
        },
        "currentBalances":{
            "type":"number",
            "description":"Sum of Current Balance of Virtual Accounts"
        }
    }
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

405 Response

Invalid input

500 Response

Internal error

Back to Top