OPay iOS SDK

OPay SDK will allow your iOS application to:

• Launch full-screen activities to collect payment details, shipping address, and shipping method.
• Accept card, reference code, installment payment readily available from OPay.

To avoid any conflicts and have a seamless integration, make sure you have the following compatibility list satisfied.

How iOS SDK Plugin Looks Like

Download and test OPay demonstrative application.

---

How it works

On this page we will walk you through iOS SDK integration steps:

1. Initialize and configure iOS SDK.
2. Present payment options and collect you client's payment data.
3. OPay iOS SDK plugin will send payment request to OPay.
4. Return payment processing information to our iOS SDK plugin.
5. Within your iOS application, inform your client with the payment result.

Please follow the below steps in order to get the SDK integrated and ready for use within your application logic.

1. Download OPay iOS SDK.
2. Extract the downloaded framework file and copy to your project folder and include it within you build phases settings.

3. Import the main header file:

                        
                                #import <OpayBusinessFramework/OpayBusinessFramework.h>
                        
                    

After integrating OPay SDK, now it's time to know how to use our SDK API hooks to:

1. Create payment order.
2. Handling payment result.
3. Order status query.

Your app cart item should implement dictionary data, the below table illustrates the values that should be passed through your dictionary object.

Create dictionary data as below.

                
                    NSDictionary *dic=@{
                        @"merchantName": merchantName,
                        @"country": country,
                        @"reference": reference,
                        @"amount": @{
                            @"total": payAmount,
                            @"currency": currency
                        },
                        @"product": @{
                            @"name": productName,
                            @"description": productDescription
                        },
                        @"callbackUrl": callbackUrl,
                        @"userClientIP":userClientIP,
                        @"expireAt":@([expireAt integerValue])
                        @"userInfo": @{
                            @"userId":userId,
                            @"userName":userName,
                            @"userMobile":userMobile,
                            @"userEmail":userEmail
                        }
                    };
                
            

Now, you need to initialize the management class. Code example as follows:

                                
                                    [[[OpayOrderRequestManager instance]registerApp:publickey MerchantId:merchantId isDebug:_isDebug]
                                
                            

                                
                                    OpayOrderRequestManager.instance().registerApp(publicKey, merchantId: merchantId, isDebug: isDebug)
                                
                            

Once you have initialized the management class, you need to call the OpayOrderRequestManager management class to start creating an order. You may follow the following sample code.

                                
                                    [[OpayOrderRequestManager instance] sendOrder:dic successHandler:^(id  _Nonnull result) {
                                        //Success callback
                                    } errorHandler:^(NSString * _Nonnull code, NSString * _Nonnull msg) {
                                        //error message callback
                                    } failHandler:^{
                                        //failed callback
                                    }];
                                
                            

                                
                                    OpayOrderRequestManager.instance().sendOrder(dic, successHandler: { (result) in
                                        //success callback
                                    }, errorHandler: { (code, msg) in
                                        //error callback
                                    }) {
                                        //failed callback
                                    }
                                
                            

failHandler: Handle the logic for the callback after the service fails to be called.

successHandler: For the callback after the service is called successfully, the callback parameter result is the result returned by the calling service. The type is a dictionary and contains order information. Sample response is given below:

                    
                        {
                            "code": "00000",
                            "data": {
                                "amount": {
                                    "currency": "EGP",
                                    "total": 1000
                                },
                                "cashierUrl": "https://sandboxcashier.opaycheckout.com/checkout-list?orderNo=211026140930379662&merchantId=256612345678901&country=EG&rc=false",
                                "orderNo": "211026140930379662",
                                "reference": "12347544444555666llljhh",
                                "status": "INITIAL",
                                "vat": {
                                    "currency": "EGP",
                                    "total": 0
                                }
                            },
                            "message": "SUCCESSFUL"
                        }
                    
                

Depending on the status code of the response, you should build some logic to handle any errors that a request or the system may return. A list of possible potential error codes that you may receive can be found below.

Once the payment has been completed by your client, OPay server will respond back to the SDK to let you know the payment processing result. After your client completes the payment, you will get the payment processing result in the form of Json object. :

Sample response Json object.

                    
                        {
                            "callbackName": "clickReferenceCodeReturnBtn",
                            "eventName": "clickReferenceCodeReturnBtn",
                            "merchantId": "256612345678901",
                            "orderNo": "211026140930379662",
                            "orderStatus": "PENDING", // INITIAL - SUCCESS - FAIL - CLOSE
                            "payNo": "211026140930379662",
                            "referenceCode": "607943772"
                        }
                    
                

Due to network and any other issues, the order status may not be timely. It is highly recommended to call order status inquiry to ensure the integrity of your data. To that end, You will need to create a dictionary that contains the following request parameters:

                    
                        NSDictionary *dic=@{
                            @"country": countryCode,
                            @"reference": reference,
                            @"orderNo":orderNo
                        };

                    
                

After creating the query dictionary, you need to initialize the managemnt class as follows:

                                
                                    [[[OpayOrderRequestManager instance]registerApp: privateKey MerchantId:merchantId isDebug:_isDebug]
                                
                            

                                
                                    OpayOrderRequestManager.instance().registerApp(privateKey, merchantId: merchantId, isDebug: isDebug)
                                
                            

Now, you need to :

                                
                                    [OpayOrderRequestManager instance] queryOrder:dic successHandler:^(NSString * _Nonnull code, NSString * _Nonnull errorMsg, id  _Nonnull result) {

                                    } failHandler:^{

                                    }];
                                
                            

                                
                                    OpayOrderRequestManager.instance().queryOrder(dic, successHandler: { (result) in

                                    }) {

                                    }
                                
                            

failHandler: Handle the logic for the callback after the service fails to be called.

successHandler: For the callback after the service is called successfully, the callback parameter result is the result returned by the calling service. The type is a dictionary and contains order status information. Sample response is given below:

                    
                        {
                            "code": "00000",
                            "message": "SUCCESSFUL",
                            "data":{
                                "reference":"1001000",
                                "orderNo":"10212100000034000",
                                "status":"SUCCESS",
                                "vat":{
                                  "total":10000,
                                  "currency":"EGP",
                                  "rate":100,
                                  "currencySymbo":"ج.م"
                                },
                                "failureReason":null,
                                "silence":"Y"
                            }
                        }
                    
                

Depending on the status code of the response, you should build some logic to handle any errors that a request or the system may return. A list of possible potential error codes that you may receive can be found below.