Storefronts & Pixels

Storefront status and marketing pixel configuration.

The merchant’s storefront and the marketing pixels wired into checkout. Storefronts are read-only — status and live URL, never the generated HTML. Pixels are read-write, so an ads integration can provision a pixel without the merchant copying IDs between two dashboards. Scoped keys need storefronts:read and pixels:read / pixels:write.

List storefronts

The merchant's storefronts — status and live URL only (the generated HTML and version history are not exposed). url is the active custom domain when one is set, else the paysio.com subdomain, and null while unpublished. Requires the storefronts:read scope on scoped keys.

GEThttps://paysio.com/api/v1/storefronts

Authorizations

Authorizationstringheaderrequired

Any API key. Prepend your key with Bearer, e.g. Bearer sk_test_your_secret_key.

Example request — cURL

curl -X GET https://paysio.com/api/v1/storefronts \
  -H "Authorization: Bearer sk_test_your_secret_key"

Example request — JavaScript

const res = await fetch("https://paysio.com/api/v1/storefronts", {
  method: "GET",
  headers: {
    "Authorization": "Bearer sk_test_your_secret_key"
  },
})
const data = await res.json()

Example response (200)

{
  "data": [
    {
      "object": "storefront",
      "id": "1e0d3a9f-7c4d-4218-a542-c3b1e0f9a8d6",
      "status": "published",
      "url": "https://acme.paysio.com",
      "published": true,
      "created": 1735689600,
      "updated": 1735689600
    }
  ],
  "has_more": false
}

Example response (401)

{
  "error": "Invalid API key provided",
  "type": "authentication_error",
  "code": "api_key_invalid"
}

Example response (429)

{
  "error": "Too many requests",
  "type": "rate_limit_error",
  "code": "rate_limited"
}

Retrieve pixels

The marketing pixel IDs wired into checkout (Meta, Google Ads, TikTok). Pixel IDs are public identifiers — ad-platform access tokens are never stored here. Returned at the top level (no data wrapper). Requires the pixels:read scope on scoped keys.

GEThttps://paysio.com/api/v1/pixels

Authorizations

Authorizationstringheaderrequired

Any API key. Prepend your key with Bearer, e.g. Bearer sk_test_your_secret_key.

Example request — cURL

curl -X GET https://paysio.com/api/v1/pixels \
  -H "Authorization: Bearer sk_test_your_secret_key"

Example request — JavaScript

const res = await fetch("https://paysio.com/api/v1/pixels", {
  method: "GET",
  headers: {
    "Authorization": "Bearer sk_test_your_secret_key"
  },
})
const data = await res.json()

Example response (200)

{
  "object": "pixels",
  "meta_pixel_id": "1234567890",
  "google_conversion_id": "AW-123456789",
  "google_conversion_label": "AbCdEfGhIj",
  "tiktok_pixel_id": null
}

Example response (401)

{
  "error": "Invalid API key provided",
  "type": "authentication_error",
  "code": "api_key_invalid"
}

Example response (429)

{
  "error": "Too many requests",
  "type": "rate_limit_error",
  "code": "rate_limited"
}

Update pixels

Update pixel IDs — lets an ads integration provision a pixel without the merchant copying IDs between dashboards. Send only the fields you want to change: an empty string or null clears a pixel, an omitted field is left alone. Requires the pixels:write scope on scoped keys.

PATCHhttps://paysio.com/api/v1/pixels

Authorizations

Authorizationstringheaderrequired

Secret key (sk_*) or app access token. Prepend your key with Bearer, e.g. Bearer sk_test_your_secret_key.

Body

meta_pixel_idstring

Meta (Facebook) pixel ID

google_conversion_idstring

Google Ads conversion ID (AW-...)

google_conversion_labelstring

Google Ads conversion label

tiktok_pixel_idstring

TikTok pixel ID

Example request — cURL

curl -X PATCH https://paysio.com/api/v1/pixels \
  -H "Authorization: Bearer sk_test_your_secret_key" \
  -H "Content-Type: application/json" \
  -d '{
  "meta_pixel_id": "...",
  "google_conversion_id": "...",
  "google_conversion_label": "..."
}'

Example request — JavaScript

const res = await fetch("https://paysio.com/api/v1/pixels", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer sk_test_your_secret_key",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "meta_pixel_id": "...",
    "google_conversion_id": "...",
    "google_conversion_label": "..."
  }),
})
const data = await res.json()

Example response (200)

{
  "object": "pixels",
  "meta_pixel_id": "1234567890",
  "google_conversion_id": "AW-123456789",
  "google_conversion_label": "AbCdEfGhIj",
  "tiktok_pixel_id": "CABC123DEF456"
}

Example response (400)

{
  "error": "Invalid request parameters",
  "type": "invalid_request_error",
  "code": "parameter_invalid"
}

Example response (401)

{
  "error": "Invalid API key provided",
  "type": "authentication_error",
  "code": "api_key_invalid"
}

Example response (429)

{
  "error": "Too many requests",
  "type": "rate_limit_error",
  "code": "rate_limited"
}