Transaction Sources
Get Plaid Link Statuses
Returns the status of all Plaid connected financial account ledgers on the platform.
GET
/
v0
/
sources
/
plaid
/
links
/
status
Authorization
Query
curl --request GET \
--url https://api.sandbox.teal.dev/v0/sources/plaid/links/status \
--header 'Authorization: <authorization>'
{
"next_page_token": "<string>",
"prev_page_token": "<string>",
"records": [
{
"instance": {
"entries_start": "2022-01-01T00:00:00Z",
"id": "RKtPbubK5NcbBsUmU1ktSP",
"name": "City Center Veterinarian",
"subscription": "tier1"
},
"ledger": {
"debit_credit": "debit",
"editable": true,
"financial_account_type": "bank_account",
"id": "7JRNsKwy2Lw66caxVU7WGC",
"is_required": true,
"name": "Accounts Receivable",
"parent_id": "HLn8oy2eqMUCwjp1Cwdgco",
"report_cash_flow": true,
"sort_code": "2003",
"sub_type": "current_assets",
"type": "asset"
},
"token_handle": {
"date": "2022-01-01T00:00:00Z",
"id": "UjL3BQnEaJtecuC7CUeDk",
"type": "plaid"
},
"txn_processing_task": {
"created_datetime": "2022-01-01T00:00:00Z",
"error": {},
"id": "UjL3BQnEaJtecuC7CUeDk",
"ledger_id": "9jXyj7EpZNizehSd9wJN3G",
"status": "pending",
"updated_datetime": "2022-01-01T00:00:00Z"
}
}
]
}
Authorizations
Authorization
string
headerrequiredThe access token received from the authorization server in the OAuth 2.0 flow.
Query Parameters
limit
integer | null
The number of records to return. Max limit is 100.
page_token
string
Response
200 - application/json
next_page_token
string | null
requiredThe token to use to request the next page
prev_page_token
string | null
requiredThe token to use to request the previous page
records
object[]
requiredList of ledger link statuses
curl --request GET \
--url https://api.sandbox.teal.dev/v0/sources/plaid/links/status \
--header 'Authorization: <authorization>'
{
"next_page_token": "<string>",
"prev_page_token": "<string>",
"records": [
{
"instance": {
"entries_start": "2022-01-01T00:00:00Z",
"id": "RKtPbubK5NcbBsUmU1ktSP",
"name": "City Center Veterinarian",
"subscription": "tier1"
},
"ledger": {
"debit_credit": "debit",
"editable": true,
"financial_account_type": "bank_account",
"id": "7JRNsKwy2Lw66caxVU7WGC",
"is_required": true,
"name": "Accounts Receivable",
"parent_id": "HLn8oy2eqMUCwjp1Cwdgco",
"report_cash_flow": true,
"sort_code": "2003",
"sub_type": "current_assets",
"type": "asset"
},
"token_handle": {
"date": "2022-01-01T00:00:00Z",
"id": "UjL3BQnEaJtecuC7CUeDk",
"type": "plaid"
},
"txn_processing_task": {
"created_datetime": "2022-01-01T00:00:00Z",
"error": {},
"id": "UjL3BQnEaJtecuC7CUeDk",
"ledger_id": "9jXyj7EpZNizehSd9wJN3G",
"status": "pending",
"updated_datetime": "2022-01-01T00:00:00Z"
}
}
]
}