{"title":"Import payment details for recurring payments","category":"default","creationDate":1681818300,"content":"<p>To migrate recurring payment contracts from another payment service provider to the\u00a0Adyen 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.<\/p>\n<h2 id=\"format\">Input file format<\/h2>\n<p>The files containing the data to be imported should be formatted as follows:<\/p>\n<ol>\n<li>\n<p>Create a file in CSV (Comma Separated Values) format as per RFC 4180, in accordance with the following requirements:<\/p>\n<ul>\n<li>The first line contains the <a href=\"#input-file-reference\">names of the fields<\/a>. 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.<\/li>\n<li>Each subsequent line contains the fields for a single recurring contract. In other words: Each recurring contract is on a separate line.<\/li>\n<li>If a field doesn't apply to the recurring contract that the line describes, specifying a value is skipped.<\/li>\n<li>Field names and values are case-sensitive.<\/li>\n<li>Multi-line fields are not allowed.<\/li>\n<li>The maximum file length is 1,000,000 lines.<\/li>\n<li>The maximum file size is 1 GB.<\/li>\n<\/ul>\n<\/li>\n<li>\n<p>Save the file in <a href=\"https:\/\/en.wikipedia.org\/wiki\/UTF-8\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">UTF-8<\/a>\u00a0format (to support non-western characters).<\/p>\n<\/li>\n<li>\n<p>Encrypt the file using the PGP public key provided to you by either our <a href=\"https:\/\/ca-test.adyen.com\/ca\/ca\/contactUs\/support.shtml?form=other\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Support Team<\/a>, or your Adyen contact.<\/p>\n<div class=\"notices blue\">\n<p>For more information, see our <a href=\"\/development-resources\/migrating-payment-data\/pgp\">PGP encryption documentation<\/a>.<\/p>\n<\/div>\n<\/li>\n<li>\n<p>Send the file to Adyen.<\/p>\n<\/li>\n<\/ol>\n<p>The following is an example input file with four recurring contracts:<\/p>\n<pre><code class=\"language-csv\">MerchantAccount,ShopperEmail,ShopperReference,RecurringContract,EchoData,OwnerName,ExpiryMonth,ExpiryYear,ExpiryYYMM,ExpiryMMYY,ExpiryMMYYYY,ExpiryYYYYMM,CardNumber,Iban,CountryCode,BankLocation,BankName,BankLocationId,BankAccountNumber,BillingAgreementId,PayerId,BillingStreet,BillingCity,BillingStateOrProvince,BillingPostalCode,BillingCountry\nTestMerchant,mark1test@adyen.com,mark1,RECURRING,MasterCard Bijenkorf NL,D.N. Mater,8,2018,,,,,5100081112223332,,,,,,,,,,,,,\nTestMerchant,mark30test@adyen.com,mark30,\"RECURRING,ONECLICK,PAYOUT\",,P.Pal,,,,,,,,,,,,,,B-2308952346426,AK5HCWWRUV2KL,,,,,\nTestMerchant,mark75test@adyen.com,mark78,RECURRING,,B.Dalby,,,,,,,,NO6012341234561,NO,,,,,,,,,,,\nTestMerchant,mark2test@adyen.com,mark2,RECURRING,,B.Dalby,,,,,,,,,US,,,121000358,123456789,,,123 Test Street,San Francisco,CA,94000,US<\/code><\/pre>\n<h2 id=\"input-file-reference\">Input file fields<\/h2>\n<p>The fields for recurring contracts are:<\/p>\n<table>\n<thead>\n<tr>\n<th>Field<\/th>\n<th style=\"text-align: center;\">Required<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td><code>MerchantAccount<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-x-\" alt=\"-x-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/x.png\" \/><\/td>\n<td>The merchant account you want to process payments with. If you are unable to provide this information in your CSV file, contact our <a href=\"https:\/\/ca-test.adyen.com\/ca\/ca\/contactUs\/support.shtml?form=other\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Support Team<\/a>.<\/td>\n<\/tr>\n<tr>\n<td><code>ShopperEmail<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-x-\" alt=\"-x-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/x.png\" \/><\/td>\n<td>The email address of the shopper.<\/td>\n<\/tr>\n<tr>\n<td><code>ShopperReference<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td>An ID that refers uniquely to the shopper. For example, a customer ID in a shopping cart system. Minimum length: three characters. Note that the value is case-sensitive. Do not include personally identifiable information (PII), such as name or email address.<\/td>\n<\/tr>\n<tr>\n<td><code>RecurringContract<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-x-\" alt=\"-x-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/x.png\" \/><\/td>\n<td><p>The type of recurring contract. Possible values:<\/p> <ul><li markdown=\"1\"><span translate=\"no\"><strong>ONECLICK<\/strong><\/span> \u2013 Payment details can be used to initiate a one-click payment, where the shopper enters the <a href=\"\/get-started-with-adyen\/adyen-glossary\/#card-security-code-cvc-cvv-cid\">card security code (CVC\/CVV)<\/a>.<\/li><li markdown=\"1\"><span translate=\"no\"><strong>RECURRING<\/strong><\/span> \u2013 Payment details can be used without the card security code to initiate <a href=\"\/get-started-with-adyen\/adyen-glossary\/#card-not-present-cnp\">card-not-present transactions<\/a>.<\/li><li markdown=\"1\"><span translate=\"no\"><strong>PAYOUT<\/strong><\/span> \u2013 Payment details can be used to <a href=\"\/online-payments\/online-payouts\">make a payout<\/a>.<\/li><\/ul><p>Values can also be concatenated with a comma. But when doing so, the combined value needs to be enclosed in double quotes, for example <span translate=\"no\"><strong>\"RECURRING,ONECLICK\"<\/strong><\/span>.<\/p><p>If you are unable to provide this information in your CSV file, contact the <a href=\"https:\/\/ca-test.adyen.com\/ca\/ca\/contactUs\/support.shtml?form=other\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Support Team<\/a>.<\/p><\/td>\n<\/tr>\n<tr>\n<td><code>OwnerName<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-x-\" alt=\"-x-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/x.png\" \/><\/td>\n<td>Name of the account holder.<\/td>\n<\/tr>\n<tr>\n<td><code>OwnerNamePostfix<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-x-\" alt=\"-x-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/x.png\" \/><\/td>\n<td>The surname of the account holder. Use this if you want to pass the First Name and Surname in two separate fields.<\/td>\n<\/tr>\n<tr>\n<td><code>IsPreferredPaymentMethod<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-x-\" alt=\"-x-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/x.png\" \/><\/td>\n<td>In this field you can specify if a payment method represents the preferred payment method for a shopper.<\/td>\n<\/tr>\n<tr>\n<td><code>EchoData<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-x-\" alt=\"-x-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/x.png\" \/><\/td>\n<td>In this field you can specify data you want to be echoed back in the output file, such as previous tokens for credit card data. The Adyen payments platform does not use this data.<\/td>\n<\/tr>\n<tr>\n<td><code>AuxEchoData<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-x-\" alt=\"-x-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/x.png\" \/><\/td>\n<td>Same as <code>EchoData<\/code> , for use when you need more than one data field to be echoed back in the output file. You can ask our <a href=\"https:\/\/ca-test.adyen.com\/ca\/ca\/contactUs\/support.shtml?form=other\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Support Team<\/a> to configure and enable this for the import result file.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<p>Apart from the above fields, the CSV file can have fields for:<\/p>\n<ul>\n<li><a href=\"#cards\">Card data<\/a><\/li>\n<li><a href=\"#address\">Address data<\/a><\/li>\n<li><a href=\"#sepa\">SEPA recurring payments<\/a><\/li>\n<li><a href=\"#ach\">ACH recurring payments<\/a><\/li>\n<li><a href=\"#paypal\">PayPal recurring payments<\/a><\/li>\n<li><a href=\"#klarna\">Klarna recurring payments<\/a><\/li>\n<li><a href=\"#shopper-alterations\">Shopper reference re-mapping (optional auxiliary file)<\/a><\/li>\n<\/ul>\n<div class=\"sc-notice note\"><div>\n<p>The order of fields is not mandatory and fields can be skipped depending on the payment method. Use the first line of your CSV file to define the field names and their order on other lines.<\/p>\n<\/div><\/div>\n<h3 id=\"cards\">Card fields<\/h3>\n<p>When specifying card data, you need to provide:<\/p>\n<ul>\n<li>Card number.<\/li>\n<li>Expiry date: month and year of expiry.<br \/>\nYou can use either a combination of fields (<code>ExpiryMonth<\/code> and <code>ExpiryYear<\/code>), or a single field to specify both month and year: <code>ExpiryMMYY<\/code>, <code>ExpiryMMYYYY<\/code>, <code>ExpiryYYMM<\/code> or <code>ExpiryYYYYMM<\/code>.<\/li>\n<\/ul>\n<table>\n<thead>\n<tr>\n<th style=\"text-align: left;\">Data<\/th>\n<th style=\"text-align: center;\">Required<\/th>\n<th style=\"text-align: left;\">Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td style=\"text-align: left;\"><code>CardNumber<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: left;\">The card number.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\">Expiry date<\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: left;\">Either a single field or a combination of fields is required. Choose from the following fields. <ul><li markdown=\"1\"><code>ExpiryMMYY<\/code>: The month and year of expiry, written as a 4-digit string. For example, <strong>0618<\/strong> for June 2018.<\/li><code>ExpiryMMYYYY<\/code>:The month and year of expiry, written as a 6-digit string. For example, <strong>062018<\/strong> for June 2018.<\/li><li markdown=\"1\"><code>ExpiryYYMM<\/code>: The year and month of expiry, written as a 4-digit string. For example, <strong>1806<\/strong> for June 2018.<\/li><li markdown=\"1\"><code>ExpiryYYYYMM<\/code>The year and month of expiry, written as a 6-digit string. For example, <strong>201806<\/strong> for June 2018.<\/li><li markdown=\"1\"><code>ExpiryMonth<\/code>The month of expiry, written as a 1 or 2-digit string. For example, <strong>6<\/strong> or <strong>06<\/strong> for June. Use in combination with <code>ExpiryYear<\/code>.<\/li><li markdown=\"1\"><code>ExpiryYear<\/code>The year of expiry, written as a 4-digit string. For example, <strong>2018<\/strong>. Use this in combination with <code>ExpiryMonth<\/code>.<\/li><\/ul><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>networkTxReference<\/code> <br> (for Visa)<\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: left;\">The Visa Transaction ID from the initial transaction where the shopper signed up for a series of <span translate=\"no\"><strong>Subscription<\/strong><\/span> or <span translate=\"no\"><strong>UnscheduledCardOnFile<\/strong><\/span> payments. Visa won't support the static value (Interim Transaction ID) after 31 October 2022. Not providing the Visa Transaction ID might result in soft declines and non-compliance assessment fees.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>networkTxReference<\/code> <br> (for Mastercard)<\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: left;\">The Mastercard Trace ID from the initial transaction where the shopper signed up for a series of  <span translate=\"no\"><strong>Subscription<\/strong><\/span> or <span translate=\"no\"><strong>UnscheduledCardOnFile<\/strong><\/span> payments. Mastercard won't support the static value (dummy Trace ID) after 19 October 2024. Not providing the Mastercard Trace ID might result in soft declines and non-compliance assessment fees.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>transactionLinkId<\/code> <br> (for Mastercard)<\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: left;\">The <a href=\"https:\/\/help.adyen.com\/updates\/mastercard-transaction-link-identifier-tlid\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Mastercard Transaction Link ID<\/a>. Mastercard is migrating from Trace ID to Transaction Link ID. We are required to store the Mastercard Transaction Link ID together with the TRACE ID. This means that <code>transactionLinkId<\/code> will only be imported if <code>networkTxReference<\/code> is also provided.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>networkTxReference<\/code> <br> (for other card schemes)<\/td>\n<td style=\"text-align: center;\"><img title=\"-x-\" alt=\"-x-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/x.png\" \/><\/td>\n<td style=\"text-align: left;\">For other card schemes besides Visa and Mastercard, we <em>recommend<\/em> that you send the <code>networkTxReference<\/code> from the initial transaction where the shopper signed up for a series of <span translate=\"no\"><strong>Subscription<\/strong><\/span> or <span translate=\"no\"><strong>UnscheduledCardOnFile<\/strong><\/span> payments. However, if you do not have the <code>networkTxReference<\/code>, we will insert a card scheme-compliant static value on your behalf. We will do that until the schemes no longer allow static values.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h3 id=\"address\">Address fields<\/h3>\n<p>Using the following fields, you can specify a physical address. If one field below is provided, then all other fields from this section are also required.<\/p>\n<table>\n<thead>\n<tr>\n<th style=\"text-align: left;\">Field<\/th>\n<th style=\"text-align: center;\">Required<\/th>\n<th style=\"text-align: left;\">Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td style=\"text-align: left;\"><code>BillingHouseNumberOrName<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-x-\" alt=\"-x-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/x.png\" \/><\/td>\n<td style=\"text-align: left;\">The number or name of the house. You can omit this and include the data in <code>BillingStreet<\/code>.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>BillingStreet<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-x-\" alt=\"-x-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/x.png\" \/><\/td>\n<td style=\"text-align: left;\">The street name.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>BillingCity<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-x-\" alt=\"-x-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/x.png\" \/><\/td>\n<td style=\"text-align: left;\">The city name.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>BillingStateOrProvince<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-x-\" alt=\"-x-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/x.png\" \/><\/td>\n<td style=\"text-align: left;\">For USA or Canada, a valid 2-character abbreviation for the state or province respectively. For other countries\/regions any abbreviation with maximum 3 characters for the state or province.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>BillingPostalCode<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-x-\" alt=\"-x-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/x.png\" \/><\/td>\n<td style=\"text-align: left;\">The postal code with a maximum of 5 characters for USA\u00a0and a maximum of 10 characters for any other country\/region.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>BillingCountry<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-x-\" alt=\"-x-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/x.png\" \/><\/td>\n<td style=\"text-align: left;\">A valid value is an 2-character ISO country\/region code.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h3 id=\"sepa\">Recurring SEPA payment fields<\/h3>\n<p>When specifying SEPA payment details, you always need to provide the IBAN of the bank account and the account holder name.<\/p>\n<p>For third-party payouts, you need to provide all fields listed below, except for the fields <code>SepaMandateId<\/code> and <code>SepaMandateDateOfSignature<\/code>. For more information, refer to <a href=\"\/online-payments\/online-payouts\/payouts-to-a-bank-account\">Payouts to a bank account<\/a>.<\/p>\n<p>To optionally import SEPA Direct Debit mandates, include the mandate identifier, and the date of the mandate signature.<\/p>\n<table>\n<thead>\n<tr>\n<th style=\"text-align: left;\">Field<\/th>\n<th style=\"text-align: center;\">Required<\/th>\n<th style=\"text-align: left;\">Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td style=\"text-align: left;\"><code>Iban<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: left;\">The IBAN of the bank account.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>OwnerName<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: left;\">The name of the account holder.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>CountryCode<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: left;\">The code for the country\/region where the bank (branch) is located. <br>Format: the two-letter <a href=\"https:\/\/en.wikipedia.org\/wiki\/ISO_3166-1_alpha-2\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">ISO-3166-1 alpha-2<\/a> country code. Exception: <strong>QZ<\/strong> (Kosovo).<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>BankLocation<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-x-\" alt=\"-x-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/x.png\" \/><\/td>\n<td style=\"text-align: left;\">The location of the shopper's bank.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>BankName<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-x-\" alt=\"-x-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/x.png\" \/><\/td>\n<td style=\"text-align: left;\">The name of the shopper's bank.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>BankLocationId<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-x-\" alt=\"-x-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/x.png\" \/><\/td>\n<td style=\"text-align: left;\">The ID of the bank location of the shopper.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>BankAccountNumber<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-x-\" alt=\"-x-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/x.png\" \/><\/td>\n<td style=\"text-align: left;\">The account number of the bank.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>ShopperReference<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-x-\" alt=\"-x-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/x.png\" \/><\/td>\n<td style=\"text-align: left;\">An ID that refers uniquely to the shopper. For example, a customer ID in a shopping cart system.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>SepaMandateId<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-x-\" alt=\"-x-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/x.png\" \/><\/td>\n<td style=\"text-align: left;\">The SEPA Direct Debit mandate identifier.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>SepaMandateDateOfSignature<\/code><\/td>\n<td style=\"text-align: center;\">Required if <code>SepaMandateId<\/code> is included<\/td>\n<td style=\"text-align: left;\">The date of the SEPA Direct Debit mandate signature. Format: YYYY-MM-DD. For example: <strong>2019-02-22<\/strong><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h3 id=\"ach\">Recurring ACH payment fields<\/h3>\n<p>When specifying ACH payment details, you need to provide all of the following fields:<\/p>\n<table>\n<thead>\n<tr>\n<th style=\"text-align: left;\">Field<\/th>\n<th style=\"text-align: center;\">Required<\/th>\n<th style=\"text-align: left;\">Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td style=\"text-align: left;\"><code>BankLocationId<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: left;\">The <a href=\"https:\/\/en.wikipedia.org\/wiki\/ABA_routing_transit_number\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">ABA routing transit number<\/a> of the account.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>BankAccountNumber<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: left;\">The US bank account number from which the payment will be debited.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>OwnerName<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: left;\">Name on the bank account.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>CountryCode<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: left;\"><span translate=\"no\"><strong>US<\/strong><\/span><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>BillingHouseNumberOrName<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: left;\">The number or name of the house. You can omit this and include the data in <code>BillingStreet<\/code>.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>BillingStreet<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: left;\">The street name.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>BillingCity<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: left;\">The city name.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>BillingStateOrProvince<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: left;\">A valid 2-character abbreviation for the state.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>BillingPostalCode<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: left;\">The postal code.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>BillingCountry<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: left;\"><span translate=\"no\"><strong>US<\/strong><\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h3 id=\"paypal\">Recurring PayPal payment fields<\/h3>\n<p>For third-party payouts, you need to provide all of the following fields.<\/p>\n<table>\n<thead>\n<tr>\n<th style=\"text-align: left;\">Field<\/th>\n<th style=\"text-align: center;\">Required<\/th>\n<th style=\"text-align: left;\">Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td style=\"text-align: left;\"><code>BillingAgreementId<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: left;\">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.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>PayPalBuyerEmailId<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-x-\" alt=\"-x-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/x.png\" \/><\/td>\n<td style=\"text-align: left;\">The email address of the Paypal account that set up the billing agreement ID with Paypal.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>PayerId<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-x-\" alt=\"-x-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/x.png\" \/><\/td>\n<td style=\"text-align: left;\">ID of PayPal account. The value depends on the type of recurring contract. If not used, should be identified as null.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h3 id=\"klarna\">Recurring Klarna payment fields<\/h3>\n<div class=\"notices green\">\n<p>Not all Klarna payment methods or countries\/regions support recurring payments.<\/p>\n<\/div>\n<p>When specifying Klarna payment details, provide all the following fields. Make sure that you enter a supported combination in the fields <code>KlarnaVariant<\/code> and <code>KlarnaCountry<\/code>.<\/p>\n<table>\n<thead>\n<tr>\n<th style=\"text-align: left;\">Field<\/th>\n<th style=\"text-align: center;\">Required<\/th>\n<th style=\"text-align: left;\">Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td style=\"text-align: left;\"><code>KlarnaTokenId<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: left;\">ID of the shopper's Klarna customer token. For more information, see <a href=\"https:\/\/docs.klarna.com\/klarna-payments\/in-depth-knowledge\/customer-token\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Klarna's documentation<\/a>.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>KlarnaVariant<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: left;\">The Klarna payment method variant. Possible values: <ul><li markdown=\"1\"><span translate=\"no\"><strong>klarna_paynow<\/strong><\/span> (for Klarna - Pay Now)<\/li><li markdown=\"1\"><span translate=\"no\"><strong>klarna<\/strong><\/span> (for Klarna - Pay later)<\/li><li markdown=\"1\"><span translate=\"no\"><strong>klarna_account<\/strong><\/span> (for Klarna - Pay over time)<\/li><\/ul><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>KlarnaCountry<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: left;\">A valid 2-character ISO country code.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h3 id=\"shopper-alterations\">Shopper reference re-mapping (optional auxiliary file)<\/h3>\n<p>If you want to change the shopper references upon importing, you can send an auxiliary shopper reference re-mapping file, in addition to the payment detail file.<br \/>\nThe format of the re-mapping file should include both of the following columns.<\/p>\n<table>\n<thead>\n<tr>\n<th style=\"text-align: left;\">Field<\/th>\n<th style=\"text-align: center;\">Required<\/th>\n<th style=\"text-align: left;\">Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td style=\"text-align: left;\"><code>oldShopperReference<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: left;\">The old or existing shopper reference which is present in the CSV file, from your other payments vendor.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>newShopperReference<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: left;\">The shopper reference under which the tokens will be stored, after they are imported into the Adyen payments platform.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<p>For example, the file might look like this:<\/p>\n<pre><code class=\"language-csv\">oldShopperReference,newShopperReference\nref_1,new_ref_1\nref_2,new_ref_2\n...<\/code><\/pre>\n<h2 id=\"output-file-reference\">Output file<\/h2>\n<p>When we have imported your CSV file, we'll send you an output file with the migration results. If you need an encrypted output file, provide your public key to our <a href=\"https:\/\/ca-test.adyen.com\/ca\/ca\/contactUs\/support.shtml?form=other\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Support Team<\/a>.<\/p>\n<div class=\"sc-notice warning\"><div>\n<p>To provide more information about the migration, we will start adding new fields to the output file. Make sure that your parsing logic can handle changes such as new headers.<\/p>\n<\/div><\/div>\n<p>The output file has the following fields:<\/p>\n<table>\n   <thead>\n      <tr class=\"header\">\n         <th>Field<\/th>\n         <th>Description<\/th>\n      <\/tr>\n   <\/thead>\n   <tbody>\n      <tr>\n         <td>\n<p><code>status<\/code><\/p>\n<\/td>\n         <td>\n<p>The status of the migration. Possible values: <ul><li markdown=\"1\"><span translate=\"no\"><strong>Success<\/strong><\/span> No issues. Line is imported correctly.<\/li><li markdown=\"1\"><span translate=\"no\"><strong>Skipped<\/strong><\/span> This typically happens if there is essential data missing in the line. For example CardNumber or ExpiryYear is missing.<\/li><\/ul><\/p>\n<\/td>\n      <\/tr>\n      <tr>\n         <td>\n<p><code>paymentMethodVariant<\/code><\/p>\n<\/td>\n         <td>\n<p>Type of payment method. See more information about this field <a href=\"\/development-resources\/paymentmethodvariant\">here<\/a>.<\/p>\n<\/td>\n      <\/tr>\n      <tr>\n         <td>\n<p><code>shopperReference<\/code><\/p>\n<\/td>\n         <td>\n<p>An ID that refers uniquely to the shopper. For example, a customer ID in a shopping cart system.<\/p>\n<\/td>\n      <\/tr>\n      <tr>\n         <td>\n<p><code>recurringDetailReference<\/code><\/p>\n<\/td>\n         <td>\n<p>The reference that uniquely identifies the recurring detail.<\/p>\n<\/td>\n      <\/tr>\n      <tr>\n         <td>\n<p><code>alias<\/code><\/p>\n<\/td>\n         <td>\n<p>The Adyen alias of the card.<br><br>Example: H167852639363479<\/p>\n<\/td>\n      <\/tr>\n      <tr>\n         <td>\n<p><code>expiryMonth<\/code><\/p>\n<\/td>\n         <td>\n<p>The card expiry month.<br>Format: 1 or 2 digits. <br> For example:<br><ul><li markdown=\"1\">3 = March<\/li><li markdown=\"1\">11 = November<\/li><\/ul><\/p>\n<\/td>\n      <\/tr>\n      <tr>\n         <td>\n<p><code>expiryYear<\/code><\/p>\n<\/td>\n         <td>\n<p>The card expiry year.<br>Format: 4 digits. For example: 2018.<\/p>\n<\/td>\n      <\/tr>\n      <tr>\n         <td>\n<p><code>bin<\/code><\/p>\n<\/td>\n         <td>\n<p>The Bank Identification Number (BIN) of a card, which is the first six digits of a card number.<br>Example: 521234<\/p>\n<\/td>\n      <\/tr>\n      <tr>\n         <td>\n<p><code>cardSummary<\/code><\/p>\n<\/td>\n         <td>\n<p>The last four digits of a card number.<\/p>\n<\/td>\n      <\/tr>\n      <tr>\n         <td>\n<p><code>issuerCountryCode<\/code><\/p>\n<\/td>\n         <td>\n<p>The country\/region of the issuer. Format: 2-letter ISO code.<\/p>\n<\/td>\n      <\/tr>\n      <tr>\n         <td>\n<p><code>echodata<\/code><\/p>\n<\/td>\n         <td>\n<p>Data that you specified in the <code>EchoData<\/code> field of your CSV file, such as previous tokens for credit card data.<\/p>\n<\/td>\n      <\/tr>\n      <tr>\n         <td>\n<p><code>statusMessage<\/code><\/p>\n<\/td>\n         <td>\n<p>If the card could not be imported, the reason why the import failed.<\/p>\n<\/td>\n      <\/tr>\n      <tr>\n         <td>\n<p><code>fundingSource<\/code><\/p>\n<\/td>\n         <td>\n<p>The funding source of the card. Example: <span translate=\"no\"><strong>DEBIT<\/strong><\/span>, <span translate=\"no\"><strong>CREDIT<\/strong><\/span>, or <span translate=\"no\"><strong>PREPAID<strong><\/strong><\/strong><\/span>.<\/p>\n<\/td>\n      <\/tr>\n   <\/tbody>\n<\/table>\n<p>You can also include the following fields in the output file. To receive these fields, contact our <a href=\"https:\/\/ca-test.adyen.com\/ca\/ca\/contactUs\/support.shtml?form=other\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Support Team<\/a>.<\/p>\n<table>\n   <thead>\n      <tr class=\"header\">\n         <th>Field<\/th>\n         <th>Description<\/th>\n      <\/tr>\n   <\/thead>\n   <tbody>\n      <tr>\n         <td>\n<p><code>auxEchodata<\/code><\/p>\n<\/td>\n         <td>\n<p>Data that you specified in the <code>AuxEchoData<\/code> field of your CSV file.<\/p>\n<\/td>\n      <\/tr>\n       <tr>\n         <td>\n<p><code>isPreferredPaymentDetail<\/code><\/p>\n<\/td>\n         <td>\n<p>Based on the field <code>IsPreferredPaymentDetail<\/code> of your CSV file.<\/p>\n<\/td>\n      <\/tr>\n       <tr>\n         <td>\n<p><code>networkTxReferenceStatus<\/code><\/p>\n<\/td>\n         <td>\n<p>Import status of the <code>networkTxReference<\/code> specified in your CSV file. Possible values: <span translate=\"no\"><strong>NOT_PROVIDED<\/strong><\/span>, <span translate=\"no\"><strong>IMPORTED<\/strong><\/span>, <span translate=\"no\"><strong>NOT_VALID<\/strong><\/span><\/p>\n<\/td>\n      <\/tr>\n       <tr>\n         <td>\n<p><code>transactionLinkIdStatus<\/code><\/p>\n<\/td>\n         <td>\n<p>Import status of the <code>transactionLinkId<\/code> specified in your CSV file. Possible values: <span translate=\"no\"><strong>NOT_PROVIDED<\/strong><\/span>, <span translate=\"no\"><strong>IMPORTED<\/strong><\/span>, <span translate=\"no\"><strong>NOT_VALID<\/strong><\/span>, <span translate=\"no\"><strong>NOT_APPLICABLE_FOR_VARIANT<\/strong><\/span>, <span translate=\"no\"><strong>NETWORK_TX_REFERENCE_MISSING<\/strong><\/span><\/p>\n<\/td>\n      <\/tr>\n      <tr>\n         <td>\n<p><code>billingAddressStatus<\/code><\/p>\n<\/td>\n         <td>\n<p>Import status of the <code>Address fields<\/code> specified in your CSV file. Possible values: <span translate=\"no\"><strong>NOT_PROVIDED<\/strong><\/span>, <span translate=\"no\"><strong>IMPORTED<\/strong><\/span>, <span translate=\"no\"><strong>NOT_VALID<\/strong><\/span><\/p>\n<\/td>\n      <\/tr>\n      <tr>\n        <td>\n<p><code>paymentDetailDifference<\/code><\/p>\n<\/td>\n        <td>\n<p>The storage status of the payment details. Possible values: <span translate=\"no\"><strong>created<\/strong><\/span>, <span translate=\"no\"><strong>updated<\/strong><\/span>, <span translate=\"no\"><strong>alreadyExisting<\/strong><\/span><\/p>\n<\/td>\n     <\/tr>\n   <\/tbody>\n<\/table>\n<p>The following is an example output file, without additional fields, with four payment details successfully migrated:<\/p>\n<pre><code class=\"language-csv\">   status,paymentMethodVariant,shopperReference,recurringDetailReference,alias,expiryMonth,expiryYear,bin,cardSummary,issuerCountryCode,echodata,statusMessage,fundingSource\n    Success,amex,HENSHAP,2914485358484074,H116006232956221,2,2017,374291,1002,,,,,\n    Success,amex,LOCKL1,2914546007913217,E167970689307238,2,2020,374293,1006,,,,,\n    Success,amex,HICKMAGP,2714583830042296,M212359999703856,8,2017,374290,1009,,,,,\n    Success,amex,SUTHM1,2714583830042304,A129651585108480,7,2016,374297,1005,,,,,<\/code><\/pre>","url":"https:\/\/docs.adyen.com\/development-resources\/migrating-payment-data\/import-payment-details-for-recurring-payments","articleFields":{"description":"Learn how to migrate your payment data.","id":"24217789","type":"page","_expandable":{"operations":""},"status":"current","last_edit_on":"04-02-2026 17:01","feedback_component":true,"filters_component":false,"page_id":"405c80ab-3505-4af1-b29a-70ec01b9f95a","decision_tree":"[]"},"algolia":{"url":"https:\/\/docs.adyen.com\/development-resources\/migrating-payment-data\/import-payment-details-for-recurring-payments","title":"Import payment details for recurring payments","content":"To migrate recurring payment contracts from another payment service provider to the\u00a0Adyen 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.\nInput file format\nThe files containing the data to be imported should be formatted as follows:\n\n\nCreate a file in CSV (Comma Separated Values) format as per RFC 4180, in accordance with the following requirements:\n\nThe 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.\nEach subsequent line contains the fields for a single recurring contract. In other words: Each recurring contract is on a separate line.\nIf a field doesn't apply to the recurring contract that the line describes, specifying a value is skipped.\nField names and values are case-sensitive.\nMulti-line fields are not allowed.\nThe maximum file length is 1,000,000 lines.\nThe maximum file size is 1 GB.\n\n\n\nSave the file in UTF-8\u00a0format (to support non-western characters).\n\n\nEncrypt the file using the PGP public key provided to you by either our Support Team, or your Adyen contact.\n\nFor more information, see our PGP encryption documentation.\n\n\n\nSend the file to Adyen.\n\n\nThe following is an example input file with four recurring contracts:\nMerchantAccount,ShopperEmail,ShopperReference,RecurringContract,EchoData,OwnerName,ExpiryMonth,ExpiryYear,ExpiryYYMM,ExpiryMMYY,ExpiryMMYYYY,ExpiryYYYYMM,CardNumber,Iban,CountryCode,BankLocation,BankName,BankLocationId,BankAccountNumber,BillingAgreementId,PayerId,BillingStreet,BillingCity,BillingStateOrProvince,BillingPostalCode,BillingCountry\nTestMerchant,mark1test@adyen.com,mark1,RECURRING,MasterCard Bijenkorf NL,D.N. Mater,8,2018,,,,,5100081112223332,,,,,,,,,,,,,\nTestMerchant,mark30test@adyen.com,mark30,\"RECURRING,ONECLICK,PAYOUT\",,P.Pal,,,,,,,,,,,,,,B-2308952346426,AK5HCWWRUV2KL,,,,,\nTestMerchant,mark75test@adyen.com,mark78,RECURRING,,B.Dalby,,,,,,,,NO6012341234561,NO,,,,,,,,,,,\nTestMerchant,mark2test@adyen.com,mark2,RECURRING,,B.Dalby,,,,,,,,,US,,,121000358,123456789,,,123 Test Street,San Francisco,CA,94000,US\nInput file fields\nThe fields for recurring contracts are:\n\n\n\nField\nRequired\nDescription\n\n\n\n\nMerchantAccount\n\nThe merchant account you want to process payments with. If you are unable to provide this information in your CSV file, contact our Support Team.\n\n\nShopperEmail\n\nThe email address of the shopper.\n\n\nShopperReference\n\nAn ID that refers uniquely to the shopper. For example, a customer ID in a shopping cart system. Minimum length: three characters. Note that the value is case-sensitive. Do not include personally identifiable information (PII), such as name or email address.\n\n\nRecurringContract\n\nThe type of recurring contract. Possible values: ONECLICK \u2013 Payment details can be used to initiate a one-click payment, where the shopper enters the card security code (CVC\/CVV).RECURRING \u2013 Payment details can be used without the card security code to initiate card-not-present transactions.PAYOUT \u2013 Payment details can be used to make a payout.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 your CSV file, contact the Support Team.\n\n\nOwnerName\n\nName of the account holder.\n\n\nOwnerNamePostfix\n\nThe surname of the account holder. Use this if you want to pass the First Name and Surname in two separate fields.\n\n\nIsPreferredPaymentMethod\n\nIn this field you can specify if a payment method represents the preferred payment method for a shopper.\n\n\nEchoData\n\nIn this field you can specify data you want to be echoed back in the output file, such as previous tokens for credit card data. The Adyen payments platform does not use this data.\n\n\nAuxEchoData\n\nSame as EchoData , for use when you need more than one data field to be echoed back in the output file. You can ask our Support Team to configure and enable this for the import result file.\n\n\n\nApart from the above fields, the CSV file can have fields for:\n\nCard data\nAddress data\nSEPA recurring payments\nACH recurring payments\nPayPal recurring payments\nKlarna recurring payments\nShopper reference re-mapping (optional auxiliary file)\n\n\nThe order of fields is not mandatory and fields can be skipped depending on the payment method. Use the first line of your CSV file to define the field names and their order on other lines.\n\nCard fields\nWhen specifying card data, you need to provide:\n\nCard number.\nExpiry date: month and year of expiry.\nYou can use either a combination of fields (ExpiryMonth and ExpiryYear), or a single field to specify both month and year: ExpiryMMYY, ExpiryMMYYYY, ExpiryYYMM or ExpiryYYYYMM.\n\n\n\n\nData\nRequired\nDescription\n\n\n\n\nCardNumber\n\nThe card number.\n\n\nExpiry date\n\nEither a single field or a combination of fields is required. Choose from the following fields. ExpiryMMYY: The month and year of expiry, written as a 4-digit string. For example, 0618 for June 2018.ExpiryMMYYYY:The month and year of expiry, written as a 6-digit string. For example, 062018 for June 2018.ExpiryYYMM: The year and month of expiry, written as a 4-digit string. For example, 1806 for June 2018.ExpiryYYYYMMThe year and month of expiry, written as a 6-digit string. For example, 201806 for June 2018.ExpiryMonthThe month of expiry, written as a 1 or 2-digit string. For example, 6 or 06 for June. Use in combination with ExpiryYear.ExpiryYearThe year of expiry, written as a 4-digit string. For example, 2018. Use this in combination with ExpiryMonth.\n\n\nnetworkTxReference  (for Visa)\n\nThe Visa Transaction ID from the initial transaction where the shopper signed up for a series of Subscription or UnscheduledCardOnFile payments. Visa won't support the static value (Interim Transaction ID) after 31 October 2022. Not providing the Visa Transaction ID might result in soft declines and non-compliance assessment fees.\n\n\nnetworkTxReference  (for Mastercard)\n\nThe Mastercard Trace ID from the initial transaction where the shopper signed up for a series of  Subscription or UnscheduledCardOnFile payments. Mastercard won't support the static value (dummy Trace ID) after 19 October 2024. Not providing the Mastercard Trace ID might result in soft declines and non-compliance assessment fees.\n\n\ntransactionLinkId  (for Mastercard)\n\nThe Mastercard Transaction Link ID. Mastercard is migrating from Trace ID to Transaction Link ID. We are required to store the Mastercard Transaction Link ID together with the TRACE ID. This means that transactionLinkId will only be imported if networkTxReference is also provided.\n\n\nnetworkTxReference  (for other card schemes)\n\nFor other card schemes besides Visa and Mastercard, we recommend that you send the networkTxReference from the initial transaction where the shopper signed up for a series of Subscription or UnscheduledCardOnFile payments. However, if you do not have the networkTxReference, we will insert a card scheme-compliant static value on your behalf. We will do that until the schemes no longer allow static values.\n\n\n\nAddress fields\nUsing the following fields, you can specify a physical address. If one field below is provided, then all other fields from this section are also required.\n\n\n\nField\nRequired\nDescription\n\n\n\n\nBillingHouseNumberOrName\n\nThe number or name of the house. You can omit this and include the data in BillingStreet.\n\n\nBillingStreet\n\nThe street name.\n\n\nBillingCity\n\nThe city name.\n\n\nBillingStateOrProvince\n\nFor USA or Canada, a valid 2-character abbreviation for the state or province respectively. For other countries\/regions any abbreviation with maximum 3 characters for the state or province.\n\n\nBillingPostalCode\n\nThe postal code with a maximum of 5 characters for USA\u00a0and a maximum of 10 characters for any other country\/region.\n\n\nBillingCountry\n\nA valid value is an 2-character ISO country\/region code.\n\n\n\nRecurring SEPA payment fields\nWhen specifying SEPA payment details, you always need to provide the IBAN of the bank account and the account holder name.\nFor third-party payouts, you need to provide all fields listed below, except for the fields SepaMandateId and SepaMandateDateOfSignature. For more information, refer to Payouts to a bank account.\nTo optionally import SEPA Direct Debit mandates, include the mandate identifier, and the date of the mandate signature.\n\n\n\nField\nRequired\nDescription\n\n\n\n\nIban\n\nThe IBAN of the bank account.\n\n\nOwnerName\n\nThe name of the account holder.\n\n\nCountryCode\n\nThe code for the country\/region where the bank (branch) is located. Format: the two-letter ISO-3166-1 alpha-2 country code. Exception: QZ (Kosovo).\n\n\nBankLocation\n\nThe location of the shopper's bank.\n\n\nBankName\n\nThe name of the shopper's bank.\n\n\nBankLocationId\n\nThe ID of the bank location of the shopper.\n\n\nBankAccountNumber\n\nThe account number of the bank.\n\n\nShopperReference\n\nAn ID that refers uniquely to the shopper. For example, a customer ID in a shopping cart system.\n\n\nSepaMandateId\n\nThe SEPA Direct Debit mandate identifier.\n\n\nSepaMandateDateOfSignature\nRequired if SepaMandateId is included\nThe date of the SEPA Direct Debit mandate signature. Format: YYYY-MM-DD. For example: 2019-02-22\n\n\n\nRecurring ACH payment fields\nWhen specifying ACH payment details, you need to provide all of the following fields:\n\n\n\nField\nRequired\nDescription\n\n\n\n\nBankLocationId\n\nThe ABA routing transit number of the account.\n\n\nBankAccountNumber\n\nThe US bank account number from which the payment will be debited.\n\n\nOwnerName\n\nName on the bank account.\n\n\nCountryCode\n\nUS\n\n\nBillingHouseNumberOrName\n\nThe number or name of the house. You can omit this and include the data in BillingStreet.\n\n\nBillingStreet\n\nThe street name.\n\n\nBillingCity\n\nThe city name.\n\n\nBillingStateOrProvince\n\nA valid 2-character abbreviation for the state.\n\n\nBillingPostalCode\n\nThe postal code.\n\n\nBillingCountry\n\nUS\n\n\n\nRecurring PayPal payment fields\nFor third-party payouts, you need to provide all of the following fields.\n\n\n\nField\nRequired\nDescription\n\n\n\n\nBillingAgreementId\n\nID 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.\n\n\nPayPalBuyerEmailId\n\nThe email address of the Paypal account that set up the billing agreement ID with Paypal.\n\n\nPayerId\n\nID of PayPal account. The value depends on the type of recurring contract. If not used, should be identified as null.\n\n\n\nRecurring Klarna payment fields\n\nNot all Klarna payment methods or countries\/regions support recurring payments.\n\nWhen specifying Klarna payment details, provide all the following fields. Make sure that you enter a supported combination in the fields KlarnaVariant and KlarnaCountry.\n\n\n\nField\nRequired\nDescription\n\n\n\n\nKlarnaTokenId\n\nID of the shopper's Klarna customer token. For more information, see Klarna's documentation.\n\n\nKlarnaVariant\n\nThe Klarna payment method variant. Possible values: klarna_paynow (for Klarna - Pay Now)klarna (for Klarna - Pay later)klarna_account (for Klarna - Pay over time)\n\n\nKlarnaCountry\n\nA valid 2-character ISO country code.\n\n\n\nShopper reference re-mapping (optional auxiliary file)\nIf you want to change the shopper references upon importing, you can send an auxiliary shopper reference re-mapping file, in addition to the payment detail file.\nThe format of the re-mapping file should include both of the following columns.\n\n\n\nField\nRequired\nDescription\n\n\n\n\noldShopperReference\n\nThe old or existing shopper reference which is present in the CSV file, from your other payments vendor.\n\n\nnewShopperReference\n\nThe shopper reference under which the tokens will be stored, after they are imported into the Adyen payments platform.\n\n\n\nFor example, the file might look like this:\noldShopperReference,newShopperReference\nref_1,new_ref_1\nref_2,new_ref_2\n...\nOutput file\nWhen we have imported your CSV file, we'll send you an output file with the migration results. If you need an encrypted output file, provide your public key to our Support Team.\n\nTo provide more information about the migration, we will start adding new fields to the output file. Make sure that your parsing logic can handle changes such as new headers.\n\nThe output file has the following fields:\n\n   \n      \n         Field\n         Description\n      \n   \n   \n      \n         \nstatus\n\n         \nThe status of the migration. Possible values: Success No issues. Line is imported correctly.Skipped This typically happens if there is essential data missing in the line. For example CardNumber or ExpiryYear is missing.\n\n      \n      \n         \npaymentMethodVariant\n\n         \nType of payment method. See more information about this field here.\n\n      \n      \n         \nshopperReference\n\n         \nAn ID that refers uniquely to the shopper. For example, a customer ID in a shopping cart system.\n\n      \n      \n         \nrecurringDetailReference\n\n         \nThe reference that uniquely identifies the recurring detail.\n\n      \n      \n         \nalias\n\n         \nThe Adyen alias of the card.Example: H167852639363479\n\n      \n      \n         \nexpiryMonth\n\n         \nThe card expiry month.Format: 1 or 2 digits.  For example:3 = March11 = November\n\n      \n      \n         \nexpiryYear\n\n         \nThe card expiry year.Format: 4 digits. For example: 2018.\n\n      \n      \n         \nbin\n\n         \nThe Bank Identification Number (BIN) of a card, which is the first six digits of a card number.Example: 521234\n\n      \n      \n         \ncardSummary\n\n         \nThe last four digits of a card number.\n\n      \n      \n         \nissuerCountryCode\n\n         \nThe country\/region of the issuer. Format: 2-letter ISO code.\n\n      \n      \n         \nechodata\n\n         \nData that you specified in the EchoData field of your CSV file, such as previous tokens for credit card data.\n\n      \n      \n         \nstatusMessage\n\n         \nIf the card could not be imported, the reason why the import failed.\n\n      \n      \n         \nfundingSource\n\n         \nThe funding source of the card. Example: DEBIT, CREDIT, or PREPAID.\n\n      \n   \n\nYou can also include the following fields in the output file. To receive these fields, contact our Support Team.\n\n   \n      \n         Field\n         Description\n      \n   \n   \n      \n         \nauxEchodata\n\n         \nData that you specified in the AuxEchoData field of your CSV file.\n\n      \n       \n         \nisPreferredPaymentDetail\n\n         \nBased on the field IsPreferredPaymentDetail of your CSV file.\n\n      \n       \n         \nnetworkTxReferenceStatus\n\n         \nImport status of the networkTxReference specified in your CSV file. Possible values: NOT_PROVIDED, IMPORTED, NOT_VALID\n\n      \n       \n         \ntransactionLinkIdStatus\n\n         \nImport status of the transactionLinkId specified in your CSV file. Possible values: NOT_PROVIDED, IMPORTED, NOT_VALID, NOT_APPLICABLE_FOR_VARIANT, NETWORK_TX_REFERENCE_MISSING\n\n      \n      \n         \nbillingAddressStatus\n\n         \nImport status of the Address fields specified in your CSV file. Possible values: NOT_PROVIDED, IMPORTED, NOT_VALID\n\n      \n      \n        \npaymentDetailDifference\n\n        \nThe storage status of the payment details. Possible values: created, updated, alreadyExisting\n\n     \n   \n\nThe following is an example output file, without additional fields, with four payment details successfully migrated:\n   status,paymentMethodVariant,shopperReference,recurringDetailReference,alias,expiryMonth,expiryYear,bin,cardSummary,issuerCountryCode,echodata,statusMessage,fundingSource\n    Success,amex,HENSHAP,2914485358484074,H116006232956221,2,2017,374291,1002,,,,,\n    Success,amex,LOCKL1,2914546007913217,E167970689307238,2,2020,374293,1006,,,,,\n    Success,amex,HICKMAGP,2714583830042296,M212359999703856,8,2017,374290,1009,,,,,\n    Success,amex,SUTHM1,2714583830042304,A129651585108480,7,2016,374297,1005,,,,,","type":"page","locale":"en","boost":17,"hierarchy":{"lvl0":"Home","lvl1":"Development resources","lvl2":"Import data from another payment provider","lvl3":"Import payment details for recurring payments"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/","lvl1":"https:\/\/docs.adyen.com\/development-resources","lvl2":"https:\/\/docs.adyen.com\/development-resources\/migrating-payment-data","lvl3":"\/development-resources\/migrating-payment-data\/import-payment-details-for-recurring-payments"},"levels":4,"category":"Development Resources","category_color":"green","tags":["Import","payment","details","recurring","payments"]}}