Plaid

Use the @bijection/connectors/plaid entrypoint to declare Plaid resources.

Availability

This page describes the pinned source package. Published availability is unestablished for this artifact. Source build and package availability.

Resources and modes

Resource	Mode	Description
Transactions	`sync`	Page-set sync with stated coverage and verified webhook hints

Declare a resource in application code, then bind deployment-specific settings and credentials. See typed resources, connections and source inspection.

Transactions

sync: Page-set sync with stated coverage and verified webhook hints

The following example matches configuration webhooks.

import { plaid } from "@bijection/connectors/plaid";
export const transactions = plaid.transactions.sync({
  environment: "production",
  updates: "webhooks",
});

Inferred record types

Resource without an operational record table

Configuration: standard

Case: plaid/transactions/sync/standard. Connection and resource configuration are declared by this exact case. Credential kind: plaid. Keep credential material in the private credential inventory. Inspect the complete configuration contract below for settings and conditional requirements.

Complete configuration contract

{
  "setup": [],
  "resource": {
    "access": {},
    "defaults": {},
    "connector": "plaid",
    "output": {
      "kind": "single",
      "collection": "transactions"
    },
    "credential_kind": "plaid",
    "connection_fields": [],
    "address": {
      "kind": "fixed",
      "url": "https://sandbox.plaid.com"
    }
  },
  "connection_setup": {
    "type": "object",
    "value": {}
  },
  "execution": null
}

Native admission analysis is available for this exact declaration. Collection: transactions

Contract	Meaning
Initial	Current membership
Changes	Repeated observations of current records
Deletions	Explicit deletion evidence
Resume	Opaque cursor
Gap	Explicit repair required after a gap
Retention	Unspecified

Complete native profile

{
  "movement": {
    "exchanges": {
      "sync": {
        "200": {
          "placement": "retained_bytes",
          "interpretation": "json",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        },
        "400": {
          "placement": "retained_bytes",
          "interpretation": "json",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        },
        "429": {
          "placement": "retained_bytes",
          "interpretation": "opaque",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        }
      }
    },
    "nativeInputLimitBytes": null,
    "steps": [
      {
        "id": "acquire.1",
        "inputs": [],
        "action": {
          "operation": "acquire",
          "subject": "exchange sync",
          "limitBytes": null
        }
      },
      {
        "id": "retain.1",
        "inputs": [
          "acquire.1"
        ],
        "action": {
          "operation": "retain",
          "subject": "acquisition evidence",
          "reason": "recovery",
          "release": "acquisition_custody"
        }
      },
      {
        "id": "interpret.1",
        "inputs": [
          "retain.1"
        ],
        "action": {
          "operation": "interpret",
          "subject": "acquired input",
          "produces": "records"
        }
      },
      {
        "id": "materialize.1",
        "inputs": [
          "interpret.1"
        ],
        "action": {
          "operation": "materialize",
          "subject": "source rows",
          "reason": "serving",
          "release": "replacement"
        }
      },
      {
        "id": "publish.1",
        "inputs": [
          "materialize.1"
        ],
        "action": {
          "operation": "publish",
          "subject": "source rows",
          "visibility": "with_acquisition"
        }
      }
    ]
  },
  "initial": "current_membership",
  "changes": "observations",
  "deletions": "explicit_events",
  "resume": "opaque_cursor",
  "retentionMs": null,
  "gap": "explicit_repair",
  "limits": {
    "http_response_bytes": "524288",
    "initial_rows": "102400"
  },
  "restrictions": [],
  "commands": {}
}

Commands, occurrences and artifacts

