Application information identifies how technology partners connect to Adyen for payment processing. Adyen can use application info to analyze and troubleshoot payments more efficiently, and to provide better support.
Who builds the integration
The fields you are required to include depend on who builds the integration between you and Adyen:
- Partner-built: you build your own integration.
- Integrator-built: you outsource building your integration.
- Pre-built: you are the integrator who customizes a pre-built integration.
Application information fields
The field values you must include depend on who builds the integration:
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 cannot sometimes specify that value as BestStoreCommerce or BESTSTORECOMMERCE. You must choose one format and stick to it.
Example API requests
See examples for the following types of applications:
Ecommerce application
The following examples shows how to provide application info in the /payments request.
POS application
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).
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.