Latest 3.9.0
Homepage https://github.com/MOLPay/molpay-mobile-xdk-cocoapods
License MIT
Platforms ios 8.0, requires ARC
Authors

molpay-mobile-xdk-cocoapods

This is the complete and functional MOLPay iOS payment module that is ready to be implemented into Xcode application project through Cocoapods framework. An example Cocoapods application project (Example) is provided for MOLPayXDK framework integration reference.

Recommended configurations

- Xcode version: 8 ++

- Minimum target version: iOS 7

Installation

Step 1 - Add pod 'MOLPayXDK', '~> <put latest release version here>' to the Podfile, then Pod install.

Step 2 - Add #import <MOLPayXDK/MOLPayLib.h>

Step 3 - Add <MOLPayLibDelegate> to @interface

Step 4 - Add -(void)transactionResult:(NSDictionary *)result for all delegate callbacks

Step 5 - Add 'App Transport Security Settings > Allow Arbitrary Loads > YES' to the application project info.plist

Step 6 - Add 'NSPhotoLibraryUsageDescription' > 'Payment images' to the application project info.plist

Prepare the Payment detail object

NSDictionary * paymentRequestDict = @{
    // Mandatory String. A value more than '1.00'
    @"mp_amount": @"1.10",

    // Mandatory String. Values obtained from MOLPay
    @"mp_username": @"username",
    @"mp_password": @"password",
    @"mp_merchant_ID": @"merchantid",
    @"mp_app_name": @"appname",
    @"mp_verification_key": @"vkey123",

    // Mandatory String. Payment values
    @"mp_order_ID": @"orderid123",
    @"mp_currency": @"MYR",
    @"mp_country": @"MY",

    // Optional String.
    @"mp_channel": @"multi", // Use 'multi' for all available channels option. For individual channel seletion, please refer to "Channel Parameter" in "Channel Lists" in the MOLPay API Spec for Merchant pdf. 
    @"mp_bill_description": @"billdesc",
    @"mp_bill_name": @"billname",
    @"mp_bill_email": @"[email protected]",
    @"mp_bill_mobile": @"+1234567",
    @"mp_channel_editing": [NSNumber numberWithBool:NO], // Option to allow channel selection.
    @"mp_editing_enabled": [NSNumber numberWithBool:NO], // Option to allow billing information editing.

    // Optional for Escrow
    @"mp_is_escrow": @"0", // Put "1" to enable escrow

    // Optional for credit card BIN restrictions
    @"mp_bin_lock": [NSArray arrayWithObjects:@"414170", @"414171", nil], 
    @"mp_bin_lock_err_msg": @"Only UOB allowed"

    // For transaction request use only, do not use this on payment process
    @"mp_transaction_id": @"", // Optional, provide a valid cash channel transaction id here will display a payment instruction screen.
    @"mp_request_type": @"", // Optional, set 'Status' when performing a transactionRequest

    // Optional, use this to customize the UI theme for the payment info screen, the original XDK custom.css file is provided at Example project source for reference and implementation.
    @"mp_custom_css_url": [[NSBundle mainBundle] pathForResource:@"custom.css" ofType:nil],

    // Optional, set the token id to nominate a preferred token as the default selection, set "new" to allow new card only
    @"mp_preferred_token": @"", 

    // Optional, credit card transaction type, set "AUTH" to authorize the transaction
    @"mp_tcctype": @"",

    // Optional, set true to process this transaction through the recurring api, please refer the MOLPay Recurring API pdf  
    @"mp_is_recurring": [NSNumber numberWithBool:NO],

    // Optional for channels restriction 
    @"mp_allowed_channels": [NSArray arrayWithObjects:@"credit", @"credit3", nil],

    // Optional for sandboxed development environment, set boolean value to enable. 
    @"mp_sandbox_mode": [NSNumber numberWithBool:YES],

    // Optional, required a valid mp_channel value, this will skip the payment info page and go direct to the payment screen.
    @"mp_express_mode": [NSNumber numberWithBool:YES],

    // Optional, enable this for extended email format validation based on W3C standards.
    @"mp_advanced_email_validation_enabled": [NSNumber numberWithBool:YES],

    // Optional, enable this for extended phone format validation based on Google i18n standards.
    @"mp_advanced_phone_validation_enabled": [NSNumber numberWithBool:YES],

    // Optional, explicitly force disable billing name edit.
    @"mp_bill_name_edit_disabled": [NSNumber numberWithBool:YES],

    // Optional, explicitly force disable billing email edit.
    @"mp_bill_email_edit_disabled": [NSNumber numberWithBool:YES],

    // Optional, explicitly force disable billing mobile edit.
    @"mp_bill_mobile_edit_disabled": [NSNumber numberWithBool:YES],

    // Optional, explicitly force disable billing description edit.
    @"mp_bill_description_edit_disabled": [NSNumber numberWithBool:YES]
};

