Get Stripe Connected ID

Request Parameters

🏷️ header · unmarked parameters are query params

Example Request

curl --get 'https://www.locally.com/headless/api/1.0/cart/checkout/stripe_connected_id' \
--header 'Locally-Api-Token: {{API_TOKEN}}' \
--data-urlencode 'store_id={{STORE_ID}}' \
--data-urlencode 'company_id={{COMPANY_ID}}'

const response = await fetch(
  'https://www.locally.com/headless/api/1.0/cart/checkout/stripe_connected_id?store_id={{STORE_ID}}&company_id={{COMPANY_ID}}',
  {
    headers: {
      'Locally-Api-Token': '{{API_TOKEN}}'
    }
  }
);
const data = await response.json();

import requests

response = requests.get(
    "https://www.locally.com/headless/api/1.0/cart/checkout/stripe_connected_id",
    params={
        "store_id": "{{STORE_ID}}",
        "company_id": "{{COMPANY_ID}}",
    },
    headers={"Locally-Api-Token": "{{API_TOKEN}}"},
)
data = response.json()

Your API token must have the Stripe Connected ID permission enabled (contact Locally customer service to request it), and the store identified by store_id must be an active dealer of the brand identified by company_id — otherwise the API responds with 401 Unauthorized or 404 Not Found respectively.

Example Response

{
  "success": true,
  "data": {
    "stripe_connected_id": "acct_1A2B3C4D5E6F7G8H",
    "session": {
      "id": "abc999"
    }
  },
  "msg": ""
}

Response Explanation

• success — false with HTTP 401 (error_code 1206) when your token lacks the Stripe Connected ID permission, or HTTP 404 (error_code 1329/1330) when the store is missing, not a dealer of company_id, or has no Stripe integration; the reason appears in msg.
• data.stripe_connected_id — The store's Stripe Connect account ID (acct_...). Combine it with your marketplace secret key to build the Stripe setup intent used when authorizing payment.
• data.session.id — The current session ID. It can change between calls, so always send the latest value in the Locally-Api-Session-Id header on your next request. Session IDs eventually expire.