Customer

Get current customer

get

Retrieves the current customer from the passed Customer token.

Authorizations

Customer

AuthorizationstringRequired

A Customer token generated using an API Key in the format 'Customer TOKEN_HERE'.

Responses

200

OK

application/json

Represents a customer in the PayNow system with their associated profiles and metadata.

idstring · flake-idRequiredExample: 411486491630370816

store_idstring · flake-idRequiredExample: 411486491630370816

steam_idstring · steam-idOptional

A 64-bit Steam account identifier. Accepts string or numeric format.

Example: 76561197960287930

minecraft_uuidstring · nullableOptional

The customer's Minecraft UUID, if they have linked their Minecraft account. Not set for offline Minecraft stores. If the platform type is Minecraft - Geyser, and the profile is a bedrock account, this will be a UUID generated from the Xbox XUID.

Example: f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2

xbox_xuidstring · nullableOptional

The customer's Xbox XUID, if available.

minecraft_platformstring · enumOptionalPossible values:

namestring · nullableOptional

The display name for the customer.

Example: m0uka

created_atstring · date-timeRequired

The date and time when the customer was created in the system.

updated_atstring · nullableOptional

The date and time when the customer was last updated, if applicable.

default

Error response

application/json

get

/v1/store/customer

HTTPcURLJavaScriptPython

GET /v1/store/customer HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": "411486491630370816",
  "store_id": "411486491630370816",
  "profile": {
    "id": "text",
    "platform": "steam",
    "name": "text",
    "avatar_url": null
  },
  "steam_id": "76561197960287930",
  "steam": {
    "id": "76561197960287930",
    "name": "text",
    "avatar_url": "text"
  },
  "minecraft_uuid": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
  "minecraft": {
    "id": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
    "name": "notch",
    "avatar_url": "text"
  },
  "xbox_xuid": null,
  "minecraft_platform": "unknown",
  "name": "m0uka",
  "created_at": "2026-02-19T00:03:12.997Z",
  "updated_at": null,
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

Lookup a gift card by the code

get

Authorizations

Customer

AuthorizationstringRequired

A Customer token generated using an API Key in the format 'Customer TOKEN_HERE'.

Path parameters

codestringRequired

Responses

200

OK

application/json

codestringRequired

balanceinteger · int32Required

starting_balanceinteger · int32Required

expires_atstring · nullableOptional

default

Error response

application/json

get

/v1/store/customer/giftcards/lookup/{code}

HTTPcURLJavaScriptPython

GET /v1/store/customer/giftcards/lookup/{code} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "code": "text",
  "balance": 1,
  "starting_balance": 1,
  "expires_at": null
}

Authenticate customer

post

Creates a customer and returns a customer token from a platform account.

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

Body

application/jsontext/jsonapplication/*+json

platformstring · enumRequiredPossible values:

idstringRequired

The account ID on the platform

Example: 76561198152492642

Responses

200

OK

application/json

customer_tokenstringRequired

The token for the Customer

default

Error response

application/json

post

/v1/store/customer/auth

HTTPcURLJavaScriptPython

POST /v1/store/customer/auth HTTP/1.1
x-paynow-store-id: text
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "platform": "invalid",
  "id": "76561198152492642"
}

application/jsontext/jsonapplication/*+json

{
  "customer_token": "text"
}