Welcome to SecurionPay Android SDK. Framework makes it easy to add SecurionPay payments to your mobile apps. It allows you to integrate SecurionPay with just a few lines of code. It also provides customizable UI elements and exposes low-level SecurionPay API from which you can create a custom payment form.
All sensitive data is sent directly to our servers instead of using your backend, so you can be sure that your payments are highly secure.
Add a smart 3D Secure verification with superior UX to your transactions. Provide smooth and uninterrupted payment experience that doesn’t interfere with your conversion process.
We provide methods corresponding to SecurionPay API. It allows you creating an entirely custom UI embedded into your application to increase conversion by keeping clients inside your app.
You can process payments in 18 languages.
Strict requirements of PCI 3DS SDK make development impossible. Running on simulator or debugging are forbidden in a production build of your application. We provide two versions of Framework both for Debug and Release builds so you can create and debug your application without any issues.
Releasing using a store other than Play Store is forbidden by default. If you want to use a different store, for example Firebase App Distribution, you have to provide their identifiers as described below.
To ensure that an application using our SDK successfully passes the review process to the Play Store, we have integrated it into the SecurionPay application. It also allows you to familiarize yourself with the features of our Framework in a convenient way. To do this, download the application, then in the Profile tab, turn on the test mode. A Developers section will appear at the bottom of the screen with a demonstration of the Framework.
3D Secure library license requirements force us to distribute it via email. Contact [email protected] to get it. Download both ipworks3ds_sdk_deploy.aar and ipworks3ds_sdk.aar 3D-Secure libraries, copy them to your project and add as dependencies. Next, add securionpay-android and securionpay-android-debug to your build.gradle dependencies.
dependencies {
releaseImplementation 'com.securionpay:securionpay-android:1.0.4'
debugImplementation 'com.securionpay:securionpay-android-debug:1.0.4'
releaseImplementation files('ipworks3ds_sdk_deploy.aar')
debugImplementation files('ipworks3ds_sdk.aar')
}
If you have not created an account yet, you can do it here: https://securionpay.com/signup.
To configure the framework you need to provide the public key. You can find it here: https://securionpay.com/account-settings. Notice that there are two types of keys: live and test. The type of key determines application mode. Make sure you used a live key in build released to Play Store.
Framework also requires you to specify App Signature. This property should be set to the SHA256 fingerprint of the certificate used to sign the app. You can find it in Google Play Console. Any attempt to perform the 3D Secure operation in release mode results in error if they do not match. This value should not be hardcoded in the application for security reasons. You should provide it on your backend side.
Releasing using a store other than Play Store is forbidden by default. If you want to use a different store, for example Firebase App Distribution, you have to provide their identifiers.
val publicKey = "pk_test_..."
val signature = "00:11:22...."
val trustedAppStores = listOf("com.google.android.packageinstaller") // Firebase App Distribution
val securionPay = SecurionPay(applicationContext, publicKey, signature, trustedAppStores)Checkout Dialog is an out-of-box solution designed to provide the smoothest payment experience possible. It is a simple overlay with payments that appears on top of your page. Well-designed and ready to use.
To present Checkout Dialog you need to create Checkout Request on your backend side. You can find more informations about Checkout Requests here: https://securionpay.com/docs/api#checkout-request. You can also create test Checkout Request here: https://securionpay.com/docs/checkout-request-generator.
val checkoutRequest = CheckoutRequest("...")
securionPay.showCheckoutDialog(this, checkoutRequest)To receive the callback from Checkout Dialog, you must implement interface SecurionPay.CheckoutDialogFragmentResultListener.
class MainActivity : AppCompatActivity(), SecurionPay.CheckoutDialogFragmentResultListener {
override fun onCheckoutFinish(result: Result<ChargeResult>?) {
result?.let {
when (it.status) {
Status.SUCCESS -> {
Log.i("SP", it.data!!.id!!)
}
Status.ERROR -> {
Log.e("SP", it.error?.message(this)!!)
}
}
} ?: run {
Log.i("SP","Cancelled")
}
}
}Checkout View Controller has a feature allowing to remember cards used before. To delete them, use code:
securionPay.cleanSavedCards()| Type | Code | Message | Explanation |
|---|---|---|---|
| .sdk | .unsupportedValue | "Unsupported value: (value)" | Framework does not accept Checkout Request fields: termsAndConditionsUrl, customerId, crossSaleOfferIds. |
| .sdk | .incorrectCheckoutRequest | "Incorrect checkout request" | Checkout Request looks corrupted. Make sure you created it according to documentation. |
| .threeDSecure | .unknown | "Unknown 3D Secure Error. Check your SDK integration." | |
| .threeDSecure | .deviceJailbroken | "The device is jailbroken." | |
| .threeDSecure | .integrityTampered | "The integrity of the SDK has been tampered." | Check your SDK integration. Error happens when you install app from untrusted App Store, when you try to run release version on Emulator or when your fingerprint is incorrect. |
| .threeDSecure | .simulator | "An emulator is being used to run the app." | |
| .threeDSecure | .osNotSupported | "The OS or the OS version is not supported." |
val tokenRequest = TokenRequest("4242424242424242", "10", "2034", "123")
securionPay.createToken(tokenRequest) { token ->
when (token.status) {
Status.ERROR -> {
Log.e("SecurionPay", token.error!!.message(this))
}
Status.SUCCESS -> {
securionPay.authenticate(token.data!!, 10000, "EUR", this) { authenticatedToken ->
when(authenticatedToken.status) {
Status.SUCCESS -> {
Log.d("SecurionPay", token.data!!.id)
}
Status.ERROR -> {
Log.e("SecurionPay", token.error!!.message(this))
}
}
}
}
}
}| Type | Code | Message | Explanation |
|---|---|---|---|
| .cardError | .invalidNumber | "The card number is not a valid credit card number." | |
| .cardError | .invalidExpiryMonth | "The card's expiration month is invalid." | |
| .cardError | .invalidExpiryYear | "The card's expiration year is invalid." | |
| .cardError | .expiredCard | "The card has expired." | |
| .cardError | .invalidCVC | "Your card's security code is invalid." |
| Type | Code | Message | Explanation |
|---|---|---|---|
| .sdk | .anotherOperation | "Another task is in progress." | You can complete only one authentication operation at a time. Your UI should prevent it from being triggered multiple times. |
| .threeDSecure | .unknown | "Unknown 3D Secure Error. Check your SDK integration." | |
| .threeDSecure | .deviceJailbroken | "The device is jailbroken." | |
| .threeDSecure | .integrityTampered | "The integrity of the SDK has been tampered." | Check your SDK integration. Error happens when you install app from untrusted App Store, when you try to run release version on Emulator or when your fingerprint is incorrect. |
| .threeDSecure | .simulator | "An emulator is being used to run the app." | |
| .threeDSecure | .osNotSupported | "The OS or the OS version is not supported." |
When making requests in test mode you have to use special card numbers to simulate successful charges or processing errors. You can find list of card numbers here: https://securionpay.com/docs/testing. You can check status of every charge you made here: https://securionpay.com/charges.
Remember not to make too many requests in a short period of time or you may reach a rate limit. If you reach the limit you have to wait 24h.
SDK supports localization in for 18 languages. Your application must be localized.
Framework is released under the MIT Licence.