PayNow

https://docs.paynow.gg
Admin
PayNow is a beta platform providing Management and StoreFront APIs for managing stores, handling...
Tokens:240,737
Snippets:763
Trust Score:8
Update:2 months ago
Show doc for...
Tokens:
Raw
### GET /getting-started/error-response.md

Source: https://docs.paynow.gg/getting-started/error-response.md

Query the documentation dynamically by performing an HTTP GET request on the documentation page URL.

```APIDOC
## GET /getting-started/error-response.md

### Description
Query the documentation dynamically by asking a question. This is useful when the answer is not explicitly present in the current page or you need additional context.

### Method
GET

### Endpoint
https://docs.paynow.gg/getting-started/error-response.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask.
- **goal** (string) - Optional - The broader end goal you are trying to accomplish.
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.paynow.gg/getting-started/management-vs-storefront-apis.md

Perform a GET request to the documentation URL with 'ask' and 'goal' parameters to retrieve dynamic information.

```http
GET https://docs.paynow.gg/getting-started/management-vs-storefront-apis.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### GET /getting-started/authentication.md

Source: https://docs.paynow.gg/getting-started/authentication.md

Perform a query against the documentation to retrieve information or clarification.

```APIDOC
## GET /getting-started/authentication.md

### Description
Queries the documentation dynamically to retrieve information not explicitly present in the current page.

### Method
GET

### Endpoint
https://docs.paynow.gg/getting-started/authentication.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the answer.
```

--------------------------------

### GET /

Source: https://docs.paynow.gg/hosted-webstores/routes.md

Displays the main homepage of the webstore.

```APIDOC
## GET /

### Description
Displays the main homepage of the webstore.

### Method
GET

### Endpoint
/
```

--------------------------------

### Query documentation via HTTP GET

Source: https://docs.paynow.gg/hosted-webstores/variables.md

Perform an HTTP GET request to the documentation URL to retrieve answers to specific questions.

```http
GET https://docs.paynow.gg/hosted-webstores/variables.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### GET /products

Source: https://docs.paynow.gg/hosted-webstores/routes.md

Lists products available in the webstore with optional filtering.

```APIDOC
## GET /products

### Description
Lists products available in the webstore.

### Method
GET

### Endpoint
/products

### Parameters
#### Query Parameters
- **tags** (string[]) - Optional - Comma-separated tag slugs to filter products
```

--------------------------------

### Get Stores API Definition

Source: https://docs.paynow.gg/management/management-api/store.md

OpenAPI path definition for the /v1/stores GET endpoint.

```json
"paths":{"/v1/stores":{"get":{"tags":["store"],"summary":"Get stores","description":"Retrieves all stores accessible to the authenticated user or API key.","operationId":"Store_GetStores","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/StoreDto"}}}}},"default":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayNowError"}}}}}}}}
```

--------------------------------

### GET /webhooks/webhook-events/webhooks.md

Source: https://docs.paynow.gg/webhooks/webhook-events/webhooks.md

Query the documentation dynamically by performing an HTTP GET request on the documentation page URL.

```APIDOC
## GET /webhooks/webhook-events/webhooks.md

### Description
Query the documentation dynamically to retrieve information not explicitly present in the page.

### Method
GET

### Endpoint
https://docs.paynow.gg/webhooks/webhook-events/webhooks.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /webhooks/integration-implementation-examples.md

Source: https://docs.paynow.gg/webhooks/integration-implementation-examples.md

Performs a dynamic query against the documentation page to retrieve answers, excerpts, and sources based on a specific question and optional goal.

```APIDOC
## GET /webhooks/integration-implementation-examples.md

### Description
Queries the documentation dynamically to retrieve information not explicitly present on the page.

### Method
GET

### Endpoint
https://docs.paynow.gg/webhooks/integration-implementation-examples.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### Get Storefront Customer Delivery Items API Specification

Source: https://docs.paynow.gg/storefront-headless/storefront-api/delivery.md

OpenAPI specification for the GET /v1/store/customer/delivery/items endpoint.

```json
{"tags":["delivery"],"summary":"Get the customers delivery items","description":"Retrieves the current customers delivery items.","operationId":"StorefrontCustomerDelivery_GetStorefrontCustomerDeliveryItems","parameters":[{"name":"limit","in":"query","description":"The maximum number of items to return in a single request.","schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32"}},{"name":"after","in":"query","description":"Returns items after the specified ID.\nUsed for forward pagination through results.","schema":{"$ref":"#/components/schemas/FlakeId"}},{"name":"before","in":"query","description":"Returns items before the specified ID.\nUsed for backward pagination through results.","schema":{"$ref":"#/components/schemas/FlakeId"}},{"name":"asc","in":"query","description":"Determines the sort order of returned items.\nWhen true, items are returned in ascending order.\nWhen false, items are returned in descending order.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/StorefrontDeliveryItemDto"}}}}},"default":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayNowError"}}}}}}
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.paynow.gg/management/management-api/data-migrations.md

