PayNow

Store

Get stores

GEThttps://api.paynow.gg/v1/stores

Retrieves all stores accessible to the authenticated user or API key.

Headers
AuthorizationAPI KeyRequired
Authentication token for this request, sent as Authorization: APIKey TOKEN.
Response
200OKStoreDto[]
Represents a PayNow store and its associated configuration.
Show fields
idFlakeIdRequired
currencystringRequired
The ISO 4217 currency code used by this store for pricing (e.g. "usd", "eur")
descriptionstringRequired
A human-readable description of the store shown to customers and PayNow.
gamestringRequired
Alias for 'platform'. Returns the platform identifier as a game name.
live_modebooleanRequired
When set to true, the store is processing real transactions in live mode.
namestringRequired
The display name of the store.
owner_idFlakeIdRequired
platformstringRequired
The platform this store is associated with (e.g. "rust", "minecraft").
slugstringRequired
The URL-safe slug used to identify the store (e.g. "my-rust-server").
contact_emailstringOptional
General contact email address for the store.
created_atstringOptional
The UTC timestamp when the store was created.
integration_typestringOptional
The integration type used by the store.
logo_square_urlstringOptional
URL of the store's square/icon logo image.
logo_urlstringOptional
URL of the store's full-size logo image.
minecraft_bedrock_username_prefixstringOptional
Username prefix used to identify Minecraft Bedrock players (e.g. ".").
onboarding_completed_atstringOptional
The UTC timestamp when the store completed onboarding.
platform_store_type_associationPlatformStoreTypeAssociationDetailsDtoOptional
disable_billing_plansbooleanRequired
When true, billing plans are disabled for this platform/store type combination.
display_disclaimersbooleanRequired
When true, legal or compliance disclaimers should be displayed to the end user.
full_external_managementbooleanRequired
Whether the management hides some PayNow UI
platform_idFlakeIdRequired
store_platformstringRequired
The store platform identifier string (e.g. "rust", "minecraft").
associated_platformPublicPlatformDtoOptional
idFlakeIdRequired
accent_colorstringRequired
business_namestringRequired
capabilitiesenum[]Required
Possible enum values
  • invalid
  • connected_users
country_codestringRequired
created_atstringRequired
descriptionstringRequired
logo_urlstringRequired
namestringRequired
slugstringRequired
typeenumRequired
Possible enum values
  • invalid
  • marketplace
  • store_platform
  • other
website_urlstringRequired
disabled_atstringOptional
updated_atstringOptional
connected_platform_fee_percentageintegerOptional
The fee percentage charged by the connected platform. Expressed in basis points (e.g. 250 = 2.50%).
connected_platform_wallet_idFlakeIdOptional
paynow_platform_fee_percentage_overrideintegerOptional
Overrides the default PayNow platform fee percentage for this association. Expressed in basis points (e.g. 250 = 2.50%).
support_emailstringOptional
Dedicated support email address for customer inquiries.
support_urlstringOptional
URL to the store's support portal or help page.
updated_atstringOptional
The UTC timestamp when the store was last updated.
website_urlstringOptional
The store's public website URL.

Failed requests return a PayNowError body. See the error response guide.

curl -X GET "https://api.paynow.gg/v1/stores" \
  -H "Authorization: APIKey TOKEN"
Response200
[
  {
    "id": "411486491630370816",
    "currency": "string",
    "description": "string",
    "game": "string",
    "live_mode": true,
    "name": "string",
    "owner_id": "411486491630370816",
    "platform": "string",
    "slug": "string",
    "contact_email": "string",
    "created_at": "2024-01-01T00:00:00Z",
    "integration_type": "string",
    "logo_square_url": "string",
    "logo_url": "string",
    "minecraft_bedrock_username_prefix": "string",
    "onboarding_completed_at": "2024-01-01T00:00:00Z",
    "platform_store_type_association": {
      "disable_billing_plans": true,
      "display_disclaimers": true,
      "full_external_management": true,
      "platform_id": "411486491630370816",
      "store_platform": "string",
      "associated_platform": {
        "id": "411486491630370816",
        "accent_color": "string",
        "business_name": "string",
        "capabilities": [
          "invalid"
        ],
        "country_code": "string",
        "created_at": "2024-01-01T00:00:00Z",
        "description": "string",
        "logo_url": "string",
        "name": "string",
        "slug": "string",
        "type": "invalid",
        "website_url": "string",
        "disabled_at": "2024-01-01T00:00:00Z",
        "updated_at": "2024-01-01T00:00:00Z"
      },
      "connected_platform_fee_percentage": 0,
      "connected_platform_wallet_id": "411486491630370816",
      "paynow_platform_fee_percentage_override": 0
    },
    "support_email": "string",
    "support_url": "string",
    "updated_at": "2024-01-01T00:00:00Z",
    "website_url": "string"
  }
]

