Payment Settings

Get store payment settings

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

Retrieves payment settings for a store.

Headers

AuthorizationAPI KeyRequired

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

Path parameters

storeIdFlakeIdRequired

Response

200OKStorePaymentSettingsDto

Store payment configuration settings.

Show fields

adaptive_currency_enabledbooleanRequired

Whether the 'Adaptive Currency' feature is enabled.

block_prepaid_cardsenumRequired

Defines when prepaid cards should be blocked from use.

Possible enum values

unspecified
Blocking type not specified.
none
Allow prepaid cards for all payment types.
trials
Block prepaid cards for trial subscriptions only.
all_recurring
Block prepaid cards for all recurring payments (trials and subscriptions).

chargeback_coverageenumRequired

Defines the type of chargeback coverage provided.

Possible enum values

unspecified
Chargeback coverage type is not specified.
none
No chargeback coverage provided.
fraudulent
Coverage for fraudulent/unauthorized chargebacks only.
all
Coverage for all chargebacks including disputes.

force_3d_securebooleanRequired

Whether to force 3D Secure authentication for all transactions.

max_checkout_amountintegerRequired

Maximum checkout amount allowed in cents.

promo_code_stacking_behaviorenumRequired

Defines the behavior of promo code stacking.

Possible enum values

invalid
Invalid state.
disabled
Promo code stacking is disabled.
enabled
Promo code stacking is enabled.
gift_cards_only
Promo code stacking is enabled only for gift cards.

show_adaptive_currency_on_storefrontbooleanRequired

Whether the displayed currency on the storefront should be the Adaptive Currency by default.

show_all_payment_methods_for_subscriptionsbooleanRequired

Whether to show all available payment methods for subscription purchases.

store_tax_inclusive_pricingbooleanRequired

Whether store pricing is tax-inclusive.

chargeback_coverage_max_amountintegerOptional

Maximum per-transaction chargeback coverage amount in cents.

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

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

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

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

const result = await paynow.paymentSettings.getStorePaymentSettings();

import requests

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

Response200

{
  "adaptive_currency_enabled": true,
  "block_prepaid_cards": "unspecified",
  "chargeback_coverage": "unspecified",
  "force_3d_secure": true,
  "max_checkout_amount": 0,
  "promo_code_stacking_behavior": "invalid",
  "show_adaptive_currency_on_storefront": true,
  "show_all_payment_methods_for_subscriptions": true,
  "store_tax_inclusive_pricing": true,
  "chargeback_coverage_max_amount": 0
}

Updates store payment settings

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

Updates payment settings for a store.

Headers

AuthorizationAPI KeyRequired

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

Path parameters

storeIdFlakeIdRequired

Request body

adaptive_currency_enabledbooleanOptional

block_prepaid_cardsenumOptional

Defines when prepaid cards should be blocked from use.

Possible enum values

unspecified
Blocking type not specified.
none
Allow prepaid cards for all payment types.
trials
Block prepaid cards for trial subscriptions only.
all_recurring
Block prepaid cards for all recurring payments (trials and subscriptions).

promo_code_stacking_behaviorenumOptional

Defines the behavior of promo code stacking.

Possible enum values

invalid
Invalid state.
disabled
Promo code stacking is disabled.
enabled
Promo code stacking is enabled.
gift_cards_only
Promo code stacking is enabled only for gift cards.

show_adaptive_currency_on_storefrontbooleanOptional

show_all_payment_methods_for_subscriptionsbooleanOptional

store_tax_inclusive_pricingbooleanOptional

Response

204No Content

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

curl -X PATCH "https://api.paynow.gg/v1/stores/{storeId}/payment-settings" \
  -H "Authorization: APIKey TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "show_all_payment_methods_for_subscriptions": true,
  "store_tax_inclusive_pricing": true,
  "block_prepaid_cards": "unspecified",
  "promo_code_stacking_behavior": "invalid",
  "adaptive_currency_enabled": true,
  "show_adaptive_currency_on_storefront": true
}'

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

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

await paynow.paymentSettings.updateStorePaymentSettings({
  show_all_payment_methods_for_subscriptions: true,
  store_tax_inclusive_pricing: true,
  block_prepaid_cards: "unspecified",
  promo_code_stacking_behavior: "invalid",
  adaptive_currency_enabled: true,
  show_adaptive_currency_on_storefront: true,
});

import requests

headers = {"Authorization": "APIKey TOKEN"}
payload = {
    "show_all_payment_methods_for_subscriptions": True,
    "store_tax_inclusive_pricing": True,
    "block_prepaid_cards": "unspecified",
    "promo_code_stacking_behavior": "invalid",
    "adaptive_currency_enabled": True,
    "show_adaptive_currency_on_storefront": True,
}
response = requests.patch("https://api.paynow.gg/v1/stores/{storeId}/payment-settings", headers=headers, json=payload)