Adyen Recurring API
> The Recurring API is a legacy API for managing tokens. We strongly recommend to use [Checkout API recurring…
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 Recurring API is a legacy API for managing tokens. We strongly recommend to use Checkout API recurring endpoints instead when possible.
The Recurring API allows you to manage and remove your tokens or stored 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/disableServer-side API libraries
We provide open-source server-side API libraries in several languages:
- PHP
- Java
- Node.js
- .NET
- Go
- Python
- Ruby
- Apex (beta)
See our integration examples for example uses of the libraries.
Developer resources
Recurring API is available through a Postman collection. Click the button below to create a fork, then set the environment variables at Environments > Adyen APIs.
[](https://god.gw.postman.com/run-collection/25716737-0d1ef0da-f5a1-4004-b24a-c5152c51dc7b?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D25716737-0d1ef0da-f5a1-4004-b24a-c5152c51dc7b%26entityType%3Dcollection%26workspaceId%3Da8d63f9f-cfc7-4810-90c5-9e0c60030d3e#?env%5BAdyen%20APIs%5D=W3sia2V5IjoiWC1BUEktS2V5IiwidmFsdWUiOiIiLCJlbmFibGVkIjp0cnVlLCJ0eXBlIjoic2VjcmV0In0seyJrZXkiOiJZT1VSX01FUkNIQU5UX0FDQ09VTlQiLCJ2YWx1ZSI6IiIsImVuYWJsZWQiOnRydWUsInR5cGUiOiJkZWZhdWx0In0seyJrZXkiOiJZT1VSX0NPTVBBTllfQUNDT1VOVCIsInZhbHVlIjoiIiwiZW5hYmxlZCI6dHJ1ZSwidHlwZSI6ImRlZmF1bHQifSx7ImtleSI6IllPVVJfQkFMQU5DRV9QTEFURk9STSIsInZhbHVlIjoiIiwiZW5hYmxlZCI6dHJ1ZSwidHlwZSI6ImRlZmF1bHQifV0=)
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/disableGet your {PREFIX} from your live Customer Area under Developers > API URLs > Prefix.
Endpoints 6
General
- POSTCreate new permits linked to a recurring contract.
/createPermitDeprecated. Create permits for a recurring contract, including support for defining restrictions. - POSTDisable stored payment details
/disableDisables stored payment details to stop charging a shopper with this particular recurring detail ID. For more information, refer to Disable stored details. - POSTDisable an existing permit.
/disablePermitDeprecated. Disable a permit that was previously linked to a recurringDetailReference. - POSTGet stored payment details
/listRecurringDetailsLists the stored payment details for a shopper, if there are any available. The recurring detail ID can be used with a regular authorisation request to charge… - POSTAsk issuer to notify the shopper
/notifyShopperSends a request to the issuer so they can inform the shopper about the upcoming recurring payment. This endpoint is used only for local acquiring in India.… - POSTSchedule running the Account Updater
/scheduleAccountUpdaterWhen making the API call, you can submit either the credit card information, or the recurring detail reference and the shopper reference: * If the card…
API details
- Base URL
https://pal-test.adyen.com/pal/servlet/Recurring/v68- Authentication
- An API key in the X-API-Key header
HTTP Basic authentication (username and password) - Operations
- 6 operations on 6 pathsPOST 6
2 marked deprecated - Main resources
- General 6
- 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 Adyen Recurring 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 Adyen Recurring 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 new permits linked to a recurring contract.” (POST /createPermit), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Adyen Recurring API?
> The Recurring API is a legacy API for managing tokens. We strongly recommend to use [Checkout API recurring… It is listed under Payments and has 6 endpoints.
Who publishes the Adyen Recurring 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 Adyen Recurring API?
Requests go to https://pal-test.adyen.com/pal/servlet/Recurring/v68. Endpoint paths are added to this base URL.
How do I authenticate with the Adyen Recurring 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 Adyen Recurring API have?
6 operations on 6 paths (6 POST). The largest groups are General.
Is forking the Adyen Recurring API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.