Get a store

GEThttps://api.paynow.gg/v1/stores/{storeId}

Retrieves a single store by its ID.

Headers
AuthorizationAPI KeyRequired
Authentication token for this request, sent as Authorization: APIKey TOKEN.
Path parameters
storeIdFlakeIdRequired
The ID of the store.
Response
200OKStoreDto
Represents a PayNow store and its associated configuration.
Show fields
idFlakeIdRequired
currencystringRequired
The ISO 4217 currency code used by this store for pricing (e.g. "usd", "eur")
descriptionstringRequired
A human-readable description of the store shown to customers and PayNow.
gamestringRequired
Alias for 'platform'. Returns the platform identifier as a game name.
live_modebooleanRequired
When set to true, the store is processing real transactions in live mode.
namestringRequired
The display name of the store.
owner_idFlakeIdRequired
platformstringRequired
The platform this store is associated with (e.g. "rust", "minecraft").
slugstringRequired
The URL-safe slug used to identify the store (e.g. "my-rust-server").
contact_emailstringOptional
General contact email address for the store.
created_atstringOptional
The UTC timestamp when the store was created.
integration_typestringOptional
The integration type used by the store.
logo_square_urlstringOptional
URL of the store's square/icon logo image.
logo_urlstringOptional
URL of the store's full-size logo image.
minecraft_bedrock_username_prefixstringOptional
Username prefix used to identify Minecraft Bedrock players (e.g. ".").
onboarding_completed_atstringOptional
The UTC timestamp when the store completed onboarding.
platform_store_type_associationPlatformStoreTypeAssociationDetailsDtoOptional
disable_billing_plansbooleanRequired
When true, billing plans are disabled for this platform/store type combination.
display_disclaimersbooleanRequired
When true, legal or compliance disclaimers should be displayed to the end user.
full_external_managementbooleanRequired
Whether the management hides some PayNow UI
platform_idFlakeIdRequired
store_platformstringRequired
The store platform identifier string (e.g. "rust", "minecraft").
associated_platformPublicPlatformDtoOptional
idFlakeIdRequired
accent_colorstringRequired
business_namestringRequired
capabilitiesenum[]Required
Possible enum values
  • invalid
  • connected_users
country_codestringRequired
created_atstringRequired
descriptionstringRequired
logo_urlstringRequired
namestringRequired
slugstringRequired
typeenumRequired
Possible enum values
  • invalid
  • marketplace
  • store_platform
  • other
website_urlstringRequired
disabled_atstringOptional
updated_atstringOptional
connected_platform_fee_percentageintegerOptional
The fee percentage charged by the connected platform. Expressed in basis points (e.g. 250 = 2.50%).
connected_platform_wallet_idFlakeIdOptional
paynow_platform_fee_percentage_overrideintegerOptional
Overrides the default PayNow platform fee percentage for this association. Expressed in basis points (e.g. 250 = 2.50%).
support_emailstringOptional
Dedicated support email address for customer inquiries.
support_urlstringOptional
URL to the store's support portal or help page.
updated_atstringOptional
The UTC timestamp when the store was last updated.
website_urlstringOptional
The store's public website URL.

Failed requests return a PayNowError body. See the error response guide.

curl -X GET "https://api.paynow.gg/v1/stores/{storeId}" \
  -H "Authorization: APIKey TOKEN"
