ADadyen
Android files - company level

Get Android app

Changed on

Returns the details of the Android app identified in the path. These apps have been uploaded to Adyen and can be installed or uninstalled on Android payment terminals through terminal actions.

To make this request, your API credential must have one of the following roles:

  • Management API—Android files read
  • Management API—Android files read and write

In the live environment, requests to this endpoint are subject to rate limits.

get/companies/{companyId}/androidApps/{id}

Request

  • Base URL
    https://management-test.adyen.com/v3
  • URL
    https://management-test.adyen.com/v3/companies/{companyId}/androidApps/{id}
  • Auth
    • HTTP basic
    • or API key in header X-API-Key

Path parameters

companyIdstring required

The unique identifier of the company account.

idstring required

The unique identifier of the app.

Response

OK - the request has succeeded.

descriptionstring

The description that was provided when uploading the app. The description is not shown on the terminal.

errorCodestring

The error code of the Android app with the status of either error or invalid.

idstring required

The unique identifier of the app.

labelstring

The app name that is shown on the terminal.

packageNamestring

The package name that uniquely identifies the Android app.

status'archived' | 'error' | 'invalid' | 'processing' | 'ready' required

The status of the app. Possible values:

  • processing: the app is being signed and converted to a format that the terminal can handle.
  • error: something went wrong. Check that the app matches the requirements.
  • invalid: there is something wrong with the APK file of the app.
  • ready: the app has been signed and converted.
  • archived: the app is no longer available.
versionCodeinteger

The version number of the app.

versionNamestring

The app version number that is shown on the terminal.

Changes

  • v3303286ccccbdRevision changes
    • warning

      added the new archived enum value to the response property for the response status

    • warning

      added the new error enum value to the response property for the response status

    • warning

      added the new invalid enum value to the response property for the response status

    • warning

      added the new processing enum value to the response property for the response status

    • warning

      added the new ready enum value to the response property for the response status

  • v317c9cf5059ffRevision changes
    • info

      added the optional property to the response with the status

    • info

      response property errorCode deprecated