Start the payment module

MOLPayLib mp = [[MOLPayLib alloc] initWithDelegate:self andPaymentDetails:paymentRequestDict];

Show the payment UI

[self presentViewController:mp animated:NO completion:nil];

Close the payment module

[mp closemolpay];

* Note: The host application needs to implement the MOLPay payment module manually upon getting a final callback from the close event.

Payment module callback

- (void)transactionResult: (NSDictionary *)result

=========================================
Sample transaction result in JSON string:
=========================================

{"status_code":"11","amount":"1.01","chksum":"34a9ec11a5b79f31a15176ffbcac76cd","pInstruction":0,"msgType":"C6","paydate":1459240430,"order_id":"3q3rux7dj","err_desc":"","channel":"Credit","app_code":"439187","txn_ID":"6936766"}

Parameter and meaning:

"status_code" - "00" for Success, "11" for Failed, "22" for *Pending. 
(*Pending status only applicable to cash channels only)
"amount" - The transaction amount
"paydate" - The transaction date
"order_id" - The transaction order id
"channel" - The transaction channel description
"txn_ID" - The transaction id generated by MOLPay

* Notes: You may ignore other parameters and values not stated above

=====================================
* Sample error result in JSON string:
=====================================

{"Error":"Communication Error"}

Parameter and meaning:

"Communication Error" - Error starting a payment process due to several possible reasons, please contact MOLPay support should the error persists.
1) Internet not available
2) API credentials (username, password, merchant id, verify key)
3) MOLPay server offline.

Cash channel payment process (How does it work?)

This is how the cash channels work on XDK:

1) The user initiate a cash payment, upon completed, the XDK will pause at the “Payment instruction” screen, the results would return a pending status.

2) The user can then click on “Close” to exit the MOLPay XDK aka the payment screen.

3) When later in time, the user would arrive at say 7-Eleven to make the payment, the host app then can call the XDK again to display the “Payment Instruction” again, then it has to pass in all the payment details like it will for the standard payment process, only this time, the host app will have to also pass in an extra value in the payment details, it’s the “mp_transaction_id”, the value has to be the same transaction returned in the results from the XDK earlier during the completion of the transaction. If the transaction id provided is accurate, the XDK will instead show the “Payment Instruction" in place of the standard payment screen.

4) After the user done the paying at the 7-Eleven counter, they can close and exit MOLPay XDK by clicking the “Close” button again.

XDK built-in checksum validator caveats

All XDK come with a built-in checksum validator to validate all incoming checksums and return the validation result through the "mp_secured_verified" parameter. However, this mechanism will fail and always return false if merchants are implementing the private secret key (which the latter is highly recommended and prefereable.) If you would choose to implement the private secret key, you may ignore the "mp_secured_verified" and send the checksum back to your server for validation. 

Private Secret Key checksum validation formula

chksum = MD5(mp_merchant_ID + results.msgType + results.txn_ID + results.amount + results.status_code + merchant_private_secret_key)

Support

Submit issue to this repository or email to our [email protected]

Merchant Technical Support / Customer Care : [email protected]
Sales/Reseller Enquiry : [email protected]
Marketing Campaign : [email protected]
Channel/Partner Enquiry : [email protected]
Media Contact : [email protected]
R&D and Tech-related Suggestion : [email protected]
Abuse Reporting : [email protected]

Latest podspec

{
    "name": "MOLPayXDK",
    "version": "3.9.0",
    "summary": "MOLPay Mobile XDK",
    "description": "MOLPay mobile payment for iOS (Cocoapods Framework)",
    "homepage": "https://github.com/MOLPay/molpay-mobile-xdk-cocoapods",
    "license": "MIT",
    "authors": {
        "MOLPay Mobile Division": "[email protected]"
    },
    "source": {
        "git": "https://github.com/MOLPay/molpay-mobile-xdk-cocoapods.git",
        "tag": "3.9.0"
    },
    "platforms": {
        "ios": "8.0"
    },
    "requires_arc": true,
    "source_files": "Pod/Classes/**/*",
    "public_header_files": "Pod/Classes/**/*.h",
    "resources": "MOLPayXDK.bundle",
    "vendored_frameworks": "MOLPayXDK.framework"
}

Pin It on Pinterest

Share This