Adyen

Payments App API

Board and manage the Adyen Payments App on your mobile devices. Authentication Each request to the Payments App API must be signed with an API key. [Generate…

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

Board and manage the Adyen Payments App on your mobile devices.

Authentication

Each request to the Payments App 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.

Versioning

Payments App API handles versioning as part of the endpoint URL. For example, to send a request to this version of the /merchants/{merchantId}/generatePaymentsAppBoardingToken endpoint, use:

https://management-test.adyen.com/v1/merchants/{merchantId}/generatePaymentsAppBoardingToken

Going live

To access the live endpoints, you need an API key from your live Customer Area. Use this API key to make requests to:

https://management-live.adyen.com/v{version}

Endpoints 5

Payments App

  • POSTCreate a boarding token - merchant level/merchants/:merchantId/generatePaymentsAppBoardingTokenCreates a boarding token used to authenticate the installation of a Payments App instance on a device. The boarding token is created for the…
  • GETGet a list of Payments Apps - merchant level/merchants/:merchantId/paymentsApps?statuses=string&limit=10&offset=0Returns the list of Payments App instances for the merchant account identified in the path. To make this request, your API credential must have the following…
  • POSTRevoke Payments App instance authentication/merchants/:merchantId/paymentsApps/:installationId/revokeRevokes the authentication of the Payments App instance for the installationId and merchant account identified in the path. This call revokes the…
  • POSTCreate a boarding token - store level/merchants/:merchantId/stores/:storeId/generatePaymentsAppBoardingTokenCreates a boarding token used to authenticate the installation of a Payments App instance on a device. The boarding token is created for the…
  • GETGet a list of Payments Apps - store level/merchants/:merchantId/stores/:storeId/paymentsApps?statuses=string&limit=10&offset=0Returns the list of Payments App instances for the store identified in the path. To make this request, your API credential must have the following role: *…

API details

Base URL
https://management-live.adyen.com/v1
https://management-test.adyen.com/v1
Authentication
An API key in the X-API-Key header
HTTP Basic authentication (username and password)
Operations
5 operations on 5 pathsPOST 3GET 2
Main resources
Payments App 5
Response formats
application/json
Description format
OpenAPI 3.1.0, API version 1

How to test the Payments App 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 Payments App 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 boarding token - merchant level” (POST /merchants/:merchantId/generatePaymentsAppBoardingToken), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Payments App API?

Board and manage the Adyen Payments App on your mobile devices. Authentication Each request to the Payments App API must be signed with an API key. [Generate… It is listed under Payments and has 5 endpoints.

Who publishes the Payments App 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 Payments App API?

Its description lists 2 base URLs: https://management-live.adyen.com/v1, https://management-test.adyen.com/v1. The first is the usual one; the others are typically sandbox or regional servers.

How do I authenticate with the Payments App 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 Payments App API have?

5 operations on 5 paths (3 POST, 2 GET). The largest groups are Payments App.

Is forking the Payments App 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.