Session authentication API
The Session authentication API enables you to create and manage the JSON Web Tokens (JWT) required for integrating…
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 Session authentication API enables you to create and manage the JSON Web Tokens (JWT) required for integrating components.
Authentication
We recommend that you use an API key to connect to the Session authentication API. Generate an API key in your Customer Area if you have a platform setup or marketplace setup. If you have an Adyen Issuing integration, generate an API key in your Balance Platform Customer Area.
To connect to the Session authentication API, add an X-API-Key header with the API key as the value, for example:
curl
-H 'Content-Type: application/json' \
-H 'X-API-Key: YOUR_API_KEY' \
...Roles and permissions
To create a token, you must meet specific requirements. These requirements vary depending on the type of component. For more information, see the documentation for Onboarding and Platform Experience components.
Going live
To access the live endpoint, generate an API key in your live Customer Area if you have a platform or marketplace setup. If you have an Adyen Issuing integration, generate an API key in your Balance Platform Customer Area. You can then use the API key to send requests to https://authe-live.adyen.com/authe/api/v1.
Endpoints 1
Session authentication
- POSTCreate a session token
/sessionsCreates a session token that is required to integrate components. The response contains encrypted session data. The front end then uses the session data to…
API details
- Base URL
https://test.adyen.com/authe/api/v1https://authe-live.adyen.com/authe/api/v1- 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
1 - Links
- OpenAPI document · Terms of service · Support
- Listed from
- Adyen's published OpenAPI description (Adyen/adyen-openapi) (MIT)
How to test the Session authentication 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 Session authentication 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 session token” (POST /sessions), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Session authentication API?
The Session authentication API enables you to create and manage the JSON Web Tokens (JWT) required for integrating… It is listed under Payments and has 1 endpoint.
Who publishes the Session authentication 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 Session authentication API?
Its description lists 2 base URLs: https://test.adyen.com/authe/api/v1, https://authe-live.adyen.com/authe/api/v1. The first is the usual one; the others are typically sandbox or regional servers.
How do I authenticate with the Session authentication 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 Session authentication API have?
1 operation on 1 path (1 POST). The largest groups are Session authentication.
Is forking the Session authentication API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.