Retrieve a Transaction Processing Task

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

teal-instance-id

string

required

The Teal instance ID

Path Parameters

task_id

string

required

The Transaction Processing Task ID.

Response

200 - application/json

created_datetime

string

required

Indicates the datetime in UTC when the task was created.

error

object | null

required

The Error object if any errors were encountered in the processing. If the processing task was created by a Plaid import, the Plaid errors will be passed through there. See Plaid's documentation for more information on their error messages.

error.error_code

string

required

The Plaid error code.

error.error_message

string

required

The Plaid error message.

error.error_type

string

required

The Plaid error type.

error.causes

object[] | null

error.causes.error_code

string

required

The Plaid error code.

error.causes.error_message

string

required

The Plaid error message.

error.causes.error_type

string

required

The Plaid error type.

error.causes.causes

object[] | null

error.causes.display_message

string | null

A display message supplied by Plaid.

error.causes.documentation_url

string | null

A url to Plaid's documentation about the error.

error.causes.request_id

string | null

The Plaid request identifier.

error.causes.status

integer | null

The status code returned from Plaid.

error.causes.suggested_action

string | null

Plaid's suggested action to resolve the error.

error.display_message

string | null

A display message supplied by Plaid.

error.documentation_url

string | null

A url to Plaid's documentation about the error.

error.request_id

string | null

The Plaid request identifier.

error.status

integer | null

The status code returned from Plaid.

error.suggested_action

string | null

Plaid's suggested action to resolve the error.

string

required

ledger_id

string | null

required

The ID of the ledger that the transactions are being created for.

source_account_id

string

required

The source account containing the transactions

status

enum<string>

required

Indicates the status of the task.

Available options:

pending,

failed,

complete

updated_datetime

string | null

required

Indicates the datetime in UTC when the task was last updated.

created_transaction_ids

string[] | null

The IDs of Transactions successfully processed by this task.

modified_transaction_ids

string[] | null

The IDs of Transactions that were modified by this task.

removed_transaction_ids

string[] | null

The IDs of Transactions that were removed by this task.

skipped_transaction_ids

string[] | null

The IDs of Transactions that were skipped by this task.

API overview

Teal API Endpoints

API Migration

Retrieve a Transaction Processing Task

Authorizations

Headers

Path Parameters

Response