Skip to main content

SoftPOS configuration API

Click to copy

The SoftPOS configuration API is used in the mutual authentication flow between an Adyen Android or iOS Mobile SDK and the Adyen payments platform. The Mobile SDK for Android or iOS devices enables businesses to accept in-person payments using a commercial off-the-shelf (COTS) device like a phone. For example, Tap to Pay transactions, or transactions on a mobile device in combination with a card reader.

Authentication

Each request to the POS Mobile API must be signed with an API key. Generate your API key in the Customer Area and then set this key to the X-API-Key header value. You also need to have a client key. The client key is part of the setup but you will not need to use it in your integration later. Therefore, when you set up the client key, you do not need to specify allowed origins, and you do not need to store the key in your system. To access the live endpoints, you need to generate a new API key and client key in your live Customer Area.

Versioning

The POS Mobile API handles versioning as part of the endpoint URL.

For example:

https://softposconfig-test.adyen.com/softposconfig/v{version}/auth/certificate

Going live

To access the live endpoints, you need an API key and client key from your live Customer Area, and switch to the live endpoint that is geographically closest to your location.

Australia:

https://softposconfig-live-au.adyen.com/softposconfig/v{version}/auth/certificate

Asia Pacific South East:

https://softposconfig-live-apse.adyen.com/softposconfig/v{version}/auth/certificate

Europe:

https://softposconfig-live.adyen.com/softposconfig/v{version}/auth/certificate

North East Asia:

https://softposconfig-live-nea.adyen.com/softposconfig/v{version}/auth/certificate

United States:

https://softposconfig-live-us.adyen.com/softposconfig/v3/auth/certificate

Methods

Create a communication session