POS Mobile API
>This API is deprecated. Use the [SoftPOS configuration API](https://docs.adyen.com/api-explorer/softpos-configuration-api/latest/overview) instead. The POS…
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
>This API is deprecated. Use the SoftPOS configuration API instead.
The POS Mobile API is used in the mutual authentication flow between an Adyen Android or iOS POS Mobile SDK and the Adyen payments platform.
The POS 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 won't need to use it in your integration later. Therefore, you don't need to specify allowed origins, and you don't 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://checkout-test.adyen.com/checkout/possdk/v68/sessionsGoing live
To access the live endpoints, you need an API key and client key from your live Customer Area.
The live endpoint URLs contain a prefix which is unique to your company account, for example:
https://{PREFIX}-checkout-live.adyenpayments.com/checkout/possdk/v68/sessionsEndpoints 1
General
- POSTCreate a communication session
/sessionsDeprecated. Establishes a secure communications session between the POS Mobile SDK and the Adyen payments platform, through mutual authentication. The request…
API details
- Base URL
https://checkout-test.adyen.com/checkout/possdk/v68- Authentication
- An API key in the X-API-Key header
HTTP Basic authentication (username and password) - Operations
- 1 operation on 1 pathPOST 1
1 marked deprecated - Main resources
- General 1
- Response formats
application/json- Description format
- OpenAPI 3.1.0, API version
68 - Links
- OpenAPI document · Terms of service · Support
- Listed from
- Adyen's published OpenAPI description (Adyen/adyen-openapi) (MIT)
How to test the POS Mobile API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the POS Mobile API collection, without the publisher's secrets.
- 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.
- Send a requestPick an endpoint, for example “Create a communication session” (POST /sessions), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the POS Mobile API?
>This API is deprecated. Use the [SoftPOS configuration API](https://docs.adyen.com/api-explorer/softpos-configuration-api/latest/overview) instead. The POS… It is listed under Payments and has 1 endpoint.
Who publishes the POS Mobile 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 POS Mobile API?
Requests go to https://checkout-test.adyen.com/checkout/possdk/v68. Endpoint paths are added to this base URL.
How do I authenticate with the POS Mobile 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 POS Mobile API have?
1 operation on 1 path (1 POST). The largest groups are General.
Is forking the POS Mobile API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.