1 of 1

Search account transactions

Use case

In this example, we will review how to fetch the account transactions.

Use case data

API parameters with values

Searching for transactions on the ID-1279 account.

...accounts/ID-1279/transactions...

The search from and to dates. The date format is: YYYY-MM-DD.

...search?dateFrom=2023-01-01&dateTo=2023-07-10...

The search data type is the posting date.

...&dateType=POSTING_DATE...

Requesting to display the search results on the first page; the page size is 5.

...&pageNumber=1&pageSize=5

You can use the following values for the dataType parameter: POSTING_DATE or VALUE_DATE.

Note:

POSTING_DATE - is always a current Tuum banking date when an account transaction was posted to the account API.
VALUE_DATE - is a date when an operation is actually carried out or is supposed to be carried out in the account.

Sample API call

To search the account transactions, make the following call.

https://account-api.sandbox.tuumplatform.com/api/v4/accounts/{accountId}/transactions/search

See more about the search account transactions endpoint in the Tuum developer portal.

Sample request

Below is the sample request to find account transactions.

https://account-api.{{env}}.{{domain}}/api/v4/accounts/ID-1279/transactions/search?dateFrom=2023-01-01&dateTo=2023-07-10&dateType=POSTING_DATE&pageNumber=1&pageSize=5

curl -L 'https://account-api.sandbox.tuumplatform.com/api/v4/accounts/ID-1279/transactions/search?dateFrom=2023-01-01&dateTo=2023-07-10&dateType=POSTING_DATE&pageNumber=1&pageSize=5' \
-H 'x-channel-code: SYSTEM' \
-H 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHBpcnlEVGltZSI6IjIwMjMtMDctMTBUMTc6MDk6MzUiLCJyb2xlcyI6WyJBRE1JTiJdLCJuYW1lIjoiSm9obiBPZmZpY2VyIiwiZW1wbG95ZWVJZCI6IjEiLCJ0ZW5hbnRDb2RlIjoiTUIiLCJleHAiOjE2ODkwMDg5NzV9.grNoFmnvoFcSb2IifdVKojVUQHZTwLU083wH2ci4fpc' \
-d ''

Sample response

Below you find an example response body to the API call above.

Response

{
    "errors": null,
    "validationErrors": null,
    "data": {
        "values": [
            {
                "accountTransactionId": "ID-1183",
                "groupId": "1190",
                "postingDate": "2023-07-01",
                "valueDate": "2023-07-01",
                "accountId": "ID-1279",
                "transactionTypeCode": "ACC_ADM_FEE",
                "transactionSubtypeCode": null,
                "directionCode": "OUT",
                "currencyCode": "EUR",
                "amount": 5.00,
                "initialBalanceAmount": 0.00,
                "filingCode": "2023070100001183",
                "details": "Account maintenance fee",
                "referenceNumber": null,
                "source": {
                    "sourceName": "ACCOUNT.ACCOUNT_PERIODIC_FEE",
                    "sourceRef": "ID-1063",
                    "sourceLink": null
                },
                "contractSource": null,
                "merchantInfo": null,
                "metaInfo": null,
                "createdDTime": "2023-07-01T00:00:09.294656Z",
                "endToEndId": null,
                "paymentServiceProviderCode": null,
                "transactionDTime": "2023-07-01T00:00:09.963737Z",
                "reversed": false,
                "virtualAccountId": null,
                "labels": [],
                "counterparty": null
            }
        ],
        "pageNumber": 1,
        "pageSize": 5,
        "endReached": true,
        "sort": null,
        "total": 1
    }
}

Result

The details of the existing account transactions are fetched.