Universal Checkout


The first fully dynamic checkout

Universal Checkout is a drop-in UI for web and mobile, with a no-code interface for product and payments teams. Now payments can be a first-class product area in your organization.

uc styling

🛒

Accessible and responsive UX that presents the payment methods you choose, along with 3D Secure 2.0 and convenient checkout modules, fully in-context with no redirects, ever!

🎛️

Use the Dashboard to activate a custom set of payment methods and checkout modules based on amount, currency, customer location and more.

🎨

Completely customizable, embedded UI for seamless user experience on your site or in your app

🔐

PCI Level 1 compliant with a centralized vault for recurring payments and one-click checkout

🎉

Low code integration that you won't have to touch when adding new payment methods, processors or other Connections

🚀

Fully dynamic checkout driven by Workflows that let you fully automate end-to-end payment flows for the first time

Payment method tokenization

Universal Checkout securely captures payment method data while fully embedded on your site or in your app. By communicating directly with Primer's PCI-L1 tokenization service, Universal Checkout transforms sensitive customer data into a secure uniform string called a payment method token.

You can safely pass this token to your backend to create payments with the Payments API, with no compliance risk.



payment instrument

🚀

Our agnostic tokenization service and centralized vault enable you to handle recurring payments, fallbacks and retries across processors without compromising UX. No more PSP-specific tokens — now you own your payments data.


So, how does it work?

flow

Whether you're embedding in a website or a mobile app:

  1. 1
    Generate a clientToken on your backend by creating a Client Session with POST/client-session
  2. 2
    Initialize Universal Checkout with the clientToken to render the UI.
  3. 3
    As the user interacts with the checkout, Universal Checkout will propose to update the Client Session using Client Session actions. Forward them to your backend to update your Client Session with POST/client-session/actions
  4. 4
    Universal Checkout will generate a paymentMethodToken when the customer submits their payment data.
  5. 5
    Create a payment using the paymentMethodToken via the Payments API POST/payments
  6. 6
    If the response indicates a requiredAction, you'll get a new clientToken.
  7. 7
    Pass the clientToken back to Universal Checkout to render next steps, like 3DS, and get a resumeToken.
  8. 8
    Call POST/payments/{paymentId}/resume with the resumeToken to resume the payment and wrap things up. (If a new requiredAction is returned, you'll have to go back to step 5.)
🚨

Universal Checkout can dynamically handle front-end payment flows constructed in Workflows such as 3D Secure, KYC and more, enabling your payments team to craft new commerce experiences with no additional code.


Manage your checkout with no code

The Dashboard features a no-code interface enabling you to simply drag-and-drop payment methods and checkout modules and create conditions that determine when and how they are displayed on Universal Checkout.

checkout builder


Generate a client token to initialize the SDK

The clientToken is a temporary key used to initialize Universal Checkout, and render the checkout options you've configured with the Dashboard.

Generate the first client token by creating a Client Session with POST/client-session.

If a payment method or checkout module requires additional information passed in the Client Session this will be documented in the Connection setup in the Dashboard.

client token

Client session request POST/client-session

12345678910111213141516
curl --location --request \ POST 'https://api.sandbox.primer.io/client-session' \ --header 'X-Api-Key: <YOUR_API_KEY>' \ --header 'X-Api-Version: 2021-10-19' \  # These fields can be passed in the payment request as well --data '{    "orderId": "<YOUR_ORDER_ID>",    "currencyCode": "GBP",    "amount": 1200,     # a customerId is required to reuse successfully authorized payment method data for your customer    # we recommend you always pass this in if you intend to use vaulting    "customerId": "<YOUR_CUSTOMER_ID>"    "metadata": { }, }'
curl
copy

🚨

Data you pass when requesting a clientToken is persisted in the payment request unless explicitly overwritten.

Client token response

Check the warnings array for missing data which may be required to display certain payment methods and checkout modules in the Universal Checkout.

123456789101112
{  "clientToken": "<THE_CLIENT_TOKEN>",  "clientTokenExpirationDate": "2021-08-12T16:14:08.578695",  "orderId": "<YOUR_ORDER_ID>",  "currencyCode": "GBP",  "amount": 1200,  "customerId": "<YOUR_CUSTOMER_ID>",  "metadata": { },  "warnings": [    "Apple Pay is missing 'customerDetails.countryCode'"  ]}
JSON
copy

Implement Universal Checkout on front-end

Step 1. Install the SDK

⚠️

This SDK requires React Native v0.63 or higher.

Add the SDK package with yarn or npm:

12345
# With yarnyarn add @primer-io/react-native # With npmnpm i @primer-io/react-native --save
bash
copy

Check out the troubleshooting section if you experience problems building the app.

For specific versions of the SDK, please refer to the changelog.

Step 2. Create a client session

Once the SDK is added, create a client session (generated on your backend with a Primer API key) and store the returned clientToken string parameter.

⭐️

Provide any order/customer details when creating the client session. For more info on what information can be passed in, please refer to the example above and the Client Session API.

12
// Ask your backend to create a client sessionconst clientToken = await createClientSession()
javascript
copy

Step 3. Configure payment callback

The SDK emits a payment method token that you should use to create a payment with Primer's Payment API. To handle this, define the onTokenizeSuccess callback like below:

1234567891011121314151617
import { Primer } from '@primer-io/react-native' const onTokenizeSuccess = async (req, res) => {    try {        const payment = await createPayment({ paymentMethod: req.token })        // resume SDK in case of required action, e.g. "3DS_AUTHENTICATION"        if (payment.requiredAction) {            setPaymentId(payment.id) // store the payment id.            // resume the SDK with the payment's client token.            res.handleNewClientToken(payment.requiredAction.clientToken)        } else {            res.handleSuccess() // show success screen.        }    } catch (e) {        res.resumeWithError(errorMessage)    }}
javascript
copy

Step 4. Configure resume callback

Next you should configure the onResumeSuccess callback. This is for scenarios where a create payment request results in a required action (see code snippet above) and the payment is expected to be resumed later on.

123456789101112
const onResumeSuccess = async (req, res) => {    try {        const payment = await resumeSession({ paymentId, resumeToken: req })        if (payment.status in ['FAILED', 'DECLINED', 'CANCELLED', 'PENDING']) {            res.handleError(errorMessage)        } else {            res.handleSuccess()        }    } catch (e) {        res.handleError(errorMessage)    }}
javascript
copy

Step 5. Show Universal Checkout

Finally, pass in the clientToken string and callbacks as arguments, and show the checkout.

12
// show Universal Checkout with above client token and config.Primer.showUniversalCheckout(clientToken, { onTokenizeSuccess, onResumeSuccess })
javascript
copy

And voilà, you're all set!