Case 1

Fetching list of value dated balances for the top N virtual accounts with respect to available balance for a selected virtual entity and currency. It fetched the

Prop_id: virtualAccounts.valueDated.DEFAULT

URL:GET + /digx-vam/v1/aggregator/resource/virtualAccounts

Request Parameters:

data: valueDated

maxRecords: 5 (Integer for number of virtual accounts)

q:

• virtualEntityId - the selected virtual entity id filter on virtual accounts
• vStatus – only open virtual accounts to be fetched
• availableBalance.currency – the selected currency filter on virtual accounts

sortParams:

• sortBy : availableBalance.amount
• sortOrder: DESC (Fetches top N)

Response:

{
            "aggregatedData": {
                "resource": "virtualAccounts",
                "groups": [{
                    "id": {
                        "displayValue": "xxxxxxxxxxxx0096",
                        "value": "C56C880F40EA1F354870342328EED1323799A835BE1813AA"
                    },
                    "intervals": [{
                        "amount": {
                            "currency": "GBP",
                            "amount": -165
                        },
                        "date": "2018-10-02T00:00:00"
                    }]
                }]
            }
        }

Id - is the virtual account number each group in groups array represents the balance for the value date in the group.

Case 2

Fetching list of virtual accounts for a selected virtual entity and group the virtual accounts based on the currency and aggregate the availableBalance of the virtual account to provide currency wise distribution to the user.

Prop_id: virtualAccounts.availableBalance.DEFAULT

URL: GET + /digx-vam/v1/aggregator/resource/virtualAccounts

Request Parameters:

data: availableBalance

grouping: Currency,Program or Program,Currency

q:

• virtualEntityId - the selected virtual entity id filter on virtual accounts
• vStatus – only open virtual accounts to be fetchedvStatus – only open virtual accounts to be fetched

sortParams:

• sortBy : availableBalance.amount
• sortOrder: DESC (Fetches top N)

Response:

{
            "aggregatedData": {
                "resource": "virtualAccounts",
                "groups": [{
                    "id": "EUR",
                    "intervals": [{
                        "amount": {
                            "currency": "EUR",
                            "amount": 1329
                        },
                        "count": 2
                    }]
                }]
            }
        }
               

Each group in the groups array represents the currency and its sum for the virtual accounts satisfying the criteria in the request and the number of virtual accounts in that criteria.