Find summing values for account Suppose you want to know the total amount of cash withdrawals in the current period, use the get-aggregated-data API endpoint.
Use case
In this example, we will get the current summing value of an assigned summing group for a particular account.
Use case data
API parameters with values
Search for aggregation data of
transaction grouping MONTHLY_ACCOUNT_WITHDRAWAL_SUM_Rand
transactionGroupingCode=MONTHLY_ACCOUNT_WITHDRAWAL_SUM_R
related to account C001718025430
Sample API call
To retrieve the current the current summing value of an assigned summing group for a particular account, make the following API call.
Sample request
Below is an example request of the API call to retrieve the current summing value of an assigned summing group for a particular account.
cURL
Copy curl --location 'https://card-api.sandbox.tuumplatform.com/api/v1/get-aggregation-data?transactionGroupingCode=MONTHLY_ACCOUNT_WITHDRAWAL_SUM_R&accountId=C001718025430' \
--header 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJuYW1lIjoiTGlpdmEgS2FzdCIsImVtcGxveWVlSWQiOiJJRC0xMjU4IiwidGVuYW50Q29kZSI6Ik1CLkVVIiwiZXhwaXJ5RFRpbWUiOiIyMDI1LTAzLTA3VDA4OjQxOjIyIiwiZXhwIjoxNzQxMzM2ODgyLCJyb2xlcyI6WyJGVUxMX0NBUkRfTUFOQUdFTUVOVCIsIlNZU1RFTSJdfQ.0HCEeLryRK5fPTCX11ieLY5C4YrSRg69946Af8Hsz4o' Sample response
Below you find an example response body to the API call above.
Copy {
"errors": null,
"validationErrors": null,
"data": {
"accountId": "C001718025430",
"cardId": null,
"transactionGroupingCode": "MONTHLY_ACCOUNT_WITHDRAWAL_SUM_R",
"currentTransactionAmount": {
"amount": 50,
"currencyCode": "EUR"
},
"currentTransactionCount": 0,
"lastActualDate": "2028-12-25",
"aggregationEvents": [
{
"directionCode": "IN",
"transactionAmount": {
"amount": 50,
"currencyCode": "EUR"
},
"source": {
"sourceName": "CARD.ACCOUNT_TRANSACTION",
"sourceRef": "C001718027803"
},
"postingDate": "2028-12-25"
},
{
"directionCode": "IN",
"transactionAmount": {
"amount": 10,
"currencyCode": "EUR"
},
"source": {
"sourceName": "CARD.CARD_TRANSACTION",
"sourceRef": "C001718026304"
},
"postingDate": "2028-12-25"
},
{
"directionCode": "OUT",
"transactionAmount": {
"amount": 10,
"currencyCode": "EUR"
},
"source": {
"sourceName": "CARD.CARD_TRANSACTION",
"sourceRef": "C001718026304"
},
"postingDate": "2028-12-25"
}
]
}
} Result
The result of the API call is the dataset consisting of transactions summing amount of 50 and the related authorisation events.
