Skip to navigation
SDK

iOS SDK

The Afterpay iOS SDK presents Clearpay checkout in your iOS app and provides prebuilt UI components, such as the payment button and price breakdown. With a UK configuration, the SDK shows Clearpay branding. Its APIs use the Afterpay name, for example Afterpay.setConfiguration.

What the SDK includes

Checkout

The SDK presents checkout in these ways:

  • Checkout V2 (recommended): the SDK shows a loading screen, asks your app for a checkout token from your server, and opens Clearpay checkout. Supports standard and express checkout.
  • Checkout V1 (deprecated): your server returns a checkout URL, and the SDK loads it in a web view. Supports standard checkout only.

UI components

The SDK includes prebuilt components that follow Clearpay brand guidelines. With a UK configuration, they show Clearpay branding.

  • Payment button: PaymentButton starts a Clearpay checkout.
  • Lockup: LockupView shows the Clearpay logo.
  • Price breakdown: PriceBreakdownView shows the installment amounts for a price.
  • Checkout widget: WidgetView shows the payment schedule and updates when you send it a new total.

For branding, color schemes, and accessibility, see iOS UI components.

Requirements

  • iOS 12.0 or later
  • Swift 5.7 or later
  • Xcode 14.0 or later
WebView support

Clearpay checkout runs in a WKWebView that requires iOS Safari 13.4 or later. The SDK runs on iOS 12, but your app must hide Clearpay from customers on earlier versions. For example, wrap your Clearpay views in an if #available(iOS 13.4, *) check.

Get started