Skip to main content
POST
/
v1
/
bridge
/
initialize
cURL
curl --request POST \
  --header 'Authorization: Bearer YOUR_SECRET_API_KEY' \
  --url https://sandbox.straddle.com/v1/bridge/initialize \
  --header 'Content-Type: application/json' \
  --data '{
  "customer_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
}'
{
  "meta": {
    "api_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "api_request_timestamp": "2023-11-07T05:31:56Z"
  },
  "response_type": "object",
  "data": {
    "bridge_token": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Use your Straddle API Key in the Authorization header as Bearer to authorize API requests.

Headers

​
Straddle-Account-Id
string<uuid>

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

​
Request-Id
string

Optional client generated identifier to trace and debug a request.

​
Correlation-Id
string

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

​
Idempotency-Key
string

Optional client generated value to use for idempotent requests.

Required string length: 10 - 40

Body

​
customer_id
string<uuid>
required

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

​
config
object
​
external_id
string | null

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

Response

Created

​
meta
object
required

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

​
response_type
enum<string>
required

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.
Available options:
object,
array,
error,
none
​
data
object
required