Clearpay: Headless Guide

Before you begin

This guide assumes that you know how to:

Initialize Headless Universal Checkout

Accept payments with Clearpay

Prepare the client session

Clearpay requires the following data to process a payment successfully. Pass the following data in the client session, or in the payment request (for manual payment creation).

Parameter Name	Required	Description
currencyCode	✓	3-letter currency code in ISO 4217 format, e.g. `USD` for US dollars
order ↳ lineItems	✓	Details of the line items of the order
order ↳ countryCode	✓	The country code of the user is required for Clearpay.
paymentMethod ↳ descriptor	✓	The descriptor of the payment method is required for Clearpay.

Prepare the SDK for payments

Web
iOS
Android
React Native

Handle payment method

Refer to the updated guide for handling payment methods with redirect: Handle Payment Methods with Redirect.

Pre-requisites

Handling redirects is required for Payment Methods that present a webpage or open a 3rd party application for the customer to enter their credentials and validate their payment.To enable this feature, ensure that you include the urlScheme parameter when configuring the PrimerPaymentMethodOptions object.Set up redirects

SWIFT

let settings = PrimerSettings(
  // ...
  paymentMethodOptions: PrimerPaymentMethodOptions(
    urlScheme: "{url scheme}", // e.g. primer://, yourscheme://
  ),
  // ...
)

Handle redirects
When the user is redirected back to the main app, the function

application(_ application: UIApplication, continue userActivity: NSUserActivity, restorationHandler: @escaping ([UIUserActivityRestoring]?) -> Void) -> Bool

is automatically called by iOS. Make sure to call Primer.shared.application... to forward this information to the SDK so that Universal Checkout can continue the flow.

SWIFT

import PrimerSDK
import UIKit
@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate {
  // ...
  func application(_ application: UIApplication, continue userActivity: NSUserActivity, restorationHandler: @escaping ([UIUserActivityRestoring]?) -> Void) -> Bool {
    return Primer.shared.application(application, continue: userActivity, restorationHandler: restorationHandler)
  }
}

Handle payment method

Clearpay requires a Native UI Manager in order to be presented to the user:

SWIFT

// 👇 Create the payment method manager
let nativeUIPaymentMethodManager = try PrimerHeadlessUniversalCheckout.NativeUIManager(paymentMethodType: "CLEARPAY")
// 👇 Show the payment method
try nativeUIPaymentMethodManager.showPaymentMethod(intent: .checkout)

This code is intended solely for illustrative purposes. As many payment methods share a common approach, it is recommended to centralize the implementation of these methods within your codebase. For a practical demonstration of how to achieve this, please refer to the guide on how to handle Native UI payment methods.

Handle payment method
Clearpay requires a Native UI Manager in order to be presented to the user:

KOTLIN

// 👇 Create the payment method manager
val nativeUiManager = PrimerHeadlessUniversalCheckoutNativeUiManager.newInstance("CLEARPAY")
// 👇 Show the payment method
nativeUiManager.showPaymentMethod(this, PrimerSessionIntent.CHECKOUT)

Handle payment method
Clearpay requires a Native UI Manager in order to be presented to the user:

Typescript

// 👇 Create the payment method manager
const nativeUIManager = new NativeUIManager()
// 👇 Configure the payment method manager
await nativeUIManager.configure({ paymentMethodType: 'CLEARPAY' })
// 👇 Show the payment method
await nativeUIManager.showPaymentMethod(SessionIntent.CHECKOUT)

Go live

You don’t need to do anything particular to go live — just make sure to use production credentials.

Payment methods

​Before you begin

​Accept payments with Clearpay

​Prepare the client session

​Prepare the SDK for payments

​Handle payment method

​Pre-requisites

​Handle payment method

​Go live

Before you begin

Accept payments with Clearpay

Prepare the client session

Prepare the SDK for payments

Handle payment method

Pre-requisites

Handle payment method

Go live