CreateTestImportEventRequest

accountIdstringrequired

Account ID

Possible values: non-empty

Example: 8lgu4vhke5

transactions object

Transactions import model for test TransactionsImported events.

dataImportIdstringnullable

Data import ID

countReceivedint32nullable

The number of transactions received

The total nomber of transactions downloaded from the provider

Example: 100

countAddedint32nullable

The number of added transactions

The number transactions that were downloaded for the first time and added

Example: 10

countUpdatedint32nullable

The number of updated transactions

The number of transactions that were already downloaded before, but this download has new data for these transactions

Example: 5

bookingDateStartdate-timenullable

Booking date and time of the earliest imported transaction

bookingDateEnddate-timenullable

Booking date and time of the latest imported transaction

createdAtdate-timenullable

Import date and time

Example: 2024-03-24T13:05:15.000

statusstringnullable

Data import status

• Done - Import completed successfully
• Importing - Currently importing
• Failed - Import failed

Example: Done

warnings object[]nullable

Array of errors

Array [

typestringnullable

Type or general classification of the error.

Example: AccountCredentialsInvalid

messagestringnullable

Error message.

providerMessagestringnullable

Original error message from the PSP.

isUserActionRequiredboolean

Whether a user action is required to resolve the error.

Example: true

isTemporaryboolean

If the error is temporary.

Example: false

]

errors object[]nullable

Array of warnings

Array [

typestringnullable

Type or general classification of the error.

Example: AccountCredentialsInvalid

messagestringnullable

Error message.

providerMessagestringnullable

Original error message from the PSP.

isUserActionRequiredboolean

Whether a user action is required to resolve the error.

Example: true

isTemporaryboolean

If the error is temporary.

Example: false

]

report objectnullable

Report model for test TransactionsImported events.

idstringnullable

Report ID

Example: 8fkjh5hr

namestringnullable

Report name

Example: Payment report

elementStatistics objectnullable

Report statistics

countint32

Number of transactions in the report

Example: 123

firstdate-timenullabledeprecated

bookingDateStartdate-timenullable

The booking date and time of the earliest transaction in the report

lastdate-timenullabledeprecated

bookingDateEnddate-timenullable

The booking date and time of the latest transaction in the report

reportDatedate-timenullable

Report date

Example: 2022-03-24T10:01:01.000

reportPeriod objectnullable

Report period

startdate-timenullable

The earliest report period date and time

Example: 2023-10-30T10:01:11.123

enddate-timenullable

The latest report period date and time

Example: 2023-10-30T10:01:11.123

depositDatedate-timenullable

Deposit date

Example: 2022-03-24T00:00:00.000

createdAtdate-timenullable

Report creation date and time

Example: 2022-03-24T10:01:01.000

modifiedAtdate-timenullable

Last report modification date and time

Example: 2022-03-24T10:01:01.000

importedAtdate-timenullable

Import date

Example: 2022-03-24T00:00:00.000

stateReportState (string)nullable

Report state

Possible values: [available, downloaded, importing, imported, download_error, import_error, skipped]

warnings object[]nullable

Array of errors

Array [

typestringnullable

Type or general classification of the error.

Example: AccountCredentialsInvalid

messagestringnullable

Error message.

providerMessagestringnullable

Original error message from the PSP.

isUserActionRequiredboolean

Whether a user action is required to resolve the error.

Example: true

isTemporaryboolean

If the error is temporary.

Example: false

]

errors object[]nullable

Array of warnings

Array [

typestringnullable

Type or general classification of the error.

Example: AccountCredentialsInvalid

messagestringnullable

Error message.

providerMessagestringnullable

Original error message from the PSP.

isUserActionRequiredboolean

Whether a user action is required to resolve the error.

Example: true

isTemporaryboolean

If the error is temporary.

Example: false

]

webhookIdsstring[]nullable

Array of webhook IDs

Notifications will be sent to the URLs of these webhooks

The webhooks should be subscribed to the TransactionsImported event

If not specified or empty, the notifications will be sent to all active webhooks subscribed to the TransactionsImported event

Example: ["8guvhke4"]

CreateTestImportEventRequest

{
  "accountId": "8lgu4vhke5",
  "transactions": {
    "dataImportId": "string",
    "countReceived": 100,
    "countAdded": 10,
    "countUpdated": 5,
    "bookingDateStart": "2024-07-29T15:51:28.071Z",
    "bookingDateEnd": "2024-07-29T15:51:28.071Z",
    "createdAt": "2024-03-24T13:05:15.000",
    "status": "Done",
    "warnings": [
      {
        "type": "AccountCredentialsInvalid",
        "message": "string",
        "providerMessage": "string",
        "isUserActionRequired": true,
        "isTemporary": false
      }
    ],
    "errors": [
      {
        "type": "AccountCredentialsInvalid",
        "message": "string",
        "providerMessage": "string",
        "isUserActionRequired": true,
        "isTemporary": false
      }
    ]
  },
  "report": {
    "id": "8fkjh5hr",
    "name": "Payment report",
    "elementStatistics": {
      "count": 123,
      "bookingDateStart": "2024-07-29T15:51:28.071Z",
      "bookingDateEnd": "2024-07-29T15:51:28.071Z"
    },
    "reportDate": "2022-03-24T10:01:01.000",
    "reportPeriod": {
      "start": "2023-10-30T10:01:11.123",
      "end": "2023-10-30T10:01:11.123"
    },
    "depositDate": "2022-03-24T00:00:00.000",
    "createdAt": "2022-03-24T10:01:01.000",
    "modifiedAt": "2022-03-24T10:01:01.000",
    "importedAt": "2022-03-24T00:00:00.000",
    "state": "available",
    "warnings": [
      {
        "type": "AccountCredentialsInvalid",
        "message": "string",
        "providerMessage": "string",
        "isUserActionRequired": true,
        "isTemporary": false
      }
    ],
    "errors": [
      {
        "type": "AccountCredentialsInvalid",
        "message": "string",
        "providerMessage": "string",
        "isUserActionRequired": true,
        "isTemporary": false
      }
    ]
  },
  "webhookIds": [
    "8guvhke4"
  ]
}