Adyen

SoftPOS configuration API

The SoftPOS configuration API is used in the mutual authentication flow between an Adyen Android or iOS [Mobile…

Payments#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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

Endpoints 1

Session authentication

  • POSTCreate a communication session/auth/certificateEstablishes a secure communication session between the Mobile SDK and the Adyen payments platform, through mutual authentication. The request sends a setup…

API details

Base URL
https://softposconfig-test.adyen.com/softposconfig/v3
https://softposconfig-live-au.adyen.com/softposconfig/v3
https://softposconfig-live-apse.adyen.com/softposconfig/v3
https://softposconfig-live.adyen.com/softposconfig/v3
https://softposconfig-live-nea.adyen.com/softposconfig/v3
Authentication
An API key in the X-API-Key header
HTTP Basic authentication (username and password)
Operations
1 operation on 1 pathPOST 1
Main resources
Session authentication 1
Response formats
application/json
Description format
OpenAPI 3.1.0, API version 3

How to test the SoftPOS configuration API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the SoftPOS configuration API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the X-API-Key header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Create a communication session” (POST /auth/certificate), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the SoftPOS configuration API?

The SoftPOS configuration API is used in the mutual authentication flow between an Adyen Android or iOS [Mobile… It is listed under Payments and has 1 endpoint.

Who publishes the SoftPOS configuration API?

It is listed from Adyen's public API description (an OpenAPI document), not published by Adyen on Swastik Codes. Anyone who controls adyen.com can claim the profile by adding a DNS TXT record.

What is the base URL of the SoftPOS configuration API?

Its description lists 5 base URLs: https://softposconfig-test.adyen.com/softposconfig/v3, https://softposconfig-live-au.adyen.com/softposconfig/v3, https://softposconfig-live-apse.adyen.com/softposconfig/v3, https://softposconfig-live.adyen.com/softposconfig/v3, https://softposconfig-live-nea.adyen.com/softposconfig/v3. The first is the usual one; the others are typically sandbox or regional servers.

How do I authenticate with the SoftPOS configuration API?

It accepts 2 methods: an API key in the X-API-Key header; HTTP Basic authentication (username and password).

How many endpoints does the SoftPOS configuration API have?

1 operation on 1 path (1 POST). The largest groups are Session authentication.

Is forking the SoftPOS configuration API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.