Use this request to ask specific questions about data migrations by appending the ask and goal parameters to the page URL.

```http
GET https://docs.paynow.gg/management/management-api/data-migrations.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Get a store API definition

Source: https://docs.paynow.gg/management/management-api/store.md

The OpenAPI specification for the GET /v1/stores/{storeId} endpoint and associated data models.

```json
250 = 2.50%).","format":"int64"},"connected_platform_wallet_id":{"$ref":"#/components/schemas/FlakeId"},"disable_billing_plans":{"type":"boolean","description":"When true, billing plans are disabled for this platform/store type combination."},"display_disclaimers":{"type":"boolean","description":"When true, legal or compliance disclaimers should be displayed to the end user."},"full_external_management":{"type":"boolean","description":"Whether the management hides some PayNow UI"}},"additionalProperties":false},"PublicPlatformDto":{"required":["accent_color","business_name","capabilities","country_code","created_at","description","id","logo_url","name","slug","type","website_url"],"type":"object","properties":{"id":{"$ref":"#/components/schemas/FlakeId"},"slug":{"type":"string"},"type":{"$ref":"#/components/schemas/PlatformType"},"country_code":{"type":"string"},"business_name":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"website_url":{"type":"string"},"logo_url":{"type":"string"},"accent_color":{"type":"string"},"capabilities":{"type":"array","items":{"$ref":"#/components/schemas/PlatformCapability"}},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":["null","string"],"format":"date-time"},"disabled_at":{"type":["null","string"],"format":"date-time"}},"additionalProperties":false},"PlatformType":{"enum":["invalid","marketplace","store_platform","other"],"type":"string"},"PlatformCapability":{"enum":["invalid","connected_users"],"type":"string"},"PayNowError":{"required":["code","message","status"],"type":"object","properties":{"status":{"type":"integer","description":"The HTTP status code.","format":"int32"},"code":{"type":"string","description":"The PayNow parseable error code."},"message":{"type":"string","description":"The human-readable error message."},"trace_id":{"type":["null","string"],"description":"A distributed trace ID used for debugging."},"errors":{"type":["null","array"],"items":{"$ref":"#/components/schemas/ValidationError"},"description":"An array of multiple errors. Only used by some API services."}},"additionalProperties":false,"description":"Represents a PayNow error"},"ValidationError":{"required":["code","message","path","validation"],"type":"object","properties":{"code":{"type":"string","description":"The parseable error code."},"message":{"type":"string","description":"The human-readable error message."},"path":{"type":"string","description":"The path leading to the validation error."},"validation":{"type":"string","description":"Type of the validation that failed."}},"additionalProperties":false,"description":"A validation error."}}},"paths":{"/v1/stores/{storeId}":{"get":{"tags":["store"],"summary":"Get a store","description":"Retrieves a single store by its ID.","operationId":"Store_GetStore","parameters":[{"name":"storeId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/FlakeId"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreDto"}}}},"default":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayNowError"}}}}}}}}
```

--------------------------------

### Get all tags for a store OpenAPI definition

Source: https://docs.paynow.gg/management/management-api/tags.md

Defines the GET /v1/stores/{storeId}/tags endpoint and the associated TagDto schema.

```json
{"openapi":"3.1.1","info":{"title":"PayNow Management API","version":"v1"},"tags":[{"name":"tags"}],"security":[{"APIKey":[]}],"components":{"securitySchemes":{"APIKey":{"type":"apiKey","description":"An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.","name":"Authorization","in":"header"}},"schemas":{"FlakeId":{"type":"string","additionalProperties":false,"format":"flake-id"},"TagDto":{"required":["created_at","created_by","enabled","id","name","slug","store_id"],"type":"object","properties":{"id":{"$ref":"#/components/schemas/FlakeId"},"store_id":{"$ref":"#/components/schemas/FlakeId"},"created_at":{"type":"string","description":"When the tag was created","format":"date-time"},"created_by":{"$ref":"#/components/schemas/ActorDto"},"name":{"type":"string","description":"The unique name for the tag."},"slug":{"type":"string","description":"The unique slug for the tag."},"description":{"type":["null","string"],"description":"The description of the tag."},"image_url":{"type":["null","string"],"description":"The Image URL associated with the tag."},"enabled":{"type":"boolean","description":"Indicates whether this tag is enabled."},"updated_at":{"type":["null","string"],"description":"When the tag was last updated.","format":"date-time"},"updated_by":{"$ref":"#/components/schemas/ActorDto"}},"additionalProperties":false},"ActorDto":{"required":["type"],"type":"object","properties":{"type":{"$ref":"#/components/schemas/PayNowActorType"},"id":{"$ref":"#/components/schemas/FlakeId"}},"additionalProperties":false},"PayNowActorType":{"enum":["anonymous","user","api_key","customer","game_server","internal","admin","platform","global_customer"],"type":"string"},"PayNowError":{"required":["code","message","status"],"type":"object","properties":{"status":{"type":"integer","description":"The HTTP status code.","format":"int32"},"code":{"type":"string","description":"The PayNow parseable error code."},"message":{"type":"string","description":"The human-readable error message."},"trace_id":{"type":["null","string"],"description":"A distributed trace ID used for debugging."},"errors":{"type":["null","array"],"items":{"$ref":"#/components/schemas/ValidationError"},"description":"An array of multiple errors. Only used by some API services."}},"additionalProperties":false,"description":"Represents a PayNow error"},"ValidationError":{"required":["code","message","path","validation"],"type":"object","properties":{"code":{"type":"string","description":"The parseable error code."},"message":{"type":"string","description":"The human-readable error message."},"path":{"type":"string","description":"The path leading to the validation error."},"validation":{"type":"string","description":"Type of the validation that failed."}},"additionalProperties":false,"description":"A validation error."}}},"paths":{"/v1/stores/{storeId}/tags":{"get":{"tags":["tags"],"summary":"Get all tags for a store","operationId":"Tags_GetTags","parameters":[{"name":"storeId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/FlakeId"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TagDto"}}}}},"default":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayNowError"}}}}}}}}
```

--------------------------------

### Configure Authorization Headers

Source: https://docs.paynow.gg/getting-started/authentication.md

Examples of Authorization headers for API Key, Customer, and Game Server authentication types.

```yaml
Authorization: apikey pnapi_v1_BRaqcrwTqptneZTsxUJKVPH1L9y14HZBae18vybzhVwT
```

```yaml
Authorization: customer yArTi2CZekPCHyxjetxUfRnUMANF5hXBxHyDrf3Nia38gGtfJCqa1EJYReqDPUaaV1UNN1U
```

```yaml
Authorization: gameserver J7273cAJT7s3cP5WdSjJPtVCsLXK3bVfVPJimTX2YDT4
```

--------------------------------

### POST /v1/stores/{storeId}/gameservers/{gameServerId}/console

Source: https://docs.paynow.gg/management/management-api/game-servers.md

Creates a new console configuration for a specified game server.

```APIDOC
## POST /v1/stores/{storeId}/gameservers/{gameServerId}/console