Response200
{
  "id": "411486491630370816",
  "currency": "string",
  "description": "string",
  "game": "string",
  "live_mode": true,
  "name": "string",
  "owner_id": "411486491630370816",
  "platform": "string",
  "slug": "string",
  "contact_email": "string",
  "created_at": "2024-01-01T00:00:00Z",
  "integration_type": "string",
  "logo_square_url": "string",
  "logo_url": "string",
  "minecraft_bedrock_username_prefix": "string",
  "onboarding_completed_at": "2024-01-01T00:00:00Z",
  "platform_store_type_association": {
    "disable_billing_plans": true,
    "display_disclaimers": true,
    "full_external_management": true,
    "platform_id": "411486491630370816",
    "store_platform": "string",
    "associated_platform": {
      "id": "411486491630370816",
      "accent_color": "string",
      "business_name": "string",
      "capabilities": [
        "invalid"
      ],
      "country_code": "string",
      "created_at": "2024-01-01T00:00:00Z",
      "description": "string",
      "logo_url": "string",
      "name": "string",
      "slug": "string",
      "type": "invalid",
      "website_url": "string",
      "disabled_at": "2024-01-01T00:00:00Z",
      "updated_at": "2024-01-01T00:00:00Z"
    },
    "connected_platform_fee_percentage": 0,
    "connected_platform_wallet_id": "411486491630370816",
    "paynow_platform_fee_percentage_override": 0
  },
  "support_email": "string",
  "support_url": "string",
  "updated_at": "2024-01-01T00:00:00Z",
  "website_url": "string"
}

Update a store

PATCHhttps://api.paynow.gg/v1/stores/{storeId}

Partially updates a store's configuration using the provided fields.

Headers
AuthorizationAPI KeyRequired
Authentication token for this request, sent as Authorization: APIKey TOKEN.
Path parameters
storeIdFlakeIdRequired
The ID of the store to update.
Request body
contact_emailstringOptional
General contact email address for the store.
descriptionstringOptional
A human-readable description of the store shown to customers and PayNow.
gamestringOptional
Alias for 'platform'. Returns the platform identifier as a game name.
integration_typestringOptional
The integration type used by the store.
live_modebooleanOptional
When set to true, the store is processing real transactions in live mode.
minecraft_bedrock_username_prefixstringOptional
Username prefix used to identify Minecraft Bedrock players (e.g. ".").
namestringOptional
The display name of the store.
platformstringOptional
The platform this store is associated with (e.g. "rust", "minecraft").
slugstringOptional
The URL-safe slug used to identify the store (e.g. "my-rust-server").
support_emailstringOptional
Dedicated support email address for customer inquiries.
support_urlstringOptional
URL to the store's support portal or help page.
website_urlstringOptional
The store's public website URL.
Response
200OKStoreDto
Represents a PayNow store and its associated configuration.
Show fields
idFlakeIdRequired
currencystringRequired
The ISO 4217 currency code used by this store for pricing (e.g. "usd", "eur")
descriptionstringRequired
A human-readable description of the store shown to customers and PayNow.
gamestringRequired
Alias for 'platform'. Returns the platform identifier as a game name.
live_modebooleanRequired
When set to true, the store is processing real transactions in live mode.
namestringRequired
The display name of the store.
owner_idFlakeIdRequired
platformstringRequired
The platform this store is associated with (e.g. "rust", "minecraft").
slugstringRequired
The URL-safe slug used to identify the store (e.g. "my-rust-server").
contact_emailstringOptional
General contact email address for the store.
created_atstringOptional
The UTC timestamp when the store was created.
integration_typestringOptional
The integration type used by the store.
logo_square_urlstringOptional
URL of the store's square/icon logo image.
logo_urlstringOptional
URL of the store's full-size logo image.
minecraft_bedrock_username_prefixstringOptional
Username prefix used to identify Minecraft Bedrock players (e.g. ".").
onboarding_completed_atstringOptional
The UTC timestamp when the store completed onboarding.
platform_store_type_associationPlatformStoreTypeAssociationDetailsDtoOptional
disable_billing_plansbooleanRequired
When true, billing plans are disabled for this platform/store type combination.
display_disclaimersbooleanRequired
When true, legal or compliance disclaimers should be displayed to the end user.
full_external_managementbooleanRequired
Whether the management hides some PayNow UI
platform_idFlakeIdRequired
store_platformstringRequired
The store platform identifier string (e.g. "rust", "minecraft").
associated_platformPublicPlatformDtoOptional
idFlakeIdRequired
accent_colorstringRequired
business_namestringRequired
capabilitiesenum[]Required
Possible enum values
  • invalid
  • connected_users