{
  "records": {
    "transactions": {
      "protocol": "record_observation",
      "coverage": "incremental_snapshot",
      "consistency": "observations",
      "atomicity": "record",
      "history": "observations",
      "recordRefresh": false,
      "reconciliation": false,
      "notifications": false,
      "snapshotMaxRows": "102400",
      "profile": {
        "movement": {
          "exchanges": {
            "sync": {
              "200": {
                "placement": "retained_bytes",
                "interpretation": "json",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              },
              "400": {
                "placement": "retained_bytes",
                "interpretation": "json",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              },
              "429": {
                "placement": "retained_bytes",
                "interpretation": "opaque",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              }
            }
          },
          "nativeInputLimitBytes": null,
          "steps": [
            {
              "id": "acquire.1",
              "inputs": [],
              "action": {
                "operation": "acquire",
                "subject": "exchange sync",
                "limitBytes": null
              }
            },
            {
              "id": "retain.1",
              "inputs": [
                "acquire.1"
              ],
              "action": {
                "operation": "retain",
                "subject": "acquisition evidence",
                "reason": "recovery",
                "release": "acquisition_custody"
              }
            },
            {
              "id": "interpret.1",
              "inputs": [
                "retain.1"
              ],
              "action": {
                "operation": "interpret",
                "subject": "acquired input",
                "produces": "records"
              }
            },
            {
              "id": "materialize.1",
              "inputs": [
                "interpret.1"
              ],
              "action": {
                "operation": "materialize",
                "subject": "source rows",
                "reason": "serving",
                "release": "replacement"
              }
            },
            {
              "id": "publish.1",
              "inputs": [
                "materialize.1"
              ],
              "action": {
                "operation": "publish",
                "subject": "source rows",
                "visibility": "with_acquisition"
              }
            }
          ]
        },
        "initial": "current_membership",
        "changes": "observations",
        "deletions": "explicit_events",
        "resume": "opaque_cursor",
        "retentionMs": null,
        "gap": "explicit_repair",
        "limits": {
          "http_response_bytes": "524288",
          "initial_rows": "102400"
        },
        "restrictions": [],
        "commands": {}
      }
    }
  },
  "occurrences": null,
  "artifacts": {
    "raw_archive": false,
    "native_file_transfer_limit_bytes": null,
    "external_versions": false,
    "files": {}
  },
  "commands": {}
}

Recorded checks

Requirement	Scope	Evidence	Result
incremental-page-set-restart	{“kind”:“collection”,“name”:“transactions”}	Native test: integrations/providers/plaid_page_sets_restart_settle_and_state_their_coverage (provider_contract)	Execution result unavailable
incremental-page-set-restart	{“kind”:“collection”,“name”:“transactions”}	Fixture: ./src/connectors/plaid/fixtures/mutation-restart.json	passed (2026-10-24T21:36:12.294Z)
incremental-page-set-restart	{“kind”:“collection”,“name”:“transactions”}	Fixture: ./src/connectors/plaid/fixtures/settlement-page.json	passed (2026-10-24T21:36:12.295Z)
page-publication-recovery	{“kind”:“collection”,“name”:“transactions”}	Native test: integrations/providers/plaid_page_sets_restart_settle_and_state_their_coverage (provider_contract)	Execution result unavailable
stated-cursor-empty-page-advances	{“kind”:“collection”,“name”:“transactions”}	Native test: integrations/providers/plaid_page_sets_restart_settle_and_state_their_coverage (provider_contract)	Execution result unavailable
stated-cursor-repeat-refused	{“kind”:“collection”,“name”:“transactions”}	No check exercises this packaged Plaid declaration against Plaid; it has not run or been qualified.	Execution result unavailable
identity-account	{“kind”:“connection”}	Fixture: ./src/connectors/plaid/fixtures/identity.json	passed (2026-10-24T21:36:12.296Z)

Hosted qualification: unestablished for this catalog configuration. Installed connections report their own identity, authority and current status.

Configuration: webhooks

Case: plaid/transactions/sync/webhooks. Connection and resource configuration are declared by this exact case. Credential kind: plaid. Keep credential material in the private credential inventory. Inspect the complete configuration contract below for settings and conditional requirements.

Complete configuration contract

{
  "setup": [],
  "resource": {
    "access": {},
    "defaults": {},
    "connector": "plaid",
    "output": {
      "kind": "single",
      "collection": "transactions"
    },
    "credential_kind": "plaid",
    "connection_fields": [],
    "address": {
      "kind": "fixed",
      "url": "https://production.plaid.com"
    }
  },
  "connection_setup": {
    "type": "object",
    "value": {}
  },
  "execution": null
}

Native admission analysis is available for this exact declaration. Collection: transactions

Contract	Meaning
Initial	Current membership
Changes	Repeated observations of current records
Deletions	Explicit deletion evidence
Resume	Opaque cursor
Gap	Explicit repair required after a gap
Retention	Unspecified

Complete native profile