### Description
Create a console for a game server.

### Method
POST

### Endpoint
/v1/stores/{storeId}/gameservers/{gameServerId}/console

### Parameters
#### Path Parameters
- **storeId** (FlakeId) - Required - The ID of the store.
- **gameServerId** (FlakeId) - Required - The ID of the game server.

#### Request Body
- **type** (GameServerConsoleTypeDto) - Required - The type of console (e.g., "rust").
- **enabled** (boolean) - Required - Whether the console is enabled.
- **host** (string) - Required - The host address for the console.
- **port** (integer) - Required - The port number for the console.
- **secure** (boolean) - Required - Whether the connection is secure.
- **password** (string) - Optional - The password for the console.

### Response
#### Success Response (200)
- **game_server_id** (FlakeId) - The ID of the game server.
- **store_id** (FlakeId) - The ID of the store.
- **type** (GameServerConsoleTypeDto) - The type of console.
- **enabled** (boolean) - Whether the console is enabled.
- **assigned_runner_id** (string) - The ID of the assigned runner.
- **connection_status** (GameServerConsoleConnectionStatusDto) - The current connection status.
- **host** (string) - The host address.
- **port** (integer) - The port number.
- **secure** (boolean) - Whether the connection is secure.
- **created_at** (string) - The creation timestamp.
- **created_by** (ActorDto) - The actor who created the console.
```

--------------------------------

### Get custom variables endpoint definition

Source: https://docs.paynow.gg/management/management-api/custom-variables.md

OpenAPI path definition for the GET request to retrieve store-specific custom variables.

```json
Only used by some API services."}},"additionalProperties":false,"description":"Represents a PayNow error"},"ValidationError":{"required":["code","message","path","validation"],"type":"object","properties":{"code":{"type":"string","description":"The parseable error code."},"message":{"type":"string","description":"The human-readable error message."},"path":{"type":"string","description":"The path leading to the validation error."},"validation":{"type":"string","description":"Type of the validation that failed."}},"additionalProperties":false,"description":"A validation error."}}},"paths":{"/v1/stores/{storeId}/custom-variables":{"get":{"tags":["custom-variables"],"summary":"Get custom variables","description":"Retrieves all custom variables for the specified store.","operationId":"CustomVariables_GetCustomVariablesForStore","parameters":[{"name":"storeId","in":"path","description":"The ID of the store to retrieve custom variables for.","required":true,"schema":{"$ref":"#/components/schemas/FlakeId"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CustomVariableDto"}}}}},"default":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayNowError"}}}}}}}}
```

--------------------------------

### Install PayNow.js via package managers

Source: https://docs.paynow.gg/paynow.js/about-paynow.js.md

Commands to install the PayNow.js package using common Node.js package managers.

```bash
npm install @paynow-gg/paynow.js
```

```bash
pnpm install @paynow-gg/paynow.js
```

```bash
yarn install @paynow-gg/paynow.js
```

--------------------------------

### GET /hosted-webstores/routes.md

Source: https://docs.paynow.gg/hosted-webstores/routes.md

Queries the documentation page dynamically to retrieve answers, excerpts, and sources based on a specific question and optional end goal.

```APIDOC
## GET /hosted-webstores/routes.md

