Adyen · JSON Structure

Management Android App Structure

AndroidApp schema from Adyen API

Type: object Properties: 8 Required: 2
PaymentsFinancial ServicesFintech

AndroidApp is a JSON Structure definition published by Adyen, describing 8 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

description errorCode id label packageName status versionCode versionName

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/json-structure/management-android-app-structure.json",
  "description": "AndroidApp schema from Adyen API",
  "type": "object",
  "properties": {
    "description": {
      "description": "The description that was provided when uploading the app. The description is not shown on the terminal.",
      "type": "string"
    },
    "errorCode": {
      "description": "The error code of the app. It exists if the status is error or invalid.",
      "type": "string"
    },
    "id": {
      "description": "The unique identifier of the app.",
      "type": "string"
    },
    "label": {
      "description": "The app name that is shown on the terminal.",
      "type": "string"
    },
    "packageName": {
      "description": "The package name that uniquely identifies the Android app.",
      "type": "string"
    },
    "status": {
      "description": "The status of the app. Possible values: \n* `processing`: the app is being signed and converted to a format that the terminal can handle.\n* `error`: something went wrong. Check that the app matches the [requirements](https://docs.adyen.com/point-of-sale/android-terminals/app-requirements).\n* `invalid`: there is something wrong with the APK file of the app.\n* `ready`: the app has been signed and converted.\n* `archived`: the app is no longer available.",
      "type": "string"
    },
    "versionCode": {
      "description": "The version number of the app.",
      "type": "int32"
    },
    "versionName": {
      "description": "The app version number that is shown on the terminal.",
      "type": "string"
    }
  },
  "required": [
    "id",
    "status"
  ],
  "name": "AndroidApp"
}