PayNow

Storefront Store

The store object contains the information about your store such as currency and other configuration values.

IMPORTANT: To properly display any relevant VAT/GST taxes, and for anti-fraud purposes, you are required to include the customer's IP address OR country code (preferred, in ISO 3166-1 alpha-2 format) in the request headers if you are proxying the requests through your server (in cases such as server-side rendering).

Endpoints

GET
/store

  • Request Headers

  • Name
    x-paynow-store-id
    Type
    flake
    Tags
    REQUIRED
    Description

    the ID of your store

  • Name
    Authorization
    Type
    customer auth?
    Tags
    OPTIONAL
    Description

    the token of your customer prefixed with customer if logged in, more information here

  • Name
    x-paynow-customer-ip
    Type
    string
    Tags
    Description

    the IP address (IPv4 or IPv6) of the customer.

  • Name
    x-paynow-customer-countrycode
    Type
    string
    Tags
    Description

    the customer's country code in ISO 3166-1 alpha-2 format. If you're using Cloudflare, you can use the value of CF-IPCountry header from the request of your customer.

    You need to include either x-paynow-customer-ip or x-paynow-customer-countrycode if the requests are not being made from the customer's browser.

The Store object

  • Fields

  • Name
    id
    Type
    flake
    Tags
    Description

    id of the store

  • Name
    slug
    Type
    string
    Tags
    Description

    the unique url-safe identifier for the store

  • Name
    name
    Type
    string
    Tags
    Description

    the name of the store

  • Name
    game
    Type
    enum
    Tags
    Description

    the game of the store

    Allowed enum values
    rust
  • Name
    currency
    Type
    string
    Tags
    Description

    the currency that this store uses for all of its pricing

  • Name
    logo_url
    Type
    string
    Tags
    NULLABLE
    Description

    a url to the main brand logo image for the store

  • Name
    logo_square_url
    Type
    string
    Tags
    NULLABLE
    Description

    a url to the square logo image for the store

The Store object

{
	"id": "94688451781206016",
	"slug": "best-store-ever",
	"name": "The BEST Store",
	"game": "rust",
	"currency": "usd",
	"logo_url": "https://example.paynow.gg/logo.webp",
	"logo_square_url": "https://example.paynow.gg/logo_square.webp"
}

Get Store

Returns the store object for the current customer.

Returns

Returns a store.

Request

GET
/store

Response

{
	"id": "94688451781206016",
	"slug": "best-store-ever",
	"name": "The BEST Store",
	"game": "rust",
	"currency": "usd",
	"logo_url": "https://example.paynow.gg/logo.webp",
	"logo_square_url": "https://example.paynow.gg/logo_square.webp"
}