Adyen Recurring API

https://pal-test.adyen.com/pal/servlet/Recurring/v68
Click to copy

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.

post/createPermit
Create new permits linked to a recurring contract.
post/disable
Disable stored payment details
post/disablePermit
Disable an existing permit.
post/listRecurringDetails
Get stored payment details
post/notifyShopper
Ask issuer to notify the shopper
post/scheduleAccountUpdater
Schedule running the Account Updater