PayssionSDK

中文文档

FAQ中文

Installation

1. Copy PayssionSDK.jar to the libs/ folder.

Android Studio：

Add the following to your build.gradle:

• compile 'com.android.support:appcompat-v7:xx.xx'
• compile files('libs/PayssionSDK.jar')

Eclipse：

• Import android-support-v7-appcompat library.
• PayssionSDK.jarAdd to Build Path.

2. Make sure you have added the following permission to the AndroidManifest.xml:

<uses-permission android:name="android.permission.INTERNET"/>
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE"/>
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>

If your app is targeting API level 28 (Android 9.0) or above, you must include the following declaration within the element of AndroidManifest.xml.

<uses-library android:name="org.apache.http.legacy" android:required="false" />

and This Activity

<activity
    android:name="com.payssion.android.sdk.PayssionActivity"
    android:label="@string/app_name"
    android:configChanges="orientation|keyboardHidden|screenSize"
    android:theme="@style/Theme.PayssionTrans"/>
<activity
    android:name="com.payssion.android.sdk.PaymentWebActivity"
    android:label="@string/app_name"
    android:theme="@style/Theme.AppCompat.Light.NoActionBar"/>

3. Add the following to your values/styles.xml

   <style name="Theme.PayssionTrans" parent="Theme.AppCompat.Light">
        <item name="android:windowIsTranslucent">true</item>
        <item name="android:windowBackground">@android:color/transparent</item>
        <item name="android:windowContentOverlay">@null</item>
        <item name="android:windowNoTitle">true</item>
        <item name="android:windowIsFloating">true</item>
        <item name="android:windowFullscreen">true</item>
        <item name="android:backgroundDimEnabled">true</item>
    </style>

Parameters note

Function name	Parameter name	Type	Required	Example	Description
setLiveMode	live_mode	boolean	No	true/false	App environment
setAPIKey	api_key	string	Yes	5963a4c1c35c2a8e	App id
setOrderId	order_id	string	Yes	123	order id
setAmount	amount	double	Yes	1.99	total payment amount
setCurrency	currency	string	Yes	USD	three-letter abbreviation
setPMId	pm_id	string	Yes	sofort	payment method id
setDescription	description	string	Yes	game recharge #123	payment description
setPayerEmail	payer_email	string	Yes	[email protected]	payer email
setPayerName	payer_name	string	Yes	John Smith	payer name

Usage

Create a transaction

Let's say you create a transaction in MainActivity.

Intent intent = new Intent(MainActivity.this, PayssionActivity.class);
intent.putExtra(PayssionActivity.ACTION_REQUEST,
        new PayRequest()
        .setLiveMode(false) //false if you are using sandbox environment
        .setAPIKey(apiKey) //Your API Key
        .setAmount(amount)
        .setCurrency(currency)
        .setPMId(pmId)
        .setDescription(description)
        .setOrderId(orderId) //Your order id
        .setPayerEmail(payerEmail)
        .setPayerName(payerName));
MainActivity.this.startActivityForResult(intent, 0);

Handle result

You need to overide onActivityResult method in MainActivity.

    @Override
    protected void onActivityResult(int requestCode, int resultCode, Intent data) {
        Log.v(this.getClass().getSimpleName(), "onActivityResult");
        switch (resultCode) {
        case PayssionActivity.RESULT_PENDING:
            if (null != data) {
                PayResponse response = (PayResponse)data.getSerializableExtra(PayssionActivity.RESULT_DATA);
                if (null != response) {
                    String transId = response.getTransactionId(); //get Payssion transaction id
					String orderId = response.getOrderId(); //get your order id
                    //you will have to query the payment state with the transId or orderId from your server
                    //as we will notify you server whenever there is a payment state change
                } else {
                    //should never go here
                }
            }
            break;
        case PayssionActivity.RESULT_CANCELED:
            //the transation has been cancelled, for example, the users doesn't pay but get back
            break;
        case PayssionActivity.RESULT_ERROR:
            //there is some error
            if (null != data) {
                String err_des = data.getStringExtra(PayssionActivity.RESULT_DESCRIPTION);
                Log.v(this.getClass().getSimpleName(), "RESULT_ERROR" + err_des);   
            }
            break;
        }
        super.onActivityResult(requestCode, resultCode, data);
    }

