Store

Get stores

get

Retrieves all stores accessible to the authenticated user or API key.

Authorizations

AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Responses

200

application/json

Represents a PayNow store and its associated configuration.

idstring · flake-idRequiredExample: 411486491630370816

owner_idstring · flake-idRequiredExample: 411486491630370816

slugstringRequired

The URL-safe slug used to identify the store (e.g. "my-rust-server").

namestringRequired

The display name of the store.

platformstringRequired

The platform this store is associated with (e.g. "rust", "minecraft").

gamestringRead-onlyRequired

Alias for PayNow.Services.HttpGateway.DataTransferObjects.V1.Stores.StoreDto.Platform. Returns the platform identifier as a game name.

currencystringRequired

The ISO 4217 currency code used by this store for pricing (e.g. "usd", "eur")

descriptionstringRequired

A human-readable description of the store shown to customers and PayNow.

website_urlstring · nullableOptional

The store's public website URL.

contact_emailstring · nullableOptional

General contact email address for the store.

support_emailstring · nullableOptional

Dedicated support email address for customer inquiries.

support_urlstring · nullableOptional

URL to the store's support portal or help page.

integration_typestring · nullableOptional

The integration type used by the store.

live_modebooleanRequired

When set to true, the store is processing real transactions in live mode.

logo_urlstring · nullableOptional

URL of the store's full-size logo image.

logo_square_urlstring · nullableOptional

URL of the store's square/icon logo image.

minecraft_bedrock_username_prefixstring · nullableOptional

Username prefix used to identify Minecraft Bedrock players (e.g. ".").

created_atstring · nullableOptional

The UTC timestamp when the store was created.

updated_atstring · nullableOptional

The UTC timestamp when the store was last updated.

onboarding_completed_atstring · nullableOptional

The UTC timestamp when the store completed onboarding.

default

Error response

application/json

get/v1/stores

GET /v1/stores HTTP/1.1
Authorization: APIKey TOKEN_HERE
Accept: */*

[
  {
    "id": "411486491630370816",
    "owner_id": "411486491630370816",
    "slug": "text",
    "name": "text",
    "platform": "text",
    "game": "text",
    "currency": "text",
    "description": "text",
    "website_url": null,
    "contact_email": null,
    "support_email": null,
    "support_url": null,
    "integration_type": null,
    "live_mode": true,
    "logo_url": null,
    "logo_square_url": null,
    "minecraft_bedrock_username_prefix": null,
    "created_at": null,
    "updated_at": null,
    "onboarding_completed_at": null,
    "platform_store_type_association": {
      "platform_id": "411486491630370816",
      "associated_platform": {
        "id": "411486491630370816",
        "slug": "text",
        "type": "invalid",
        "country_code": "text",
        "business_name": "text",
        "name": "text",
        "description": "text",
        "website_url": "text",
        "logo_url": "text",
        "accent_color": "text",
        "capabilities": [
          "invalid"
        ],
        "created_at": "2026-07-10T10:28:56.261Z",
        "updated_at": null,
        "disabled_at": null
      },
      "store_platform": "text",
      "paynow_platform_fee_percentage_override": null,
      "connected_platform_fee_percentage": null,
      "connected_platform_wallet_id": "411486491630370816",
      "disable_billing_plans": true,
      "display_disclaimers": true,
      "full_external_management": true
    }
  }
]

Get a store

get

Retrieves a single store by its ID.

Authorizations

AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

Responses

200

application/json

Represents a PayNow store and its associated configuration.

idstring · flake-idRequiredExample: 411486491630370816

owner_idstring · flake-idRequiredExample: 411486491630370816

slugstringRequired

The URL-safe slug used to identify the store (e.g. "my-rust-server").

namestringRequired

The display name of the store.

platformstringRequired

The platform this store is associated with (e.g. "rust", "minecraft").

gamestringRead-onlyRequired

Alias for PayNow.Services.HttpGateway.DataTransferObjects.V1.Stores.StoreDto.Platform. Returns the platform identifier as a game name.

currencystringRequired

The ISO 4217 currency code used by this store for pricing (e.g. "usd", "eur")

descriptionstringRequired

A human-readable description of the store shown to customers and PayNow.

website_urlstring · nullableOptional

The store's public website URL.

contact_emailstring · nullableOptional

General contact email address for the store.

support_emailstring · nullableOptional

Dedicated support email address for customer inquiries.

support_urlstring · nullableOptional

URL to the store's support portal or help page.

integration_typestring · nullableOptional

The integration type used by the store.

live_modebooleanRequired

When set to true, the store is processing real transactions in live mode.

logo_urlstring · nullableOptional

URL of the store's full-size logo image.

logo_square_urlstring · nullableOptional

URL of the store's square/icon logo image.

minecraft_bedrock_username_prefixstring · nullableOptional

Username prefix used to identify Minecraft Bedrock players (e.g. ".").

created_atstring · nullableOptional

The UTC timestamp when the store was created.

updated_atstring · nullableOptional

The UTC timestamp when the store was last updated.

onboarding_completed_atstring · nullableOptional

The UTC timestamp when the store completed onboarding.

default

Error response

application/json

get/v1/stores/{storeId}

GET /v1/stores/{storeId} HTTP/1.1
Authorization: APIKey TOKEN_HERE
Accept: */*

