Get Plaid Link Statuses

GET

sources

plaid

links

status

curl --request GET \
  --url https://api.sandbox.teal.dev/v0/sources/plaid/links/status \
  --header 'Authorization: Bearer <token>'

{
  "next_page_token": "ikal0NEVfMhF8dJf4yQ6KQZmGD",
  "prev_page_token": "vuA7JeKI5c6FLnPt5JfRcZcJxW",
  "records": [
    {
      "token_handle": {
        "id": "UjL3BQnEaJtecuC7CUeDk",
        "type": "plaid",
        "date": "2022-01-01T00:00:00Z",
        "enabled": true
      },
      "ledger": {
        "id": "7JRNsKwy2Lw66caxVU7WGC",
        "name": "Pluto Checking 4242",
        "debit_credit": "debit",
        "editable": false,
        "financial_account_type": "bank_account",
        "is_required": false,
        "parent": "<any>",
        "parent_id": "<string>",
        "report_cash_flow": false,
        "sort_code": "1400",
        "sub_type": "current_assets",
        "type": "asset"
      },
      "instance": {
        "id": "RKtPbubK5NcbBsUmU1ktSP",
        "entries_start": "2024-01-01T00:00:00Z",
        "name": "ACME Goods Inc",
        "subscription": "tier3",
        "accounting_package": "platformgl",
        "parent_id": "Kv7sp6Y1gAH2vfNxAWemRy",
        "child_ids": "['A5SswbYm7eZM2ec5q7Hm2t']",
        "parent": "<any>",
        "children": [
          {}
        ]
      },
      "txn_processing_task": {
        "id": "UjL3BQnEaJtecuC7CUeDk",
        "status": "pending",
        "created_datetime": "2024-01-01T00:00:00Z",
        "updated_datetime": [
          "2024-01-01T00:00:00Z"
        ],
        "error": null,
        "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

header

required

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

Query Parameters

instance_id

string | null

The Instance ID

limit

integer | null

default:50

The number of records to return. Max limit is 100.

Required range: 1 <= x < 101

page_token

string | null

Response

200

application/json

Successful Response

next_page_token

string | null

required

The token to use to request the next page

Example:

"ikal0NEVfMhF8dJf4yQ6KQZmGD"

prev_page_token

string | null

required

The token to use to request the previous page

Example:

"vuA7JeKI5c6FLnPt5JfRcZcJxW"

records

object[]

required

List of source account statuses

records.token_handle

object

required

records.ledger

object | null

required

records.ledger.id

string

required

The unique ID of the object.

Example:

"7JRNsKwy2Lw66caxVU7WGC"

records.ledger.name

string

required

The name of the ledger. Teal does not enforce any other conventions or patterns on naming schemes; however, we recommend you use concise, descriptive names, especially for financial account ledgers.

Example:

"Pluto Checking 4242"

records.ledger.debit_credit

enum<string>

required

Indicates if the ledger is a credit or debit ledger.

Required if financial_account_type is not specified.

Available options:

debit,

credit

Example:

"debit"

records.ledger.editable

boolean

required

Whether line entries can be manually added or removed from the Ledger. Set to false if you control the source of truth for the Ledger and want to restrict user changes, for example, if the Ledger is for a bank account or a payments account you control (i.e. you are a neobank or using a Banking as a Service platform).

Example:

false

records.ledger.is_required

boolean

required

Indicates that the ledger is one of the four system ledgers required for teal to work. In the default chart of accounts, these are named one of: Transfers Between Accounts, Opening Balance Retained Earnings, Uncategorized Cash Inflow, Uncategorized Cash Outflow. You can update the names of these to fit your needs.

Example:

false

records.ledger.parent_id

string | null

required

If the Ledger is a child Ledger, the ID of the parent Ledger object.

records.ledger.report_cash_flow

boolean

required

Whether Teal includes this ledger in the cash flow report.

Required if financial_account_type is not specified.

Example:

false

records.ledger.sort_code

string

required

Determines the display order in reports, ordered digit by digit, starting from the leftmost position. For example, 20010 will come before 3050.

Teal does not enforce any other conventions or patterns on sort codes. However, it is recommended to adopt a common convention such as starting all ledgers of the same type with the same number (assets start with 1, liabilities start with 2, etc.). The default CoA templates provided by Teal follow best practices for sort code numbering.

Example:

"1400"

records.ledger.sub_type

enum<string>

required

Indicates similar characteristics and accounting treatment for a group of ledgers within a type.

Required if financial_account_type is not specified.

Available options:

current_assets,

non-current_assets,

transfers_between_accounts,

uncategorized_assets,

current_liabilities,

non-current_liabilities,

equity,

operating_revenues,

other_income,

cost_of_goods_sold,

operating_expenses,

other_expenses

Example:

"current_assets"

records.ledger.type

enum<string>

required

Indicates the purpose and location of the funds and value recorded in the Ledger and which report it is included in: asset, liability and equity ledgers are displayed on the balance sheet; revenue and expenses are displayed on the income statement.

    Required if `financial_account_type` is not specified.

Available options:

asset,

liability,

equity,

revenue,

expense

Example:

"asset"

records.ledger.financial_account_type

enum<string> | null

If specified, indicates that the ledger represents a real-world financial account.

If provided when creating a new Ledger object, you do not need to provide debit_credit, type, sub_type, or report_cash_flow values as we will provide default values.

Available options:

bank_account,

credit_card,

payments,

payroll,

loan,

prepaid_card,

accounts_receivable,

accounts_payable

Example:

"bank_account"

records.ledger.parent

any | null

Expandable. If the ledger is a child ledger, the parent Ledger object.

records.instance

object

required

records.instance.id

string

required

The unique ID of the object.

Example:

"RKtPbubK5NcbBsUmU1ktSP"

records.instance.entries_start

string

required

The datetime in UTC time from which the API will sync an Instance's accounting data. Transactions or journal entries cannot be entered before this date.

Example:

"2024-01-01T00:00:00Z"

records.instance.name

string

required

The name of the business.

Example:

"ACME Goods Inc"

records.instance.subscription

enum<string>

required

The Instance's subscription tier.

Available options:

tier0,

tier1,

tier2,

tier3,

tier4,

tier5

Example:

"tier3"

records.instance.accounting_package

enum<string>

required

The type of accounting package the Instance uses as the source of truth for their books.

Available options:

platformgl,

quickbooks

Example:

"platformgl"

records.instance.parent_id

string | null

The ID of the Instance's parent.

Example:

"Kv7sp6Y1gAH2vfNxAWemRy"

records.instance.child_ids

string[] | null

The IDs of the Instance's children.

Example:

"['A5SswbYm7eZM2ec5q7Hm2t']"

records.instance.parent

any | null

The Instance's parent. Included in expanded responses.

records.instance.children

object[] | null

The Instance's children. Included in expanded responses.

records.instance.children.id

string

required

The unique ID of the object.

Example:

"RKtPbubK5NcbBsUmU1ktSP"

records.instance.children.entries_start

string

required

The datetime in UTC time from which the API will sync an Instance's accounting data. Transactions or journal entries cannot be entered before this date.

Example:

"2024-01-01T00:00:00Z"

records.instance.children.name

string

required

The name of the business.

Example:

"ACME Goods Inc"

records.instance.children.subscription

enum<string>

required

The Instance's subscription tier.

Available options:

tier0,

tier1,

tier2,

tier3,

tier4,

tier5

Example:

"tier3"

records.instance.children.accounting_package

enum<string>

required

The type of accounting package the Instance uses as the source of truth for their books.

Available options:

platformgl,

quickbooks

Example:

"platformgl"

records.instance.children.parent_id

string | null

The ID of the Instance's parent.

Example:

"Kv7sp6Y1gAH2vfNxAWemRy"

records.instance.children.child_ids

string[] | null

The IDs of the Instance's children.

Example:

"['A5SswbYm7eZM2ec5q7Hm2t']"

records.instance.children.parent

any | null

The Instance's parent. Included in expanded responses.

records.instance.children.children

object[] | null

The Instance's children. Included in expanded responses.

records.txn_processing_task

object | null

required

records.txn_processing_task.id

string

required

Example:

"UjL3BQnEaJtecuC7CUeDk"

records.txn_processing_task.status

enum<string>

required

Indicates the status of the task.

Available options:

pending,

failed,

complete

Example:

"pending"

records.txn_processing_task.created_datetime

string

required

Indicates the datetime in UTC when the task was created.

Example:

"2024-01-01T00:00:00Z"

records.txn_processing_task.updated_datetime

string | null

required

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

Example:

["2024-01-01T00:00:00Z"]

records.txn_processing_task.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.

records.txn_processing_task.error.error_type

string

required

The Plaid error type.

Example:

"API_ERROR"

records.txn_processing_task.error.error_code

string

required

The Plaid error code.

Example:

"INTERNAL_SERVER_ERROR"

records.txn_processing_task.error.error_message

string

required

The Plaid error message.

Example:

"An unexpected error occurred."

records.txn_processing_task.error.display_message

string | null

A display message supplied by Plaid.

Example:

"Something went wrong."

records.txn_processing_task.error.request_id

string | null

The Plaid request identifier.

Example:

"KipL51BWnPIpOmi"

records.txn_processing_task.error.causes

object[] | null

records.txn_processing_task.error.status

integer | null

The status code returned from Plaid.

Example:

500

records.txn_processing_task.error.documentation_url

string | null

A url to Plaid's documentation about the error.

Example:

"https://plaid.com/docs/errors/api/#internal_server_error-or-plaid-internal-error"

records.txn_processing_task.error.suggested_action

string | null

Plaid's suggested action to resolve the error.

Example:

null

records.txn_processing_task.source_account_id

string

required

The source account containing the transactions

records.txn_processing_task.ledger_id

string | null

required

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

Example:

"7JRNsKwy2Lw66caxVU7WGC"

records.txn_processing_task.created_transaction_ids

string[] | null

The IDs of Transactions successfully processed by this task.

records.txn_processing_task.removed_transaction_ids

string[] | null

The IDs of Transactions that were removed by this task.

records.txn_processing_task.modified_transaction_ids

string[] | null

The IDs of Transactions that were modified by this task.

records.txn_processing_task.skipped_transaction_ids

string[] | null

The IDs of Transactions that were skipped by this task.

Link Plaid Account Create a Business Transaction Source Account

curl --request GET \
  --url https://api.sandbox.teal.dev/v0/sources/plaid/links/status \
  --header 'Authorization: Bearer <token>'

{
  "next_page_token": "ikal0NEVfMhF8dJf4yQ6KQZmGD",
  "prev_page_token": "vuA7JeKI5c6FLnPt5JfRcZcJxW",
  "records": [
    {
      "token_handle": {
        "id": "UjL3BQnEaJtecuC7CUeDk",
        "type": "plaid",
        "date": "2022-01-01T00:00:00Z",
        "enabled": true
      },
      "ledger": {
        "id": "7JRNsKwy2Lw66caxVU7WGC",
        "name": "Pluto Checking 4242",
        "debit_credit": "debit",
        "editable": false,
        "financial_account_type": "bank_account",
        "is_required": false,
        "parent": "<any>",
        "parent_id": "<string>",
        "report_cash_flow": false,
        "sort_code": "1400",
        "sub_type": "current_assets",
        "type": "asset"
      },
      "instance": {
        "id": "RKtPbubK5NcbBsUmU1ktSP",
        "entries_start": "2024-01-01T00:00:00Z",
        "name": "ACME Goods Inc",
        "subscription": "tier3",
        "accounting_package": "platformgl",
        "parent_id": "Kv7sp6Y1gAH2vfNxAWemRy",
        "child_ids": "['A5SswbYm7eZM2ec5q7Hm2t']",
        "parent": "<any>",
        "children": [
          {}
        ]
      },
      "txn_processing_task": {
        "id": "UjL3BQnEaJtecuC7CUeDk",
        "status": "pending",
        "created_datetime": "2024-01-01T00:00:00Z",
        "updated_datetime": [
          "2024-01-01T00:00:00Z"
        ],
        "error": null,
        "source_account_id": "<string>",
        "ledger_id": "7JRNsKwy2Lw66caxVU7WGC",
        "created_transaction_ids": [
          "<string>"
        ],
        "removed_transaction_ids": [
          "<string>"
        ],
        "modified_transaction_ids": [
          "<string>"
        ],
        "skipped_transaction_ids": [
          "<string>"
        ]
      }
    }
  ]
}

API overview

Teal API Endpoints

API Migration

Get Plaid Link Statuses

Authorizations

Query Parameters

Response