All pages
Powered by GitBook
1 of 2

Loading...

Loading...

Request to generate account transactions report

Use case

In this example, we will review how to request to generate account transactions report.

Use case data
API parameters with values

The ID of the account from where the transactions report will be exported.

...accounts/ID-12333/transactions/export

The type of report file that is going to be generated. The exportFileType can be:

  • JSON or

  • CSV.

The transaction export time frame. For the dateType you can choose:

  • POSTING_DATE - is the current Tuum banking date when the account transaction was posted.

  • VALUE_DATE - is the date on which operation actually carries out or is supposed to carry out in the account. Must be the same or earlier than the posting date.

Sample API call

To request account transaction report, make the following call.

Sample request

In the sample below you will find information on how to request an account transactions report.

{
  "exportFileType": "JSON",
  "dateFrom": "2029-04-01",
  "dateTo": "2029-05-31",
  "dateType": "POSTING_DATE"
}
curl --location 'https://reports-api.sandbox.tuumplatform.com/api/v4/accounts/ID-12333/transactions/export' \
--header 'x-channel-code: system' \
--header 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJuYW1lIjoiT2ZmaWNlciBUZXN0IiwiZW1wbG95ZWVJZCI6IklELTEyMzgiLCJ0ZW5hbnRDb2RlIjoiTUIuRVUiLCJleHBpcnlEVGltZSI6IjIwMjUtMDMtMDdUMTg6MDA6NTYiLCJleHAiOjE3NDEzNzA0NTYsInJvbGVzIjpbIkFDQ09VTlRBTlQiLCJBRE1JTiJdfQ.BCgLd6S47mKEIZ0JG1ADMtc6ThjJlJPWPpv3pidIugk' \
--header 'Content-Type: application/json' \
--data '{
  "exportFileType": "JSON",
  "dateFrom": "2029-04-01",
  "dateTo": "2029-05-31",
  "dateType": "POSTING_DATE"
}'

Sample response

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

Response
{
    "errors": null,
    "validationErrors": null,
    "data": {
        "generationId": "ID-2864",
        "generationTypeCode": "ACCOUNT_TRANSACTIONS",
        "groupTypeCode": "ACCOUNT",
        "statusCode": "PENDING",
        "createdDTime": "2025-03-07T17:21:10.04Z",
        "inputJson": "{\"exportFileType\":\"JSON\",\"transactionType\":null,\"transactionSubtype\":null,\"dateFrom\":\"2029-04-01\",\"dateTo\":\"2029-05-31\",\"dateType\":\"POSTING_DATE\",\"directionCode\":null,\"amountFrom\":null,\"amountTo\":null,\"currencyCode\":null,\"contractNumber\":null,\"transactionGroupCodes\":null,\"referenceNumber\":null,\"counterpartyNameSubstring\":null,\"counterpartyAccountNumberSubstring\":null,\"detailsSubstring\":null,\"virtualAccountId\":null,\"source\":null,\"includeAccessRestricted\":false,\"uniqueIdentifier\":null}",
        "errorCode": null,
        "source": {
            "sourceName": "ACCOUNT",
            "sourceRef": "ID-12333"
        },
        "previewEnabled": false
    }
}

Note that the report generation process is asynchronous. Use the generationId parameter (ID-2864 in this example) to check the report status and retrieve the report in the subsequent steps.

Result

As a result, an account transaction report was requested.

Sample account transaction export file

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

See more about the endpoint in the Tuum developer portal.

Below, you will find a sample of transaction export file. This way the file is structured after being .

"exportFileType": "JSON"
"dateFrom": "2029-04-01",
"dateTo": "2029-05-31",
"dateType": "POSTING_DATE"
export account transactions
downloaded

Account transactions report parameters

