Point-of-sale icon

Upload apps and certificates

Upload apps and certificates to Adyen for your Android payment terminals.

Before installing apps on your Android payment terminals, you need to upload the app so we can convert it into a format that the terminals can handle. If an app also requires a certificate, you need to upload it as well.
You can upload your app manually in your Customer Area, or by making an API call.

By choosing to upload, install, or run any third-party applications on an Adyen payment terminal, you accept full responsibility and liability for any consequences of uploading, installing, or running any such applications.

Prepare the APK file

Before you upload apps to Adyen, you need to create a signed APK file of your app:

  1. In Android Studio, select Build > Generate Signed Bundle / APK.
  2. In the dialog, select APK and then Next.
  3. Configure your key store details and select Next.
  4. Select a build variant:
    • If your minSdkVersion is 23 or earlier, select V1 (Jar Signature). We recommend also selecting V2 (Full APK Signature).
    • If your minSdkVersion is later than 23, we recommend selecting V2 (Full APK Signature).
  5. Select Finish.

For more details, see the Android APK signing documentation.

Manually upload your apps

To manage Android apps in your Customer Area, you must have the following user role:

  • Merchant POS Terminal Management Admin

After you have prepared the APK file:

  1. In your Customer Area, go to In-person payments > Android and select the Apps tab.
  2. Select Upload app.

    If you do not see the Upload app button, contact our Support Team to enable it.

  3. In the dialog box:
    1. Drag the APK file to the upload box or select the box and choose the APK file.
    2. Optionally, enter a description of the app so that we can store this in our systems.
      On the terminal, we will use the app name that is included in the APK.
    3. Select the checkbox to opt in.
    4. Select Upload app.
  4. Stay on the page until the dialog box closes.
    On the Android page, the Apps tab now shows the icon and APK name of your app.
  5. Check the status of your app.

    Status Description
    Processing We are busy signing and converting the app. This can take up to an hour.
    Error Something went wrong. Check that the app matches the specifications and retry uploading the APK file. If the retry attempt fails as well, contact our Support Team or your Adyen implementation manager.
    Invalid There is something wrong with the APK file. Contact our Support Team or your Adyen implementation manager.
    Ready We finished signing and converting the app. The app is ready for installation.

Use API calls to upload your apps

You can use our Management API to upload your app. You need to prepare the APK file first and then pass it in the request body as multipart form data.

To make this request to Management API, you need to have an API credential with an API key and the following roles:

  • Management API—Android files read and write

After you have prepared the APK file:

  1. Make a /companies/{companyId}/androidApps request and specify:

    • As a path parameter:
    Parameters Required Description
    companyId -white_check_mark- The unique identifier of the company account.
    • As request parameters:
    Parameters Required Description
    file -white_check_mark- The path to the Android Package (APK) of the app, in multipart form data format. The maximum APK file size is 200 MB.
    description -x- Your description of the Android app, in multipart form data format.
  2. A successful request returns a response with a 200 OK HTTP status code and no body.

(Optional) Upload the certificate

Some apps need a digital certificate. For example, a certificate to protect network communications between a POS app and the back end of that app. Such a certificate needs to be installed on the terminal, and replaced with a new one before the validity period of the certificate expires.

To manage Android apps and Android certificates in your Customer Area, you must have the following user role:

  • Merchant POS Terminal Management Admin
  1. Make sure you have the certificate in .pem or .cert format.
  2. In your Customer Area, go to In-person payments > Android and select the Certificates tab.
  3. Select Upload new certificate.
  4. In the dialog box:
    1. Drag the certificate file to the upload box or select the box and choose the certificate file.
    2. Enter the certificate name to show in the Customer Area.
    3. Optionally, enter a description of the certificate.
    4. Select Upload certificate.
  5. Check that the Certificates tab now shows the name of your certificate, and the status Ready.

See also