Pass application information

Provide platform, merchant application, and merchant device details to the Adyen Payments Platform.

Application information identifies the software that you use for making payment requests to the Adyen payments platform. Add application info to your payment requests so that we can analyze and troubleshoot payments more efficiently and provide better support.

Application information fields

Include these fields in the applicationInfo object:

Field	Description	Required	Example
`externalPlatform.name`	Your company name or the name of your platform.		Best Store Commerce
`externalPlatform.version`	The software version of the platform.	If your platform has versions.	1.3
`externalPlatform.integrator`	Your company name if you built the POS application, or the name of the service partner that built your integration.		AAA Systems
`merchantApplication.name`	The name of the POS application or product being used.		Best Instore
`merchantApplication.version`	The software version of the application.	If your application has versions.	2.13.05
`merchantDevice.os`	The operating system of the device that runs the POS application.		iOS
`merchantDevice.osVersion`	The software version of the operating system.		16.3

Field value requirements

The values you send in the application info fields can:

be between up to 40 characters in length.
start with a number or letter.
contain letters, digits, dashes, underscores, and spaces.

The formatting of the values must be the same in every request.
For example, if the externalPlatform.name is Best Store Commerce, you can't sometimes specify that value as BestStoreCommerce or BESTSTORECOMMERCE. You must choose one format and stick to it.

Add application info to your request

To add application info to your payment request, you pass data elements in the SaleToAcquirerData field. There are two ways to do that:

Option 1: as a JSON object converted to a Base64-encoded string.
Option 2: as form-encoded key-value pairs (using & as a separator).

This example shows how to add application info to your payment request as a JSON object converted to a Base64-encoded string:

Create a JSON object with the data elements you want to pass. For example:

{
    "applicationInfo": {
        "externalPlatform": {
            "name": "Best Store Commerce",
            "version": "1.3",
            "integrator": "AAA Systems"
        },
        "merchantApplication": {
            "name": "Best Instore",
            "version": "2.13.05"
        },
        "merchantDevice": {
            "os": "iOS",
            "osVersion": "16.3"
        }
    }
}

Encode the JSON object to Base64.

ewogICAgImFwcGxpY2F0aW9uSW5mbyI6ewogICAgICAgICJleHRlcm5hbFBsYXRmb3JtIjp7CiAgICAgICAgICAgICJuYW1lIjoiQmVzdCBTdG9yZSBDb21tZXJjZSIsCiAgICAgICAgICAgICJ2ZXJzaW9uIjoiMS4zIiwKICAgICAgICAgICAgImludGVncmF0b3IiOiJBQUEgU3lzdGVtcyIKICAgICAgICB9LAogICAgICAgICJtZXJjaGFudEFwcGxpY2F0aW9uIjp7CiAgICAgICAgICAgICJuYW1lIjoiQmVzdCBJbnN0b3JlIiwKICAgICAgICAgICAgInZlcnNpb24iOiIyLjEzLjA1IgogICAgICAgIH0sCiAgICAgICAgIm1lcmNoYW50RGV2aWNlIjp7CiAgICAgICAgICAgICJvcyI6ImlPUyIsCiAgICAgICAgICAgICJvc1ZlcnNpb24iOiIxNi4zIgogICAgICAgIH0KICAgIH0KfQ==

Make a payment request with:
- SaleData.SaletoAcquirerData: The Base64-encoded JSON object.
Note that the payment response has the AdditionalResponse in the same format as the SaleToAcquirerData, a Base64-encoded JSON object.
Decode the Base64 string in the AdditionalResponse field of the payment response.
This contains data resulting from the processing of the payment.

The format of the SaleToAcquirerData, Base64-encoded or key-value pairs, determines the format of the AdditionalResponse that you receive. To always receive the AdditionalResponse in one of those formats, contact our Support Team.

Combining application info and other data elements

Apart from application info, you can also add other information in the SaleToAcquirerData field. For example, you can add tender options or metadata.

To combine application info and other data elements, see Add information to a payment.