country_codestringRequired
created_atstringRequired
descriptionstringRequired
logo_urlstringRequired
namestringRequired
slugstringRequired
typeenumRequired
Possible enum values
  • invalid
  • marketplace
  • store_platform
  • other
website_urlstringRequired
disabled_atstringOptional
updated_atstringOptional
connected_platform_fee_percentageintegerOptional
The fee percentage charged by the connected platform. Expressed in basis points (e.g. 250 = 2.50%).
connected_platform_wallet_idFlakeIdOptional
paynow_platform_fee_percentage_overrideintegerOptional
Overrides the default PayNow platform fee percentage for this association. Expressed in basis points (e.g. 250 = 2.50%).
support_emailstringOptional
Dedicated support email address for customer inquiries.
support_urlstringOptional
URL to the store's support portal or help page.
updated_atstringOptional
The UTC timestamp when the store was last updated.
website_urlstringOptional
The store's public website URL.

Failed requests return a PayNowError body. See the error response guide.

curl -X PATCH "https://api.paynow.gg/v1/stores/{storeId}" \
  -H "Authorization: APIKey TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "contact_email": "string",
  "description": "string",
  "game": "string",
  "integration_type": "string",
  "live_mode": true,
  "minecraft_bedrock_username_prefix": "string",
  "name": "string",
  "platform": "string",
  "slug": "string",
  "support_email": "string",
  "support_url": "string",
  "website_url": "string"
}'
Response200
{
  "id": "411486491630370816",
  "currency": "string",
  "description": "string",
  "game": "string",
  "live_mode": true,
  "name": "string",
  "owner_id": "411486491630370816",
  "platform": "string",
  "slug": "string",
  "contact_email": "string",
  "created_at": "2024-01-01T00:00:00Z",
  "integration_type": "string",
  "logo_square_url": "string",
  "logo_url": "string",
  "minecraft_bedrock_username_prefix": "string",
  "onboarding_completed_at": "2024-01-01T00:00:00Z",
  "platform_store_type_association": {
    "disable_billing_plans": true,
    "display_disclaimers": true,
    "full_external_management": true,
    "platform_id": "411486491630370816",
    "store_platform": "string",
    "associated_platform": {
      "id": "411486491630370816",
      "accent_color": "string",
      "business_name": "string",
      "capabilities": [
        "invalid"
      ],
      "country_code": "string",
      "created_at": "2024-01-01T00:00:00Z",
      "description": "string",
      "logo_url": "string",
      "name": "string",
      "slug": "string",
      "type": "invalid",
      "website_url": "string",
      "disabled_at": "2024-01-01T00:00:00Z",
      "updated_at": "2024-01-01T00:00:00Z"
    },
    "connected_platform_fee_percentage": 0,
    "connected_platform_wallet_id": "411486491630370816",
    "paynow_platform_fee_percentage_override": 0
  },
  "support_email": "string",
  "support_url": "string",
  "updated_at": "2024-01-01T00:00:00Z",
  "website_url": "string"
}

List store members

GEThttps://api.paynow.gg/v1/stores/{storeId}/members

Retrieves all members who have access to the specified store.

Headers
AuthorizationAPI KeyRequired
Authentication token for this request, sent as Authorization: APIKey TOKEN.
Path parameters
storeIdFlakeIdRequired
Response
200OKStoreMemberDto[]
Represents a member of a PayNow store.
Show fields
idFlakeIdRequired
userStoreMemberUserDtoRequired
Represents identity and profile information for a store member.
idFlakeIdRequired
typeenumRequired
Possible enum values
  • anonymous
  • user
  • api_key
  • customer
  • game_server
  • internal
  • admin
  • platform
  • global_customer
emailstringOptional
The email address associated with the user. Only visible if you are the store owner.
first_namestringOptional
The first name of the actor. Hidden if the user has a set nickname, and you are not the store owner.
last_namestringOptional
The last name of the actor. Hidden if the user has a set nickname, and you are not the store owner.
nicknamestringOptional
The nickname of the user.
user_idFlakeIdRequired
added_atstringOptional
The UTC timestamp when the member was added to the store.
added_byActorDtoOptional
Represents the actor that performed an action, such as the user, API key or game server that created or changed a record.
idFlakeIdOptional
typeenumRequired
Possible enum values
  • anonymous
  • user
  • api_key
  • customer
  • game_server
  • internal
  • admin
  • platform
  • global_customer
