Search

Are you looking for test card numbers?

Would you like to contact support?

Feature icon

Import payment details for recurring payments

Learn how to migrate your payment data.

To migrate recurring payment contracts from another payment service provider to the Adyen payments platform, you need to provide us with a CSV file containing the recurring payment details. We will then import this file. After importing, we will send you an output file with the migration results.

Input file format

The files containing the data to be imported should be formatted as follows:

  1. Create a file in CSV (Comma Separated Values) format as per RFC 4180, in accordance with the following requirements:

    • The first line contains the names of the fields. You do not have to use all field names and you do not have to use them in the same order as listed on this page.
    • Each subsequent line contains the fields for a single recurring contract. In other words: Each recurring contract is on a separate line.
    • If a field doesn't apply to the recurring contract that the line describes, specifying a value is skipped.
    • Field names and values are case-sensitive.
    • Multi-line fields are not allowed.
    • The maximum file length is 100000 lines.
  2. Save the file in UTF-8 format (to support non-western characters).
  3. Encrypt the file using the PGP public key provided to you by either our Support Team, or your Adyen contact.
  4. Send the file to Adyen.

The following is an example input file with four recurring contracts:

MerchantAccount,ShopperEmail,ShopperReference,RecurringContract,EchoData,OwnerName,ExpiryMonth,ExpiryYear,ExpiryYYMM,ExpiryMMYY,ExpiryMMYYYY,ExpiryYYYYMM,CardNumber,Iban,CountryCode,BankLocation,BankName,BankLocationId,BankAccountNumber,BillingAgreementId,PayerId,BillingStreet,BillingCity,BillingState,BillingPostalCode,BillingCountry
TestMerchant,mark1test@adyen.com,mark1,RECURRING,MasterCard Bijenkorf NL,D.N. Mater,8,2018,,,,,5100081112223332,,,,,,,,,,,,,,
TestMerchant,mark30test@adyen.com,mark30,"RECURRING,ONECLICK,PAYOUT",,P.Pal,,,,,,,,,,,,,,,B2308952346426,,,,,,
TestMerchant,mark75test@adyen.com,mark78,RECURRING,,B.Dalby,,,,,,,,,NO6012341234561,NO,,,,,,,,,,,,
TestMerchant,mark2test@adyen.com,mark2,RECURRING,,B.Dalby,,,,,,,,,US,121000358,123456789,,,123 Test Street,San Francisco,CA,94000,US

Input file fields

The fields for recurring contracts are :

Field Required Description
MerchantAccount -x- The merchant account you want to process paymentw with. If you are unable to provide this information in the CSV file, contact our Support Team.
ShopperEmail -x- The email address of the shopper.
ShopperReference -white_check_mark- An ID that refers uniquely to the shopper. For example, a customer ID in a shopping cart system.
RecurringContract -x-

The type of recurring contract. Possible values:

Values can also be concatenated with a comma. But when doing so, the combined value needs to be enclosed in double quotes, for example "RECURRING,ONECLICK".

If you are unable to provide this information in the CSV file, contact the Support Team.

OwnerName -x- Name of the account holder.
OwnerNamePostfix -x- The surname of the account holder. Use this if you want to pass the First Name and Surname in two separate fields.
EchoData -x- In this field you can specify other data you want to import, such as previous tokens for credit card data. When this field is populated, its content is imported exactly as is. The Adyen payments platform does not use this data. Maximum character length: 80 characters.

Apart from the above fields, the CSV file can have fields for:

The order of fields is not mandatory and fields can be skipped depending on the payment method. Use the first line of the CSV file to define the field names and their order on other lines.

Card fields

When specifying card data, you need to provide:

  • Card number.
  • Expiry date: month and year of expiry.
    You can use the ExpiryMonth and ExpiryYear fields, or use a single field to specify both month and year: ExpiryMMYY, ExpiryMMYYYY, ExpiryYYMM or ExpiryYYYYMM.
Field Required Description
ExpiryMMYY -x- The month and year of expiry, written as a 4-digit string. For example, 0618 for June 2018.
ExpiryMMYYYY -x- The month and year of expiry, written as a 6-digit string. For example, 062018 for June 2018.
ExpiryMonth -x- The month of expiry, written as a 2-digit string. For example, 06 for June.
ExpiryYYMM -x- The year and month of expiry, written as a 4-digit string. For example, 1806 for June 2018.
ExpiryYYYYMM -x- The year and month of expiry, written as a 6-digit string. For example, 201806 for June 2018.
ExpiryYear -x- The year of expiry, written as a 4-digit string. For example, 2018.
CardNumber -white_check_mark- The card number.

