API Reference

Bridge

View as Markdown

View as Markdown

Copy Markdown

---

Open in Claude

Open in ChatGPT

Create a Widget session token

bridge.initialize(BridgeInitializeParams**kwargs) -> BridgeTokenV1

post/v1/bridge/initialize

Use this endpoint to generate a session token for use in the Bridge widget.

ParametersExpand Collapse

customer_id: str

The Straddle generated unique identifier of the customer to create a bridge token for.

formatuuid

config: Optional[Config]

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

Accepts one of the following:

"inline"

"background"

"skip"

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

Accepts one of the following:

"standard"

"active"

"rejected"

"review"

external_id: Optional[str]

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

correlation_id: Optional[str]

idempotency_key: Optional[str]

request_id: Optional[str]

straddle_account_id: Optional[str]

ReturnsExpand 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.

Accepts one of the following:

"object"

"array"

"error"

"none"

Create a Widget session token

Python

• HTTP
• TypeScript
• Python
• Ruby

from straddle import Straddle

client = Straddle(
    api_key="My API Key",
)
bridge_token_v1 = client.bridge.initialize(
    customer_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
)
print(bridge_token_v1.data)

200 example

{
  "data": {
    "bridge_token": "bridge_token"
  },
  "meta": {
    "api_request_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "api_request_timestamp": "2019-12-27T18:11:19.117Z"
  },
  "response_type": "object"
}

Returns Examples

200 example

{
  "data": {
    "bridge_token": "bridge_token"
  },
  "meta": {
    "api_request_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "api_request_timestamp": "2019-12-27T18:11:19.117Z"
  },
  "response_type": "object"
}