role_idFlakeIdOptional

Failed requests return a PayNowError body. See the error response guide.

curl -X GET "https://api.paynow.gg/v1/stores/{storeId}/members" \
  -H "Authorization: APIKey TOKEN"
Response200
[
  {
    "id": "411486491630370816",
    "user": {
      "id": "411486491630370816",
      "type": "anonymous",
      "email": "string",
      "first_name": "string",
      "last_name": "string",
      "nickname": "string"
    },
    "user_id": "411486491630370816",
    "added_at": "2024-01-01T00:00:00Z",
    "added_by": {
      "id": "411486491630370816",
      "type": "anonymous"
    },
    "role_id": "411486491630370816"
  }
]

Get store member permissions

GEThttps://api.paynow.gg/v1/stores/{storeId}/members/{memberId}/permissions

Retrieves the resolved permissions map for a specific member of a store.

Headers
AuthorizationAPI KeyRequired
Authentication token for this request, sent as Authorization: APIKey TOKEN.
Path parameters
storeIdFlakeIdRequired
memberIdFlakeIdRequired
Response
200OKobject

Failed requests return a PayNowError body. See the error response guide.

curl -X GET "https://api.paynow.gg/v1/stores/{storeId}/members/{memberId}/permissions" \
  -H "Authorization: APIKey TOKEN"
Response200
{}

Update a store member

PATCHhttps://api.paynow.gg/v1/stores/{storeId}/members/{memberId}

Updates the role assigned to a specific member of the store.

Headers
AuthorizationAPI KeyRequired
Authentication token for this request, sent as Authorization: APIKey TOKEN.
Path parameters
storeIdFlakeIdRequired
memberIdFlakeIdRequired
Request body
role_idFlakeIdRequired
Response
204No Content

Failed requests return a PayNowError body. See the error response guide.

curl -X PATCH "https://api.paynow.gg/v1/stores/{storeId}/members/{memberId}" \
  -H "Authorization: APIKey TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "role_id": "411486491630370816"
}'

Remove a store member

DELETEhttps://api.paynow.gg/v1/stores/{storeId}/members/{memberId}

Removes the specified member from the store, revoking their access.

Headers
AuthorizationAPI KeyRequired
Authentication token for this request, sent as Authorization: APIKey TOKEN.
Path parameters
storeIdFlakeIdRequired
memberIdFlakeIdRequired
Response
204No Content

Failed requests return a PayNowError body. See the error response guide.

curl -X DELETE "https://api.paynow.gg/v1/stores/{storeId}/members/{memberId}" \
  -H "Authorization: APIKey TOKEN"

Get upload URL for store logo

GEThttps://api.paynow.gg/v1/stores/{storeId}/logo-upload-url

Gets a pre-signed upload URL for uploading a logo to a store.

Headers
AuthorizationAPI KeyRequired
Authentication token for this request, sent as Authorization: APIKey TOKEN.
Path parameters
storeIdFlakeIdRequired
Response
200OKGetStoreLogoUploadUrlResponseDto
Show fields
idstringRequired
The ID of the direct image upload URL.
upload_urlstringRequired
The URL to upload the logo to.

Failed requests return a PayNowError body. See the error response guide.

curl -X GET "https://api.paynow.gg/v1/stores/{storeId}/logo-upload-url" \
  -H "Authorization: APIKey TOKEN"
Response200
{
  "id": "string",
  "upload_url": "string"
}

Finish store logo upload

POSThttps://api.paynow.gg/v1/stores/{storeId}/logo-upload-finish

Finishes a logo upload for a store, attaching the uploaded image to the store.

Headers
AuthorizationAPI KeyRequired
Authentication token for this request, sent as Authorization: APIKey TOKEN.
Path parameters
storeIdFlakeIdRequired
Request body
image_idstringRequired
The ID of the uploaded image returned by the server.
logo_typeintegerRequired
Which logo the upload replaces. 1 is the default logo, 2 the square logo.
Response
204No Content

Failed requests return a PayNowError body. See the error response guide.

curl -X POST "https://api.paynow.gg/v1/stores/{storeId}/logo-upload-finish" \
  -H "Authorization: APIKey TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "image_id": "string",
  "logo_type": 0
}'