### Description
Perform an HTTP GET request on the current page URL to query the documentation dynamically. This is useful when the answer is not explicitly present in the page or additional context is required.

### Method
GET

### Endpoint
https://docs.paynow.gg/hosted-webstores/routes.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask, written in natural language.
- **goal** (string) - Optional - The broader end goal to help tailor the answer.

### Request Example
GET https://docs.paynow.gg/hosted-webstores/routes.md?ask=How do I configure webhooks?&goal=Setting up payment notifications

### Response
#### Success Response (200)
- **answer** (string) - A direct answer to the question.
- **excerpts** (array) - Relevant excerpts from the documentation.
- **sources** (array) - Sources used to generate the answer.
```

--------------------------------

### GET /hosted-webstores.md

Source: https://docs.paynow.gg/hosted-webstores

Performs a dynamic query against the documentation to retrieve answers, excerpts, and sources based on a specific question and optional goal.

```APIDOC
## GET /hosted-webstores.md

### Description
Queries the documentation dynamically to retrieve information not explicitly present in the current page.

### Method
GET

### Endpoint
https://docs.paynow.gg/hosted-webstores.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.

### Response
#### Success Response (200)
- **answer** (string) - A direct answer to the question.
- **excerpts** (array) - Relevant excerpts from the documentation.
- **sources** (array) - Sources used to generate the answer.
```

--------------------------------

### Get delivery items OpenAPI definition

Source: https://docs.paynow.gg/management/management-api/delivery.md

Defines the GET endpoint for retrieving delivery items with support for pagination and sorting parameters.

```json
{
  "/v1/stores/{storeId}/customers/{customerId}/delivery/items": {
    "get": {
      "tags": [
        "delivery"
      ],
      "summary": "Get delivery items associated with a customer",
      "description": "Retrieves delivery items associated with a customer",
      "operationId": "CustomersDelivery_GetCustomerDeliveryItems",
      "parameters": [
        {
          "name": "storeId",
          "in": "path",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/FlakeId"
          }
        },
        {
          "name": "customerId",
          "in": "path",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/FlakeId"
          }
        },
        {
          "name": "limit",
          "in": "query",
          "description": "The maximum number of items to return in a single request.",
          "schema": {
            "maximum": 100,
            "minimum": 1,
            "type": "integer",
            "format": "int32"
          }
        },
        {
          "name": "after",
          "in": "query",
          "description": "Returns items after the specified ID.\nUsed for forward pagination through results.",
          "schema": {
            "$ref": "#/components/schemas/FlakeId"
          }
        },
        {
          "name": "before",
          "in": "query",
          "description": "Returns items before the specified ID.\nUsed for backward pagination through results.",
          "schema": {
            "$ref": "#/components/schemas/FlakeId"
          }
        },
        {
          "name": "asc",
          "in": "query",
          "description": "Determines the sort order of returned items.\nWhen true, items are returned in ascending order.\nWhen false, items are returned in descending order.",
          "schema": {
            "type": "boolean"
          }
        },
        {
          "name": "activeOnly",
          "in": "query",
          "schema": {
            "type": "boolean"
          }
        }
      ],
      "responses": {
        "200": {
          "description": "OK",
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/DeliveryItemDto"
                }
              }
            }
          }
        },
        "default": {
          "description": "Error response",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PayNowError"
              }
            }
          }
        }
      }
    }
  }
}
```

--------------------------------

### Get Game Server Console OpenAPI Specification

Source: https://docs.paynow.gg/management/management-api/game-servers.md

The OpenAPI definition for the GET /v1/stores/{storeId}/gameservers/{gameServerId}/console endpoint.

```json
{"openapi":"3.1.1","info":{"title":"PayNow Management API","version":"v1"},"tags":[{"name":"game-servers"}],"security":[{"APIKey":[]}],"components":{"securitySchemes":{"APIKey":{"type":"apiKey","description":"An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.","name":"Authorization","in":"header"}},"schemas":{"FlakeId":{"type":"string","additionalProperties":false,"format":"flake-id"},"GameServerConsoleDto":{"required":["assigned_runner_id","connection_status","created_at","created_by","enabled","game_server_id","host","port","secure","store_id","type"],"type":"object","properties":{"game_server_id":{"$ref":"#/components/schemas/FlakeId"},"store_id":{"$ref":"#/components/schemas/FlakeId"},"type":{"$ref":"#/components/schemas/GameServerConsoleTypeDto"},"enabled":{"type":"boolean"},"assigned_runner_id":{"type":"string"},"connection_status":{"$ref":"#/components/schemas/GameServerConsoleConnectionStatusDto"},"last_heartbeat_at":{"type":["null","string"],"format":"date-time"},"host":{"type":"string"},"port":{"type":"integer","format":"int32"},"password":{"type":["null","string"]},"secure":{"type":"boolean"},"created_at":{"type":"string","format":"date-time"},"created_by":{"$ref":"#/components/schemas/ActorDto"},"updated_at":{"type":["null","string"],"format":"date-time"},"updated_by":{"$ref":"#/components/schemas/ActorDto"}},"additionalProperties":false},"GameServerConsoleTypeDto":{"enum":["unknown","rust"],"type":"string"},"GameServerConsoleConnectionStatusDto":{"enum":["unknown","disconnected","connecting","connected","backoff"],"type":"string"},"ActorDto":{"required":["type"],"type":"object","properties":{"type":{"$ref":"#/components/schemas/PayNowActorType"},"id":{"$ref":"#/components/schemas/FlakeId"}},"additionalProperties":false},"PayNowActorType":{"enum":["anonymous","user","api_key","customer","game_server","internal","admin","platform","global_customer"],"type":"string"},"PayNowError":{"required":["code","message","status"],"type":"object","properties":{"status":{"type":"integer","description":"The HTTP status code.","format":"int32"},"code":{"type":"string","description":"The PayNow parseable error code."},"message":{"type":"string","description":"The human-readable error message."},"trace_id":{"type":["null","string"],"description":"A distributed trace ID used for debugging."},"errors":{"type":["null","array"],"items":{"$ref":"#/components/schemas/ValidationError"},"description":"An array of multiple errors. Only used by some API services."}},"additionalProperties":false,"description":"Represents a PayNow error"},"ValidationError":{"required":["code","message","path","validation"],"type":"object","properties":{"code":{"type":"string","description":"The parseable error code."},"message":{"type":"string","description":"The human-readable error message."},"path":{"type":"string","description":"The path leading to the validation error."},"validation":{"type":"string","description":"Type of the validation that failed."}},"additionalProperties":false,"description":"A validation error."}}},"paths":{"/v1/stores/{storeId}/gameservers/{gameServerId}/console":{"get":{"tags":["game-servers"],"summary":"Get the associated console for a game server.","operationId":"GameServersConsole_GetGameServerConsole","parameters":[{"name":"storeId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/FlakeId"}},{"name":"gameServerId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/FlakeId"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GameServerConsoleDto"}}}},"default":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayNowError"}}}}}}}}
```

--------------------------------

### GET /hosted-webstores/variables.md

Source: https://docs.paynow.gg/hosted-webstores/variables.md

Queries the documentation page dynamically by providing a question and an optional goal to receive a tailored response.

```APIDOC
## GET /hosted-webstores/variables.md

