Hubtel Merchant Checkout SDK - iOS

The Hubtel Checkout Library is a convenient and easy-to-use library that simplifies the process of implementing a checkout flow in your iOS application.

Installation

Hubtel Checkout is available through SPM. Support for CocoaPods will be added soon.

Swift Package Manager

1. File > Add Packages

2. Add https://github.com/hubtel/hubtel-mobile-ios-checkout-sdk

Getting Started

Objects needed

Properties	Explanation
HubtelCheckoutConfiguration	is an object used for payment processing with Hubtel Checkout service. It enables merchants to set their identification, specify a callback URL for payment notifications, and secure transactions with a merchant API key.
merchantId (required)	given to the merchant to use the sdk. This is one of three parameters to passed the configuration object.
merchantApiKey (required)	Base64 encoded string of the customer’s id and password. Also passed to the configuration object.
callbackUrl (required)	A url provided by the merchant in order to be able to listen for callbacks from the payment api to know the status of payments. Also passed to the configuration object.
PurchaseInfo	Information about the purchase to process. Details are given below.
amount (required)	The price of the item or service the customer is trying to purchase from.
customerPhoneNumber (required)	A required mobile number of the customer purchasing the item.
purchaseDescription (required)	An optional description attached to the purchase.
tintColor	a UIColor of your choosing, or rather your design's.
Delegate Object	an object that implements the PaymentFinishedDelegate in order to get information about UI changes from the sdk.

Integration

1. Add the library using SPM (CocoaPods will be supported soon).

2. Import Hubtel_Checkout in the ViewController where payment is to be initiated.

3. Create a HubtelCheckoutConfiguration object, like so:

let configuration = HubtelCheckoutConfiguration(merchantId: "11624", callbackUrl: "https://9cb7-154-160-1-110.ngrok-free.app/payment-callback", merchantApiKey: "T0UwbjAzcko9ZjAxMzhkOTk5ZmM0ODMxYjc3MWFhMzEzYTNjNQhhNA==")

4. Create a PurchaseInfo object, like so:

let purchaseInfo = PurchaseInfo(amount: 1, customerPhoneNumber: "0545454545", purchaseDescription: "This is a desc", clientReference:self.uuid.uuidString)

5. On your pay button having all necessary info set, call presentCheckout, like so:

CheckoutViewController.presentCheckout(from: self, with: configuration, and: purchaseInfo, delegate: self, tintColor: UIColor.black)

The calling controller must implement the PaymentFinishedDelegate protocol to be able to see the checkout status.

The PaymentFinishedDelegate protocol has a function with a single parameter value of type PaymentStatus

PaymentStatus Cases

The PaymentStatus is an enum displaying the status of payment. It contains the following cases:

• userCancelledPayment: When the user closes the checkout page without performing any transaction.
• paymentFailed: When the user performs a transaction but payment fails.
• paymentSuccessful: When the user finally pays successfully.
• unknown: When the user cancels transaction after payment attempt without checking status.

Example

extension ViewController: PaymentFinishedDelegate {

    func checkStatus(value: PaymentStatus) {
    }
}

Screenshots