Menu

Android SDK

SDK v3
Last updated January 2024

Take payments and still qualify for SAQ-A – the lowest PCI compliance level – with our Android SDK.

Create your own uniquely styled and branded checkout form by integrating our SDK into your native app.

Read more about the Checkout SDK and the supported payment journeyshere.

Note: Make yourself familiar with ourAPI Principlesto ensure a resilient integration.

Important: Please ensure you integrate the SDK as advised in our documentation or you might be subject to additional PCI Compliance and won't meet the SAQ-A Compliance level.

How does it work?

We are securing your customer's payment details by generating sessions. You can thencreate a tokenwith the session totake a payment.

What is a session?

A session is a unique identifier for your customer's payment details, generated by the SDK.

Get our SDK

To get our SDK, include the Gradle,Mavenor Local AAR library configuration below.

Copied!
implementation 'com.worldpay.access:access-checkout-android:3.0.0'
<dependency>
  <groupId>com.worldpay.access</groupId>
  <artifactId>access-checkout-android</artifactId>
  <version>3.0.0</version>
</dependency>
allprojects {
    repositories {
        //...
        flatDir {
            dirs 'libs'
        }
    }
}

Local AAR library

If you're using the Local AAR library to get the SDK, copy the library file into your app/libs folder. Then add the flatDir repo to the project level build.gradle using the code in the Local AAR library example above.

You must also add the example below to your app-level dependency list:

Copied!
implementation (name:'access-checkout-android', ext:'aar')
implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk8:1.6.21"

And here's a link to our Access Checkout Android SDK GitHub Repo:

access-checkout-android

See More
  • Kotlin
  • 8
  • 4

Verify integrity of the SDK using Gradle

You can verify the integrity of the SDK with theDependency Verificationfeature of Gradle.

Run the command below at the root of your Gradle project to generate the verification-metadata.xml file used by Gradle to verify dependencies.

This file, generated by Gradle, contains the checksums of all the libraries defined in your project, with every checksum retrieved from the same repository where Gradle retrieves a dependency from.

This file instructs Gradle to verify the checksums of each library defined in the file. It will fail your build if any library's checksum retrieved from the remote repository is different from the checksum computed by Gradle.

Copied!
gradle --write-verification-metadata sha256

What to do next

See our guides on how to create sessions you can use to take a payment:

Note: For one-time payments, you mustdelete the tokenafter you take the payment.

Create a session to pay with a card

  1. Submit card details to create a session
  2. Create averified token
  3. Take a paymentwith this token

Create sessions to pay with a card and CVC

  1. Submit card details and CVC to create two separate sessions
  2. Create averified tokenwith your CARD session
  3. Use your CVC session and verified token in our card/checkout payment instrument totake a payment

Create a session for CVC only and pay with a stored token

  1. Submit the CVC to create a session
  2. Use your cvc session and stored verified token in our card/checkout payment instrument totake a payment