{
  "id": "411486491630370816",
  "owner_id": "411486491630370816",
  "slug": "text",
  "name": "text",
  "platform": "text",
  "game": "text",
  "currency": "text",
  "description": "text",
  "website_url": null,
  "contact_email": null,
  "support_email": null,
  "support_url": null,
  "integration_type": null,
  "live_mode": true,
  "logo_url": null,
  "logo_square_url": null,
  "minecraft_bedrock_username_prefix": null,
  "created_at": null,
  "updated_at": null,
  "onboarding_completed_at": null,
  "platform_store_type_association": {
    "platform_id": "411486491630370816",
    "associated_platform": {
      "id": "411486491630370816",
      "slug": "text",
      "type": "invalid",
      "country_code": "text",
      "business_name": "text",
      "name": "text",
      "description": "text",
      "website_url": "text",
      "logo_url": "text",
      "accent_color": "text",
      "capabilities": [
        "invalid"
      ],
      "created_at": "2026-07-10T10:28:56.261Z",
      "updated_at": null,
      "disabled_at": null
    },
    "store_platform": "text",
    "paynow_platform_fee_percentage_override": null,
    "connected_platform_fee_percentage": null,
    "connected_platform_wallet_id": "411486491630370816",
    "disable_billing_plans": true,
    "display_disclaimers": true,
    "full_external_management": true
  }
}

Update a store

patch

Partially updates a store's configuration using the provided fields.

Authorizations

AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

Body

slugstringOptional

namestringOptional

platformstringOptional

gamestringOptional

descriptionstringOptional

website_urlstringOptional

contact_emailstringOptional

support_emailstringOptional

support_urlstringOptional

integration_typestringOptional

live_modebooleanOptional

minecraft_bedrock_username_prefixstringOptional

Responses

200

application/json

Represents a PayNow store and its associated configuration.

idstring · flake-idRequiredExample: 411486491630370816

owner_idstring · flake-idRequiredExample: 411486491630370816

slugstringRequired

The URL-safe slug used to identify the store (e.g. "my-rust-server").

namestringRequired

The display name of the store.

platformstringRequired

The platform this store is associated with (e.g. "rust", "minecraft").

gamestringRead-onlyRequired

Alias for PayNow.Services.HttpGateway.DataTransferObjects.V1.Stores.StoreDto.Platform. Returns the platform identifier as a game name.

currencystringRequired

The ISO 4217 currency code used by this store for pricing (e.g. "usd", "eur")

descriptionstringRequired

A human-readable description of the store shown to customers and PayNow.

website_urlstring · nullableOptional

The store's public website URL.

contact_emailstring · nullableOptional

General contact email address for the store.

support_emailstring · nullableOptional

Dedicated support email address for customer inquiries.

support_urlstring · nullableOptional

URL to the store's support portal or help page.

integration_typestring · nullableOptional

The integration type used by the store.

live_modebooleanRequired

When set to true, the store is processing real transactions in live mode.

logo_urlstring · nullableOptional

URL of the store's full-size logo image.

logo_square_urlstring · nullableOptional

URL of the store's square/icon logo image.

minecraft_bedrock_username_prefixstring · nullableOptional

Username prefix used to identify Minecraft Bedrock players (e.g. ".").

created_atstring · nullableOptional

The UTC timestamp when the store was created.

updated_atstring · nullableOptional

The UTC timestamp when the store was last updated.

onboarding_completed_atstring · nullableOptional

The UTC timestamp when the store completed onboarding.

default

Error response

application/json

patch/v1/stores/{storeId}

