Upgrade from Frames for iOS

Last updated: March 12, 2025

Follow this guide to upgrade your Frames for iOS integration to Flow for mobile.

Create a public key and a secret key from the Dashboard, with the following key scopes:

Public key – payment-sessions:pay and vault-tokenization
Secret key – payment-sessions

To receive notifications for the payment events that may be triggered throughout the steps, configure your webhook receiver.

To prepare for the upgrade to Flow, remove all Frames code from your client-side and server-side integrations.

Remove the SDK:

Run the following command in the terminal:


1pod deintegrate

Remove any Swift code where you initialize Frames. For example:


1import Frames
2
3let framesViewController = PaymentFormFactory.buildViewController(
4    configuration: configuration,
5    style: style,
6    completionHandler: completion
7)
8
9navigationController?.pushViewController(framesViewController, animated: true)

Remove all server-side API calls to the following endpoints:

post

https://api.checkout.com/payments

Update your server to create a PaymentSession for the Flow integration:


1const createPaymentSession = async (req, res) => {
2  const response = await fetch("https://api.checkout.com/payment-sessions", {
3    method: "POST",
4    headers: {
5      Authorization: `Bearer ${secretKey}`,
6      "Content-Type": "application/json",
7    },
8    body: JSON.stringify({
9      amount: 1000,
10      currency: "GBP",
11      reference: "ORD-123A",
12      display_name: "Online Shop",
13      billing: {
14        address: { country: "GB" },
15      },
16      customer: {
17        name: "Jia Tsang",
18        email: "[email protected]",
19      },
20      success_url: "https://example.com/payments/success",
21      failure_url: "https://example.com/payments/failure",
22    }),
23  });
24
25  const paymentSession = await response.json();
26  res.json(paymentSession);
27};

In Xcode, go to Project > Package Dependencies and add https://github.com/checkout/checkout-ios-components.

Configure Flow with your public key and the payment session data returned from the server:


1import CheckoutComponentsSDK 
2
3let configuration = try await CheckoutComponents.Configuration(
4  paymentSession: paymentSession,
5  publicKey: publicKey,
6  environment: environment,
7  callbacks: .init(
8    onSuccess: { paymentMethod, paymentID in
9      // Handle success
10    },
11    onError: { error in
12      // Handle error
13    }
14  )
15)
16
17// Initialize the Flow for mobile payment component:
18try checkoutComponentsSDK.create(.flow())

Check if the Flow component is available and render it:


1// Check if component is available
2if component.isAvailable {
3    return component.render()
4} else {
5    return nil
6}

You can use Flow to handle payment methods that require a redirect (asynchronous payments) and those that do not (synchronous payments).

Depending on the payment outcome, customers are redirected to the success_url or failure_url you specified when you created the PaymentSession.

We send a webhook to your server notifying you of changes to the payment's status. Wait for the webhook callback before you trigger your order fulfillment process.

For payments submitted with Flow, the PaymentSession ID is returned in the webhook payload's data.metadata.cko_payment_session_id field.

Optionally, you can retrieve the payment result using the callbacks provided by Flow:

onSuccess for successful payments
onError for unsuccessful payments

For payment methods that do not require a redirect, use the onSuccess callback to handle payments. You can use this to notify the customer of the payment status.


1let callbacks = CheckoutComponents.Callbacks(onSuccess: { paymentMethod, paymentID in
2  // Payment with ID: paymentID has gone through successfully
3}
4
5let configuration = CheckoutComponents.Configuration(callbacks: callbacks)

Use our test cards to simulate different payment flows, to ensure your integration is set up correctly and behaving as expected.

Information

Ensure that you test each payment method that you plan to offer to your customers.

You can check the status of a payment from the Payments > Processing > All payments screen in the Dashboard.

You can use Flow for mobile to natively offer Apple Pay payments.

To upgrade from your Apple Pay Frames integration:

Remove any PKPayment related code from your Frames implementation. For Example:


1func handle(payment: PKPayment) {
2  // Create a CheckoutAPIClient instance with your public key.
3  let checkoutAPIClient = CheckoutAPIClient(
4    publicKey: "PUBLIC_KEY",
5    environment: .sandbox)
6
7  // Get the data containing the encrypted payment information.
8  let paymentData = payment.token.paymentData
9
10  // Request an Apple Pay token.
11  checkoutAPIClient.createApplePayToken(paymentData: paymentData) { result in
12    switch result {
13      case .success(let response):
14        print(response)
15      case .failure(let error):
16        print(error.localizedDescription)
17    }
18  }
19}

Follow the Flow for mobile instructions to accept Apple Pay payments.

Upgrade from Frames for iOS

Before you start

Remove existing Frames code

Remove Frames dependency
Client side

Remove Frames initialization
Client side

Remove payment logic
Server side

Create a Flow Payment Session
Server side

Initialize and mount Flow
Client side

Add Flow dependency

Initialize Flow

Render Flow

Handle payment responses

Asynchronous payments

Synchronous payments

Test the Flow integration

Information

Upgrade your Apple Pay integration

Next steps

Customize your Flow for mobile integration

Flow for mobile library reference

Tokenize credentials

Before you start

Remove existing Frames code

Remove Frames dependency Client side

Remove Frames initialization Client side

Remove payment logic Server side

Create a Flow Payment Session Server side

Initialize and mount Flow Client side

Add Flow dependency

Initialize Flow

Render Flow

Handle payment responses

Asynchronous payments

Synchronous payments

Test the Flow integration

Information

Upgrade your Apple Pay integration

Next steps

Customize your Flow for mobile integration

Flow for mobile library reference

Tokenize credentials

Remove Frames dependency
Client side

Remove Frames initialization
Client side

Remove payment logic
Server side

Create a Flow Payment Session
Server side

Initialize and mount Flow
Client side