Account Updater 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.

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).

After you are ready to go live, you should switch to either generic or custom live endpoints. For more information, refer to Live endpoints.

ScheduleAccountUpdaterRequest

When making the API call, merchants 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.

The call has the following fields:

Field Type Required Description
additionalData Object (error)

This field contains additional data, which may be required for a particular payment request.

card Card   (error)

A container for credit card data.

Optional if shopperReference and selectedRecurringDetailReference are provided.

merchantAccount String (tick) Account of the merchant.
reference String (tick)

A reference that merchants can apply for the call.

selectedRecurringDetailReference String (error)

The selected detail recurring reference.

Optional if all card information is provided.

shopperReference String (error)

The reference of the shopper that owns the recurring contract.

Optional if all card information is provided.

ScheduleAccountUpdaterResult

Contains data returned in response to the /scheduleAccountUpdater request.

Field Type Required Description
pspReference String (tick)
Adyen's 16-character unique reference associated with the transaction/the request. This value is globally unique; quote it when communicating with us about this request.
result String (tick)

The result of a schedule request.

Examples of some possible values:

  • NoChange
  • CloseAccount
  • PANChanged
  • CardExpiryChanged
  • Error