To enable accepting payments through the Adyen POS Mobile SDK, take the following steps:
- Add the Adyen POS Mobile SDK for Android to the Android Studio (or other) project that contains your Android POS app.
- Add code to establish a session.
- Add code to enable transactions through the Adyen POS Mobile SDK.
Add the Adyen POS Mobile SDK
We provide the Adyen POS Mobile SDK for Android through GitHub Packages, using a private GitHub repository. To get access, you need to create a single access token for your company.
We recommend using Android SDK version 30 (Android 11) or later. It is possible to run the POS Mobile SDK on a lower versions of the Android SDK, but it can cause crashes.
-
Provide your Adyen contact with the username of the personal GitHub account that your company will use for generating an access token to the remote repository where the SDK is stored.
We will add one GitHub account per company to our repository.
-
Generate a classic personal access token:
- Log in to GitHub with the username provided to Adyen.
- Go to https://github.com/settings/tokens and select Generate new token > Generate new token (classic).
- Select only the
read:packages
scope and then select Generate token. - Copy the token to a secure location.
You can share the token with anybody in your team who needs to get the SDK.
-
Remove any existing, old SDK files from your local Maven
/.m2/repository/
folder. -
In your project's
build.gradle
file, add the package dependencies.val version = 1.1.1 releaseImplementation 'com.adyen.ipp:pos-mobile-release:$version' debugImplementation 'com.adyen.ipp:pos-mobile-debug:$version'
- The
-debug
version can only access the Test environment and the-release
version can only access the Live environment. - In case of other custom build variants, use
<buildVariantName>Implementation 'com.adyen.ipp:pos-mobile-<type>:$version'
where<type>
can be release (for production builds) or debug (for debug or development builds).
- The
-
In the
repositories
block of thebuild.gradle
file, add the URL to the remote repository where the SDK is stored, the GitHub username provided to Adyen, and the GitHub token that was created for that user.repositories { maven { url = uri("https://maven.pkg.github.com/Adyen/adyen-pos-mobile-android-artifacts") credentials { username = "GITHUB_USER_NAME" password = "GITHUB_CLASSIC_PERSONAL_ACCESS_TOKEN" } } }
Establish a session
The Adyen POS Mobile SDK has to communicate in a secure way with the plataforma de pagamentos da Adyen. To enable this, you must integrate a server-to-server POST /checkout/possdk/v68/sessions request to create a session. Your POS app needs to call your backend to trigger this request and get the session data.
The SDK uses the session data from the response to authenticate with our payments platform. Because the session expires after some time, the SDK checks regularly if it needs to establish a new session.
API key and roles
To authenticate your /checkout/possdk/v68/sessions
requests, you need an API credential. This API credential must have an API key and a client key, and the following role:
- Checkout webservice role. This role is assigned by default when the API key is created.
Going live
When going live, you need to change the endpoint as well as your API key:
-
To access the live endpoint, generate an API key from your live Customer Area.
-
The live endpoint URL contains a prefix which is unique to your company account, for example:
https://{PREFIX}-checkout-live.adyenpayments.com/checkout/possdk/v68/sessions
Get your
{PREFIX}
from your live Customer Area under Developers > API URLs > Prefix.
Make a /sessions
request
To let your backend establish a session:
-
From your backend, make a POST /checkout/possdk/v68/sessions request. In the request body, specify:
Parameter Required Description merchantAccount The unique identifier of your merchant account. setupToken The setup token provided by the Adyen POS Mobile SDK for Android through the MerchantAuthenticationService.authenticate(setupToken)
callback ofMerchantAuthenticationService
.store The unique identifier of the store that you want to process payments for. -
When you receive the response:
- Check that you get a 201 Created HTTP status code.
- Return the sdkData to your POS app.
- If you create the Terminal API request on your backend, save the installationId and use this as the
POIID
in theMessageHeader
of the payment request.
Enable transactions
The Adyen POS Mobile SDK initializes automatically, using the the Android App Startup library. It is possible to disable the automatic initialization of the POS Mobile SDK if needed.
To enable the payments functionality of the Adyen POS Mobile SDK for Android, add code to your Android POS app:
-
Implement the
MerchantAuthenticationService
interface. Note that you need to extract the sdkData from the server response and create anAuthenticationResponse
object withsdkData
in the constructor. Below is an example of how you could do that (assuming your project uses OkHttp).class MyAuthenticationProvider : AuthenticationProvider() { override suspend fun authenticate(setupToken: String): Result<AuthenticationResponse> { // Make a call to your backend to trigger a `/checkout/possdk/v68/sessions` request, specifying the `setupToken` provided by the SDK val client = OkHttpClient() val request = Request.Builder() .url("ADDRESS_OF_YOUR_BACKEND_API") .build() client.newCall(request).execute().use { response -> response.body?.let { // parse your own back-end response and return AuthenticationResponse ... return Result.success(AuthenticationResponse(sdkData)) } } } }
-
Implement the
MerchantAuthenticationService
abstract class: in your implementation, provide an instance of yourAuthenticationProvider
from the previous step. If you use Dagger2/Hilt dependency injection, below is an example of how you could do this:class MyAuthenticationService : MerchantAuthenticationService() { @Inject override lateinit var authenticationProvider: AuthenticationProvider }
-
Add the service to your POS app's
AndroidManifest.xml
file.<service android:name=".MyAuthenticationService"/>
-
Make sure that the
MerchantAuthenticationService
can provide newsdkData
at any time.
If there is no session or the session has expired, the service is called using theMerchantAuthenticationService.authenticate(setupToken)
callback. Using the providedsetupToken
you need to get thesdkData
through your backend and return it. For instructions, see Establish a session.The Adyen POS Mobile SDK detects the
MerchantAuthenticationService
automatically. If there is more than one implementation ofMerchantAuthenticationService
, the system will return an error.
Manage automatic initialization
The Adyen POS Mobile SDK initializes automatically, using the the Android App Startup library. If you prefer to manually initialize the Adyen POS Mobile SDK, add the following code to the POS app's AndroidManifest.xml
file to disable the Adyen POS Mobile SDK.
<provider
android:name="androidx.startup.InitializationProvider"
android:authorities="${applicationId}.androidx-startup"
android:exported="false"
tools:node="merge">
<meta-data android:name="com.adyen.ipp.InPersonPaymentsInitializer"
tools:node="remove" />
</provider>
To manually initialize that component at a later point, add the following code to the POS app's AndroidManifest.xml
.
AppInitializer.getInstance(this)
.initializeComponent(InPersonPaymentsInitializer::class.java)
Manage POS app dependency initialization
The code that you add to the Application.onCreate()
method is executed for all processes. In some cases, it can be beneficial to skip the re-execution of the code, for example the initialization of your dependency graph or analytics libraries.
The method below evaluates specific conditions and returns a boolean value that indicates whether the initialization should be skipped.
if (InPersonPaymentsTools.shouldSkipAppInitialize(context)) {
// Perform actions when initialization should be skipped
} else {
// Proceed with application initialization
}