### Description
Perform an HTTP GET request on the current page URL to query the documentation dynamically using natural language.

### Method
GET

### Endpoint
https://docs.paynow.gg/hosted-webstores/variables.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask the documentation.
- **goal** (string) - Optional - Describes the broader end goal to help tailor the response.
```

--------------------------------

### POST /v1/stores/{storeId}/gameservers

Source: https://docs.paynow.gg/management/management-api/game-servers.md

Creates a new game server for a specified store.

```APIDOC
## POST /v1/stores/{storeId}/gameservers

### Description
Create a new Game Server for a store.

### Method
POST

### Endpoint
/v1/stores/{storeId}/gameservers

### Parameters
#### Path Parameters
- **storeId** (FlakeId) - Required - The ID of the store.

#### Request Body
- **name** (string) - Required - The display name of the game server.
- **enabled** (boolean) - Required - Indicates whether the game server is currently enabled.

### Response
#### Success Response (200)
- **id** (FlakeId) - The unique identifier of the game server.
- **store_id** (FlakeId) - The ID of the store the server belongs to.
- **name** (string) - The display name of the game server.
- **enabled** (boolean) - Indicates whether the game server is currently enabled.
- **token** (string|null) - The authentication token used by the game server.
- **token_reset_at** (string|null) - The date and time when the authentication token was last reset.
- **linked_to** (GameServerLinkDto) - Linking information for the game server.
- **created_at** (string) - The date and time when the game server was created.
- **created_by** (ActorDto) - The actor who created the game server.
- **updated_at** (string|null) - The date and time when the game server was last updated.
- **updated_by** (ActorDto) - The actor who last updated the game server.
```

--------------------------------

### Get product OpenAPI specification

Source: https://docs.paynow.gg/management/management-api/products.md

Defines the GET endpoint for retrieving a specific product by ID. Do not use this route for storefront product displays.

```json
{"openapi":"3.1.1","info":{"title":"PayNow Management API","version":"v1"},"tags":[{"name":"products"}],"security":[{"APIKey":[]}],"components":{"securitySchemes":{"APIKey":{"type":"apiKey","description":"An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.","name":"Authorization","in":"header"}},"schemas":{"FlakeId":{"type":"string","additionalProperties":false,"format":"flake-id"},"ProductDto":{"type":"object"},"PayNowError":{"required":["code","message","status"],"type":"object","properties":{"status":{"type":"integer","description":"The HTTP status code.","format":"int32"},"code":{"type":"string","description":"The PayNow parseable error code."},"message":{"type":"string","description":"The human-readable error message."},"trace_id":{"type":["null","string"],"description":"A distributed trace ID used for debugging."},"errors":{"type":["null","array"],"items":{"$ref":"#/components/schemas/ValidationError"},"description":"An array of multiple errors. Only used by some API services."}},"additionalProperties":false,"description":"Represents a PayNow error"},"ValidationError":{"required":["code","message","path","validation"],"type":"object","properties":{"code":{"type":"string","description":"The parseable error code."},"message":{"type":"string","description":"The human-readable error message."},"path":{"type":"string","description":"The path leading to the validation error."},"validation":{"type":"string","description":"Type of the validation that failed."}},"additionalProperties":false,"description":"A validation error."}}},"paths":{"/v1/stores/{storeId}/products/{productId}":{"get":{"tags":["products"],"summary":"Get product","description":"Retrieves a specific product by ID from the specified store.\nDO NOT USE THIS ROUTE FOR DISPLAYING PRODUCTS ON YOUR STOREFRONT, use the storefront API instead.","operationId":"Products_GetProduct","parameters":[{"name":"storeId","in":"path","description":"The ID of the store the product belongs to.","required":true,"schema":{"$ref":"#/components/schemas/FlakeId"}},{"name":"productId","in":"path","description":"The ID of the product to retrieve.","required":true,"schema":{"$ref":"#/components/schemas/FlakeId"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductDto"}}}},"default":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayNowError"}}}}}}}}}
```

--------------------------------

### GET /hosted-webstores/modules.md

Source: https://docs.paynow.gg/hosted-webstores/modules.md

Queries the documentation content by providing a natural language question and an optional goal to receive a tailored answer.

```APIDOC
## GET /hosted-webstores/modules.md

