Search docs

Are you looking for test card numbers?

Would you like to contact support?

Start searching Adyen's documentation...

  Documentation

Recurring API

To communicate with the Adyen API you should submit HTTP POST requests to corresponding endpoints. These endpoints differ for test and live accounts, and also depend on the data format (SOAP, JSON, or FORM) you use to submit data to the Adyen payments platform.

This document lists all endpoints available for you to integrate with the test platform and run QA checks.

Indicators used in this section:

-white_check_mark- This field is mandatory and must be always present.
-x- This field is optional and may be required in specific scenarios.

Endpoints

SOAP

For the SOAP messaging protocol, all test payment requests must be posted to the following endpoint:

The data schema for corresponding SOAP objects is available at:

JSON and FORM

This is an overview of the test URL endpoints to communicate with our API using JSON or FORM (key-value parameters passed in an Http POST URL).

POST https://pal-test.adyen.com/pal/servlet/Recurring/v25/listRecurringDetails
POST https://pal-test.adyen.com/pal/servlet/Recurring/v25/disable
After you are ready to go live, you should switch to either generic or custom live endpoints. For more information, refer to Live endpoints.

DisableRequest

This class contains data that should be passed in a /disable request.

Field Type Required Description
contract String -x-

Specify the contract if you only want to disable a specific use.

This field can be set to one of the following values, or to their combination (comma-separated):

  • ONECLICK
  • RECURRING
  • PAYOUT
merchantAccount String -white_check_mark-

Your merchant account.

recurringDetailReference String -x-

The ID that uniquely identifies the recurring detail reference.

If it is not provided, the whole recurring contract of the shopperReference will be disabled, which includes all recurring details.

shopperReference String -white_check_mark-

The ID that uniquely identifies the shopper.

This shopperReference must be the same as the shopperReference used in the initial payment.

DisableResult

This class contains data that is returned as a response to a /disable request.

Field Type Required Description
response String -white_check_mark- Depending on whether a specific recurring detail was in the request, result is either "[detail-successfully-disabled]" or "[all-details-successfully-disabled]".

RecurringDetail

The RecurringDetailsResult is a result with a list with zero or more details containing:

Field Type Required Description
additionalData Object -x-

This field contains additional data, which may be returned in a particular response.

The additionalData object consists of entries, each of which includes the key and value. For more information on possible key-value pairs, refer to RecurringDetail.additionalData.

alias String -white_check_mark-

The alias of the credit card number.

Applies only to recurring contracts storing credit card details.

aliasType String -white_check_mark-

The alias type of the credit card number.

Applies only to recurring contracts storing credit card details.

bank BankAccount -x- A container for bank account data.
billingAddress Address -x- The billing address.
card Card -x- A container for card data.
contractTypes Array of strings -x- Types of recurring contracts.
creationDate Date/Time -white_check_mark- The date when the recurring details were created.
firstPspReference String -white_check_mark- The pspReference of the first recurring payment that created the recurring detail.
name String -x- An optional descriptive name for this recurring detail.
paymentMethodVariant String -x- The  type or sub-brand of a payment method used, e.g. Visa Debit, Visa Corporate, etc. For more information, refer to PaymentMethodVariant.
recurringDetailReference String -white_check_mark- The reference that uniquely identifies the recurring detail.
shopperName Name -x- The name of the shopper.
socialSecurityNumber String -x- A shopper's social security number (only in countries where it is legal to collect).
variant String -white_check_mark-

The payment method, such as "mc", "visa", "ideal".

RecurringDetailsRequest

This class contains data that should be passed in a /listRecurringDetails request.

Field Type Required Description
merchantAccount String -white_check_mark- The merchant account identifier you want to process the (transaction) request with.
recurring Recurring -x-

A container for the type of a recurring contract to be retrieved.

The contract value needs to match the contract value submitted in the payment transaction used to create a recurring contract.

However, if ONECLICK,RECURRING is the original contract definition in the initial payment, then contract should take either ONECLICK or RECURRING, depending on whether or not you want the shopper to enter their card's security code when they finalize their purchase.

shopperReference String -white_check_mark- The reference you use to uniquely identify the shopper (e.g. user ID or account ID).

RecurringDetailsResult

This class contains data returned as a response to a /listRecurringDetails request.

Field Type Required Description
creationDate DateTime -white_check_mark- The date when the recurring details were created.
details Array of RecurringDetail -white_check_mark- A list of one or more recurring payment details.
lastKnownShopperEmail String -x- The most recent email for this shopper (if available).
shopperReference String -white_check_mark- The reference you use to uniquely identify the shopper (e.g. user ID or account ID).

The response is different in the following scenarios:

  • If the shopperReference does not exist, the endpoint returns an empty object.
  • If the shopperReference exists but the request contains a specific contract type and a recurring detail for that contract does not exist, the details array is not included in the response.