{
  "movement": {
    "exchanges": {
      "sync": {
        "200": {
          "placement": "retained_bytes",
          "interpretation": "json",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        },
        "400": {
          "placement": "retained_bytes",
          "interpretation": "json",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        },
        "429": {
          "placement": "retained_bytes",
          "interpretation": "opaque",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        }
      }
    },
    "nativeInputLimitBytes": null,
    "steps": [
      {
        "id": "acquire.1",
        "inputs": [],
        "action": {
          "operation": "acquire",
          "subject": "exchange sync",
          "limitBytes": null
        }
      },
      {
        "id": "acquire.2",
        "inputs": [],
        "action": {
          "operation": "acquire",
          "subject": "listener changes",
          "limitBytes": null
        }
      },
      {
        "id": "retain.1",
        "inputs": [
          "acquire.1",
          "acquire.2"
        ],
        "action": {
          "operation": "retain",
          "subject": "acquisition evidence",
          "reason": "recovery",
          "release": "acquisition_custody"
        }
      },
      {
        "id": "interpret.1",
        "inputs": [
          "retain.1"
        ],
        "action": {
          "operation": "interpret",
          "subject": "acquired input",
          "produces": "records"
        }
      },
      {
        "id": "materialize.1",
        "inputs": [
          "interpret.1"
        ],
        "action": {
          "operation": "materialize",
          "subject": "source rows",
          "reason": "serving",
          "release": "replacement"
        }
      },
      {
        "id": "publish.1",
        "inputs": [
          "materialize.1"
        ],
        "action": {
          "operation": "publish",
          "subject": "source rows",
          "visibility": "with_acquisition"
        }
      }
    ]
  },
  "initial": "current_membership",
  "changes": "observations",
  "deletions": "explicit_events",
  "resume": "opaque_cursor",
  "retentionMs": null,
  "gap": "explicit_repair",
  "limits": {
    "http_response_bytes": "524288",
    "initial_rows": "102400"
  },
  "restrictions": [],
  "commands": {}
}

Commands, occurrences and artifacts

{
  "records": {
    "transactions": {
      "protocol": "record_observation",
      "coverage": "incremental_snapshot",
      "consistency": "observations",
      "atomicity": "record",
      "history": "observations",
      "recordRefresh": false,
      "reconciliation": false,
      "notifications": true,
      "snapshotMaxRows": "102400",
      "profile": {
        "movement": {
          "exchanges": {
            "sync": {
              "200": {
                "placement": "retained_bytes",
                "interpretation": "json",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              },
              "400": {
                "placement": "retained_bytes",
                "interpretation": "json",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              },
              "429": {
                "placement": "retained_bytes",
                "interpretation": "opaque",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              }
            }
          },
          "nativeInputLimitBytes": null,
          "steps": [
            {
              "id": "acquire.1",
              "inputs": [],
              "action": {
                "operation": "acquire",
                "subject": "exchange sync",
                "limitBytes": null
              }
            },
            {
              "id": "acquire.2",
              "inputs": [],
              "action": {
                "operation": "acquire",
                "subject": "listener changes",
                "limitBytes": null
              }
            },
            {
              "id": "retain.1",
              "inputs": [
                "acquire.1",
                "acquire.2"
              ],
              "action": {
                "operation": "retain",
                "subject": "acquisition evidence",
                "reason": "recovery",
                "release": "acquisition_custody"
              }
            },
            {
              "id": "interpret.1",
              "inputs": [
                "retain.1"
              ],
              "action": {
                "operation": "interpret",
                "subject": "acquired input",
                "produces": "records"
              }
            },
            {
              "id": "materialize.1",
              "inputs": [
                "interpret.1"
              ],
              "action": {
                "operation": "materialize",
                "subject": "source rows",
                "reason": "serving",
                "release": "replacement"
              }
            },
            {
              "id": "publish.1",
              "inputs": [
                "materialize.1"
              ],
              "action": {
                "operation": "publish",
                "subject": "source rows",
                "visibility": "with_acquisition"
              }
            }
          ]
        },
        "initial": "current_membership",
        "changes": "observations",
        "deletions": "explicit_events",
        "resume": "opaque_cursor",
        "retentionMs": null,
        "gap": "explicit_repair",
        "limits": {
          "http_response_bytes": "524288",
          "initial_rows": "102400"
        },
        "restrictions": [],
        "commands": {}
      }
    }
  },
  "occurrences": null,
  "artifacts": {
    "raw_archive": false,
    "native_file_transfer_limit_bytes": null,
    "external_versions": false,
    "files": {}
  },
  "commands": {}
}

Recorded checks

