Skip to content

MOLPay mobile payment for Cordova (Plugin) (IONIC, Framework7 Compatible)

Notifications You must be signed in to change notification settings

LeowWH/molpay-mobile-xdk-cordova

 
 

Repository files navigation

molpay-mobile-xdk-cordova

This is the complete and functional MOLPay Cordova payment module that is ready to be implemented into Cordova project through Cordova plugin installation procedures. An example application project (MOLPayXDKExample) is provided for MOLPayXDK Cordova integration reference.

This plugin provides an integrated MOLPay payment module that contains a wrapper 'molpay.js' and an upgradable core as the 'molpay-mobile-xdk-www' folder, which the latter can be separately downloaded at https://github.com/MOLPay/molpay-mobile-xdk-www and update the local version.

Recommended configurations

- Cordova SDK Version: 6.5.0 ++

- Node.js Version: 5.3.0 ++

- Minimum Android target version: Android 4.4

- Minimum iOS target version: 7.0

Installation

Step 1 - cordova plugin add molpay-mobile-xdk-cordova

Step 2 - Add the following meta tags to the app index.html
<meta http-equiv="Content-Security-Policy" content="default-src * data: gap: 'unsafe-eval' 'unsafe-inline'; style-src 'self' 'unsafe-inline'; media-src *"> *This allow cross-domain communication between MOLPay payment module and payment servers.*
<meta name="format-detection" content="telephone=no">

Step 3 - Add the MOLPay div to your payment UI
<div id="molpay" class="molpay"/>

Step 4 - Add the result callback function
var molpayCallback = function (transactionResult) {
        // transactionResult return in json;
};

=========================================
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.

Prepare the Payment detail object

document.addEventListener("deviceready", onDeviceReady, false);
function onDeviceReady() {
    var paymentDetails = {
        // Mandatory String. A value more than '1.00'
        'mp_amount' : '',

        // Mandatory String. Values obtained from MOLPay
        'mp_username' : '',
        'mp_password' : '',
        'mp_merchant_ID' : '',
        'mp_app_name' : '',
        'mp_verification_key' : '',  

        // Mandatory String. Payment values
        'mp_order_ID' : '', 
        'mp_currency' : 'MYR',
        'mp_country' : 'MY',  
        
        // Optional String.
        'mp_channel' : '', // 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' : '',
        'mp_bill_name' : '',
        'mp_bill_email' : '',
        'mp_bill_mobile' : '',
        'mp_channel_editing' : false, // Option to allow channel selection.
        'mp_editing_enabled' : false, // Option to allow billing information editing.
        
        // Optional for Escrow
        'mp_is_escrow' : '' // Optional for Escrow, put "1" to enable escrow

        // Optional for credit card BIN restrictions
        'mp_bin_lock' : ['414170', '414171'] // Optional for credit card BIN restrictions
        'mp_bin_lock_err_msg' : 'Only UOB allowed' // Optional for credit card BIN restrictions
        
        // 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 doing 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. Required cordova-plugin-file to be installed
        'mp_custom_css_url' : cordova.file.applicationDirectory + 'www/custom.css',

        // 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': false,

        // Optional for channels restriction 
        'mp_allowed_channels': ['credit', 'credit3'],

        // Optional for sandboxed development environment, set boolean value to enable.
        'mp_sandbox_mode': true,

        // Optional, required a valid mp_channel value, this will skip the payment info page and go direct to the payment screen.
        'mp_express_mode': true,

        // Optional, enable this for extended email format validation based on W3C standards.
        'mp_advanced_email_validation_enabled': true,

        // Optional, enable this for extended phone format validation based on Google i18n standards.
        'mp_advanced_phone_validation_enabled': true,

        // Optional, explicitly force disable billing name edit.
        'mp_bill_name_edit_disabled': true,

        // Optional, explicitly force disable billing email edit.
        'mp_bill_email_edit_disabled': true,

        // Optional, explicitly force disable billing mobile edit.
        'mp_bill_mobile_edit_disabled': true,

        // Optional, explicitly force disable billing description edit.
        'mp_bill_description_edit_disabled': true,
        
        // Optional, EN, MS, VI, TH, FIL, MY, KM, ID, ZH.
        'mp_language': 'EN',

        // Optional, enable for online sandbox testing.
        'mp_dev_mode': false
    };
}

Start the payment module UI

window.molpay.startMolpay(paymentDetails, molpayCallback);

Close the payment module UI

window.molpay.closeMolpay();

* Notes: closeMolpay does not close remove the UI, the host application must implement it's own mechanism to close the payment module UI, i.e. <button onclick="window.molpay.closeMolpay()">Close</button>. The close event will also return a final result.

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]

About

MOLPay mobile payment for Cordova (Plugin) (IONIC, Framework7 Compatible)

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%