Bridge

Bridge provides a comprehensive suite of tools for connecting customer bank accounts. Use it to generate secure widget sessions for instant account verification, accept tokens from major providers like Plaid and Finicity, or verify accounts directly via our API. Bridge handles all sensitive banking credentials and ensures secure, compliant connections with support for 90% of US bank accounts.

Create a Widget session token

bridge.initialize() -> BridgeTokenV1

POST/v1/bridge/initialize

ModelsExpand Collapse

class BridgeTokenV1: …

data: Data

bridge_token: str

JWT Token to use in the bridge widget.

meta: ResponseMetadata

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

api_request_id: str

Unique identifier for this API request, useful for troubleshooting.

formatuuid

api_request_timestamp: datetime

Timestamp for this API request, useful for troubleshooting.

formatdate-time

response_type: Literal["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.

One of the following:

"object"

"array"

"error"

"none"

BridgeLink

Bridge a bank account

bridge.link.bank_account() -> PaykeyV1

POST/v1/bridge/bank_account

Bridge a Plaid token

bridge.link.plaid() -> PaykeyV1

POST/v1/bridge/plaid

Create Tan

bridge.link.create_tan() -> LinkCreateTanResponse

POST/v1/bridge/tan

Create a paykey from a Quiltt token

bridge.link.create_paykey() -> LinkCreatePaykeyResponse

POST/v1/bridge/quiltt

ModelsExpand Collapse

class LinkCreateTanResponse: …

data: Data

id: str

Unique identifier for the paykey.

formatuuid

config: DataConfig

processing_method: Optional[Literal["inline", "background", "skip"]]

One of the following:

"inline"

"background"

"skip"

sandbox_outcome: Optional[Literal["standard", "active", "rejected", "review"]]

One of the following:

"standard"

"active"

"rejected"

"review"

created_at: datetime

Timestamp of when the paykey was created.

formatdate-time

label: str

Human-readable label that combines the bank name and masked account number to help easility represent this paykey in a UI

paykey: str

The tokenized paykey value. This token is used to create payments and should be stored securely.

source: Literal["bank_account", "straddle", "mx", 3 more]

One of the following:

"bank_account"

"straddle"

"mx"

"plaid"

"tan"

"quiltt"

status: Literal["pending", "active", "inactive", 3 more]

One of the following:

"pending"

"active"

"inactive"

"rejected"

"review"

"blocked"

updated_at: datetime

Timestamp of the most recent update to the paykey.

formatdate-time

balance: Optional[DataBalance]

status: Literal["pending", "completed", "failed"]

One of the following:

"pending"

"completed"

"failed"

account_balance: Optional[int]

Account Balance when last retrieved

formatint32

updated_at: Optional[datetime]

Last time account balance was updated.

formatdate-time

bank_data: Optional[DataBankData]

account_number: str

Bank account number. This value is masked by default for security reasons. Use the /unmask endpoint to access the unmasked value.

account_type: Literal["checking", "savings"]

One of the following:

"checking"

"savings"

routing_number: str

The routing number of the bank account.

minLength9

maxLength9

customer_id: Optional[str]

Unique identifier of the related customer object.

formatuuid

expires_at: Optional[datetime]

Expiration date and time of the paykey, if applicable.

formatdate-time

external_id: Optional[str]

Unique identifier for the paykey in your database, used for cross-referencing between Straddle and your systems.

institution_name: Optional[str]

Name of the financial institution.

metadata: Optional[Dict[str, str]]

Up to 20 additional user-defined key-value pairs. Useful for storing additional information about the paykey in a structured format.

status_details: Optional[DataStatusDetails]

changed_at: datetime

The time the status change occurred.

formatdate-time

message: str

A human-readable description of the current status.

reason: Literal["insufficient_funds", "closed_bank_account", "invalid_bank_account", 24 more]

One of the following:

"insufficient_funds"

"closed_bank_account"

"invalid_bank_account"

"invalid_routing"

"disputed"

"payment_stopped"

"owner_deceased"

"frozen_bank_account"

"risk_review"

"fraudulent"

"duplicate_entry"

"invalid_paykey"

"payment_blocked"

"amount_too_large"

"too_many_attempts"

"internal_system_error"

"user_request"

"ok"

"other_network_return"

"payout_refused"

"cancel_request"

"failed_verification"

"require_review"

"blocked_by_system"

"watchtower_review"

"validating"

"auto_hold"

source: Literal["watchtower", "bank_decline", "customer_dispute", 2 more]

One of the following:

"watchtower"

"bank_decline"

"customer_dispute"

"user_action"

"system"

code: Optional[str]

The status code if applicable.

meta: ResponseMetadata

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

api_request_id: str

Unique identifier for this API request, useful for troubleshooting.

formatuuid

api_request_timestamp: datetime

Timestamp for this API request, useful for troubleshooting.

formatdate-time

response_type: Literal["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.

One of the following:

"object"

"array"

"error"

"none"

class LinkCreatePaykeyResponse: …

data: Data

id: str

Unique identifier for the paykey.

formatuuid

config: DataConfig

processing_method: Optional[Literal["inline", "background", "skip"]]

One of the following:

"inline"

"background"

"skip"

sandbox_outcome: Optional[Literal["standard", "active", "rejected", "review"]]

One of the following:

"standard"

"active"

"rejected"

"review"

created_at: datetime

Timestamp of when the paykey was created.

formatdate-time

label: str

Human-readable label that combines the bank name and masked account number to help easility represent this paykey in a UI

paykey: str

The tokenized paykey value. This token is used to create payments and should be stored securely.

source: Literal["bank_account", "straddle", "mx", 3 more]

One of the following:

"bank_account"

"straddle"

"mx"

"plaid"

"tan"

"quiltt"

status: Literal["pending", "active", "inactive", 3 more]

One of the following:

"pending"

"active"

"inactive"

"rejected"

"review"

"blocked"

updated_at: datetime

Timestamp of the most recent update to the paykey.

formatdate-time

balance: Optional[DataBalance]

status: Literal["pending", "completed", "failed"]

One of the following:

"pending"

"completed"

"failed"

account_balance: Optional[int]

Account Balance when last retrieved

formatint32

updated_at: Optional[datetime]

Last time account balance was updated.

formatdate-time

bank_data: Optional[DataBankData]

account_number: str

Bank account number. This value is masked by default for security reasons. Use the /unmask endpoint to access the unmasked value.

account_type: Literal["checking", "savings"]

One of the following:

"checking"

"savings"

routing_number: str

The routing number of the bank account.

minLength9

maxLength9

customer_id: Optional[str]

Unique identifier of the related customer object.

formatuuid

expires_at: Optional[datetime]

Expiration date and time of the paykey, if applicable.

formatdate-time

external_id: Optional[str]

Unique identifier for the paykey in your database, used for cross-referencing between Straddle and your systems.

institution_name: Optional[str]

Name of the financial institution.

metadata: Optional[Dict[str, str]]

Up to 20 additional user-defined key-value pairs. Useful for storing additional information about the paykey in a structured format.

status_details: Optional[DataStatusDetails]

changed_at: datetime

The time the status change occurred.

formatdate-time

message: str

A human-readable description of the current status.

reason: Literal["insufficient_funds", "closed_bank_account", "invalid_bank_account", 24 more]

One of the following:

"insufficient_funds"

"closed_bank_account"

"invalid_bank_account"

"invalid_routing"

"disputed"

"payment_stopped"

"owner_deceased"

"frozen_bank_account"

"risk_review"

"fraudulent"

"duplicate_entry"

"invalid_paykey"

"payment_blocked"

"amount_too_large"

"too_many_attempts"

"internal_system_error"

"user_request"

"ok"

"other_network_return"

"payout_refused"

"cancel_request"

"failed_verification"

"require_review"

"blocked_by_system"

"watchtower_review"

"validating"

"auto_hold"

source: Literal["watchtower", "bank_decline", "customer_dispute", 2 more]

One of the following:

"watchtower"

"bank_decline"

"customer_dispute"

"user_action"

"system"

code: Optional[str]

The status code if applicable.

meta: ResponseMetadata

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

api_request_id: str

Unique identifier for this API request, useful for troubleshooting.

formatuuid

api_request_timestamp: datetime

Timestamp for this API request, useful for troubleshooting.

formatdate-time

response_type: Literal["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.

One of the following:

"object"

"array"

"error"

"none"