Get Started

Log In to the

Log in to the using your test or production credentials:

Open the Unified Checkout Configuration

In the left navigation panel, choose Payment Configuration > Unified Checkout. The Unified Checkout customer experience page appears.

Configure Your Checkout Experience

The customer experience page is organized into three configuration screens:

• Payment Options: enable, add, remove, and arrange the payment methods that Unified Checkout displays to your customers.
• Look & Feel: configure the visual appearance and branding of the payment UI.
• Customer Information and Payment Flow: control which billing and shipping data Unified Checkout collects and which follow-on services process the payment.

Call the Sessions API

Send a POST request to the sessions resource. This example shows the minimum required fields: targetOrigins, locale, country, and the order amount and currency:

curl -X POST /uc/v1/sessions \  -H "Content-Type: application/json" \  -d '{    "targetOrigins": ["https://merchant.example.com"],    "locale": "en_US",    "country": "US",    "data": {      "orderInformation": {        "amountDetails": {          "totalAmount": "21.00",          "currency": "USD"        }      }    }  }'

curl -X POST /uc/v1/sessions \  -H "Content-Type: application/json" \  -d '{    "targetOrigins": ["https://merchant.example.com"],    "locale": "en_US",    "country": "US",    "data": {      "orderInformation": {        "amountDetails": {          "totalAmount": "21.00",          "currency": "USD"        }      }    }  }'

The targetOrigins array must include every origin that hosts the SDK.

Handle the Response

The response body contains the capture context: a JWT that includes a transaction-specific public key for end-to-end encryption and the merchant configuration that drives the client-side experience.

Pass the Capture Context to the Browser

Store the capture context on your server, and pass it to the customer's browser as the session JWT that the client-side library uses to initialize.

Initialize the SDK

Call VAS.UnifiedCheckout() with the capture context JWT from your server. It returns a Promise that resolves to a client instance:

const client = await VAS.UnifiedCheckout(sessionJWT);

Initialization validates the JWT signature and checks that the current page origin matches targetOrigins. If the JWT is invalid or expired, initialization throws a UnifiedCheckoutError.

Create a Checkout

Create a checkout to render the list of available payment methods and handle the payment flow:

const checkout = await client.createCheckout();

Mount the Checkout

Call mount() to attach the payment UI to your page:

// Sidebar mode — payment screen appears as an overlayconst result = await checkout.mount('#payment-buttons');// Embedded mode — button list and payment screen both render inlineconst result = await checkout.mount({  paymentSelection: '#payment-buttons',  paymentScreen: '#payment-form'});

When the session includes a completeMandate, autoProcessing defaults to true, and mount() resolves with the completed payment result once the customer finishes the payment flow:

const client = await VAS.UnifiedCheckout(sessionJWT);const checkout = await client.createCheckout();const result = await checkout.mount('#payment-buttons');// result is the completed payment result JWT

When you set autoProcessing to false, mount() resolves with a transient token instead, and you call checkout.complete() to finish the payment:

const client = await VAS.UnifiedCheckout(sessionJWT);const checkout = await client.createCheckout({ autoProcessing: false });const transientToken = await checkout.mount('#payment-buttons');// Complete the payment when your server is readyconst result = await checkout.complete(transientToken);