Store

Get current store

get

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

Authorizations

Customer & APIKey

Header parameters

x-paynow-store-idstring · flake-idRequired

PayNow Store Identifier (Store ID) available in Store Settings

x-paynow-customer-ipstring · ipv4Optional

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.

Pattern: ^[A-Z]{2}$

Responses

200

OK

application/json

Represents a store entity within the storefront system.

idstring · flake-idRequiredExample: 411486491630370816

slugstringRequired

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

Example: m0ukas-awesome-store

namestringRequired

The display name of the store shown to customers.

Example: m0uka's awesome store

platformstringRequired

The platform or the game of the store.

Example: rust

gamestringRead-onlyRequired

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

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).

Example: eur

creator_currencystringRequired

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

Example: usd

descriptionstring · nullableOptional

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

website_urlstring · nullableOptional

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

support_emailstring · nullableOptional

The email address customers can use to contact store support.

Example: [email protected]

support_urlstring · nullableOptional

The URL of the store's support page.

integration_typestring · nullableOptional

The type of integration this store uses with external systems.

live_modebooleanRequired

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

logo_urlstring · nullableOptional

The URL to the store's main logo image.

logo_square_urlstring · nullableOptional

The URL to the store's square logo image.

created_atstring · nullableOptional

The date and time when the store was created.

updated_atstring · nullableOptional

The date and time when the store was last updated.

default

Error response

application/json

get

/v1/store

HTTPcURLJavaScriptPython

GET /v1/store HTTP/1.1
x-paynow-store-id: text
Accept: */*

{
  "id": "411486491630370816",
  "slug": "m0ukas-awesome-store",
  "name": "m0uka's awesome store",
  "platform": "rust",
  "game": "text",
  "currency": "eur",
  "creator_currency": "usd",
  "description": null,
  "website_url": null,
  "support_email": "[email protected]",
  "support_url": null,
  "integration_type": null,
  "live_mode": true,
  "logo_url": null,
  "logo_square_url": null,
  "created_at": null,
  "updated_at": null
}