Import payment details for recurring payments

You can import existing payment details into the Adyen payments platform for using in subsequent recurring payments. List these details in a CSV file, with each line referring to a different recurring payment contract. 

Encrypt the file with the Adyen public key called the Adyen Product Security Key, available at https://www.adyen.com/pgp.

The columns required per recurring payment are:

Field Required Description
MerchantAccount
(error)

The merchant account you want to process this payment with.

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

ShopperEmail (tick) The email of the shopper.
ShopperReference (tick) An ID that refers uniquely to the shopper (for example, a customer ID in a shopping cart system).
RecurringContract
(error)

This parameter defines what type of recurring contract is used. For the normal recurring initial payments, the RECURRING,ONECLICK value should be used.

For payout, the value should be PAYOUT.

The recurringContract should 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 .
EchoData (error)

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.

Card

The card expiry date (month and year) is required.

You can provide this using the ExpiryMMYY, ExpiryMMYYY, ExpiryYYMM or ExpiryYYYYMM fields. Alternatively, use both the ExpiryMonth and ExpiryYear fields.

ExpiryMMYY
(error) The month and year of expiry, written as a 4-digit string (for example, 0618 for June 2018).

ExpiryMMYYYY

(error) The month and year of expiry, written as a 6-digit string (for example, 062018 for June 2018).

ExpiryMonth

(error)

The month of expiry, written as a 2-digit string (for example, 06 for June).

ExpiryYYMM
(error) The year and month of expiry, written as a 4-digit string (for example, 1806 for June 2018).
ExpiryYYYYMM (error) The year and month of expiry, written as a 6-digit string (for example, 201806 for June 2018).
ExpiryYear (error)

The year of expiry, written as a 4-digit string (for example, 2018).

CardNumber (tick) The card number.
OwnerName (tick) Name of the account holder.

OwnerNamePostfix

(error) The surname of the account holder. Use this if you want to pass the First Name and Surname in two separate fields.
Address (error) This object contains detailed information on a physical address.

BillingCountry

(error) A valid value is an ISO 2-character country code.

BillingHouseNumberOrName

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

BillingCity

(error) The city name.
BillingStreet (error)

The street name.

 

Don't append the house number to this field. Instead, pass the house number separately as houseNumberOrName.

BillingPostalCode

(error) The postal code with a maximum of 5 characters for USA and maximum of 10 characters for any other country.

BillingStateOrProvince

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

SEPA

All of the fields below are mandatory for third-party payouts. For more information, read Payouts to a bank account.

BankLocation (error) Bank location of the shopper.
BankName (error) Bank name of the shopper.
BankLocationId (error) ID of the bank location of the shopper.
BankAccountNumber (error) Account number of the bank.
CountryCode (error) The two letter county code in which the bank (branch) is located.
Iban (tick) IBAN of the bank account.
OwnerName (tick) Name of the account holder.

PayPal

Both of the fields below are mandatory for third-party payouts. For more information, read Payouts to a PayPal account.


BillingAgreementId (tick)

ID of the billing agreement. Required for recurring payments, it must start with 'B-'.

Type of identifier. This is a possible value depending on the type of recurring contract, if not being used should be identified as null.

PayPalBuyerEmailId

(error) The email address of the Paypal account that set up the billing agreement ID with Paypal.

PayerId

(error)

ID of PayPal account.

Type of identifier. This is a possible value depending on the type of recurring contract, if not being used should be identified as null.

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

The following is an example file with two payment details:

MerchantAccount,ShopperEmail,ShopperReference,RecurringContract,EchoData,OwnerName,ExpiryMonth,ExpiryYear,ExpiryYYMM,ExpiryMMYY,ExpiryMMYYYY,ExpiryYYYYMM,CardNumber,Iban,CountryCode,BankLocation,BankName,BankLocationId,BankAccountNumber,BillingAgreementId,PayerId
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,,,,,

Output

You receive an output file from Support after the import. 

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

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

The reason the card could not be imported is returned, in the case of a failure.
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,,