### Description
Queries the documentation content by providing a natural language question and an optional goal to receive a tailored answer.

### Method
GET

### Endpoint
https://docs.paynow.gg/hosted-webstores/modules.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the answer.
```

--------------------------------

### PUT /v1/stores/{storeId}/marketing/purchase-follow-ups/configuration

Source: https://docs.paynow.gg/management/management-api/marketing.md

OpenAPI specification for setting purchase follow-up behavior for a specific store.

```json
{"put":{"tags":["marketing"],"summary":"Sets the purchase follow up behaviour for a store","operationId":"StorePurchaseFollowUps_SetStorePurchaseFollowUpConfigurationOptions","parameters":[{"name":"storeId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/FlakeId"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseFollowUpStoreConfigurationUpdateDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/PurchaseFollowUpStoreConfigurationUpdateDto"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/PurchaseFollowUpStoreConfigurationUpdateDto"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseFollowUpStoreConfigurationDto"}}}},"204":{"description":"No Content"},"default":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayNowError"}}}}}}}
```

--------------------------------

### Get products endpoint definition

Source: https://docs.paynow.gg/management/management-api/products.md

OpenAPI specification for the GET /v1/stores/{storeId}/products endpoint. Do not use this route for storefront product display.

```json
{"tags":["products"],"summary":"Get products","description":"Retrieves all products for the specified store.
DO NOT USE THIS ROUTE FOR DISPLAYING PRODUCTS ON YOUR STOREFRONT, use the storefront API instead!","operationId":"Products_GetProducts","parameters":[{"name":"storeId","in":"path","description":"The ID of the store to retrieve products for.","required":true,"schema":{"$ref":"#/components/schemas/FlakeId"}},{"name":"product_id","in":"query","schema":{"type":"array","items":{"$ref":"#/components/schemas/FlakeId"}}},{"name":"slug","in":"query","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ProductDto"}}}}},"default":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayNowError"}}}}}}
```

--------------------------------

### POST /customers/bulk

Source: https://docs.paynow.gg/management/management-api/customers.md

Creates up to 200 customers at once.

```APIDOC
## POST /customers/bulk

### Description
Creates up to 200 customers at once.

### Method
POST

### Endpoint
/customers/bulk

### Request Body
- **customers** (array) - Required - A list of customer objects to create, containing fields such as steam_id, minecraft_uuid, minecraft_platform, xbox_xuid, name, and metadata.
```

--------------------------------

### Get Current Customer OpenAPI Specification

Source: https://docs.paynow.gg/storefront-headless/storefront-api/customer.md

OpenAPI definition for the GET /v1/store/customer endpoint, which retrieves customer details using a provided Customer token.

```json
{"openapi":"3.1.1","info":{"title":"PayNow Storefront (Headless) API","version":"v1"},"tags":[{"name":"customer"}],"security":[{"Customer":[]}],"components":{"securitySchemes":{"Customer":{"type":"apiKey","description":"A Customer token generated using an API Key in the format 'Customer TOKEN_HERE'.","name":"Authorization","in":"header"}},"schemas":{"CustomerDto":{"type":"object"},"PayNowError":{"required":["code","message","status"],"type":"object","properties":{"status":{"type":"integer","description":"The HTTP status code.","format":"int32"},"code":{"type":"string","description":"The PayNow parseable error code."},"message":{"type":"string","description":"The human-readable error message."},"trace_id":{"type":["null","string"],"description":"A distributed trace ID used for debugging."},"errors":{"type":["null","array"],"items":{"$ref":"#/components/schemas/ValidationError"},"description":"An array of multiple errors. Only used by some API services."}},"additionalProperties":false,"description":"Represents a PayNow error"},"ValidationError":{"required":["code","message","path","validation"],"type":"object","properties":{"code":{"type":"string","description":"The parseable error code."},"message":{"type":"string","description":"The human-readable error message."},"path":{"type":"string","description":"The path leading to the validation error."},"validation":{"type":"string","description":"Type of the validation that failed."}},"additionalProperties":false,"description":"A validation error."}}},"paths":{"/v1/store/customer":{"get":{"tags":["customer"],"summary":"Get current customer","description":"Retrieves the current customer from the passed Customer token.","operationId":"StorefrontCustomer_GetStorefrontCustomer","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerDto"}}}},"default":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayNowError"}}}}}}}}}
```

--------------------------------

### GET /v1/store/products

Source: https://docs.paynow.gg/storefront-headless/storefront-api/products.md

Retrieves the available products. To make sure all VAT rates are properly displayed, pass in the IP headers as instructed.

```APIDOC
## GET /v1/store/products

### Description
Retrieves the available products. To make sure all VAT rates are properly displayed, pass in the IP headers as instructed.

### Method
GET

### Endpoint
/v1/store/products

### Parameters
#### Query Parameters
- **tag** (array) - Optional - Tag slugs to filter by. Each tag slug is a separate query parameter.
- **currency** (string) - Optional - The ISO three-letter lowercase currency code (e.g., usd, eur, gbp) to display prices in.
```

--------------------------------

### GET /subscriptions

Source: https://docs.paynow.gg/management/management-api/subscriptions.md

Retrieves all subscriptions for the specified store.

```APIDOC
## GET /subscriptions

### Description
Retrieves all subscriptions for the specified store.

### Method
GET

### Endpoint
/subscriptions
```

--------------------------------

### GET /v1/store/tags

Source: https://docs.paynow.gg/storefront-headless/storefront-api/tags.md

Retrieves a list of all tags associated with the store.

```APIDOC
## GET /v1/store/tags

### Description
Retrieves the store's tags, which are used for categorizing and filtering products.

### Method
GET

### Endpoint
/v1/store/tags

### Parameters
#### Header Parameters
- **x-paynow-store-id** (string) - Required - PayNow Store Identifier (Store ID) available in Store Settings.

### Response
#### Success Response (200)
- **Array of StorefrontTagDto** - A list of tag entities.

#### Response Example
[
  {
    "id": "123456789012345678",
    "store_id": "987654321098765432",
    "slug": "electronics",
    "name": "Electronics",
    "description": "Gadgets and devices",
    "image_url": null,
    "enabled": true,
    "created_at": "2023-01-01T00:00:00Z",
    "updated_at": null
  }
]
```

--------------------------------

### POST /v1/store/customer/auth

Source: https://docs.paynow.gg/storefront-headless/storefront-api/customer.md

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

```APIDOC
## POST /v1/store/customer/auth

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

### Method
POST

### Endpoint
/v1/store/customer/auth

### Parameters
#### Header Parameters
- **x-paynow-store-id** (string) - Required - PayNow Store Identifier (Store ID) available in Store Settings
- **x-paynow-customer-ip** (string) - Optional - 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-countrycode** (string) - Optional - The customer's country code in ISO 3166-1 alpha-2 format.

#### Request Body
- **platform** (string) - Required - The platform type (e.g., steam, minecraft, paynow, etc.)
- **id** (string) - Required - The account ID on the platform

### Response
#### Success Response (200)
- **customer_token** (string) - The token for the Customer
```

--------------------------------

### GET /v1/stores/{storeId}

Source: https://docs.paynow.gg/management/management-api/store.md

Retrieves a single store by its ID.

```APIDOC
## GET /v1/stores/{storeId}

### Description
Retrieves a single store by its ID.

### Method
GET

### Endpoint
/v1/stores/{storeId}

### Parameters
#### Path Parameters
- **storeId** (FlakeId) - Required - The unique identifier of the store.

### Response
#### Success Response (200)
- **StoreDto** (Object) - The store details object.

#### Error Response (default)
- **PayNowError** (Object) - Error response containing status, code, and message.
```

--------------------------------

### POST /products/{product.slug}/checkout

Source: https://docs.paynow.gg/hosted-webstores/routes.md

Initiates a checkout process for a specific product.

```APIDOC
## POST /products/{product.slug}/checkout

### Description
Initiates a checkout process for a specific product.

### Method
POST

### Endpoint
/products/{product.slug}/checkout

### Parameters
#### Path Parameters
- **product.slug** (string) - Required - The slug of the product

#### Query Parameters
- **cart** (boolean) - Optional - Adds to cart if true
- **subscription** (boolean) - Optional - Adds as a subscription
- **trial** (boolean) - Optional - Adds as a trial. Subscription must also be true.
- **quantity** (int) - Optional - Product quantity (default: 1)
- **gift_to** (string) - Optional - Recipient’s platform ID
- **gift_platform** (string) - Optional - Gifting platform (default: "steam")
- **gameserver_id** (string) - Optional - ID of selected gameserver
```

--------------------------------

### GET /payments/{id}

Source: https://docs.paynow.gg/management/management-api/payments.md

Retrieves a payment by its unique identifier.

```APIDOC
## GET /payments/{id}

### Description
Retrieves a payment by an ID.

### Method
GET

### Endpoint
/payments/{id}

### Parameters
#### Path Parameters
- **id** (FlakeId) - Required - The unique identifier of the payment.
```

--------------------------------

### Get products

Source: https://docs.paynow.gg/storefront-headless/storefront-api/products.md

Retrieves the available products. To ensure correct VAT rate display, include the client's IP headers in the request.

```APIDOC
## GET /products

### Description
Retrieves the available products. To make sure all VAT rates are properly displayed, pass in the IP headers as instructed.

### Method
GET

### Endpoint
/products
```

--------------------------------

### GET /customers

Source: https://docs.paynow.gg/management/management-api/customers.md

Retrieves all customers associated with the specified store.

```APIDOC
## GET /customers

### Description
Retrieves all customers for the specified store.

### Method
GET

### Endpoint
/customers

### Response
#### Success Response (200)
- **customers** (array) - A list of CustomerDto objects representing the customers in the store.
```
Tokens:
Raw