Create a Widget session token

$ straddle bridge initialize

POST/v1/bridge/initialize

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

ParametersExpand Collapse

--customer-id: string

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

--config: optional object { processing_method, sandbox_outcome }

Body param

--external-id: optional string

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

--correlation-id: optional string

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

--idempotency-key: optional string

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

--request-id: optional string

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

--straddle-account-id: optional string

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

ReturnsExpand Collapse

bridgeTokenV1: object { data, meta, response_type }

data: object { bridge_token }

bridge_token: string

JWT Token to use in the bridge widget.

meta: object { 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.

api_request_timestamp: string

Timestamp for this API request, useful for troubleshooting.

response_type: "object" or "array" or "error" or "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.

"object"

"array"

"error"

"none"

Create a Widget session token

straddle bridge initialize \
  --api-key 'My API Key' \
  --customer-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e

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