Account & Members

The workspace behind your credential, and its team.

The workspace this credential belongs to (identity and branding only) and its team members. Single objects here are returned at the top level with no data wrapper, like GET /disputes/:id; lists use the usual data + has_more shape. Scoped keys need account:read / account:write for the account and members:read for the team.

Retrieve the account

The workspace this credential belongs to — identity and branding only (processor and fee configuration is deliberately not exposed). custom_domain is null unless the merchant's custom domain is active; subdomain is where the storefront and hosted pages live otherwise. payout_descriptor is what recipients read on their statement for money sent out of the balance, and is null when payouts use the descriptor approved on the Debit & Payouts account. Returned at the top level (no data wrapper).

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

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/account \
  -H "Authorization: Bearer sk_test_your_secret_key"

Example request — JavaScript

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

Example response (200)

{
  "object": "account",
  "id": "b858cb91-7521-44a0-b097-94f6a8ee8d5d",
  "name": "Acme Supplements",
  "slug": "acme",
  "logo_url": "https://cdn.paysio.com/avatars/acme.png",
  "currency": "USD",
  "timezone": "America/New_York",
  "subdomain": "acme",
  "custom_domain": "shop.acme.com",
  "payout_descriptor": "ACME PAY"
}

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 the account

Update branding. Editable fields: name, logo_url, timezone, payout_descriptor. slug, currency, subdomain and custom_domain are read-only here on purpose — each one silently breaks live URLs, existing prices, or a domain binding, so they stay deliberate dashboard actions. Requires the account:write scope on scoped keys.

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

Authorizations

Authorizationstringheaderrequired

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

Body

namestring

Workspace display name (max 120 chars)

logo_urlstring

Logo URL; empty string or null clears it

timezonestring

IANA timezone, e.g. "America/New_York"

payout_descriptorstring

Default statement descriptor for every payout, withdrawal and card refund sent from the balance (max 10 characters, letters, numbers and spaces, at least one letter). A value with no letter is rejected with 400. null or "" clears it and payouts go back to the descriptor approved on the Debit & Payouts account. A descriptor on an individual POST /payouts still wins. Instant (RTP) transfers do not carry one

Example request — cURL

curl -X PATCH https://paysio.com/api/v1/account \
  -H "Authorization: Bearer sk_test_your_secret_key" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "...",
  "logo_url": "...",
  "timezone": "..."
}'

Example request — JavaScript

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

Example response (200)

{
  "object": "account",
  "id": "b858cb91-7521-44a0-b097-94f6a8ee8d5d",
  "name": "Acme Supplements",
  "slug": "acme",
  "logo_url": "https://cdn.paysio.com/avatars/acme.png",
  "currency": "USD",
  "timezone": "America/New_York",
  "subdomain": "acme",
  "custom_domain": null,
  "payout_descriptor": "ACME PAY"
}

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

List members

Team members — name, email and role, nothing else. Read-only by design: there is no members:write scope, so an integration can attribute work or route a notification but can never change who is on the team. Requires the members:read scope on scoped keys.

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

Authorizations

Authorizationstringheaderrequired

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

Query parameters

limitinteger

1-100, default 10

starting_afterstring

Cursor for pagination (pages on the member id)

Example request — cURL

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

Example request — JavaScript

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

Example response (200)

{
  "data": [
    {
      "object": "member",
      "id": "3c93c21b-5074-478e-bed0-c112d4dfdfee",
      "user_id": "9f7c4d21-8a54-2c3b-1e0f-9a8d6b1e0d3a",
      "name": "Jane Doe",
      "email": "[email protected]",
      "avatar_url": null,
      "role": "owner",
      "created": 1735689600
    }
  ],
  "has_more": false
}

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