Paze

iOS

Register custom URL scheme

Add the shopper result url in custom url scheme in your app's Info.plist:

<key>LSApplicationQueriesSchemes</key>
<array>
    <string>com.companyname.appname.payments</string>
</array>
    

Ready-to-Use UI

When you use our ready-to-use UI, everything works out-of-box. Just set PAZE payment brand and shopper result url in the Checkout Settings class and you are done. Proceed with the presenting checkout as for standard transaction.

OPPCheckoutSettings *checkoutSettings = [[OPPCheckoutSettings alloc] init];
        
// Set Paze payment method
checkoutSettings.paymentBrands = [@"PAZE"];
checkoutSettings.shopperResultURL = @"com.companyname.appname.payments://result";

let checkoutSettings = OPPCheckoutSettings()
    
// Set Paze payment method
checkoutSettings.paymentBrands = ["PAZE"]
checkoutSettings.shopperResultURL = "com.companyname.appname.payments://result"

SDK & Your Own UI

In this guide we assume that you have already implemented all steps for performing standard mSDK transaction. There are several steps that you have to perform to integrate Paze, which are as follows:

1. Create payment parameters for PAZE using OPPPaymentParams.

NSError *error = nil;
OPPPaymentParams *paymentParams = [[OPPPaymentParams alloc] initWithCheckoutID:chekoutID paymentBrand:@"PAZE" error:&error];
paymentParams.shopperResultURL = @"com.companyname.appname.payments://result";

let paymentParams = try? OPPPaymentParams(checkoutID: chekoutID, paymentBrand: "PAZE")
paymentParams?.shopperResultURL = "com.companyname.appname.payments://result"

2. Create transaction object and submit transaction.

OPPTransaction *transaction = [OPPTransaction transactionWithPaymentParams:paymentParams];
OPPPaymentProvider *provider = [OPPPaymentProvider paymentProviderWithMode:providerMode];
[provider submitTransaction:transaction completionHandler:^(OPPTransaction * _Nonnull transaction, NSError * _Nullable error) {
    if (error) {
        // Handle the error.
    } else {
        // Process transaction here using Paze processor
    }
}];

let transaction = OPPTransaction(paymentParams: paymentParams)
let provider = OPPPaymentProvider(mode: providerMode)
provider.submitTransaction(transaction) { (transaction, error) in
    if (error != nil) {
        // Handle the error.
    } else {
        // Process transaction here using Paze processor
    }
}

3. Create Paze processor to process transaction.

OPPPazeProcessor *processor = [[OPPPazeProcessor alloc] initWithTransaction:transaction provider:provider];    
[processor startPaze:^(OPPTransaction * _Nullable transaction, NSError * _Nullable error) {
    // At this stage, the application may consume and handle any error if present. However, Step 4 remains mandatory and serves as the final step to obtain the definitive payment status.
}];

let pazeProcessor = OPPPazeProcessor(transaction: transaction, provider: provider)
pazeProcessor.startPaze { transaction, error in
    // At this stage, the application may consume and handle any error if present. However, Step 4 remains mandatory and serves as the final step to obtain the definitive payment status.
}

4. Get the payment status

Finally your app should request the payment status from your server.

For more details you can refer to this document.

Web Browsing Session Type

We are using ASWebAuthenticationSession for the Paze session. This allows us to initiate the session with the prefersEphemeralWebBrowserSession flag set to either true or false. An ephemeral web browser session does not share cookies, cache, or other browsing data with the user’s regular browsing context. By default, we are using the default behavior, where prefersEphemeralWebBrowserSession is set to false when initiating the session with ASWebAuthenticationSession. This means the session uses the standard web browser context and shares existing browsing data such as cookies.

We provided a way to set this property using Mobile SDK in both Ready-to-Use UI & Custom UI integration.

Set browserSessionType on CheckoutSettings created above in Ready-to-Use UI flow.

checkoutSettings.browserSessionType = OPPWebBrowserSessionTypeEphemeral;

checkoutSettings.browserSessionType = .ephemeral

Provide a browserSessionType while creating OPPPazeProcessor in Custom UI flow.

OPPPazeProcessor *processor = [[OPPPazeProcessor alloc] initWithTransaction:transaction provider:provider browserSessionType: OPPWebBrowserSessionTypeEphemeral];    
[processor startPaze:^(OPPTransaction * _Nullable transaction, NSError * _Nullable error) {
    // At this stage, the application may consume and handle any error if present. However, Step 4 remains mandatory and serves as the final step to obtain the definitive payment status.
}];

let pazeProcessor = OPPPazeProcessor(transaction: transaction, provider: provider, browserSessionType: .ephemeral)
pazeProcessor.startPaze { transaction, error in
    // At this stage, the application may consume and handle any error if present. However, Step 4 remains mandatory and serves as the final step to obtain the definitive payment status.
}

Error Codes

We have three error codes in Paze work flow which can throw in case any error occurs.

• OPPErrorCodePazeTransactionFailed - 5016: It is common error code which we use internally for our logging purpose.
• OPPErrorCodeGeneralCancelError - 9001: When Mobile SDK get cancelled status from PAZE UX or user tapped on cancel button in the browsing session.
• OPPErrorCodeGeneralFailedError - 9002: When mSDK get failed status from PAZE UX.