Create a Widget session token

bridge.initialize_(**kwargs) -> 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

customer_id: String

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

formatuuid

config: { processing_method, sandbox_outcome}

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

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

correlation_id: String

idempotency_key: String

request_id: String

straddle_account_id: String

ReturnsExpand Collapse

class BridgeTokenV1 { data, meta, response_type }

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: Time

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

require "straddle"

straddle = Straddle::Client.new(
  api_key: "My API Key",
  environment: "production" # defaults to "sandbox"
)

bridge_token_v1 = straddle.bridge.initialize_(customer_id: "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

puts(bridge_token_v1)

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