Adyen Recurring API

The Recurring APIs allow you to manage and remove your tokens or saved payment details. Tokens should be created with validation during a payment request.

For more information, refer to our Tokenization documentation.

Authentication

You need an API credential to authenticate to the API.

If using an API key, 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" \
...

Alternatively, you can use the username and password to connect to the API using basic authentication, for example:

curl
-U "ws@Company.YOUR_COMPANY_ACCOUNT":"YOUR_BASIC_AUTHENTICATION_PASSWORD" \
-H "Content-Type: application/json" \
...

Versioning

Recurring API supports versioning using a version suffix in the endpoint URL. This suffix has the following format: “vXX”, where XX is the version number.

For example:

https://pal-test.adyen.com/pal/servlet/Recurring/v68/disable

Going live

To authenticate to the live endpoints, you need an API credential from your live Customer Area.

The live endpoint URLs contain a prefix which is unique to your company account:

https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Recurring/v68/disable

Get your {PREFIX} from your live Customer Area under Developers > API URLs > Prefix.

Use this page to mock Adyen Recurring API in your testing and development.

Run our mock API sample using the open source WireMock library, or in the free edition of WireMock Cloud. You'll have a working API server simulating the behavior of Adyen Recurring API, which will allow you to keep building and testing even if the actual API you isn't currently available.