integrations.sh
← all integrations

adyen.com – RecurringService

OpenAPI apis-guru payment

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 .

Authentication

You need an 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 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/v25/disable

Going live

To authenticate to the live endpoints, you need an 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/v25/disable

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

Homepage
https://api.apis.guru/v2/specs/adyen.com:RecurringService/25.json
Provider
adyen.com:RecurringService / RecurringService
OpenAPI version
3.1.0
Spec (JSON)
https://api.apis.guru/v2/specs/adyen.com/RecurringService/25/openapi.json
Spec (YAML)
https://api.apis.guru/v2/specs/adyen.com/RecurringService/25/openapi.yaml

Tools (6)

Extracted live via the executor SDK.

  • general.postDisable

    Disables stored payment details to stop charging a shopper with this particular recurring detail ID.

    For more information, refer to .

  • general.postListRecurringDetails

    Lists 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 the shopper. A summary of the payment detail is returned for presentation to the shopper.

    For more information, refer to .

  • general.postNotifyShopper

    Sends 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. For more information, refer to .

  • general.postScheduleAccountUpdater

    When making the API call, you can submit either the credit card information, or the recurring detail reference and the shopper reference:

    • If the card information is provided, all the sub-fields for card are mandatory.
    • If the recurring detail reference is provided, the fields for shopperReference and selectedRecurringDetailReference are mandatory.
  • openapi.previewSpec

    Preview an OpenAPI document before adding it as a source

  • openapi.addSource

    Add an OpenAPI source and register its operations as tools