Customers | PayNow API

Get customers

get

Retrieves all customers for the specified store.

Authorizations

Path parameters

storeIdstring · flake-idRequired

The ID of the store to retrieve customers for.

Example: 411486491630370816

Query parameters

limitinteger · int32 · min: 1 · max: 100Optional

The maximum number of items to return in a single request.

afterinteger · int64Optional

Returns items after the specified ID. Used for forward pagination through results.

beforeinteger · int64Optional

Returns items before the specified ID. Used for backward pagination through results.

ascbooleanOptional

Determines the sort order of returned items. When true, items are returned in ascending order. When false, items are returned in descending order.

searchstringOptional

Responses

200

OK

application/json

default

Error response

application/json

get

GET /v1/stores/{storeId}/customers 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-08-22T18:15:51.754Z",
    "updated_at": "2025-08-22T18:15:51.754Z",
    "metadata": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  }
]

Create customer

post

Creates a new customer based on the fields passed.

Authorizations

Path parameters

storeIdstring · flake-idRequired

The ID of the store to create the customer for.

Example: 411486491630370816

Body

steam_idstring · steam-idOptional

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

Example: 76561197960287930

minecraft_uuidstring | nullableOptional

The Minecraft UUID for the customer.

minecraft_platformstring · enumOptionalPossible values:

xbox_xuidstring | nullableOptional

The Xbox XUID (Xbox User ID) for the customer.

namestring | nullableOptional

The name of the customer.

Responses

200

OK

application/json

default

Error response

application/json

post

POST /v1/stores/{storeId}/customers HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 166

{
  "steam_id": "76561197960287930",
  "minecraft_uuid": "text",
  "minecraft_platform": "unknown",
  "xbox_xuid": "text",
  "name": "text",
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

{
  "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-08-22T18:15:51.754Z",
  "updated_at": "2025-08-22T18:15:51.754Z",
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

Get customer by ID

get

Retrieves a customer by the ID for the specified store.

Authorizations

Path parameters

storeIdstring · flake-idRequired

The ID of the store to retrieve the customer for.

Example: 411486491630370816

customerIdstring · flake-idRequired

The ID of the customer.

Example: 411486491630370816

Responses

200

OK

application/json

default

Error response

application/json

get

GET /v1/stores/{storeId}/customers/{customerId} 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-08-22T18:15:51.754Z",
  "updated_at": "2025-08-22T18:15:51.754Z",
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

Update customer

patch

Updates an existing customer based on the fields passed.

Authorizations

Path parameters

storeIdstring · flake-idRequired

The ID of the store to update the customer for.

Example: 411486491630370816

customerIdstring · flake-idRequiredExample: 411486491630370816

Body

steam_idstring · steam-idOptional

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

Example: 76561197960287930

minecraft_uuidstring | nullableOptional

The Minecraft UUID for the customer.

minecraft_platformstring · enumOptionalPossible values:

xbox_xuidstring | nullableOptional

The Xbox XUID (Xbox User ID) for the customer.

namestring | nullableOptional

The name of the customer.

Responses

200

OK

application/json

default

Error response

application/json

patch

PATCH /v1/stores/{storeId}/customers/{customerId} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 166

{
  "steam_id": "76561197960287930",
  "minecraft_uuid": "text",
  "minecraft_platform": "unknown",
  "xbox_xuid": "text",
  "name": "text",
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

{
  "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-08-22T18:15:51.754Z",
  "updated_at": "2025-08-22T18:15:51.754Z",
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

Create customer token

post

Generates a customer token that can be used by the Storefront (Headless) API.

Authorizations

Path parameters

storeIdstring · flake-idRequired

The ID of the store to generate the customer token for.

Example: 411486491630370816

customerIdstring · flake-idRequired

The ID of the customer to generate the customer token for.

Example: 411486491630370816

Responses

200

OK

application/json

default

Error response

application/json

post

POST /v1/stores/{storeId}/customers/{customerId}/tokens HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "token": "text"
}

Invalidate customer tokens

delete

Invalidates all generated customer tokens.

Authorizations

Path parameters

storeIdstring · flake-idRequired

The ID of the store to invalidate the customer tokens for.

Example: 411486491630370816

customerIdstring · flake-idRequired

The ID of the customer to invalidate the customer tokens for.

Example: 411486491630370816

Responses

204

No Content

default

Error response

application/json

delete

DELETE /v1/stores/{storeId}/customers/{customerId}/tokens HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

No content

Lookup customer

get

Looks up a customer by an external platform ID.

Authorizations

Path parameters

storeIdstring · flake-idRequired

The ID of the store to retrieve the customer for.

Example: 411486491630370816

Query parameters

idstringOptional

Looks up customer by PayNow Customer ID.

steam_idstring · steam-idOptional

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

Example: 76561197960287930

minecraft_uuidstringOptional

Looks up customer by a Minecraft UUID.

xbox_xuidstringOptional

Looks up customer by an Xbox XUID.

minecraft_java_namestringOptional

Looks up customer by Minecraft Java name.

minecraft_bedrock_namestringOptional

Looks up customer by Minecraft Bedrock name.

namestringOptional

Looks up customer by a PayNow Customer Name. Name has to be explicitly set in the Customer entity - profile names won't be matched.

Responses

200

OK

application/json

default

Error response

application/json

get

GET /v1/stores/{storeId}/customers/lookup 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-08-22T18:15:51.754Z",
  "updated_at": "2025-08-22T18:15:51.754Z",
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

Bulk create customers

post

Creates up to 200 customers at once.

Authorizations

Path parameters

storeIdstring · flake-idRequired

The ID of the store to create the customers for.

Example: 411486491630370816

Bodyobject[]

steam_idstring · steam-idOptional

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

Example: 76561197960287930

minecraft_uuidstring | nullableOptional

The Minecraft UUID for the customer.

minecraft_platformstring · enumOptionalPossible values:

xbox_xuidstring | nullableOptional

The Xbox XUID (Xbox User ID) for the customer.

namestring | nullableOptional

The name of the customer.

Responses

200

OK

application/json

default

Error response

application/json

post

POST /v1/stores/{storeId}/customers/bulk HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 168

[
  {
    "steam_id": "76561197960287930",
    "minecraft_uuid": "text",
    "minecraft_platform": "unknown",
    "xbox_xuid": "text",
    "name": "text",
    "metadata": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  }
]

[
  {
    "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-08-22T18:15:51.754Z",
    "updated_at": "2025-08-22T18:15:51.754Z",
    "metadata": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  }
]