molpay-mobile-xdk-reactnative-beta
This is the beta but functional MOLPay React Native payment module that is ready to be implemented into any React Native project npm install module. An example application project (MOLPayReactExampleProject) is provided for MOLPayXDK framework integration reference.
Recommended configurations
-
Node.js Version: 5.3.0 ++
-
Minimum Android SDK Version: 27 ++
-
Minimum Android API level: 19 ++
-
Minimum Android target version: Android 4.4
-
Minimum React Navtive version : 0.47.1 ++
-
Xcode version: 9 ++
-
Minimum target version: iOS 8
Installation
Android
-
npm install molpay-mobile-xdk-reactnative-beta
-
add the following code to add the package to
MainApplication.java(MainActivity.javaif RN < 0.33)
import com.molpayxdk.MOLPayReactPackage; //<- this
protected List<ReactPackage> getPackages() {
return Arrays.<ReactPackage>asList(
new MainReactPackage(),
new MOLPayReactPackage() //<- this
);
}
- add the following codes to your
android/setting.gradle
you might have multiple 3rd party libraries, make sure that you don't create multiple include.
include ':app', ':molpay-mobile-xdk-reactnative-beta'
project(':molpay-mobile-xdk-reactnative-beta').projectDir = new File(rootProject.projectDir, '../node_modules/molpay-mobile-xdk-reactnative-beta/android')
- edit
android/app/build.gradleand add the following line insidedependencies
compile project(':molpay-mobile-xdk-reactnative-beta')
- run
react-native run-androidto see if everything is compilable.
if have any issue when run-android please make sure your android/local.properties already set sdk path
ndk.dir=path/Android/sdk/ndk-bundle
sdk.dir=path/Android/sdk
- (Optional) header include Close button in payment UI
change the following codes in yourandroid/app/src/main/res/values/styles.xml
<resources>
<!-- Base application theme. -->
<style name="AppTheme" parent="Theme.AppCompat.Light.DarkActionBar">
<!-- Customize your theme here. -->
<!-- use any perfer color-->
<item name="colorPrimary">#3F51B5</item>
</style>
</resources>
IOS
-
npm install molpay-mobile-xdk-reactnative-beta
-
navigate to
node_modules/molpay-mobile-xdk-reactnative-beta/iosand copy MOLPayXDK.bundle into the application project folder{ReactProject}/ios/and open Xcode to perform all imports.
-
In Xcode click on project and find
Build Phasesthen expandLink Binary With Librariesand click+sign to add a new library. selectlibMOLPayXDKlib.aand clickAddbutton. -
final result will be like below (please make sure the MOLPayXDK.bundle also included)
-
Add 'App Transport Security Settings > Allow Arbitrary Loads > YES' to the application project info.plist
-
Add 'NSPhotoLibraryUsageDescription' > 'Payment images' to the application project info.plist
-
Add 'NSPhotoLibraryAddUsageDescription' > 'Payment images' to the application project info.plist
Sample 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.
Prepare the Payment detail object
var paymentDetails = {
// Mandatory String. A value more than '1.00'
'mp_amount': '1.1',
// 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 https://github.com/MOLPay/molpay-mobile-xdk-examples/blob/master/channel_list.tsv.
'mp_bill_description': 'test payment',
'mp_bill_name': 'anyname',
'mp_bill_email': '[email protected]',
'mp_bill_mobile': '0161111111',
'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': '',
// 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': false,
// Optional, required a valid mp_channel value, this will skip the payment info page and go direct to the payment screen.
'mp_express_mode': false,
// 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': false,
// Optional, explicitly force disable billing email edit.
'mp_bill_email_edit_disabled': false,
// Optional, explicitly force disable billing mobile edit.
'mp_bill_mobile_edit_disabled': false,
// Optional, explicitly force disable billing description edit.
'mp_bill_description_edit_disabled': false,
// 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
//import molpay package
var molpay = require("molpay-mobile-xdk-reactnative-beta");
//start molpay payment
molpay.startMolpay(paymentDetails, function(data){
//callback after payment success
console.log(data);
});
React Native android below than 0.47.1 build error
Navigate to node_modules/molpay-mobile-xdk-reactnative-beta/android/src/main/java/com/molpayxdk/MOLPayReactPackage.java and add the below code.
@Override
public List<Class<? extends JavaScriptModule>> createJSModules() {
return Collections.emptyList();
}
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]
