Checkout Optimize - Pillar8 Docs

The Checkout Optimize API returns a decision package that ranks available payment methods for a given checkout session.

Endpoint

POST /api/shopify/checkout-optimize

Request

Headers

Content-Type: application/json

Body

{
  "shop_domain": "example.myshopify.com",
  "cart_value": 85,
  "currency_code": "EUR",
  "country_code": "DE",
  "device_type": "mobile",
  "checkoutToken": "abc123",
  "default_fops": ["card", "paypal", "klarna"],
  "presented_payment_methods": ["card", "paypal", "klarna"]
}

Request Fields

Field	Type	Description
shop_domain	string	Your shop identifier
cart_value	number	Total transaction amount
currency_code	string	ISO 4217 currency code
country_code	string	ISO 3166-1 country code
device_type	string	`mobile` or `desktop`
checkoutToken	string	Unique checkout session identifier
default_fops	array	Payment methods available to the shopper
presented_payment_methods	array	Payment methods currently displayed at checkout

Response

{
  "status": "ok",
  "ab_variant": "optimize",
  "was_optimized": true,
  "shadow_engine": {
    "scored": [
      { "code": "paypal", "score": 0.82 },
      { "code": "card", "score": 0.74 }
    ]
  },
  "gating_passed": true
}

Response Fields

Field	Type	Description
status	string	Request status: `ok` or `error`
ab_variant	string	Test group assignment: `control` or `optimize`
was_optimized	boolean	Whether the API applied optimization to this session
shadow_engine.scored	array	Payment methods ranked by conversion likelihood, highest score first
gating_passed	boolean	Whether to display the optimization advisory to the shopper

Security & Privacy

This API does not process or store payment data
No cardholder information is required or transmitted
Optimization occurs before payment execution

Next Steps

See Webhooks to track checkout outcomes
See How It Works to understand the ranking algorithm

Webhooks

​Endpoint

​Request

​Headers

​Body

​Request Fields

​Response

​Response Fields

​Security & Privacy

​Next Steps

Endpoint

Request

Headers

Body

Request Fields

Response

Response Fields

Security & Privacy

Next Steps