Requirement	Scope	Evidence	Result
listener-custody-before-ack	{“kind”:“listener”,“collection”:“transactions”}	Native test: integrations/listeners/webhook_delivery_commits_responsibility_before_acknowledging (shared_engine)	Execution result unavailable
listener-duplicate-delivery	{“kind”:“listener”,“collection”:“transactions”}	Native test: integrations/accounts/integration_asymmetric_ingress_admits_and_refuses (shared_engine)	Execution result unavailable
incremental-page-set-restart	{“kind”:“collection”,“name”:“transactions”}	Native test: integrations/providers/plaid_page_sets_restart_settle_and_state_their_coverage (provider_contract)	Execution result unavailable
incremental-page-set-restart	{“kind”:“collection”,“name”:“transactions”}	Fixture: ./src/connectors/plaid/fixtures/mutation-restart.json	passed (2026-10-24T21:36:12.296Z)
incremental-page-set-restart	{“kind”:“collection”,“name”:“transactions”}	Fixture: ./src/connectors/plaid/fixtures/settlement-page.json	passed (2026-10-24T21:36:12.297Z)
page-publication-recovery	{“kind”:“collection”,“name”:“transactions”}	Native test: integrations/providers/plaid_page_sets_restart_settle_and_state_their_coverage (provider_contract)	Execution result unavailable
stated-cursor-empty-page-advances	{“kind”:“collection”,“name”:“transactions”}	Native test: integrations/providers/plaid_page_sets_restart_settle_and_state_their_coverage (provider_contract)	Execution result unavailable
stated-cursor-repeat-refused	{“kind”:“collection”,“name”:“transactions”}	No check exercises this packaged Plaid declaration against Plaid; it has not run or been qualified.	Execution result unavailable
identity-account	{“kind”:“connection”}	Fixture: ./src/connectors/plaid/fixtures/identity.json	passed (2026-10-24T21:36:12.297Z)

Hosted qualification: unestablished for this catalog configuration. Installed connections report their own identity, authority and current status.

Provider guidance

Compiled declaration examples and configuration details are published in the connector reference. The connection holds a plaid credential (plaid.credential): a body_fields envelope carrying client_id, secret and the Item’s access_token, which the host writes into every request body at dispatch. Identity is the Item’s item_id from POST /item/get. environment selects https://sandbox.plaid.com or https://production.plaid.com. transactions.sync reads POST /transactions/sync as an incremental snapshot of one Item, 100 transactions per page:

The resume position advances per page set. has_more says whether next_cursor continues this pass or is the position the next pass resumes from. TRANSACTIONS_SYNC_MUTATION_DURING_PAGINATION discards the pass’s staged pages and restarts it from the cursor it began at.
The record key is a function of the record: a posted transaction is keyed by the pending_transaction_id it settled from, otherwise by its own transaction_id. A settlement (removed names the pending id, added carries the posted one) is one record changing state. A removal is provisional until the pass is consumed: a presence for the same key anywhere in the pass supersedes it.
transactions_update_status is read on every page. INITIAL_UPDATE_COMPLETE publishes rows without a population certificate, HISTORICAL_UPDATE_COMPLETE with one, and NOT_READY is a declared unavailability that publishes nothing.
ITEM_LOGIN_REQUIRED and INVALID_ACCESS_TOKEN fail as authentication; PRODUCT_NOT_READY as unavailable.

Known limits. A removal of a posted transaction that settled from a pending one names the posted id, which is not the record’s key, so it withdraws nothing and the record stays until the Item is re-read from no cursor. amount is a JSON double kept as the shortest text that round-trips it, not an exact decimal. A pass reads at most 1,024 pages, so an Item above 102,400 transactions cannot complete a first pass. With updates: "webhooks", a delivery verified as an ES256 JWS in Plaid-Verification (key fetched per kid from POST /webhook_verification_key/get, retired keys refused, body digest claim request_body_sha256, five-minute iat bound) requests another pass. The key request carries the connection’s body fields; whether Plaid accepts access_token beside key_id there has not been observed. Nothing here has run against Plaid or been qualified.

Provider references

Provider references and prerequisites are maintained in the connector guidance above. No separate provider-documentation review date is recorded.

Source and evidence

Canonical connector source, native analysis and check receipts. Connector artifact: 905888ea276a2a28e36981a79e8142b2547ea451c3e63162cb6915ad4a7d1305. The resource declaration examples above are compiled and compared with exact catalog declarations. Recorded checks apply only to their source, declaration and runtime identities. Configure a connection and inspect its status to establish deployment-specific readiness.

Get Started

Use-case atlas

Platform

Data and Operations

Guides

Client Libraries

Tools

API Reference

Availability

Resources and modes

Transactions

sync: Page-set sync with stated coverage and verified webhook hints

Configuration: standard

Configuration: webhooks

Provider guidance

Provider references

Source and evidence

​Availability

​Resources and modes

​Transactions

​sync: Page-set sync with stated coverage and verified webhook hints

​Configuration: standard

​Configuration: webhooks

​Provider guidance

​Provider references

​Source and evidence

Availability

Resources and modes

Transactions

sync: Page-set sync with stated coverage and verified webhook hints

Configuration: standard

Configuration: webhooks

Provider guidance

Provider references

Source and evidence