Customer

Get current customer

get

Retrieves the current customer from the passed Customer token.

Authorizations
AuthorizationstringRequired

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

Responses
200

OK

application/json
get
/v1/store/customer
GET /v1/store/customer HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": "411486491630370816",
  "store_id": "411486491630370816",
  "profile": {
    "id": "text",
    "platform": "steam",
    "name": "text",
    "avatar_url": "text"
  },
  "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": "text",
  "minecraft_platform": "unknown",
  "name": "m0uka",
  "created_at": "2025-11-19T15:38:16.375Z",
  "updated_at": "2025-11-19T15:38:16.375Z",
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

Lookup a gift card by the code

get
Authorizations
AuthorizationstringRequired

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

Path parameters
codestringRequired
Responses
200

OK

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

{
  "code": "text",
  "balance": 1,
  "starting_balance": 1,
  "expires_at": "2025-11-19T15:38:16.375Z"
}

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
platformstring · enumRequiredPossible values:
idstringRequired

The account ID on the platform

Example: 76561198152492642
Responses
200

OK

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

{
  "platform": "invalid",
  "id": "76561198152492642"
}
{
  "customer_token": "text"
}
PreviousCheckoutNextDelivery

Last updated

Was this helpful?