iOS

Payment SDK (iOS, Swift)

The Payment SDK is a library that simplifies interaction with the Freedom Pay API.

Link to the SDK repository

Source code for the demo application

Features

Payment Initialization

Payment Cancellation

Payment Refund

Payment Clearing

Recurring Payments with Saved Cards

Fetching Payment Information/Status

Adding/Removing Cards

Payment with Saved Cards

Direct Debit Payments

Apple Pay Integration

Installation

To integrate SDK into your Xcode project using CocoaPods, add the following to your Podfile

Then execute the following command in your terminal

$ pod install

This will install the SDK and set it up for use in your Xcode project.

SDK integration

Initialization

Add the `PaymentView` to your UIViewController

Pass the instance of `paymentView` to the SDK

To track the progress of loading the payment page, use WebDelegate

SDK Configuration

Test mode

By default, test mode is enabled

Region selection

Region.DEFAULT is the default value

The Region class has the following values:

Parameter	Value
`DEFAULT`	Kazakhstan and other countries of presence
`RU`	Russia
`UZ`	Uzbekistan
`KG`	Kyrgyzstan

Payment System selection

Payment currency selection

Auto-clearing activation

Encoding configuration

By default, UTF-8

Lifetime of the recurring profile

By default, 0 months (the parameter is excluded from the list when the value is 0)

Lifetime of the payment page, within which the payment must be completed

By default, 300 seconds

Enabling recurring payment mode

By default, it is false

Setup customer's phone

The customer's phone number will be displayed on the payment page. If not provided, the user will be prompted to enter it on the payment page.

Setup customer's email

The customer's email will be displayed on the payment page. If the email is not provided, the user will be prompted to enter it on the payment page.

Language of the payment page

To transmit information from the payment gateway

Display a Frame instead of the payment page

By default, it is false

Working with the SDK

Creating a payment

After calling it, the payment page will open in the paymentView.

Recurring payment

Fetching the payment status

Payment clearing

If nil is specified instead of the clearing amount, the clearing will be processed for the full payment amount.

Payment cancellation

Payment refund

Saving the card

After calling it, the page to add a card will open in the paymentView.

Retrieve the list of saved cards

Removing a saved card

Creating a payment with a saved card

The createCardPayment method using cardId is deprecated

Confirming the payment of a created payment

After calling it, the payment page for 3DS authentication will open in the paymentView.

Confirming the payment of a created payment with a direct debit (without acceptance)

Apple Pay Integration

First, you need to create a merchant ID and configure the payment processing certificate in the developer console according to the documentation on the official PassKit website. After that, you can proceed with setting up the project and the integration itself

Enable Apple Pay support for your project in Xcode

In the navigation window of your project, select the project file.

Choose your app in the TARGET menu.

Go to the Signing & Capabilities tab.

In the top menu, click the + button to add Apple Pay library support.

In the added Apple Pay section, click the Update button to synchronize merchant identifiers with the Apple Developer site.

Select the required merchant identifier to work with your app.

Import `PassKit` into your controller

Add a check for the Apple Pay status on the device

Set the list of supported Payment Networks

Here’s a method that prepares the payment data and displays the Apple Pay controller

Add a method for initializing and confirming payment using the SDK

Add an Apple Pay Button to Your Screen

Creating the Apple Pay Button:

Adding the Button to the View:

Set the position of the button on the screen:

Add a call to the initApplePay function to prepare the payment and display the Apple Pay window when the button is clicked:

For proper functionality, make sure that Apple Pay is set up on the device and manage the button's state based on the received status:

Inherit the `PKPaymentAuthorizationControllerDelegate` delegate

Implement the delegate methods

Support

If you have questions or need help, feel free to reach out! 👋

Email: support@freedompay.kz

Payment SDK (iOS, Swift)#

Features#

Installation#

SDK integration#

Initialization#

Add the PaymentView to your UIViewController#

Pass the instance of paymentView to the SDK#

To track the progress of loading the payment page, use WebDelegate#

SDK Configuration#

Test mode#

Region selection#

Payment System selection#

Payment currency selection#

Auto-clearing activation#

Encoding configuration#

Lifetime of the recurring profile#

Lifetime of the payment page, within which the payment must be completed#

Enabling recurring payment mode#

Setup customer's phone#

Setup customer's email#

Language of the payment page#

To transmit information from the payment gateway#

Display a Frame instead of the payment page#

Working with the SDK#

Creating a payment#

Recurring payment#

Fetching the payment status#

Payment clearing#

Payment cancellation#

Payment refund#

Saving the card#

Retrieve the list of saved cards#

Removing a saved card#

Creating a payment with a saved card#

Confirming the payment of a created payment#

Confirming the payment of a created payment with a direct debit (without acceptance)#

Apple Pay Integration#

Enable Apple Pay support for your project in Xcode#

Import PassKit into your controller#

Add a check for the Apple Pay status on the device#

Set the list of supported Payment Networks#

Here’s a method that prepares the payment data and displays the Apple Pay controller#

Add a method for initializing and confirming payment using the SDK#

Add an Apple Pay Button to Your Screen#

Inherit the PKPaymentAuthorizationControllerDelegate delegate#

Implement the delegate methods#

Support#

Payment SDK (iOS, Swift)

Features

Installation

SDK integration

Initialization

Add the `PaymentView` to your UIViewController

Pass the instance of `paymentView` to the SDK

To track the progress of loading the payment page, use WebDelegate

SDK Configuration

Test mode

Region selection

Payment System selection

Payment currency selection

Auto-clearing activation

Encoding configuration

Lifetime of the recurring profile

Lifetime of the payment page, within which the payment must be completed

Enabling recurring payment mode

Setup customer's phone

Setup customer's email

Language of the payment page

To transmit information from the payment gateway

Display a Frame instead of the payment page

Working with the SDK

Creating a payment

Recurring payment

Fetching the payment status

Payment clearing

Payment cancellation

Payment refund

Saving the card

Retrieve the list of saved cards

Removing a saved card

Creating a payment with a saved card

Confirming the payment of a created payment

Confirming the payment of a created payment with a direct debit (without acceptance)

Apple Pay Integration

Enable Apple Pay support for your project in Xcode

Import `PassKit` into your controller

Add a check for the Apple Pay status on the device

Set the list of supported Payment Networks

Here’s a method that prepares the payment data and displays the Apple Pay controller

Add a method for initializing and confirming payment using the SDK

Add an Apple Pay Button to Your Screen

Inherit the `PKPaymentAuthorizationControllerDelegate` delegate

Implement the delegate methods

Support