Address fields

Using the following fields, you can specify a physical address.

Field Required Description
BillingHouseNumberOrName -x- The number or name of the house. You can omit this and include the data in BillingStreet.
BillingStreet -x- The street name.
BillingCity -x- The city name.
BillingStateOrProvince -x- For USA or Canada, a valid 2-character abbreviation for the state or province respectively. For other countries any abbreviation with maximum 3 characters for the state or province.
BillingPostalCode -x- The postal code with a maximum of 5 characters for USA and a maximum of 10 characters for any other country.
BillingCountry -x- A valid value is an 2-character ISO country code.

Recurring SEPA payment fields

When specifying SEPA payment details, you always need to provide the IBAN of the bank account and the account holder name.

For third-party payouts, you need to provide all fields listed below. For more information, refer to Payouts to a bank account.

Field Required Description
BankLocation -x- Location of the shopper's bank.
BankName -x- Name of the shopper's bank.
BankLocationId -x- ID of the bank location of the shopper.
BankAccountNumber -x- Account number of the bank.
CountryCode -x- The two-letter county code for the country where the bank (branch) is located.
Iban -white_check_mark- IBAN of the bank account.
OwnerName -white_check_mark- Name of the account holder.

Recurring ACH payment fields

When specifying ACH payment details, you need to provide all of the following fields:

Field Required Description
BankLocationId -white_check_mark- The ABA routing transit number of the account.
BankAccountNumber -white_check_mark- The US bank account number from which the payment will be debited.
OwnerName -white_check_mark- Name on the bank account.
CountryCode -white_check_mark- US
BillingHouseNumberOrName -white_check_mark- The number or name of the house. You can omit this and include the data in BillingStreet.
BillingStreet -white_check_mark- The street name.
BillingCity -white_check_mark- The city name.
BillingStateOrProvince -white_check_mark- A valid 2-character abbreviation for the state.
BillingPostalCode -white_check_mark- The postal code.
BillingCountry -white_check_mark- US

Recurring PayPal payment fields

Tor third-party payouts, you need to provide all of the following fields. For more information, refer to Payouts to a PayPal account.

Field Required Description
BillingAgreementId -white_check_mark- ID of the billing agreement. Required for recurring payments and must start with 'B-'. The value depends on the type of recurring contract. If not used, should be identified as null.
PayPalBuyerEmailId -x- The email address of the Paypal account that set up the billing agreement ID with Paypal.
PayerId -x- ID of PayPal account. The value depends on the type of recurring contract. If not used, should be identified as null.

Output file

When we have imported your CSV file, we'll send you an output file with the migration results.

If you need an encrypted result file, provide your private key to the Support Team.

The output file has the following fields:

Field Description

status

The status of the migration.

paymentMethodVariant

Type of payment method. See more information about this field here.

shopperReference

An ID that refers uniquely to the shopper. For example, a customer ID in a shopping cart system.

recurringDetailReference

The reference that uniquely identifies the recurring detail.

alias

The Adyen alias of the card.

Example: H167852639363479

expiryMonth

The card expiry month.

Format: 2 digits, zero-padded for single digits. For example:

  • 03 = March
  • 11 = November

expiryYear

The card expiry year.

Format: 4 digits. For example: 2018.

bin

The Bank Identification Number (BIN) of a card, which is the first six digits of a card number.

Example: 521234

cardSummary

The last four digits of a card number.

echodata

Data that you specified in the EchoData field of the CSV file, such as previous tokens for credit card data.

statusMessage

If the card could not be imported, the reason why the import failed.

The following is an example output file with four successful migrations:

    status,paymentMethodVariant,shopperReference,recurringDetailReference,alias,expiryMonth,expiryYear,bin,cardSummary,echodata,statusMessage
    Success,amex,HENSHAP,2914485358484074,H116006232956221,2,2017,374291,1002,,
    Success,amex,LOCKL1,2914546007913217,E167970689307238,2,2020,374293,1006,,
    Success,amex,HICKMAGP,2714583830042296,M212359999703856,8,2017,374290,1009,,
    Success,amex,SUTHM1,2714583830042304,A129651585108480,7,2016,374297,1005,,