Skip to main content

CreateTestImportEventResponse

notifications object[]nullable

Array of notifications

  • Array [
  • idstringnullable

    Notification Id

    webhookIdstringnullable

    Webhook Id

    eventTypestringnullable

    Event Type

    eventRaisedAtdate-time

    Date and time when the event was triggered

    eventData objectnullable

    Import event details

    partnerIdstringnullable

    Partner ID

    userIdstringnullable

    User ID

    accountIdstringnullable

    Account ID

    transactions objectnullable

    Transactions import details

    countReceivedint32

    The number of transactions received

    The total nomber of transactions downloaded from the provider

    Example: 100
    countAddedint32

    The number of added transactions

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

    Example: 10
    countUpdatedint32

    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-time

    Import date and time

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

    Error message

    Example: An error occurred when importing transactions
    statusstringrequired

    Data import status

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

    Possible values: non-empty

    Example: Done
    warnings object[]nullable
  • 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 [
  • 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
  • ]
  • dataImportIdstringnullable
    report objectnullable

    Report details

    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-time

    Report creation date and time

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

    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)

    Report state

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

    errorstringnullabledeprecated

    Error

    warnings object[]nullable
  • 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 [
  • 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
  • ]
  • ]
  • CreateTestImportEventResponse
    {
    "notifications": [
    {
    "id": "string",
    "webhookId": "string",
    "eventType": "string",
    "eventRaisedAt": "2024-07-29T15:51:28.071Z",
    "eventData": {
    "partnerId": "string",
    "userId": "string",
    "accountId": "string",
    "transactions": {
    "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
    }
    ],
    "dataImportId": "string"
    },
    "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
    }
    ]
    }
    }
    }
    ]
    }