Result Data Note

1.result parameters note

The return data package is PayResponse.class ,you can get it by Intent.getSerializableExtra(PayssionActivity.RESULT_DATA)

Function name	Parameter name	Type	Description
getTransactionId	transaction_id	String	transaction id
getPMId	pm_id	String	The Payment method id
getAmount	amount	String	order amount
getCurrency	currency	String	currency
getOrderId	order_id	String	order id
getPaid	paid	String	The amount which the user has paid
getNet	net	String	The amount after decucting the fees
getState	state	Int	order state
getStateStr	stateStr	String	order state
getCreated	created	Int	created time
getDescription	description	String	description

2.Result Code

Parameter name	Description	Type	Value
RESULT_PENDING	The payment activity is finished and the payment status is unknown	int	770
RESULT_CANCELED	Payment canceled	int	771
RESULT_ERROR	Payment error	int	772

3.Tips

1. Payssion will post the following parameters to your notify url when the payment state changes.Please read the document.notify_url

##PMIDSetting

1. You can set supports only one payment for PayRequest

Example:

Intent intent = new Intent(MainActivity.this, PayssionActivity.class);
intent.putExtra(PayssionActivity.ACTION_REQUEST,
new PayRequest()
    .setLiveMode(false) //false if you are using sandbox environment
    .setAPIKey(apiKey) //Your API Key
    .setAmount(amount)
    .setCurrency(currency)
    .setPMId(pmId)
    ...
MainActivity.this.startActivityForResult(intent, 0);

2. You can set up support for multiple payment methods.

We provide the following two functions to support you in a reasonable configuration of the required payment methods.
You can use the payment method we provide logo, you can also project the assets folder to create the "payssion/pm/" path, and you will be able to customize the payment method logo pictures under the path. Image format is.png, the picture names for the payment method of PMID.

   /**
     * set enable payment methods
     * @param pm_id enable PMID.For more than one can be used "to" split open。For example"pm_idA|pm_idB|pm_idC"
     */
    PayssionConfig.setPM(String pm_id);

   /**
     * set disable payment methods
     * @param disablePM disable PMID.For more than one can be used "to" split open。For example"pm_idA|pm_idB|pm_idC"
     */
    PayssionConfig.disablePM(String disenablePM);
    
    /**
     * set default country
     * @param country 
     */
    PayssionConfig.setDefaultCountry(String country);

Set Theme Color

You can set theme color following this.

   /**
     * Set Theme Color
     * @param color theme color
     */
PayssionConfig.setThemeColor(@ColorInt int color);

Color default reads the following code to obtain

getTheme().resolveAttribute(android.R.attr.colorAccent, TypedValue, true);  
defaultColor = TypedValue.data;

*Tips* PayssionConfig's function needs to be called before the transaction is created.

Multi language setting

We support the Chinese Simplified (ZH_SIMPLIFIED), Traditional Chinese (ZH_TRADITIONAL), English (EN), German (DE), Spanish (ES), Portuguese (PT), Russian (RU), Arabic (AR) and other languages.
You can set the language through the functionPayRequest.setLanguage(String language)or the functionPayssionConfig.setLanguage(String language),the incoming parameter is the language variable of the**PLanguage**class.

Example:

PayRequest payRequest = new PayRequest();
payRequest.setLanguage(PLanguage.ZH_SIMPLIFIED);
...

or

PayssionConfig.setLanguage(PLanguage.ZH_SIMPLIFIED);
...

The default language can be read by thejava.util.Locale.getDefault().getLanguage()function in the local language settings.

*Tips*

1. PayRequest sets the priority of the language to be greater than PayssionConfig.
2. Arabic needs to add the android:supportsRtl= "true" attribute to the applicationelement in theAndroidManifest.xml` file. This property supports Android4.2 and above versions.

Example:

<application
    android:allowBackup="true"
    android:icon="@mipmap/ic_launcher"
    android:label="@string/app_name"
    android:supportsRtl="true"
    android:theme="@style/AppTheme">
    ...
</application>