Create a Widget session token

client.bridge.initialize(, ?): BridgeTokenV1 { data, meta, response_type }

post/v1/bridge/initialize

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

ParametersExpand Collapse

params: BridgeInitializeParams { customer_id, config, external_id, 4 more }

customer_id: string

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

formatuuid

config?: Config

Body param:

processing_method?: "inline" | "background" | "skip"

Accepts one of the following:

"inline"

"background"

"skip"

sandbox_outcome?: "standard" | "active" | "rejected" | "review"

Accepts one of the following:

"standard"

"active"

"rejected"

"review"

external_id?: string | null

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

correlationID?: string

Header param: Optional client generated identifier to trace and debug a series of requests.

idempotencyKey?: string

Header param: Optional client generated value to use for idempotent requests.

maxLength40

minLength10

requestID?: string

Header param: Optional client generated identifier to trace and debug a request.

straddleAccountID?: string

Header param: For use by platforms to specify an account id and set scope of a request.

formatuuid

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

Create a Widget session token

import Straddle from '@straddlecom/straddle';

const client = new Straddle({
  apiKey: 'My API Key',
});

const bridgeTokenV1 = await client.bridge.initialize({ customer_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' });

console.log(bridgeTokenV1.data);

{
  "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

{
  "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"
}