GET
/
v0
/
transactions
/
tasks
/
{task_id}
curl --request GET \
  --url https://api.sandbox.teal.dev/v0/transactions/tasks/{task_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'teal-instance-id: <teal-instance-id>'
{
  "id": "UjL3BQnEaJtecuC7CUeDk",
  "status": "pending",
  "created_datetime": "2024-01-01T00:00:00Z",
  "updated_datetime": [
    "2024-01-01T00:00:00Z"
  ],
  "error": {
    "error_type": "API_ERROR",
    "error_code": "INTERNAL_SERVER_ERROR",
    "error_message": "An unexpected error occurred.",
    "display_message": "Something went wrong.",
    "request_id": "KipL51BWnPIpOmi",
    "causes": [
      {
        "error_type": "API_ERROR",
        "error_code": "INTERNAL_SERVER_ERROR",
        "error_message": "An unexpected error occurred.",
        "display_message": "Something went wrong.",
        "request_id": "KipL51BWnPIpOmi",
        "causes": [
          {
            "error_type": "API_ERROR",
            "error_code": "INTERNAL_SERVER_ERROR",
            "error_message": "An unexpected error occurred.",
            "display_message": "Something went wrong.",
            "request_id": "KipL51BWnPIpOmi",
            "causes": [
              {
                "error_type": "API_ERROR",
                "error_code": "INTERNAL_SERVER_ERROR",
                "error_message": "An unexpected error occurred.",
                "display_message": "Something went wrong.",
                "request_id": "KipL51BWnPIpOmi",
                "causes": [
                  {
                    "error_type": "API_ERROR",
                    "error_code": "INTERNAL_SERVER_ERROR",
                    "error_message": "An unexpected error occurred.",
                    "display_message": "Something went wrong.",
                    "request_id": "KipL51BWnPIpOmi",
                    "causes": [
                      {
                        "error_type": "API_ERROR",
                        "error_code": "INTERNAL_SERVER_ERROR",
                        "error_message": "An unexpected error occurred.",
                        "display_message": "Something went wrong.",
                        "request_id": "KipL51BWnPIpOmi",
                        "causes": [
                          "<any>"
                        ],
                        "status": 500,
                        "documentation_url": "https://plaid.com/docs/errors/api/#internal_server_error-or-plaid-internal-error",
                        "suggested_action": "<string>"
                      }
                    ],
                    "status": 500,
                    "documentation_url": "https://plaid.com/docs/errors/api/#internal_server_error-or-plaid-internal-error",
                    "suggested_action": "<string>"
                  }
                ],
                "status": 500,
                "documentation_url": "https://plaid.com/docs/errors/api/#internal_server_error-or-plaid-internal-error",
                "suggested_action": "<string>"
              }
            ],
            "status": 500,
            "documentation_url": "https://plaid.com/docs/errors/api/#internal_server_error-or-plaid-internal-error",
            "suggested_action": "<string>"
          }
        ],
        "status": 500,
        "documentation_url": "https://plaid.com/docs/errors/api/#internal_server_error-or-plaid-internal-error",
        "suggested_action": "<string>"
      }
    ],
    "status": 500,
    "documentation_url": "https://plaid.com/docs/errors/api/#internal_server_error-or-plaid-internal-error",
    "suggested_action": "<string>"
  },
  "source_account_id": "<string>",
  "ledger_id": "7JRNsKwy2Lw66caxVU7WGC",
  "created_transaction_ids": [
    "<string>"
  ],
  "removed_transaction_ids": [
    "<string>"
  ],
  "modified_transaction_ids": [
    "<string>"
  ],
  "skipped_transaction_ids": [
    "<string>"
  ]
}

Authorizations

Authorization
string
headerrequired

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
id
string
required
status
enum<string>
required

Indicates the status of the task.

Available options:
pending,
failed,
complete
created_datetime
string
required

Indicates the datetime in UTC when the task was created.

updated_datetime
string | null
required

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

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.

source_account_id
string
required

The source account containing the transactions

ledger_id
string | null
required

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

created_transaction_ids
string[] | null

The IDs of Transactions successfully processed by this task.

removed_transaction_ids
string[] | null

The IDs of Transactions that were removed by this task.

modified_transaction_ids
string[] | null

The IDs of Transactions that were modified by this task.

skipped_transaction_ids
string[] | null

The IDs of Transactions that were skipped by this task.