Checkout Settings

Configure your checkout with the right parameters to create a seamless payment experience. This guide covers all the configurable options for Plexy checkout sessions and payments.

Amount and Currency

Every payment request requires an amount object specifying the value and currency.

Amount Format

Amounts are specified in the smallest currency unit (e.g., cents for USD, tiyn for KZT).

curl -X POST https://api.plexypay.com/v2/sessions \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": {
      "value": 10000,
      "currency": "KZT"
    }
  }'

Currency	Minor Units	Example
KZT (Kazakhstani Tenge)	100	1000 = ₸10.00
USD (US Dollar)	100	1000 = $10.00
EUR (Euro)	100	1000 = €10.00

KZT amounts are submitted in tiyn (1/100 of a tenge), so value: 10000 equals exactly ₸100.00.

Supported Currencies

curl https://api.plexypay.com/v2/config \
  -H "x-api-key: YOUR_API_KEY"

Common supported currencies:

Code	Currency	Symbol
`KZT`	Kazakhstani Tenge	₸
`USD`	US Dollar	$
`EUR`	Euro	€

Country Codes

The country code affects which payment methods are available and how transactions are processed.

curl -X POST https://api.plexypay.com/v2/sessions \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": { "value": 10000, "currency": "KZT" },
    "countryCode": "KZ"
  }'

Shopper Information

Providing shopper details improves payment success rates and fraud detection.

Basic Shopper Data

curl -X POST https://api.plexypay.com/v2/sessions \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": { "value": 10000, "currency": "KZT" },
    "shopperReference": "customer_12345",
    "shopperEmail": "customer@example.com",
    "shopperName": {
      "firstName": "John",
      "lastName": "Smith"
    },
    "telephoneNumber": "+77001234567",
    "shopperLocale": "en-US"
  }'

Return URLs

Configure where customers are redirected after payment.

curl -X POST https://api.plexypay.com/v2/sessions \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": { "value": 10000, "currency": "KZT" },
    "returnUrl": "https://your-site.com/checkout/complete",
    "successUrl": "https://your-site.com/order/confirmed",
    "cancelUrl": "https://your-site.com/checkout"
  }'

Return URL Parameters

Plexy appends these query parameters to your return URL:

Parameter	Description
`resultCode`	Payment result (Authorised, Refused, etc.)
`sessionId`	The session ID
`reference`	Your merchant reference
`pspReference`	Plexy's payment reference

Example return URL:

https://your-site.com/checkout/complete?resultCode=Authorised&sessionId=ses_abc123&reference=order_12345&pspReference=8835511210681324

Payment Method Configuration

Control which payment methods are displayed.

curl -X POST https://api.plexypay.com/v2/sessions \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": { "value": 10000, "currency": "KZT" },
    "allowedPaymentMethods": ["scheme", "applepay"],
    "blockedPaymentMethods": ["applepay"]
  }'

Available Payment Method Types

Type	Description
`scheme`	Credit/Debit cards
`applepay`	Apple Pay
`googlepay`	Google Pay

3D Secure Configuration

Control 3D Secure behavior.

curl -X POST https://api.plexypay.com/v2/sessions \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": { "value": 10000, "currency": "KZT" },
    "authenticationData": {
      "attemptAuthentication": "always",
      "challengeIndicator": "requestChallenge"
    }
  }'

Checkout Settings

On this page