Skip to content
Developer home

Transaction Import Object

  Less than to read

Transaction Import object

There are two GET endpoints to make use of when requesting information from the Transaction Import object.

[Domain URL]/api-v1/organisations/{consumer_organisationId}/companies/{consumer_companyId}/imports/{consumer_post_import_id}

The GET single endpoint will retrieve a single Transaction Import based on the Transaction Import ID.

[Domain URL]/api-v1/organisations/{consumer_organisationId}/companies/{consumer_companyId}/imports

The GET all for company endpoint will return an array of Transaction Imports for a given Company ID.

{
    _id: "11111-00000-00000-00000-22222", // Transaction Import ID
    companyId: "aaaaa-00000-00000-00000-bbbbb", // Company ID
    organisationId: "ccccc-12345-00000-00000-ddddd", // Organisation ID
    bankId: "11111-22222-33333-44444-55555", // Bank ID
    fileFormat: "CAMT053", // The file type of the Transaction Import
    fileName: "april_imports.CAMT053", // The file type of the Transaction Import
    fileUploaded: true, // A boolean value to represent the file being uploaded
    description: "John Doe - Uploading transactions for the last 2 weeks of April 2020", // The comment field from the Common UI when uploading a file
    status: "complete", // The current status of the Transaction Import
    statusMonitor: {
        pollAttempts: 4, // The number of times the Status Monitor has polled against Provider API
        pollFirstAttempt: "2021-01-21T10:13:22Z" // The date and time of the first poll attempt
        pollLastAttempt: "2021-01-21T12:25:36Z" // The date and time of the last poll attempt
    },
    s3FilePath: "test/aaaaa-00000-00000-00000-bbbbb/11111-00000-00000-00000-22222", // The file path for the transaction file.
    statement: {
        id: "aaaaa-bbbbb-ccccc-ddddd-eeeee", // The ID generated by Provider API for the statement batch we are submitting
        summary: {
            transactionCount: 370, // The number of transactions uploaded as part of this statement
            transactionDebitSum: 2698, // The sum of all debits uploaded as part of this statement
            transactionCreditSum: 1675, // The sum of all credits uploaded as part of this statement
            transactionRangeStartDate: "2020-02-18T10:13:22Z", // The earliest datePosted date within a batch of transactions
            transactionRangeEndDate: "2020-12-23T13:22:19Z", // The latest datePosted date within a batch of transactions
        }
    },
    errorDetails: [
        {
            severity: "error", // The type of error (error, warn, info)
            target: "File", // A JSONPath expression which indicates the location of the error
            message: "Invalid data", // An optional friendly value which gives a detailed description of the error
            code: "InvalidSourceData", // A summary description of the error
        }
    ]
}