DRAFTThe sandbox is not live yet. Every example here was returned by the platform's code in a test run on 2026-10-28, priced with example fees: no fee amount in them is an SMP price. Paths and fields can change before launch. Live keys are issued only after our bank program is approved.Sandbox not live yet · examples from a test run on 2026-10-28 · example fees

Reference · 4 operations

Sites

A merchant's stores or websites: each can have its own keys, domain and statement descriptor, and can be disabled.

Sandboxhttps://sandbox.socialmatterspay.com
Livehttps://api.socialmatterspay.com
GET /v1/sites

This merchant's sites (a site's key sees its own)
Secret key

Host https://api.socialmatterspay.com · https://sandbox.socialmatterspay.com

Responses

StatusMeaning
200The sites
401Error — error shape and codes

Fields of each item of data (200)

FieldNotes
idstringpattern ^site_[0-9a-f]{24}$
objectstring = "site"—
namestring—
domainstring | null—
statement_descriptorstring | nullAppears as SMS*<descriptor> on the site's payments
statusenumone of active, disabled
created_atstring (date-time)—
updated_atstring (date-time)—
Example

List sites

GET /v1/sites
curl https://sandbox.socialmatterspay.com/v1/sites \
  -H 'Authorization: Bearer sk_sandbox_…'
Response · 200
HTTP 200
Cache-Control: no-store

{
  "data": [
    {
      "id": "site_3d810c4cb0b887ef83ca99c8",
      "object": "site",
      "name": "Northwind Wholesale",
      "domain": "wholesale.northwind.example",
      "statement_descriptor": "NW WHOLESALE",
      "status": "active",
      "created_at": "2026-10-28T00:22:39.860Z",
      "updated_at": "2026-10-28T00:22:39.860Z"
    }
  ]
}
POST /v1/sites

A store or website under this merchant
Secret key

Host https://api.socialmatterspay.com · https://sandbox.socialmatterspay.com

Request body

FieldNotes
name requiredstringUnique within the merchant. 1–100 characters
domainstringA host name such as shop.example.com; unique within the merchant
statement_descriptorstringpattern ^[A-Za-z0-9 .&-]{1,12}$

Responses

StatusMeaning
201The site
400Error — error shape and codes
403Error — error shape and codes
409Error — error shape and codes

Fields of data (201)

The same fields as under listSites.

Example

Add a site

POST /v1/sites
curl -X POST https://sandbox.socialmatterspay.com/v1/sites \
  -H 'Authorization: Bearer sk_sandbox_…' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Northwind Wholesale",
  "domain": "wholesale.northwind.example",
  "statement_descriptor": "NW WHOLESALE"
}'
Response · 201
HTTP 201
Cache-Control: no-store

{
  "data": {
    "id": "site_3d810c4cb0b887ef83ca99c8",
    "object": "site",
    "name": "Northwind Wholesale",
    "domain": "wholesale.northwind.example",
    "statement_descriptor": "NW WHOLESALE",
    "status": "active",
    "created_at": "2026-10-28T00:22:39.860Z",
    "updated_at": "2026-10-28T00:22:39.860Z"
  }
}
GET /v1/sites/{id}

Get a site
Secret key

Host https://api.socialmatterspay.com · https://sandbox.socialmatterspay.com

Parameters

FieldNotes
id requiredpath · string—

Responses

StatusMeaning
200The site
404Error — error shape and codes

Fields of data (200)

The same fields as under listSites.

Example

Get a site

GET /v1/sites/site_3d810c4cb0b887ef83ca99c8
curl https://sandbox.socialmatterspay.com/v1/sites/site_3d810c4cb0b887ef83ca99c8 \
  -H 'Authorization: Bearer sk_sandbox_…'
Response · 200
HTTP 200
Cache-Control: no-store

{
  "data": {
    "id": "site_3d810c4cb0b887ef83ca99c8",
    "object": "site",
    "name": "Northwind Wholesale",
    "domain": "wholesale.northwind.example",
    "statement_descriptor": "NW WHOLESALE",
    "status": "active",
    "created_at": "2026-10-28T00:22:39.860Z",
    "updated_at": "2026-10-28T00:22:39.860Z"
  }
}
PATCH /v1/sites/{id}

Rename a site, change its domain or descriptor (null clears them), or disable it
Secret key

Host https://api.socialmatterspay.com · https://sandbox.socialmatterspay.com

A disabled site takes no new payments, sessions or subscriptions, and its keys stop working until it is active again.

Parameters

FieldNotes
id requiredpath · string—

Request body

FieldNotes
namestring1–100 characters
domainstring | null—
statement_descriptorstring | nullpattern ^[A-Za-z0-9 .&-]{1,12}$
statusenumone of active, disabled

Responses

StatusMeaning
200The site
400Error — error shape and codes
403Error — error shape and codes
404Error — error shape and codes
409Error — error shape and codes

Fields of data (200)

The same fields as under listSites.

Example

Disable a site

PATCH /v1/sites/site_3d810c4cb0b887ef83ca99c8
curl -X PATCH https://sandbox.socialmatterspay.com/v1/sites/site_3d810c4cb0b887ef83ca99c8 \
  -H 'Authorization: Bearer sk_sandbox_…' \
  -H 'Content-Type: application/json' \
  -d '{
  "status": "disabled"
}'
Response · 200
HTTP 200
Cache-Control: no-store

{
  "data": {
    "id": "site_3d810c4cb0b887ef83ca99c8",
    "object": "site",
    "name": "Northwind Wholesale",
    "domain": "wholesale.northwind.example",
    "statement_descriptor": "NW WHOLESALE",
    "status": "disabled",
    "created_at": "2026-10-28T00:22:39.860Z",
    "updated_at": "2026-10-28T00:22:39.879Z"
  }
}