Checkout Style

Get store checkout style

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

Retrieves the checkout styling for the store.

Headers

AuthorizationAPI KeyRequired

Authentication token for this request, sent as Authorization: APIKey TOKEN.

Path parameters

storeIdFlakeIdRequired

Response

200OKCheckoutStyleDto

Represents the styling applied to the store's hosted checkout.

Show fields

store_idFlakeIdRequired

background_media_asset_idFlakeIdOptional

border_radiusintegerOptional

The corner radius applied to buttons, inputs and panels on the checkout, in pixels, or null to use the default radius.

color_backgroundstringOptional

The background colour of the checkout page, as a CSS colour value, or null to use the default.

color_elementsstringOptional

The background colour of panels and cards on the checkout, as a CSS colour value, or null to use the default.

color_inputstringOptional

The background colour of input fields, as a CSS colour value, or null to use the default.

color_outlinestringOptional

The colour of borders and outlines on the checkout, as a CSS colour value, or null to use the default.

color_primarystringOptional

The accent colour used for primary buttons and highlights, as a CSS colour value, or null to use the default.

color_textstringOptional

The colour of text on the checkout, as a CSS colour value, or null to use the default.

font_familystringOptional

The CSS font family used for text on the checkout, or null to use the default font.

url_backgroundstringOptional

The URL of the image shown behind the checkout, or null when there is none. It cannot be set directly; set 'background_media_asset_id' instead.

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

curl -X GET "https://api.paynow.gg/v1/stores/{storeId}/checkout-style" \
  -H "Authorization: APIKey TOKEN"

import { createManagementClient } from "@paynow-gg/typescript-sdk";

const paynow = createManagementClient({
  apiKey: "API_KEY",
  storeId: "STORE_ID",
});

const result = await paynow.checkoutStyle.getStoreCheckoutStyle();

import requests

headers = {"Authorization": "APIKey TOKEN"}
response = requests.get("https://api.paynow.gg/v1/stores/{storeId}/checkout-style", headers=headers)

Response200

{
  "store_id": "411486491630370816",
  "background_media_asset_id": "411486491630370816",
  "border_radius": 0,
  "color_background": "string",
  "color_elements": "string",
  "color_input": "string",
  "color_outline": "string",
  "color_primary": "string",
  "color_text": "string",
  "font_family": "string",
  "url_background": "string"
}

Update store checkout style

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

Updates the stores checkout style.

Headers

AuthorizationAPI KeyRequired

Authentication token for this request, sent as Authorization: APIKey TOKEN.

Path parameters

storeIdFlakeIdRequired

Request body

background_media_asset_idFlakeIdOptional

border_radiusintegerOptional

The corner radius applied to buttons, inputs and panels on the checkout, in pixels, or null to use the default radius.

color_backgroundstringOptional

The background colour of the checkout page, as a CSS colour value, or null to use the default.

color_elementsstringOptional

The background colour of panels and cards on the checkout, as a CSS colour value, or null to use the default.

color_inputstringOptional

The background colour of input fields, as a CSS colour value, or null to use the default.

color_outlinestringOptional

The colour of borders and outlines on the checkout, as a CSS colour value, or null to use the default.

color_primarystringOptional

The accent colour used for primary buttons and highlights, as a CSS colour value, or null to use the default.

color_textstringOptional

The colour of text on the checkout, as a CSS colour value, or null to use the default.

font_familystringOptional

The CSS font family used for text on the checkout, or null to use the default font.

Response

200OKCheckoutStyleDto

Represents the styling applied to the store's hosted checkout.

Show fields

store_idFlakeIdRequired

background_media_asset_idFlakeIdOptional

border_radiusintegerOptional

The corner radius applied to buttons, inputs and panels on the checkout, in pixels, or null to use the default radius.

color_backgroundstringOptional

The background colour of the checkout page, as a CSS colour value, or null to use the default.

color_elementsstringOptional

The background colour of panels and cards on the checkout, as a CSS colour value, or null to use the default.

color_inputstringOptional

The background colour of input fields, as a CSS colour value, or null to use the default.

color_outlinestringOptional

The colour of borders and outlines on the checkout, as a CSS colour value, or null to use the default.

color_primarystringOptional

The accent colour used for primary buttons and highlights, as a CSS colour value, or null to use the default.

color_textstringOptional

The colour of text on the checkout, as a CSS colour value, or null to use the default.

font_familystringOptional

The CSS font family used for text on the checkout, or null to use the default font.

url_backgroundstringOptional

The URL of the image shown behind the checkout, or null when there is none. It cannot be set directly; set 'background_media_asset_id' instead.

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

curl -X PATCH "https://api.paynow.gg/v1/stores/{storeId}/checkout-style" \
  -H "Authorization: APIKey TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "background_media_asset_id": "411486491630370816",
  "border_radius": 0,
  "color_background": "string",
  "color_elements": "string",
  "color_input": "string",
  "color_outline": "string",
  "color_primary": "string",
  "color_text": "string",
  "font_family": "string"
}'

import { createManagementClient } from "@paynow-gg/typescript-sdk";

const paynow = createManagementClient({
  apiKey: "API_KEY",
  storeId: "STORE_ID",
});

const result = await paynow.checkoutStyle.updateStoreCheckoutStyle({
  background_media_asset_id: "411486491630370816",
  border_radius: 0,
  color_background: "string",
  color_elements: "string",
  color_input: "string",
  color_outline: "string",
  color_primary: "string",
  color_text: "string",
  font_family: "string",
});

import requests

headers = {"Authorization": "APIKey TOKEN"}
payload = {
    "background_media_asset_id": "411486491630370816",
    "border_radius": 0,
    "color_background": "string",
    "color_elements": "string",
    "color_input": "string",
    "color_outline": "string",
    "color_primary": "string",
    "color_text": "string",
    "font_family": "string",
}
response = requests.patch("https://api.paynow.gg/v1/stores/{storeId}/checkout-style", headers=headers, json=payload)

Response200

{
  "store_id": "411486491630370816",
  "background_media_asset_id": "411486491630370816",
  "border_radius": 0,
  "color_background": "string",
  "color_elements": "string",
  "color_input": "string",
  "color_outline": "string",
  "color_primary": "string",
  "color_text": "string",
  "font_family": "string",
  "url_background": "string"
}

Delete checkout background image

DELETEhttps://api.paynow.gg/v1/stores/{storeId}/checkout-style/background-image

Removes the hosted checkout background image for the store.

Headers

AuthorizationAPI KeyRequired

Authentication token for this request, sent as Authorization: APIKey TOKEN.

Path parameters

storeIdFlakeIdRequired

Response

204No Content

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

curl -X DELETE "https://api.paynow.gg/v1/stores/{storeId}/checkout-style/background-image" \
  -H "Authorization: APIKey TOKEN"

import { createManagementClient } from "@paynow-gg/typescript-sdk";

const paynow = createManagementClient({
  apiKey: "API_KEY",
  storeId: "STORE_ID",
});

await paynow.checkoutStyle.deleteStoreCheckoutStyleBackgroundImage();

import requests

headers = {"Authorization": "APIKey TOKEN"}
response = requests.delete("https://api.paynow.gg/v1/stores/{storeId}/checkout-style/background-image", headers=headers)