Store

Get current store

GEThttps://api.paynow.gg/v1/store

Retrieves a store by the passed in x-paynow-store-id or Customer token.

Headers

AuthorizationCustomer tokenAPI KeyRequired

Authentication token for this request, sent as Authorization: Customer TOKEN or Authorization: APIKey TOKEN.

x-paynow-store-idstringRequired

PayNow Store Identifier (Store ID) available in Store Settings

x-paynow-customer-ipstringOptional

The IP address (IPv4 or IPv6) of the customer. Required if the request is not being made from the customer's browser.

x-paynow-customer-countrycodestringOptional

The customer's country code in ISO 3166-1 alpha-2 format. Optional, but recommended if you have this available.

Response

200OKStorefrontStoreDto

Represents a store entity within the storefront system.

Show fields

creator_currencystringRequired

The three-letter ISO currency code signifying the main currency of the store.

currencystringRequired

The three-letter ISO currency code used for pricing in this store. If using the Adaptive Currency feature, this will be updated to reflect customer's local currency (based on passed in IP / country headers).

gamestringRequired

The game of the store. Equivalent to the `platform` for backwards compatibility.

idFlakeIdRequired

live_modebooleanRequired

Indicates whether the store is in live mode (true) or test mode (false).

namestringRequired

The display name of the store shown to customers.

platformstringRequired

The platform or the game of the store.

slugstringRequired

The URL-friendly identifier for the store, used in store URLs.

created_atstringOptional

The date and time when the store was created.

descriptionstringOptional

A detailed description of the store. Only present for some platform types.

integration_typestringOptional

The type of integration this store uses with external systems.

logo_square_urlstringOptional

The URL to the store's square logo image.

logo_urlstringOptional

The URL to the store's main logo image.

support_emailstringOptional

The email address customers can use to contact store support.

support_urlstringOptional

The URL of the store's support page.

updated_atstringOptional

The date and time when the store was last updated.

website_urlstringOptional

The URL of the store's main website, if not using Hosted Webstores.

Failed requests return a PayNowError body. See the error response guide.

curl -X GET "https://api.paynow.gg/v1/store" \
  -H "Authorization: Customer TOKEN"

import { createStorefrontClient } from "@paynow-gg/typescript-sdk";

const paynow = createStorefrontClient({
  storeId: "STORE_ID",
  customerToken: "CUSTOMER_TOKEN",
});

const result = await paynow.store.getStorefrontStore();

import requests

headers = {"Authorization": "Customer TOKEN"}
response = requests.get("https://api.paynow.gg/v1/store", headers=headers)

Response200

{
  "creator_currency": "usd",
  "currency": "eur",
  "game": "string",
  "id": "411486491630370816",
  "live_mode": true,
  "name": "m0uka's awesome store",
  "platform": "rust",
  "slug": "m0ukas-awesome-store",
  "description": "string",
  "website_url": "string",
  "support_email": "support@example.com",
  "support_url": "string",
  "integration_type": "string",
  "logo_url": "string",
  "logo_square_url": "string",
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z"
}