Jump to

• Request
• Response

Fetches top five virtual accounts current balances based on a currency for a real customer number

get

/service/topFiveVirtualAccBalances

This endpoint is used to fetch the top five virtual accounts current balances based on a currency for a real customer number.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

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

Header Parameters

• sourceCode: string
  Source Code

Back to Top

Response

Supported Media Types

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

200 Response

Returns list of top five virtual accounts based on the current balances and currency for a real customer number

Headers

• Location: string

Body ()

Root Schema : TopFiveVirtualAccBalancesCollection

Type: object

Collection of top five virtual accounts current balances based on currencies for a real customer number

Show Source

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

{
    "description":"Collection of top five virtual accounts current balances based on currencies for a real customer number",
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/TopFiveVirtualAccBalancesDTO"
            }
        },
        "paging":{
            "$ref":"#/definitions/PagingDto"
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object TopFiveVirtualAccBalancesDTO

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

Nested Schema : PagingDto

Type: object

Show Source

• totalResults(optional): integer

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

Nested Schema : TopFiveVirtualAccBalancesDTO

Type: object

Show Source

• currency(optional): string
  Virtual Account Currency
• currentBalance(optional): number
  Current Balance
• virtualAccountName(optional): string
  Virtual Account number
• virtualAccountNo(optional): string
  Virtual Account number

{
    "type":"object",
    "properties":{
        "virtualAccountNo":{
            "type":"string",
            "description":"Virtual Account number"
        },
        "currency":{
            "type":"string",
            "description":"Virtual Account Currency"
        },
        "currentBalance":{
            "type":"number",
            "description":"Current Balance"
        },
        "virtualAccountName":{
            "type":"string",
            "description":"Virtual Account number"
        }
    }
}

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