API Reference

View as Markdown

View as Markdown

Copy Markdown

---

Open in Claude

Open in ChatGPT

Bridge

Create a Widget session token

client.bridge.initialize(BridgeInitializeParams { customer_id, config, external_id, 4 more } params, RequestOptionsoptions?): BridgeTokenV1 { data, meta, response_type }

post/v1/bridge/initialize

ModelsExpand Collapse

BridgeTokenV1 { data, meta, response_type }

data: Data { bridge_token }

bridge_token: string

JWT Token to use in the bridge widget.

meta: ResponseMetadata { api_request_id, api_request_timestamp }

Metadata about the API request, including an identifier and timestamp.

api_request_id: string

Unique identifier for this API request, useful for troubleshooting.

formatuuid

api_request_timestamp: string

Timestamp for this API request, useful for troubleshooting.

formatdate-time

response_type: "object" | "array" | "error" | "none"

Indicates the structure of the returned content.

• "object" means the data field contains a single JSON object.
• "array" means the data field contains an array of objects.
• "error" means the data field contains an error object with details of the issue.
• "none" means no data is returned.

Accepts one of the following:

"object"

"array"

"error"

"none"

BridgeLink

Bridge a bank account

client.bridge.link.bankAccount(LinkBankAccountParams { account_number, account_type, customer_id, 8 more } params, RequestOptionsoptions?): PaykeyV1 { data, meta, response_type }

post/v1/bridge/bank_account

Bridge a Plaid token

client.bridge.link.plaid(LinkPlaidParams { customer_id, plaid_token, config, 6 more } params, RequestOptionsoptions?): PaykeyV1 { data, meta, response_type }

post/v1/bridge/plaid

Create Tan

client.bridge.link.createTan(LinkCreateTanParams { account_type, customer_id, routing_number, 8 more } params, RequestOptionsoptions?): LinkCreateTanResponse { data, meta, response_type }

post/v1/bridge/tan

Create a paykey from a Quiltt token

client.bridge.link.createPaykey(LinkCreatePaykeyParams { customer_id, quiltt_token, config, 6 more } params, RequestOptionsoptions?): LinkCreatePaykeyResponse { data, meta, response_type }

post/v1/bridge/quiltt