PATCH /v1/stores/{storeId} HTTP/1.1
Authorization: APIKey TOKEN_HERE
Content-Type: application/json
Accept: */*
Content-Length: 256

{
  "slug": "text",
  "name": "text",
  "platform": "text",
  "game": "text",
  "description": "text",
  "website_url": "text",
  "contact_email": "text",
  "support_email": "text",
  "support_url": "text",
  "integration_type": "text",
  "live_mode": true,
  "minecraft_bedrock_username_prefix": "text"
}

{
  "id": "411486491630370816",
  "owner_id": "411486491630370816",
  "slug": "text",
  "name": "text",
  "platform": "text",
  "game": "text",
  "currency": "text",
  "description": "text",
  "website_url": null,
  "contact_email": null,
  "support_email": null,
  "support_url": null,
  "integration_type": null,
  "live_mode": true,
  "logo_url": null,
  "logo_square_url": null,
  "minecraft_bedrock_username_prefix": null,
  "created_at": null,
  "updated_at": null,
  "onboarding_completed_at": null,
  "platform_store_type_association": {
    "platform_id": "411486491630370816",
    "associated_platform": {
      "id": "411486491630370816",
      "slug": "text",
      "type": "invalid",
      "country_code": "text",
      "business_name": "text",
      "name": "text",
      "description": "text",
      "website_url": "text",
      "logo_url": "text",
      "accent_color": "text",
      "capabilities": [
        "invalid"
      ],
      "created_at": "2026-07-10T10:28:56.261Z",
      "updated_at": null,
      "disabled_at": null
    },
    "store_platform": "text",
    "paynow_platform_fee_percentage_override": null,
    "connected_platform_fee_percentage": null,
    "connected_platform_wallet_id": "411486491630370816",
    "disable_billing_plans": true,
    "display_disclaimers": true,
    "full_external_management": true
  }
}

List store members

get

Retrieves all members who have access to the specified store.

Authorizations

AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

Responses

200

application/json

Represents a member of a PayNow store.

idstring · flake-idRequiredExample: 411486491630370816

user_idstring · flake-idRequiredExample: 411486491630370816

added_atstring · nullableOptional

The UTC timestamp when the member was added to the store.

role_idstring · flake-idOptionalExample: 411486491630370816

default

Error response

application/json

get/v1/stores/{storeId}/members

GET /v1/stores/{storeId}/members HTTP/1.1
Authorization: APIKey TOKEN_HERE
Accept: */*

[
  {
    "id": "411486491630370816",
    "user_id": "411486491630370816",
    "user": {
      "type": "anonymous",
      "id": "411486491630370816",
      "email": null,
      "first_name": null,
      "last_name": null,
      "nickname": null
    },
    "added_at": null,
    "added_by": {
      "type": "anonymous",
      "id": "411486491630370816"
    },
    "role_id": "411486491630370816"
  }
]

Get store member permissions

get

Retrieves the resolved permissions map for a specific member of a store.

Authorizations

AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

memberIdstring · flake-idRequiredExample: 411486491630370816

Responses

200

application/json

Other propertiesbooleanOptional

default

Error response

application/json

get/v1/stores/{storeId}/members/{memberId}/permissions

GET /v1/stores/{storeId}/members/{memberId}/permissions HTTP/1.1
Authorization: APIKey TOKEN_HERE
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": true
}

Remove a store member

delete

Removes the specified member from the store, revoking their access.

Authorizations

AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

memberIdstring · flake-idRequiredExample: 411486491630370816

Responses

204

No Content

No content

default

Error response

application/json

delete/v1/stores/{storeId}/members/{memberId}

DELETE /v1/stores/{storeId}/members/{memberId} HTTP/1.1
Authorization: APIKey TOKEN_HERE
Accept: */*

No content

Update a store member

patch

Updates the role assigned to a specific member of the store.

Authorizations

AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

memberIdstring · flake-idRequiredExample: 411486491630370816

Body

role_idstring · flake-idRequiredExample: 411486491630370816

Responses

204

No Content

No content

default

Error response

application/json

patch/v1/stores/{storeId}/members/{memberId}

PATCH /v1/stores/{storeId}/members/{memberId} HTTP/1.1
Authorization: APIKey TOKEN_HERE
Content-Type: application/json
Accept: */*
Content-Length: 32

{
  "role_id": "411486491630370816"
}

No content

PreviousSales NextSubscriptions

Last updated 3 days ago

Was this helpful?