On this page, you will find a list of parameters included in the account transactions report. The report is available in both CSV and JSON formats, with a similar parameter structure. The key difference is that in the JSON format, the following parameters are represented as nested objects:

  • transactionAmount: amount, currencyCode

  • initialBalanceAmount: amount, currencyCode

  • source: sourceName, sourceRef

  • counterparty: name, accountNumber, accountNumberSubtype, accountNumberCountryCode, financialInstitutionId

Parmeter name
Type
Description

transactionId

Number, Text

Transaction Id number.

Example: ID-275388

groupId

Number

Transaction groupId. Example: 290379

postingDate

Date

Posting date is the current Tuum banking date when the account transaction was posted to the Account API. Date format: YYYY-MM-DD. Example: 2029-04-01

accountId

Number, Text

The account number from where the account transactions are extracted. Example: ID-12333

transactionTypeCode

Text, Number

The transaction type code.

Example: ACC_ADM_FE

transactionSubtypeCode

Text

Transaction subtype.

directionCode

Text

Transaction direction. Example: OUT

initialBalanceAmount

Number

Initial balance amount. Example: 3989.97

transactionAmount

Number

Transaction amount. Example: 12.4

currencyCode

Text

Transaction currency. Example: EUR

counterpartyName

Text

Transaction counterparty name. Example: Simon Parker

counterpartyAccountNumber

Number, Text

Counterparty account number. Example: EE871275295834652820

counterpartyAccountNumberTypeCode

Text

Counterparty account number type. Example: IBAN

counterpartyAccountNumberSubtype

Text

Counterparty account number subtype.

counterpartyAccountNumberCountryCode

Text

Counterparty account number country code. Example: EE

counterpartyFinancialInstitutionId

Number, Text

Counterparty financial institution Id. Example: PARXEE22XXX

counterpartyFinancialInstitutionIdTypeCode

Text

Counterparty financial institution type. Example: BIC

details

Text, Number

Transaction details. Example: Account maintenance fee

metaInfo

Text, Number

Transaction meta info. Example: {"paymentResidencyCountryCode":"LV","intrabankPaymentSource":null,"paymentMetaInfo":"[{"typeCode":"SELECTED_SCHEME","value":"SEPA_REGULAR"}]"}

merchantInfo

Text, Number

Merchant information.

endToEndId

Number

End to end Id. Example: 2222223

transactionDTime

Date, Time

Transaction date-time. Format: YYYY-MM-DDThh:mm:ss.sssZ Example: 2025-02-28T11:23:58.16Z

paymentServiceProviderCode

Text

Payment service provider code. Example: SEPA

labels

Text

Transaction labels. Example: SEPA_REGULAR

referenceNumber

Number, Text

Transaction reference number.

contractSourceName

Text

Contract source name. Example: LOAN.CONTRACT_HEADER

contractSourceRef

Number, Text

Contract source reference. Example: ID-1718026338

contractRef

Number, Text

Contract reference.

valueDate

Date

Value date is the date on which operation actually carries out or is supposed to carry out in the account. Must be the same or earlier than the posting date. Date format: YYYY-MM-DD. Example: 2029-04-01

isReversed

Text

Defines if the transaction is reversed. Example: false

reversedTransactionId

Number, Text

Id number of the reversed transaction.

filingCode

Number

Technical code assigned to the transaction record. Example: 2029040100275388

reportDateType

Text

Account transaction report date type. Example: POSTING_DATE

domainCode

Text

Domain code. Example: PMNT

familyCode

Text

Transaction family code. Example: RCDT

subfamilyCode

Text

Transaction subfamily code. Example: FEES

sourceName

Text, Number

Transaction source name. Example: ACCOUNT.ACCOUNT_PERIODIC_FEE

sourceRef

Text, Number

Transaction source reference. Example: ID-78253

transactionGroupCode

Text

Transaction group code. Example: FEE

virtualAccountId

Number, Text

Virtual account Id.

uniqueIdentifier

Number, Text

Transaction unique identifier. Example: 1f78c038-96a6-4882-925e-ce8cd2668220

2KB
account_transaction_export.json
1KB
account_transaction_export.csv