Batch File Processing Manual

Batch file processing allows you to process multiple transactions in bulk: you submit a file listing all the payments you want us to process, and you are done.

This feature comes in handy when you need to process refunds or retry failed capture attempts, for example. Instead of submitting one transaction at a time, you group them in a file, and then you upload it. When we receive it, we process all the valid data.

  • The file must comply with structure defined in this manual.
  • Each batch file can hold only one request type per merchant account.
    For example, if you want to process multiple payment authorisation requests, capture attempts and some refunds, you cannot include them all in the same file. Instead, you need to create three batch files:
    • a file with authorisation requests;
    • a file with capture attempts;
    • a file with refund requests.

 

To handle your batch file submissions on our end, you need to be granted the following permissions at merchant account level:

  • Merchant submit batch modifications
  • Merchant submit batch payments

This functionality is not enabled by default, as it requires additional configuration on Adyen's end. Contact the  Adyen Support Team to request enabling it for you.

We can enable the merchant submit batch payments permission for card payments only if you are PCI compliant.

Audience

This manual targets developers who integrate merchants' systems with the Adyen payment platform.

Feedback

We strive to provide you with clear, concise, and complete documentation. We are committed to improving it continuously to make it accessible and easy to understand.

We appreciate your comments, and we'd love to hear your voice: drop us a line and share your thoughts with us!

  Adyen Support Team

Batch file processing last update

Version Date Changes
4.2.2 2016-05-10 Added new subline for Authorisation request.

Version

Date

Changes

4.2.2 2016-05-10 Added new subline for Authorisation request.
4.2.1 2016-04-08

Added new transaction status 'Pending' to Modification result file and PayoutModification result file.

4.2 2015-11-25
  • Changed information in AccountUpdater result file.
  • Changed information about recurring subline in Payout.
  • Creation of recurring contract is not supported.
4.1 2015-08-31
  • Modification requests do not require any longer a merchant reference field in the modification line. This field is now optional.
  • Modification request file, modification line table, field 6: changed from (tick) to (error).
  • Modification result file, modification line table, field 6: added explanatory note.
4.0 2015-08-07
  • Documentation migration from PDF to web-based online deliverable as main distributable asset.
  • Versioning: version reset and adoption of semantic versioning as per v. 4.0.0.
  • Manual redesign to improve readability, navigation, content search.

3.6

2015-03-23

  • Edited: minor fixes to text content and code examples.

  • Added: RefundWithData.

3.5

2015-03-06

Edited: examples in Appendix C: Account Updater Request and Response Files.

3.4

2015-03-03

  • Added: Next File Submission Number.

  • Added: “Recurring” SL is mandatory when field #5 in Payout file type is “Payout”.

  • Added: ShopperInteraction sub-line to the following sub-line options:

    • Authorisation

    • StoreToken

  • Added: Minor edits and bug fixes.

  • Edited: updated documentation link.

3.3

2014-12-15

Added airline data for payment transactions.

3.2

2014-11-12

Added info about PGP encryption, PAN numbers.

3.1

2014-09-12

Rewrote ACK file chapter.

3.0

2014-04-11

Added StoreToken, Payout, PayoutModification and RefundWithData file types.

2.0

2014-01-30

Updated file format for batch response file.

SFTP and PGP configuration

Before starting to submit batch files, we need to establish a secure communication channel. To achieve that, we use the SFTP transfer protocol and PGP data encryption.

SFTP configuration

We need to create a secure FTP (SFTP) directory for you to upload your batch files to. The Adyen Support Team can set it up for you, after receiving the following information from you:

  • Your source IP address(es): the IP addresses of the servers you are going to upload batch request files from.
  • Your public SSH key: you need to generate an RSA SSH key pair (public and private keys). Key length should be 2048 bits for each key.
  • Technical point of contact: the names and email addresses of your technical points of contact.

PGP encryption

Since batch files contain sensitive information, for example card numbers, you need to encrypt them before uploading.
To enable PGP data encryption file with PGP. To do this, do the following:

  • Go to the Adyen Customer Area (CA).
  • From the left navigation sidebar, select Settings.
  • Under Company Settings, click the Manage PGP Keys link.
     
  • Select the Adyen key you want to use. To download the public part, click Download.
    You can encrypt the file with this key before sending it to Adyen. Adyen signs the batch result file with this key.
  • Upload your public key and specify Batch Files as a purpose for the action.
    You can sign your file with this key to have it verified by Adyen. Adyen signs the batch result file with this key to encrypt it.

PGP troubleshooting

In some cases, your file may be rejected. You receive a batch acknowledgement file providing details about the rejections. Common causes for batch file rejection are:

  • You send a PGP-encrypted file whose decryption operation returns errors.
    For example, a failure to verify the signature, or the key used to sign the file is not configured for your company account.
  • You send a PGP-encrypted file, but you do not have a public key to encrypt the response file.
  • You send an unencrypted file containing live card numbers.

Batch file naming

Batch request file

File name

The file name for each batch request file must be unique.

File name format

To be accepted for further processing, a batch request file name must comply with the following format: 

[Submission Platform]_[File Sequence Number]_[FileType].csv


File name format description

  • Submission Platform is the unique identifier for the server you use to submit batch files to Adyen.
    This is especially important if you have multiple servers submitting files, and find it difficult to keep track of the sequence number across the servers.
  • File Sequence Number is the file submission number. It must always increment by exactly one unit after each successful file submission.
    File sequence numbers are associated with the submission platform, i.e. the server, the files originate from.
    The Adyen system rejects batch files when:
    • The batch file submission number, i.e. the file sequence number, has already been used;
    • The system detects a gap in the number sequence because adjacent numbers are not consecutive. For example: 201 followed by 203.
  • FileType defines the type of transactions/requests that the file contains.
    Allowed values:

Batch result file

File name format

The file name for each batch result file complies with the following format:

Non-encrypted
batch result file
[Submission Platform]_[File Sequence Number]_[FileType].csv_result
Encrypted
batch result file
[Submission Platform]_[File Sequence Number]_[FileType].csv_result_enc

The batch request file undergoes a series of validation checks at line item level, and then the batch result file is posted to the result folder on the SFTP.


Batch acknowledgement file 

File name format

The file name for each batch acknowledgement file complies with the following format:

[Submission Platform]_[File Sequence Number]_[FileType].csv_ack

The batch request file undergoes a series of validation checks at line item level. If any error occur during the process, the batch acknowledgement file is posted to the ack folder on the SFTP.

 

 

Batch file structure

The batch file should be delivered in CSV (Comma Separated Values) format, as per RFC 4180, with the following exceptions:

  • Multi-line fields are not allowed;
  • It is allowed to have a variable number of fields per line. 
The file needs to have a file header and a file trailer to allow parsing.
If either file header or file trailer is missing, it is not possible top parse the file, and the process returns one or more errors.

The batch file has the following structure:

The file must conform to the following parameters:

  • File sequence number: the file header ([FH]) contains a file sequence number that must match the file sequence number in the file name.
  • File encoding: the batch file should be encoded using UTF-8.
  • Column counts: Some lines in the file contain optional fields.
    While the amount of fields per line may vary depending on the specified transaction type, the column count per transaction type is fixed.
    For example, File Header field 9 is an optional field. However, if you do not use it, you need in any case to insert a delimiter as a placeholder.
  • Character set: the character set used to represent text data needs to be Unicode.

Batch request file

The following fields are common across all batch request files, regardless of the transaction type being submitted. They must be included in each batch request file.

 

The File Header [FH] record contains information that is crucial to successfully process the batch file:

Field #

Format

Required

Description

1

Fixed value: FH

(tick)

Record type identifier.

2

Fixed value: 1.0

(tick)

Version number.
This field enables version control for the release of future enhancements for batch processing.

3

Allowed values:
  • TEST
  • LIVE

(tick)

It specifies the environment: either test or live/production.

4

Fixed value: Company

(tick)

Account type.

5

Alphabetic data [A-Z, a-z]

(tick)

Specifies the company account name.

6

Alphabetic data [A-Z, a-z]

(tick)

Submission platform.
The value specified in the file should match the corresponding value in the file name.

7

Numeric [0-9]+

(tick)

File sequence number.
The value specified in the file should match the corresponding value in the file name.

8

Alphabetic data [A-Z, a-z]

(tick)

The WS user name specified to connect to the Adyen SOAP service.

9

Allowed values:

(tick)

File type.
Defines the type of transactions that are submitted for further processing.

10

Alphabetic data [A-Z, a-z]

(error)

EchoData

In this field you can specify any data you may want to be returned with the result file.
When this field is populated, its content is returned exactly as is.
The Adyen system does not use this data.

Maximum character length: 80 characters.

The File Trailer [FT] record specifies the number of blocks in the batch file.

Field #

Format

Required

Description

1

Fixed value: FT

(tick)

Record type identifier.

2

Numeric [0-9]+

(tick)

Number of blocks in the file.

The Block Header [BH] record information notifies the Adyen system about a new grouping of transactions that should be expected.

Field #

Format

Required

Description

1

Fixed value: BH

(tick)

Record type identifier.

2

Numeric [0-9]+

(tick)

Block number.
Its value increments sequentially by one unit per block.


3

Alphabetic data [A-Z, a-z]

(error)

EchoData

In this field you can specify any data you may want to be returned with the result file.
When this field is populated, its content is returned exactly as is.
The Adyen system does not use this data.

Maximum character length: 80 characters.

The Block Trailer [BT] record specifies the number of lines in the block it refers to.

Field #

Format

Required

Description

1

Fixed value: BT

(tick)

Record type identifier.

2

Numeric [0-9]+

(tick)

Number of line records in the block.

After preparing the batch file as outlined above, you can upload it to the in sub-folder of your SFTP folder. The Adyen system can then fetch the file and add it to the processing queue.

Example

FH,1.0,TEST,Company,TestCompany,Default,2,ws@Company.TestCompany,Authorisation,FileHeaderEchoData
BH,1,BlockHeaderEchoData
...
BT,5
FT,1

Authorisation request file

Authorisation line

The line record [L] holds the metadata information that applies to its corresponding sub-line [SL] records.

Field #

Format

Required

Description

1

Fixed value: L

(tick)

Record type identifier

2

Numeric [0-9]+

(tick)

L line record number reference within the batch file block it belongs to.

The counter starts at 1, and it increments sequentially by one unit.

3

Fixed value: MerchantAccount

(tick)

Account type.
Defines the type of account the transactions are related to.

4

Alphabetic data [A-Z, a-z]

(tick)

Specifies the merchant account name.

5

Fixed value: Authorisation
 

(tick)

Processing type.
Defines the type of action that is required for the specified transaction.

6

Alphabetic data [A-Z, a-z]

(tick)

A unique identifier associated to a specific transaction.

7

Alphabetic data [A-Z, a-z]

(error)

EchoData

In this field you can specify any data you may want to be returned with the result file.
When this field is populated, its content is returned exactly as is.
The Adyen system does not use this data.

Maximum character length: 80 characters.

Authorisation sub-lines

The number and the type of sub-lines that you need to include varies, depending on the payment method specified in the request.

Authorization for a card payment

Mandatory sub-lines

You can send this sub-line(s) with your batch file only if you encrypt the file with PGP before submitting it.

The sub-lines described below are mandatory when submitting a card payment authorization request.

  • This sub-line specifies transaction amount and customer details.
  • Optional fields: if you do not populate one or more non-mandatory fields and leave them blank, you need in any case to insert delimiting commas because our system expects a preset, fixed number of fields per line/sub-line.

Field #

Format

Required

Description

1

Fixed value: SL
(tick)

Record type identifier

2

Numeric [0-9]+

(tick)

SL sub-line record number reference within its parent line.

The counter starts at 1, and it increments sequentially by one unit.

3

Fixed value: PaymentDetails

(tick)

Transaction type.
Defines the required field types for the specific sub-line.

4

Numeric [0-9]+

(tick)

Amount.

5

Numeric [0-9]+

(tick)

6

Alphabetic data [A-Z, a-z]

(tick)

The three-character ISO currency code.

7

Alphabetic data [A-Z, a-z]

(error)

A shopper's reference, which is the unique identifier for a shopper.

Required element for recurring payments and to create recurring contracts.

8

Email address

(error)

A shopper's email address.

Required element for recurring payments and to create recurring contracts.

9

Alphabetic data [A-Z, a-z]

(error)

Shopper statement.
The soft descriptor for the transaction.

10

IP address

(error)

The IP address the shopper used to carry out the transaction.

11

Numeric [0-9]+

(error)

Fraud offset.
The value to be applied to offset the calculated risk score.
It can be either a positive or a negative value.

  • This sub-line holds information about card payments.
  • In an authorization request for card payments, the Card sub-line needs to be submitted as sub-line 2.

Field #

Format

Required

Description

1

Fixed value: SL

(tick)

Record type identifier

2

Numeric [0-9]+

(tick)
SL sub-line record number reference within its parent line.

The counter starts at 1, and it increments sequentially by one unit.

3

Fixed value: Card

(tick)

Transaction type.
Defines the required field types for the specific sub-line.

4

Numeric [0-9]+

(tick)

Card number.

5

Numeric [0-9]+

(tick)

Expiry month.

  • Format: MM, zero-padded (eg: 03)

6

Numeric [0-9]+

(tick)

Expiry year.

  • Format: YYYY (eg: 2016)
7

Numeric [0-9]+

(tick)

CVC code.

  • Three-digit CVC/CVV code (Visa, Mastercard, Discover)
  • Four-digit CVC/CVV code (American Express)

8

Alphabetic data [A-Z, a-z]

(tick)

Cardholder name.

9

Numeric [0-9]+

(error)

Start month.

  • Format: MM, zero-padded (eg: 03)

Maestro UK only.

10

Numeric [0-9]+

(error)

Start year.

  • Format: YYYY (eg: 2016)

Maestro UK only.

11

Numeric [0-9]+

(error)

One-digit card issue number.

Maestro UK only.

Example

FH,1.0,TEST,Company,TestCompany,Default,2,ws@Company.TestCompany,Authorisation,FileHeaderEchoData
BH,1,BlockHeaderEchoData
L,1,MerchantAccount,TestMerchant,Authorisation,Test Product 6,
SL,1,PaymentDetails,100,2,SEK,,,,,
SL,2,Card,4111111111111111,06,2016,737,CardHolderName,,,
BT,1
FT,1

Optional sub-lines

The sub-lines described below can be optionally included in the payment request.


You can use the Address sub-line to include information about the shopper's billing and delivery addresses.
You need to specify billing and deliver addresses on separate Address sub-lines:

  • One Address sub-line containing the billing address information;
  • One Address sub-line containing the delivery address information.


Field #

Format

Required

Description

1

Fixed value: SL

(tick)

Record type identifier

2

Numeric [0-9]+

(tick)
SL sub-line record number reference within its parent line.

The counter starts at 1, and it increments sequentially by one unit.
3

Fixed value: Address

(tick)

Transaction type.
Defines the required field types for the specific sub-line.

4

Allowed values:

  • Billing
  • Delivery

(tick)

The type of address that is being submitted: either a billing or a delivery address.

5

Alphabetic data [A-Z, a-z]

(tick)

Street address.

6

Alphabetic data [A-Z, a-z]

(tick)

House number or name.

7

Alphabetic data [A-Z, a-z]

(tick)

City.

8

Alphabetic data [A-Z, a-z]

(tick)

ZIP/Post code.

9

Alphabetic data [A-Z, a-z]

(tick)

State/Province/Region.

10

Alphabetic data [A-Z, a-z]

(tick)

Two-letter country code.

The country value format needs to adhere to the ISO 3166-1 alpha-2 standard. An invalid country code results in a transaction/request rejection. You can look up country codes on the ISO web site.

Example

FH,1.0,TEST,Company,TestCompany,Default,2,ws@Company.TestCompany,Authorisation,FileHeaderEchoData
BH,1,BlockHeaderEchoData
L,1,MerchantAccount,TestMerchant,Authorisation,Test Product 6,
SL,1,PaymentDetails,100,2,SEK,,,,,
SL,2,Card,4111111111111111,06,2016,737,CardHolderName,,,
SL,3,Address,Billing,South Buena Vista Street,500,Burbank,91521,CA,US
SL,4,Address,Delivery,Some Street,123,Some Town,90102,CA,US
BT,1
FT,1

Field #

Format

Required

Description

1

Fixed value: SL

(tick)

Record type identifier

2

Numeric [0-9]+

(tick)
SL sub-line record number reference within its parent line.

The counter starts at 1, and it increments sequentially by one unit.
3

Fixed value: MerchantOrderReference

(tick)

Transaction type.
Defines the required field types for the specific sub-line.

4

Alphanumeric data

(tick)

Value of your order reference.

Example:

FH,1.0,TEST,Company,TestCompany,Default,2,ws@Company.TestCompany,Authorisation,FileHeaderEchoData
BH,1,BlockHeaderEchoData
L,1,MerchantAccount,TestMerchant,Authorisation,Test Product 6,
SL,1,PaymentDetails,100,2,SEK,,,,,
SL,2,Card,4111111111111111,08,2018,737,CardHolderName,,,
SL,3,MerchantOrderReference,XY66AB
BT,1
FT,1

Authorization for an IBAN payment

Mandatory sub-lines

The sub-lines described below are mandatory when submitting a bank transfer or a SEPA Direct Debit (DD) payment authorization request.

  • This sub-line specifies transaction amount and customer details.
  • Optional fields: if you do not populate one or more non-mandatory fields and leave them blank, you need in any case to insert delimiting commas because our system expects a preset, fixed number of fields per line/sub-line.

Field #

Format

Required

Description

1

Fixed value: SL
(tick)

Record type identifier

2

Numeric [0-9]+

(tick)

SL sub-line record number reference within its parent line.

The counter starts at 1, and it increments sequentially by one unit.

3

Fixed value: PaymentDetails

(tick)

Transaction type.
Defines the required field types for the specific sub-line.

4

Numeric [0-9]+

(tick)

Amount.

5

Numeric [0-9]+

(tick)

6

Alphabetic data [A-Z, a-z]

(tick)

The three-character ISO currency code.

7

Alphabetic data [A-Z, a-z]

(error)

A shopper's reference, which is the unique identifier for a shopper.

Required element for recurring payments and to create recurring contracts.

8

Email address

(error)

A shopper's email address.

Required element for recurring payments and to create recurring contracts.

9

Alphabetic data [A-Z, a-z]

(error)

Shopper statement.
The soft descriptor for the transaction.

10

IP address

(error)

The IP address the shopper used to carry out the transaction.

11

Numeric [0-9]+

(error)

Fraud offset.
The value to be applied to offset the calculated risk score.
It can be either a positive or a negative value.

  • This sub-line holds information about bank transfer or SEPA Direct Debit (DD) payments carried out using the shopper's IBAN details.
  • In an authorization request for IBAN payments, the IBAN sub-line needs to be submitted as sub-line 2.

Field #

Format

Required

Description

1

Fixed value: SL

(tick)

Record type identifier

2

Numeric [0-9]+

(tick)

SL sub-line record number reference within its parent line.

The counter starts at 1, and it increments sequentially by one unit.

3

Fixed value: IBAN

(tick)

Transaction type.
Defines the required field types for the specific sub-line.

4

Alphabetic data [A-Z, a-z]

(tick)

Bank account owner name.

5

Alphabetic data [A-Z, a-z]

(tick)

Two-letter country code.

The country value format needs to adhere to the ISO 3166-1 alpha-2 standard. An invalid country code results in a transaction/request rejection. You can look up country codes on the ISO web site.

6

Alphabetic data [A-Z, a-z]

(tick)

IBAN code.

7

Alphabetic data [A-Z, a-z]

(error)

BIC code.

Example

FH,1.0,TEST,Company,TestCompany,Default,2,ws@Company.TestCompany,Authorisation,FileHeaderEchoData
BH,1,BlockHeaderEchoData
L,1,MerchantAccount,TestMerchant,Authorisation,Test Product 6,
SL,1,PaymentDetails,100,2,SEK,,,,,
SL,2,IBAN,Simon Hopper,GB,GB57RBOS16121110041073,
BT,1
FT,1

The sub-lines described below can be optionally included in the payment request.Optional sub-lines


You can use the Address sub-line to include information about the shopper's billing and delivery addresses.
You need to specify billing and deliver addresses on separate Address sub-lines:

  • One Address sub-line containing the billing address information;
  • One Address sub-line containing the delivery address information.


Field #

Format

Required

Description

1

Fixed value: SL

(tick)

Record type identifier

2

Numeric [0-9]+

(tick)
SL sub-line record number reference within its parent line.

The counter starts at 1, and it increments sequentially by one unit.
3

Fixed value: Address

(tick)

Transaction type.
Defines the required field types for the specific sub-line.

4

Allowed values:

  • Billing
  • Delivery

(tick)

The type of address that is being submitted: either a billing or a delivery address.

5

Alphabetic data [A-Z, a-z]

(tick)

Street address.

6

Alphabetic data [A-Z, a-z]

(tick)

House number or name.

7

Alphabetic data [A-Z, a-z]

(tick)

City.

8

Alphabetic data [A-Z, a-z]

(tick)

ZIP/Post code.

9

Alphabetic data [A-Z, a-z]

(tick)

State/Province/Region.

10

Alphabetic data [A-Z, a-z]

(tick)

Two-letter country code.

The country value format needs to adhere to the ISO 3166-1 alpha-2 standard. An invalid country code results in a transaction/request rejection. You can look up country codes on the ISO web site.

Example

FH,1.0,TEST,Company,TestCompany,Default,2,ws@Company.TestCompany,Authorisation,FileHeaderEchoData
BH,1,BlockHeaderEchoData
L,1,MerchantAccount,TestMerchant,Authorisation,Test Product 6,
SL,1,PaymentDetails,100,2,SEK,,,,,
SL,2,IBAN,Simon Hopper,GB,GB57RBOS16121110041073,
SL,3,Address,Billing,South Buena Vista Street,500,Burbank,91521,CA,US
SL,4,Address,Delivery,Some Street,123,Some Town,90102,CA,US
BT,1
FT,1

Field #

Format

Required

Description

1

Fixed value: SL

(tick)

Record type identifier

2

Numeric [0-9]+

(tick)
SL sub-line record number reference within its parent line.

The counter starts at 1, and it increments sequentially by one unit.
3

Fixed value: MerchantOrderReference

(tick)

Transaction type.
Defines the required field types for the specific sub-line.

4

Alphanumeric data

(tick)

Value of your order reference.

Example:

FH,1.0,TEST,Company,TestCompany,Default,2,ws@Company.TestCompany,Authorisation,FileHeaderEchoData
BH,1,BlockHeaderEchoData
L,1,MerchantAccount,TestMerchant,Authorisation,Test Product 6,
SL,1,PaymentDetails,100,2,SEK,,,,,
SL,2,Card,4111111111111111,08,2018,737,CardHolderName,,,
SL,3,MerchantOrderReference,XY66AB
BT,1
FT,1

Authorization for a recurring payment

Mandatory sub-lines

The sub-lines described below are mandatory when submitting a recurring payment authorization request.

  • This sub-line specifies transaction amount and customer details.
  • Optional fields: if you do not populate one or more non-mandatory fields and leave them blank, you need in any case to insert delimiting commas because our system expects a preset, fixed number of fields per line/sub-line.

Field #

Format

Required

Description

1

Fixed value: SL
(tick)

Record type identifier

2

Numeric [0-9]+

(tick)

SL sub-line record number reference within its parent line.

The counter starts at 1, and it increments sequentially by one unit.

3

Fixed value: PaymentDetails

(tick)

Transaction type.
Defines the required field types for the specific sub-line.

4

Numeric [0-9]+

(tick)

Amount.

5

Numeric [0-9]+

(tick)

6

Alphabetic data [A-Z, a-z]

(tick)

The three-character ISO currency code.

7

Alphabetic data [A-Z, a-z]

(error)

A shopper's reference, which is the unique identifier for a shopper.

Required element for recurring payments and to create recurring contracts.

8

Email address

(error)

A shopper's email address.

Required element for recurring payments and to create recurring contracts.

9

Alphabetic data [A-Z, a-z]

(error)

Shopper statement.
The soft descriptor for the transaction.

10

IP address

(error)

The IP address the shopper used to carry out the transaction.

11

Numeric [0-9]+

(error)

Fraud offset.
The value to be applied to offset the calculated risk score.
It can be either a positive or a negative value.

Field #

Format

Required

Description

1

Fixed value: SL
(tick)

Record type identifier

2

Numeric [0-9]+

(tick)

SL sub-line record number reference within its parent line.

The counter starts at 1, and it increments sequentially by one unit.

3

Fixed value: Recurring

(tick)

Transaction type.
Defines the required field types for the specific sub-line.

4

Fixed value: RECURRING

(tick)

The type of a recurring contract.

5

Allowed values:
  • Adyen's 16-digit unique token, or
  • LATEST

(tick)

  • The 16-digit unique token corresponds to the selectedRecurringDetailReference field value.
    It targets a specific stored recurring data set.
  • If you specify LATEST, the latest/more recent data set is fetched for usage.

  • This sub-line holds information about payments requests involving shopper interaction.
  • Include a ShopperInteraction sub-line when you are submitting these transaction types:
    • ContAuth
    • Moto

You can add a ShopperInteraction sub-line to any sub-line option that supports a shopper interaction other than Ecommerce:

  • Authorisation
  • Recurring
  • StoreToken

Field #

Format

Required

Description

1

Fixed value: SL
(tick)

Record type identifier

2

Numeric [0-9]+

(tick)

SL sub-line record number reference within its parent line.

The counter starts at 1, and it increments sequentially by one unit.

3

Fixed value: ShopperInteraction

(tick)

Transaction type.
Defines the required field types for the specific sub-line.

4

Alphabetic data [A-Z, a-z]

(tick)

The type of shopper interaction transaction to carry out.
Allowed values:

  • ContAuth

  • Ecommerce

  • Moto

  • POS

Unless you need to perform a MOTO transaction, set this field value to ContAuth.

Example

FH,1.0,TEST,Company,TestCompany,Default,2,ws@Company.TestCompany,Authorisation,FileHeaderEchoData
BH,1,BlockHeaderEchoData
L,1,MerchantAccount,TestMerchant,Authorisation,Test Product 6,
SL,1,PaymentDetails,100,2,SEK,Ref123,s.hopper@gmail.com,,,
SL,2,Recurring,RECURRING,LATEST
SL,3,ShopperInteraction,ContAuth
BT,1
FT,1

The sub-lines described below can be optionally included in the payment request.Optional sub-lines


You can use the Address sub-line to include information about the shopper's billing and delivery addresses.
You need to specify billing and deliver addresses on separate Address sub-lines:

  • One Address sub-line containing the billing address information;
  • One Address sub-line containing the delivery address information.


Field #

Format

Required

Description

1

Fixed value: SL

(tick)

Record type identifier

2

Numeric [0-9]+

(tick)
SL sub-line record number reference within its parent line.

The counter starts at 1, and it increments sequentially by one unit.
3

Fixed value: Address

(tick)

Transaction type.
Defines the required field types for the specific sub-line.

4

Allowed values:

  • Billing
  • Delivery

(tick)

The type of address that is being submitted: either a billing or a delivery address.

5

Alphabetic data [A-Z, a-z]

(tick)

Street address.

6

Alphabetic data [A-Z, a-z]

(tick)

House number or name.

7

Alphabetic data [A-Z, a-z]

(tick)

City.

8

Alphabetic data [A-Z, a-z]

(tick)

ZIP/Post code.

9

Alphabetic data [A-Z, a-z]

(tick)

State/Province/Region.

10

Alphabetic data [A-Z, a-z]

(tick)

Two-letter country code.

The country value format needs to adhere to the ISO 3166-1 alpha-2 standard. An invalid country code results in a transaction/request rejection. You can look up country codes on the ISO web site.

Example

FH,1.0,TEST,Company,TestCompany,Default,2,ws@Company.TestCompany,Authorisation,FileHeaderEchoData
BH,1,BlockHeaderEchoData
L,1,MerchantAccount,TestMerchant,Authorisation,Test Product 6,
SL,1,PaymentDetails,100,2,SEK,,,,,
SL,2,Recurring,RECURRING,LATEST
SL,3,ShopperInteraction,ContAuth
SL,4,Address,Billing,South Buena Vista Street,500,Burbank,91521,CA,US
SL,5,Address,Delivery,Some Street,123,Some Town,90102,CA,US
BT,1
FT,1

Field #

Format

Required

Description

1

Fixed value: SL

(tick)

Record type identifier

2

Numeric [0-9]+

(tick)
SL sub-line record number reference within its parent line.

The counter starts at 1, and it increments sequentially by one unit.
3

Fixed value: MerchantOrderReference

(tick)

Transaction type.
Defines the required field types for the specific sub-line.

4

Alphanumeric data

(tick)

Value of your order reference.

Example:

FH,1.0,TEST,Company,TestCompany,Default,2,ws@Company.TestCompany,Authorisation,FileHeaderEchoData
BH,1,BlockHeaderEchoData
L,1,MerchantAccount,TestMerchant,Authorisation,Test Product 6,
SL,1,PaymentDetails,100,2,SEK,,,,,
SL,2,Card,4111111111111111,08,2018,737,CardHolderName,,,
SL,3,MerchantOrderReference,XY66AB
BT,1
FT,1

Authorization with airline data

You can include airline data in batch file authorization and capture requests.

Airline data fields may have specific format and/or character limitations: refer to the airline data overview for details.

When you send an authorization request with a batch file submission, you can include airline data information.
To do so, you append the relevant airline data as sub-lines to the card payment, IBAN payment or recurring payment authorization requests.

Below you can find an overview of the airline data sub-lines you can pass with the above mentioned batch file requests.

Airline data sub-lines

This sub-line holds information about airline data information you want to send along with batch file authorisation and capture requests.

Airline data fields may have specific format and/or character limitations: refer to the airline data overview for details.

Field #

Format

Required

Description

1

Fixed value: SL

(tick)

Record type identifier

2

Numeric [0-9]+

(tick)

SL sub-line record number reference within its parent line.

The counter starts at 1, and it increments sequentially by one unit.

3 Fixed value: Airline

(tick)

Transaction type.
Defines the required field types for the specific sub-line.

4

Alphabetic data [A-Z, a-z]

(error)

Customer reference identifier/number.

5

Alphabetic data [A-Z, a-z]

(error)

Airline code.
6 Alphabetic data [A-Z, a-z] (error) Airline designator code.
7 Alphabetic data [A-Z, a-z] (error) Ticket issue address.
8 Alphabetic data [A-Z, a-z] (error) Ticket number.
9 Alphabetic data [A-Z, a-z] (error) Travel agency code.
10 Alphabetic data [A-Z, a-z] (error) Travel agency name.
11 Alphabetic data [A-Z, a-z] (error) Agency plan name.
12 Alphabetic data [A-Z, a-z] (error) Agency invoice number.

Example

Isolated airline data batch file sub-line:

SL,3,Airline,BVQT04,KLM,DSG123,5th avenue 66,100020003034,12345678,,,,

Airline data batch file sub-line in a batch file context:

FH,1.0,DEVL,Company,TestCompany,Default,27,ws@Company.TestCompany,Modification,FileHeaderEchoData
BH,1,BlockHeaderEchoData
L,1,MerchantAccount,TestMerchant,CaptureWithExternalAuth,Test Product
3,123456
SL,1,PaymentDetails,10000,2,EUR
SL,2,Card,4111111111111111,6,2016,737,CardHolderName,,,
SL,3,Airline,BVQT04,074,KL,C1,ABCDEF123456,A1B2C3D4,Adyen-Air,AP,123456
SL,4,AirlineLeg,1,AMS,FL123,AA,1,B,A,LND,2025-01-01 10:00,,
SL,5,AirlinePassenger,1,Name,Miguel,Rodriguez,,,
SL,8,ShopperInteraction,Ecommerce
BT,1
FT,1

This sub-line holds information about airline leg information you want to send along with batch file authorisation and capture requests.

If you include airline data in your request, the batch file needs to contain at least one airline leg sub-line as well.

Airline data fields may have specific format and/or character limitations: refer to the airline data overview for details.

Field #

Format

Required

Description

1

Fixed value: SL

(tick)

Record type identifier

2

Numeric [0-9]+

(tick)

SL sub-line record number reference within its parent line.

The counter starts at 1, and it increments sequentially by one unit.

3 Fixed value: AirlineLeg

(tick)

Transaction type.
Defines the required field types for the specific sub-line.

4

Numeric [0-9]+
(tick)
Leg number identifier.
The counter starts at 1, and it increments sequentially by one unit.
5
Alphabetic data [A-Z, a-z]
(tick) Departure airport.
6
Alphabetic data [A-Z, a-z]
(tick) Flight number.
7
Alphabetic data [A-Z, a-z]
(tick) Carrier code.
8
Alphabetic data [A-Z, a-z]
(tick) Fare basis code.
9
Alphabetic data [A-Z, a-z]
(tick) Travel class identifier.
10
Alphabetic data [A-Z, a-z]
(error) Stopover code.
11
Alphabetic data [A-Z, a-z]
(tick) Destination code.
12
Alphabetic data [A-Z, a-z]
(tick) Travel date.
13
Alphabetic data [A-Z, a-z]
(error) Departure tax.

Example

Isolated airline leg data batch file sub-line:

SL,4,AirlineLeg,1,AMS,12345,AA,Y123456,B,O,LON,2014-08-02T19:05:00.000,Y

Airline leg data batch file sub-line in a batch file context:

FH,1.0,DEVL,Company,TestCompany,Default,27,ws@Company.TestCompany,Modification,FileHeaderEchoData
BH,1,BlockHeaderEchoData
L,1,MerchantAccount,TestMerchant,CaptureWithExternalAuth,Test Product
3,123456
SL,1,PaymentDetails,10000,2,EUR
SL,2,Card,4111111111111111,6,2016,737,CardHolderName,,,
SL,3,Airline,BVQT04,074,KL,C1,ABCDEF123456,A1B2C3D4,Adyen-Air,AP,123456
SL,4,AirlineLeg,1,AMS,FL123,AA,1,B,A,LND,2025-01-01 10:00,,
SL,5,AirlinePassenger,1,Name,Miguel,Rodriguez,,,
SL,8,ShopperInteraction,Ecommerce
BT,1
FT,1

This sub-line holds information about airline passenger information you want to send along with batch file authorisation and capture requests.

If you include airline data in your request, besides at least one airline leg sub-line the batch file needs to contain at least one airline passenger sub-line as well.

Airline data fields may have specific format and/or character limitations: refer to the airline data overview for details.

Field #

Format

Required

Description

1

Fixed value: SL

(tick)

Record type identifier

2

Numeric [0-9]+

(tick)

SL sub-line record number reference within its parent line.

The counter starts at 1, and it increments sequentially by one unit.

3 Fixed value: AirlinePassenger

(tick)

Transaction type.
Defines the required field types for the specific sub-line.

4

Numeric [0-9]+
(tick)
Passenger number identifier.
The counter starts at 1, and it increments sequentially by one unit.
5 Fixed value: Name (tick) Passenger data type.
6
Alphabetic data [A-Z, a-z]
(tick) Passenger's first/given name.
7
Alphabetic data [A-Z, a-z]
(tick) Passenger's last/family name.
8
Alphabetic data [A-Z, a-z]
(error)

Passenger's birth date.

  • Format: yyyy-MM-dd
    For example: 1980-02-28

9
Alphabetic data [A-Z, a-z]
(error) Traveller type.
Passenger type code (PTC).

Example

Isolated airline passenger data batch file sub-line:

SL,1,PaymentDetails,100,2,EUR,,,,,
SL,2,Card,4111111111111111,6,2016,737,CardHolderName,,,
SL,3,Airline,BVQT04,KLM,DSG123,5th avenue 66,100020003034,12345678,,,
SL,4,AirlineLeg,1,AMS,12345,AA,Y123456,B,O,LON,2014-08-02T19:05:00.000,Y
SL,5,AirlinePassenger,1,Name,John,Doe,1979-02-28,,

Airline passenger data batch file sub-line in a batch file context:

FH,1.0,DEVL,Company,TestCompany,Default,27,ws@Company.TestCompany,Modification,FileHeaderEchoData
BH,1,BlockHeaderEchoData
L,1,MerchantAccount,TestMerchant,CaptureWithExternalAuth,Test Product
3,123456
SL,1,PaymentDetails,10000,2,EUR
SL,2,Card,4111111111111111,6,2016,737,CardHolderName,,,
SL,3,Airline,BVQT04,074,KL,C1,ABCDEF123456,A1B2C3D4,Adyen-Air,AP,123456
SL,4,AirlineLeg,1,AMS,FL123,AA,1,B,A,LND,2025-01-01 10:00,,
SL,5,AirlinePassenger,1,Name,Miguel,Rodriguez,,,
SL,8,ShopperInteraction,Ecommerce
BT,1
FT,1

Optional sub-lines

The sub-lines described below can be optionally included in the payment request.

MerchantOrderReference

Field #

Format

Required

Description

1

Fixed value: SL

(tick)

Record type identifier

2

Numeric [0-9]+

(tick)
SL sub-line record number reference within its parent line.

The counter starts at 1, and it increments sequentially by one unit.
3

Fixed value: MerchantOrderReference

(tick)

Transaction type.
Defines the required field types for the specific sub-line.

4

Alphanumeric data

(tick)

Value of your order reference.

 

Example:

FH,1.0,TEST,Company,TestCompany,Default,2,ws@Company.TestCompany,Authorisation,FileHeaderEchoData
BH,1,BlockHeaderEchoData
L,1,MerchantAccount,TestMerchant,Authorisation,Test Product 6,
SL,1,PaymentDetails,100,2,SEK,,,,,
SL,2,Card,4111111111111111,08,2018,737,CardHolderName,,,
SL,3,MerchantOrderReference,XY66AB
BT,1
FT,1

Modification request file

Modification line

The line record [L] holds the metadata information that applies to its corresponding sub-line [SL] records.

Field #

Format

Required

Description

1

Fixed value: L

(tick)

Record type identifier

2

Numeric [0-9]+

(tick)

L line record number reference within the batch file block it belongs to.

The counter starts at 1, and it increments sequentially by one unit.

3

Fixed value: MerchantAccount

(tick)

Account type.
Defines the type of account the transactions are related to.

4

Alphabetic data [A-Z, a-z] 

(tick)

Specifies the merchant account name.

5

Allowed values:

  • AuthoriseReferral
  • Cancel
  • Capture
  • Refund
  • CancelOrRefund

(tick)

Processing type.
Defines the type of action that is required for the specified transaction.

6

Alphabetic data [A-Z, a-z]

(error)

A unique identifier associated to a specific transaction.

As for modification requests, the merchant reference value can either:

  • Keep the same value and refer to the original payment authorisation reference. Or
  • Take a new reference value for the modification request in question.

7

Alphabetic data [A-Z, a-z]

(error)

EchoData

In this field you can specify any data you may want to be returned with the result file.
When this field is populated, its content is returned exactly as is.
The Adyen system does not use this data.

Maximum character length: 80 characters.

Modification sub-lines

The number and the type of sub-lines that you need to include varies, depending on the modification request you are submitting.

AuthorisationReferral request

When you process  MOTO transactions, you may need to handle transactions with a resulting Declined status and a corresponding Referral reason.

If the shopper contacted their issuing bank and you have the authorisation code for the transaction, you can submit it in a batch file to update the transaction in the Adyen system.

When we receive and process the batch file, we book a new Authorised journal entry for the transaction, and then proceed with the standard workflow.

Mandatory sub-lines

The sub-lines described below are mandatory when submitting a bank transfer authorisation request.

  • This sub-line specifies transaction amount and customer details.
  • Optional fields: if you do not populate one or more non-mandatory fields and leave them blank, you need in any case to insert delimiting commas because our system expects a preset, fixed number of fields per line/sub-line.

Field #

Format

Required

Description

1

Fixed value: SL
(tick)

Record type identifier

2

Numeric [0-9]+

(tick)

SL sub-line record number reference within its parent line.

The counter starts at 1, and it increments sequentially by one unit.

3

Fixed value: PaymentDetails

(tick)

Transaction type.
Defines the required field types for the specific sub-line.

4

Numeric [0-9]+

(tick)

Amount.

5

Numeric [0-9]+

(tick)

6

Alphabetic data [A-Z, a-z]

(tick)

The three-character ISO currency code.

7

Alphabetic data [A-Z, a-z]

(error)

A shopper's reference, which is the unique identifier for a shopper.

Required element for recurring payments and to create recurring contracts.

8

Email address

(error)

A shopper's email address.

Required element for recurring payments and to create recurring contracts.

9

Alphabetic data [A-Z, a-z]

(error)

Shopper statement.
The soft descriptor for the transaction.

10

IP address

(error)

The IP address the shopper used to carry out the transaction.

11

Numeric [0-9]+

(error)

Fraud offset.
The value to be applied to offset the calculated risk score.
It can be either a positive or a negative value.

Field #

Format

Required

Description

1

Fixed value: SL

(tick)

Record type identifier

2

Numeric [0-9]+

(tick)

SL sub-line record number reference within its parent line.

The counter starts at 1, and it increments sequentially by one unit.

3

Fixed value: AuthoriseReferral

(tick)

Transaction type.
Defines the required field types for the specific sub-line.

4

Numeric [0-9]+

(tick)

The original payment PSP reference.

5

Alphabetic data [A-Z, a-z]

(tick)

The authorisation code for the transaction (authCode).

Example

FH,1.0,TEST,Company,TestCompany,Default,2,ws@Company.TestCompany,Modification,FileHeaderEchoData
BH,1,BlockHeaderEchoData
L,1,MerchantAccount,TestMerchant,AuthoriseReferral,Test Product 6,
SL,1,PaymentDetails,100,2,EUR,,,,,
SL,2,AuthoriseReferral,8452147851579029,259016
BT,1
FT,1

CancelOrRefund request

Mandatory sub-lines

The sub-line described below is mandatory when submitting a cancellation request.

Field #

Format

Required

Description

1

Fixed value: SL

(tick)

Record type identifier

2

Numeric [0-9]+

(tick)

SL sub-line record number reference within its parent line.

The counter starts at 1, and it increments sequentially by one unit.

3

Fixed value: CancelOrRefund

(tick)

Transaction type.
Defines the required field types for the specific sub-line.

4

Numeric [0-9]+

(tick)

The original payment PSP reference.

Example

FH,1.0,TEST,Company,TestCompany,Default,3,ws@Company.TestCompany,Modification,FileHeaderEchoData 
BH,1,BlockHeaderEchoData 
L,1,MerchantAccount,TestMerchant,CancelOrRefund,Test Product 3,EchoData 
SL,1,CancelOrRefund,8452147851579029
BT,1
FT,1

Cancel request

Mandatory sub-lines

The sub-line described below is mandatory when submitting a payment cancellation request.

  • This sub-line holds information about Cancel modification requests.
  • You cannot submit partial cancellation modifications.

Field #

Format

Required

Description

1

Fixed value: SL

(tick)

Record type identifier

2

Numeric [0-9]+

(tick)

SL sub-line record number reference within its parent line.

The counter starts at 1, and it increments sequentially by one unit.

3

Fixed value: Cancel

(tick)

Transaction type.
Defines the required field types for the specific sub-line.

4

Numeric [0-9]+

(tick)

The original payment PSP reference.

Example

FH,1.0,TEST,Company,TestCompany,Default,3,ws@Company.TestCompany,Modification,FileHeaderEchoData 
BH,1,BlockHeaderEchoData 
L,1,MerchantAccount,TestMerchant,Cancel,Test Product 3,EchoData 
SL,1,Cancel,8452147852369014
BT,1
FT,1

Capture request

You can include airline data in batch file authorization and capture requests.

Airline data fields may have specific format and/or character limitations: refer to the airline data overview for details.

To include airline data, append the appropriate sub-line(s) to the standard capture sub-line described below.

Mandatory sub-lines

The sub-line described below is mandatory when submitting a payment capture request.

This sub-line holds information about capture modification requests.

Field #

Format

Required

Description

1

Fixed value: SL

(tick)

Record type identifier

2

Numeric [0-9]+

(tick)

SL sub-line record number reference within its parent line.

The counter starts at 1, and it increments sequentially by one unit.

3

Fixed value: Capture

(tick)

Transaction type.
Defines the required field types for the specific sub-line.

4

Numeric [0-9]+

(tick)

The original payment PSP reference.
5
Numeric [0-9]+
(tick) Amount.
6
Numeric [0-9]+
(tick)
7
Alphabetic data [A-Z, a-z]
(tick)
The three-character ISO currency code.

Example

FH,1.0,TEST,Company,TestCompany,Default,3,ws@Company.TestCompany,Modification,FileHeaderEchoData 
BH,1,BlockHeaderEchoData 
L,1,MerchantAccount,TestMerchant,Capture,Test Product 3,EchoData 
SL,1,Capture,9145754231690158,100,2,EUR
BT,1
FT,1
Capture with airline data

You can include airline data in batch file authorization and capture requests.

Airline data fields may have specific format and/or character limitations: refer to the airline data overview for details.

When you send a capture request with a batch file submission, you can include airline data information.
To do so, you append the relevant airline data as sub-lines to the payment capture requests.

Below you can find an overview of the airline data sub-lines you can pass with capture batch file requests.

Airline data sub-lines

This sub-line holds information about airline data information you want to send along with batch file authorisation and capture requests.

Airline data fields may have specific format and/or character limitations: refer to the airline data overview for details.

Field #

Format

Required

Description

1

Fixed value: SL

(tick)

Record type identifier

2

Numeric [0-9]+

(tick)

SL sub-line record number reference within its parent line.

The counter starts at 1, and it increments sequentially by one unit.

3 Fixed value: Airline

(tick)

Transaction type.
Defines the required field types for the specific sub-line.

4

Alphabetic data [A-Z, a-z]

(error)

Customer reference identifier/number.

5

Alphabetic data [A-Z, a-z]

(error)

Airline code.
6 Alphabetic data [A-Z, a-z] (error) Airline designator code.
7 Alphabetic data [A-Z, a-z] (error) Ticket issue address.
8 Alphabetic data [A-Z, a-z] (error) Ticket number.
9 Alphabetic data [A-Z, a-z] (error) Travel agency code.
10 Alphabetic data [A-Z, a-z] (error) Travel agency name.
11 Alphabetic data [A-Z, a-z] (error) Agency plan name.
12 Alphabetic data [A-Z, a-z] (error) Agency invoice number.

Example

Isolated airline data batch file sub-line:

SL,2,Airline,BVQT04,KLM,DSG123,5th avenue 66,100020003034,12345678,,,,

Airline data batch file sub-line in a batch file context:

FH,1.0,TEST,Company,TestCompany,Default,3,ws@Company.TestCompany,Modification,FileHeaderEchoData
BH,1,BlockHeaderEchoData
L,1,MerchantAccount,TestMerchant,Capture,Test Product 3,EchoData
SL,1,Capture,9145754231690158,100,2,EUR
SL,2,Airline,BVQT04,074,KL,C1,ABCDEF123456,A1B2C3D4,Adyen-Air,AP,123456
SL,3,AirlineLeg,1,AMS,FL123,AA,1,B,A,LND,2025-01-01 10:00,,
SL,4,AirlinePassenger,1,Name,Miguel,Rodriguez,,,
SL,5,ShopperInteraction,Ecommerce
SL,6,AuthorisationData,eci,1234
BT,1
FT,1

This sub-line holds information about airline leg information you want to send along with batch file authorisation and capture requests.

If you include airline data in your request, the batch file needs to contain at least one airline leg sub-line as well.

Airline data fields may have specific format and/or character limitations: refer to the airline data overview for details.

Field #

Format

Required

Description

1

Fixed value: SL

(tick)

Record type identifier

2

Numeric [0-9]+

(tick)

SL sub-line record number reference within its parent line.

The counter starts at 1, and it increments sequentially by one unit.

3 Fixed value: AirlineLeg

(tick)

Transaction type.
Defines the required field types for the specific sub-line.

4

Numeric [0-9]+
(tick)
Leg number identifier.
The counter starts at 1, and it increments sequentially by one unit.
5
Alphabetic data [A-Z, a-z]
(tick) Departure airport.
6
Alphabetic data [A-Z, a-z]
(tick) Flight number.
7
Alphabetic data [A-Z, a-z]
(tick) Carrier code.
8
Alphabetic data [A-Z, a-z]
(tick) Fare basis code.
9
Alphabetic data [A-Z, a-z]
(tick) Travel class identifier.
10
Alphabetic data [A-Z, a-z]
(error) Stopover code.
11
Alphabetic data [A-Z, a-z]
(tick) Destination code.
12
Alphabetic data [A-Z, a-z]
(tick) Travel date.
13
Alphabetic data [A-Z, a-z]
(error) Departure tax.

Example

Isolated airline leg data batch file sub-line:

SL,3,AirlineLeg,1,AMS,12345,AA,Y123456,B,O,LON,2014-08-02T19:05:00.000,Y

Airline data batch file sub-line in a batch file context:

FH,1.0,TEST,Company,TestCompany,Default,3,ws@Company.TestCompany,Modification,FileHeaderEchoData
BH,1,BlockHeaderEchoData
L,1,MerchantAccount,TestMerchant,Capture,Test Product 3,EchoData
SL,1,Capture,9145754231690158,100,2,EUR
SL,2,Airline,BVQT04,074,KL,C1,ABCDEF123456,A1B2C3D4,Adyen-Air,AP,123456
SL,3,AirlineLeg,1,AMS,FL123,AA,1,B,A,LND,2025-01-01 10:00,,
SL,4,AirlinePassenger,1,Name,Miguel,Rodriguez,,,
SL,5,ShopperInteraction,Ecommerce
SL,6,AuthorisationData,eci,1234
BT,1
FT,1

This sub-line holds information about airline passenger information you want to send along with batch file authorisation and capture requests.

If you include airline data in your request, besides at least one airline leg sub-line the batch file needs to contain at least one airline passenger sub-line as well.

Airline data fields may have specific format and/or character limitations: refer to the airline data overview for details.

Field #

Format

Required

Description

1

Fixed value: SL

(tick)

Record type identifier

2

Numeric [0-9]+

(tick)

SL sub-line record number reference within its parent line.

The counter starts at 1, and it increments sequentially by one unit.

3 Fixed value: AirlinePassenger

(tick)

Transaction type.
Defines the required field types for the specific sub-line.

4

Numeric [0-9]+
(tick)
Passenger number identifier.
The counter starts at 1, and it increments sequentially by one unit.
5 Fixed value: Name (tick) Passenger data type.
6
Alphabetic data [A-Z, a-z]
(tick) Passenger's first/given name.
7
Alphabetic data [A-Z, a-z]
(tick) Passenger's last/family name.
8
Alphabetic data [A-Z, a-z]
(error)

Passenger's birth date.

  • Format: yyyy-MM-dd
    For example: 1980-02-28

9
Alphabetic data [A-Z, a-z]
(error) Traveller type.
Passenger type code (PTC).

Example

Isolated airline passenger data batch file sub-line:

SL,4,AirlinePassenger,1,Name,John,Doe,1979-02-28,,

Airline data batch file sub-line in a batch file context::

FH,1.0,TEST,Company,TestCompany,Default,3,ws@Company.TestCompany,Modification,FileHeaderEchoData
BH,1,BlockHeaderEchoData
L,1,MerchantAccount,TestMerchant,Capture,Test Product 3,EchoData
SL,1,Capture,9145754231690158,100,2,EUR
SL,2,Airline,BVQT04,074,KL,C1,ABCDEF123456,A1B2C3D4,Adyen-Air,AP,123456
SL,3,AirlineLeg,1,AMS,FL123,AA,1,B,A,LND,2025-01-01 10:00,,
SL,4,AirlinePassenger,1,Name,Miguel,Rodriguez,,,
SL,5,ShopperInteraction,Ecommerce
SL,6,AuthorisationData,eci,1234
BT,1
FT,1

Refund request

Mandatory sub-lines

The sub-line described below is mandatory when submitting a refund modification request.

This sub-line holds information about refund modification requests.

Field #

Format

Required

Description

1

Fixed value: SL

(tick)

Record type identifier

2

Numeric [0-9]+

(tick)

SL sub-line record number reference within its parent line.

The counter starts at 1, and it increments sequentially by one unit.

3

Fixed value: Refund

(tick)

Transaction type.
Defines the required field types for the specific sub-line.

4

Numeric [0-9]+

(tick)

The original payment PSP reference.
5 Numeric [0-9]+ (tick) Amount.
6 Numeric [0-9]+ (tick)
7 Alphabetic data [A-Z, a-z] (tick)
The three-character ISO currency code.

Example

FH,1.0,TEST,Company,TestCompany,Default,3,ws@Company.TestCompany,Modification,FileHeaderEchoData 
BH,1,BlockHeaderEchoData 
L,1,MerchantAccount,TestMerchant,Refund,Test Product 3,EchoData 
SL,1,Refund,9630124578963201,123,2,EUR
BT,1
FT,1

RefundWithData request file

RefundWithData lines

The line record [L] holds the metadata information that applies to its corresponding sub-line [SL] records.

Field #

Format

Required

Description

1

Fixed value: L

(tick)

Record type identifier

2

Numeric [0-9]+

(tick)

L line record number reference within the batch file block it belongs to.

The counter starts at 1, and it increments sequentially by one unit.

3

Fixed value: MerchantAccount

(tick)

Account type.
Defines the type of account the transactions are related to.

4

Alphabetic data [A-Z, a-z]

(tick)

Specifies the merchant account name.

5

Fixed value: RefundWithData

(tick)

Processing type.
Defines the type of action that is required for the specified transaction.

6

Alphabetic data [A-Z, a-z]

(tick)

A unique identifier associated to a specific transaction.

As for modification requests, the merchant reference value can either:

  • Keep the same value and refer to the original payment authorisation reference. Or
  • Take a new reference value for the modification request in question.

7

Alphabetic data [A-Z, a-z]

(error)

EchoData

In this field you can specify any data you may want to be returned with the result file.
When this field is populated, its content is returned exactly as is.
The Adyen system does not use this data.

Maximum character length: 80 characters.

RefundWithData sub-lines

RefundWithData has only one processing type and one sub-line.

RefundWithData request

Mandatory sub-lines

The sub-lines described below are mandatory when submitting a bank transfer authorisation request.

  • This sub-line specifies transaction amount and customer details.
  • Optional fields: if you do not populate one or more non-mandatory fields and leave them blank, you need in any case to insert delimiting commas because our system expects a preset, fixed number of fields per line/sub-line.

Field #

Format

Required

Description

1

Fixed value: SL
(tick)

Record type identifier

2

Numeric [0-9]+

(tick)

SL sub-line record number reference within its parent line.

The counter starts at 1, and it increments sequentially by one unit.

3

Fixed value: PaymentDetails

(tick)

Transaction type.
Defines the required field types for the specific sub-line.

4

Numeric [0-9]+

(tick)

Amount.

5

Numeric [0-9]+

(tick)

6

Alphabetic data [A-Z, a-z]

(tick)

The three-character ISO currency code.

7

Alphabetic data [A-Z, a-z]

(error)

A shopper's reference, which is the unique identifier for a shopper.

Required element for recurring payments and to create recurring contracts.

8

Email address

(error)

A shopper's email address.

Required element for recurring payments and to create recurring contracts.

9

Alphabetic data [A-Z, a-z]

(error)

Shopper statement.
The soft descriptor for the transaction.

10

IP address

(error)

The IP address the shopper used to carry out the transaction.

11

Numeric [0-9]+

(error)

Fraud offset.
The value to be applied to offset the calculated risk score.
It can be either a positive or a negative value.

Besides the required sub-lines described above, a refund with data request needs to include one of the following payment methods.

  • This sub-line holds information about card payments.
  • In an authorization request for card payments, the Card sub-line needs to be submitted as sub-line 2.

Field #

Format

Required

Description

1

Fixed value: SL

(tick)

Record type identifier

2

Numeric [0-9]+

(tick)
SL sub-line record number reference within its parent line.

The counter starts at 1, and it increments sequentially by one unit.

3

Fixed value: Card

(tick)

Transaction type.
Defines the required field types for the specific sub-line.

4

Numeric [0-9]+

(tick)

Card number.

5

Numeric [0-9]+

(tick)

Expiry month.

  • Format: MM, zero-padded (eg: 03)

6

Numeric [0-9]+

(tick)

Expiry year.

  • Format: YYYY (eg: 2016)
7

Numeric [0-9]+

(tick)

CVC code.

  • Three-digit CVC/CVV code (Visa, Mastercard, Discover)
  • Four-digit CVC/CVV code (American Express)

8

Alphabetic data [A-Z, a-z]

(tick)

Cardholder name.

9

Numeric [0-9]+

(error)

Start month.

  • Format: MM, zero-padded (eg: 03)

Maestro UK only.

10

Numeric [0-9]+

(error)

Start year.

  • Format: YYYY (eg: 2016)

Maestro UK only.

11

Numeric [0-9]+

(error)

One-digit card issue number.

Maestro UK only.

Example

FH,1.0,TEST,Company,TestCompany,Default,1,ws@Company.TestCompany,RefundWithData,FileHeaderEchoData
BH,1,BlockHeaderEchoData 
L,1,MerchantAccount,TestMerchant,RefundWithData,MerchantReference, 
SL,1,PaymentDetails,100,2,EUR,,,,, 
SL,2,Card,4111111111111111,06,2016,CardHolderName,,, 
BT,1
FT,1

  • This sub-line holds information about bank transfer or SEPA Direct Debit (DD) payments carried out using the shopper's IBAN details.
  • In an authorization request for IBAN payments, the IBAN sub-line needs to be submitted as sub-line 2.

Field #

Format

Required

Description

1

Fixed value: SL

(tick)

Record type identifier

2

Numeric [0-9]+

(tick)

SL sub-line record number reference within its parent line.

The counter starts at 1, and it increments sequentially by one unit.

3

Fixed value: IBAN

(tick)

Transaction type.
Defines the required field types for the specific sub-line.

4

Alphabetic data [A-Z, a-z]

(tick)

Bank account owner name.

5

Alphabetic data [A-Z, a-z]

(tick)

Two-letter country code.

The country value format needs to adhere to the ISO 3166-1 alpha-2 standard. An invalid country code results in a transaction/request rejection. You can look up country codes on the ISO web site.

6

Alphabetic data [A-Z, a-z]

(tick)

IBAN code.

7

Alphabetic data [A-Z, a-z]

(error)

BIC code.

Example

FH,1.0,TEST,Company,TestCompany,Default,1,ws@Company.TestCompany,RefundWithData,FileHeaderEchoData
BH,1,BlockHeaderEchoData 
L,1,MerchantAccount,TestMerchant,RefundWithData,MerchantReference, 
SL,1,PaymentDetails,100,2,EUR,,,,, 
SL,2,IBAN,Simon Hopper,GB,GB57RBOS16121110041073,
BT,1
FT,1

Optional sub-lines

The sub-lines described below can be optionally included in the payment request.


You can use the Address sub-line to include information about the shopper's billing and delivery addresses.
You need to specify billing and deliver addresses on separate Address sub-lines:

  • One Address sub-line containing the billing address information;
  • One Address sub-line containing the delivery address information.


Field #

Format

Required

Description

1

Fixed value: SL

(tick)

Record type identifier

2

Numeric [0-9]+

(tick)
SL sub-line record number reference within its parent line.

The counter starts at 1, and it increments sequentially by one unit.
3

Fixed value: Address

(tick)

Transaction type.
Defines the required field types for the specific sub-line.

4

Allowed values:

  • Billing
  • Delivery

(tick)

The type of address that is being submitted: either a billing or a delivery address.

5

Alphabetic data [A-Z, a-z]

(tick)

Street address.

6

Alphabetic data [A-Z, a-z]

(tick)

House number or name.

7

Alphabetic data [A-Z, a-z]

(tick)

City.

8

Alphabetic data [A-Z, a-z]

(tick)

ZIP/Post code.

9

Alphabetic data [A-Z, a-z]

(tick)

State/Province/Region.

10

Alphabetic data [A-Z, a-z]

(tick)

Two-letter country code.

The country value format needs to adhere to the ISO 3166-1 alpha-2 standard. An invalid country code results in a transaction/request rejection. You can look up country codes on the ISO web site.

Payout request file

Payout lines

The line record [L] holds the metadata information that applies to its corresponding sub-line [SL] records.

Field #

Format

Required

Description

1

Fixed value: L

(tick)

Record type identifier.

2

Numeric [0-9]+

(tick)

L line record number reference within the batch file block it belongs to.

The counter starts at 1, and it increments sequentially by one unit.

3

Fixed value: MerchantAccount

(tick)

Account type.
Defines the type of account the transactions are related to.

4

Alphabetic data [A-Z, a-z]

(tick)

Specifies the merchant account name.

5

Allowed values:
  • Payout

(tick)

Processing type.
Defines the type of action that is required for the specified transaction.

6

Alphabetic data [A-Z, a-z]

(tick)

A unique identifier associated to a specific transaction.

As for modification requests, the merchant reference value can either:

  • Keep the same value and refer to the original payment authorisation reference. Or
  • Take a new reference value for the modification request in question.

7

Alphabetic data [A-Z, a-z]

(error)

EchoData

In this field you can specify any data you may want to be returned with the result file.
When this field is populated, its content is returned exactly as is.
The Adyen system does not use this data.

Maximum character length: 80 characters.

Payout sub-lines

The number and the type of sub-lines that you need to include:

Payout request

Mandatory sub-lines

The sub-lines described below are mandatory when submitting a payout authorisation request.

  • This sub-line specifies transaction amount and customer details.
  • Optional fields: if you do not populate one or more non-mandatory fields and leave them blank, you need in any case to insert delimiting commas because our system expects a preset, fixed number of fields per line/sub-line.

Field #

Format

Required

Description

1

Fixed value: SL (tick)

Record type identifier

2

Numeric [0-9]+

(tick)

SL sub-line record number reference within its parent line.

The counter starts at 1, and it increments sequentially by one unit.

3

Fixed value: PayoutDetails

(tick)

Transaction type.
Defines the required field types for the specific sub-line.

4

Numeric [0-9]+

(tick)

Amount.

5

Numeric [0-9]+

(tick)

6

Alphabetic data [A-Z, a-z]

(tick)

The three-character ISO currency code.

7

Alphabetic data [A-Z, a-z]

(tick)

A shopper's reference, which is the unique identifier for a shopper.

8

Email address

(tick)

A shopper's email address.

9

Alphabetic data [A-Z, a-z]

(error)

Shopper statement.
The soft descriptor for the transaction.

10

IP address

(error)

The IP address the shopper used to carry out the transaction.

Field #

Format

Required

Description

1

Fixed value: SL (tick)

Record type identifier

2

Numeric [0-9]+

(tick)

SL sub-line record number reference within its parent line.

The counter starts at 1, and it increments sequentially by one unit.

3

Fixed value: Recurring

(tick)

Transaction type.
Defines the required field types for the specific sub-line.

4

Fixed value: PAYOUT

(tick)

The type of recurring payment.

5

Fixed value: Latest

(tick)

Fixed value.

Besides the required sub-lines described above, a payout request needs to include one of the following payment methods.

For this payout, you need a user role with permission to store payout details.

  • This sub-line holds information about card payments.
  • In an authorization request for card payments, the Card sub-line needs to be submitted as sub-line 2.

Field #

Format

Required

Description

1

Fixed value: SL

(tick)

Record type identifier

2

Numeric [0-9]+

(tick)
SL sub-line record number reference within its parent line.

The counter starts at 1, and it increments sequentially by one unit.

3

Fixed value: Card

(tick)

Transaction type.
Defines the required field types for the specific sub-line.

4

Numeric [0-9]+

(tick)

Card number.

5

Numeric [0-9]+

(tick)

Expiry month.

  • Format: MM, zero-padded (eg: 03)

6

Numeric [0-9]+

(tick)

Expiry year.

  • Format: YYYY (eg: 2016)
7

Numeric [0-9]+

(tick)

CVC code.

  • Three-digit CVC/CVV code (Visa, Mastercard, Discover)
  • Four-digit CVC/CVV code (American Express)

8

Alphabetic data [A-Z, a-z]

(tick)

Cardholder name.

9

Numeric [0-9]+

(error)

Start month.

  • Format: MM, zero-padded (eg: 03)

Maestro UK only.

10

Numeric [0-9]+

(error)

Start year.

  • Format: YYYY (eg: 2016)

Maestro UK only.

11

Numeric [0-9]+

(error)

One-digit card issue number.

Maestro UK only.

Example

FH,1.0,TEST,Company,TestCompany,Default,1,storeToken@Company.TestCompany,Payout,FileHeaderEchoData 
BH,1,BlockHeaderEchoData
L,1,MerchantAccount,TestMerchant,Payout,MerchantReference,
SL,1,PayoutDetails,1000,2,EUR,test@adyen.com,test@adyen.com,,,
SL,2,Card,4444333322221111,12,2012,J. de Tester,,,
SL,3,Recurring,PAYOUT,LATEST
BT,1 
FT,1

  • This sub-line holds information about bank transfer payments carried out using the shopper's bank account details.
  • In an authorisation request for bank account payments, the BankAccount sub-line needs to be submitted as sub-line 2.

Field #

Format

Required

Description

1

Fixed value: SL

(tick)

Record type identifier

2

Numeric [0-9]+

(tick)

SL sub-line record number reference within its parent line.

The counter starts at 1, and it increments sequentially by one unit.

3

Fixed value: BankAccount

(tick)

Transaction type.
Defines the required field types for the specific sub-line.

4

Alphabetic data [A-Z, a-z]

(tick)

Two-letter bank account owner name.

  • Format: AA

5

Alphabetic data [A-Z, a-z]

(tick)

Two-letter country code.

The country value format needs to adhere to the ISO 3166-1 alpha-2 standard. An invalid country code results in a transaction/request rejection. You can look up country codes on the ISO web site.

6

Numeric [0-9]+

(tick)

Bank account number.

7

Alphabetic data [A-Z, a-z]

(tick)

Two-letter bank location.

  • Format: AA

8

Alphabetic data [A-Z, a-z]

(tick)

Two-letter bank name.

  • Format: AA

9

Numeric [0-9]+

(tick)

Bank code.

10

Alphabetic data [A-Z, a-z]

(error)

Two-letter check code.

  • Format: AA

Example

FH,1.0,TEST,Company,TestCompany,Default,1,storeToken@Company.TestCompany,Payout,FileHeaderEchoData 
BH,1,BlockHeaderEchoData
L,1,MerchantAccount,TestMerchant,Payout,MerchantReference,
SL,1,PayoutDetails,1000,2,EUR,test@adyen.com,test@adyen.com,,,
SL,2,BankAccount,Simon Hopper,SE,123456789,20010020,Postbank Stockholm,3125876,Hameln
SL,3,Recurring,PAYOUT,LATEST
BT,1 
FT,1

  • This sub-line holds information about bank transfer or SEPA Direct Debit (DD) payments carried out using the shopper's IBAN details.
  • In an authorization request for IBAN payments, the IBAN sub-line needs to be submitted as sub-line 2.

Field #

Format

Required

Description

1

Fixed value: SL

(tick)

Record type identifier

2

Numeric [0-9]+

(tick)

SL sub-line record number reference within its parent line.

The counter starts at 1, and it increments sequentially by one unit.

3

Fixed value: IBAN

(tick)

Transaction type.
Defines the required field types for the specific sub-line.

4

Alphabetic data [A-Z, a-z]

(tick)

Bank account owner name.

5

Alphabetic data [A-Z, a-z]

(tick)

Two-letter country code.

The country value format needs to adhere to the ISO 3166-1 alpha-2 standard. An invalid country code results in a transaction/request rejection. You can look up country codes on the ISO web site.

6

Alphabetic data [A-Z, a-z]

(tick)

IBAN code.

7

Alphabetic data [A-Z, a-z]

(error)

BIC code.

Example

FH,1.0,TEST,Company,TestCompany,Default,1,storeToken@Company.TestCompany,Payout,FileHeaderEchoData 
BH,1,BlockHeaderEchoData
L,1,MerchantAccount,TestMerchant,Payout,MerchantReference,
SL,1,PayoutDetails,1000,2,EUR,test@adyen.com,test@adyen.com,,,
SL,2,IBAN,Simon Hopper,GB,GB57RBOS16121110041073,
SL,3,Recurring,PAYOUT,LATEST
BT,1 
FT,1

PayoutModification request file

PayoutModification lines

The line record [L] holds the metadata information that applies to its corresponding sub-line [SL] records.

Field #

Format

Required

Description

1

Fixed value: L

(tick)

Record type identifier

2

Numeric [0-9]+

(tick)

L line record number reference within the batch file block it belongs to.

The counter starts at 1, and it increments sequentially by one unit.

3

Fixed value: MerchantAccount

(tick)

Account type.
Defines the type of account the transactions are related to.

4

Alphabetic data [A-Z, a-z]

(tick)

Specifies the merchant account name.

5

Allowed values:

  • PayoutConfirm
  • PayoutDecline

(tick)

Processing type.
Defines the type of action that is required for the specified transaction.

 

6

Alphabetic data [A-Z, a-z]

(tick)

A unique identifier associated to a specific transaction.

7

Alphabetic data [A-Z, a-z]

(error)

EchoData

In this field you can specify any data you may want to be returned with the result file.
When this field is populated, its content is returned exactly as is.
The Adyen system does not use this data.

Maximum character length: 80 characters.

PayoutModification sub-lines

The number and the type of sub-lines that you need to include varies, depending on the payout modification specified in the request: either PayoutConfirm or PayoutDecline.

PayoutConfirm request

Mandatory sub-lines

 This sub-line holds information about payout confirmation requests.

Field #

Format

Required

Description

1

Fixed value: SL (tick)

Record type identifier

2

Numeric [0-9]+

(tick)

SL sub-line record number reference within its parent line.

The counter starts at 1, and it increments sequentially by one unit.

3

Fixed value: PayoutConfirm

(tick)

Transaction type.
Defines the required field types for the specific sub-line.

4

Numeric [0-9]+

(tick)

The original payout PSP reference.

Example

FH,1.0,TEST,Company,TestCompany,Default,1,reviewPayout@Company.TestCompany,PayoutModification,FileHeaderEchoData
BH,1,BlockHeaderEchoData
L,1,MerchantAccount,TestMerchant,PayoutConfirm,MerchantReference,
SL,1,PayoutConfirm,9913122736590001
BT,1
FT,1

For this PayoutConfirm, you need a user role with permission to review/decline a payout.

PayoutDecline request

Mandatory sub-lines

 This sub-line holds information about payout decline requests.

Field #

Format

Required

Description

1

Fixed value: SL (tick)

Record type identifier

2

Numeric [0-9]+

(tick)

SL sub-line record number reference within its parent line.

The counter starts at 1, and it increments sequentially by one unit.

3

Fixed value: PayoutDecline

(tick)

Transaction type.
Defines the required field types for the specific sub-line.

4

Numeric [0-9]+

(tick)

The original payout PSP reference.

Example

FH,1.0,TEST,Company,TestCompany,Default,1,reviewPayout@Company.TestCompany,PayoutModification,FileHeaderEchoData
BH,1,BlockHeaderEchoData
L,1,MerchantAccount,TestMerchant,PayoutDecline,MerchantReference,
SL,1,PayoutDecline,9913122736590001
BT,1
FT,1

For this PayoutDecline, you need a user role with permission to review/decline a payout.

AccountUpdater request file

AccountUpdater lines

The line record [L] holds the metadata information that applies to its corresponding sub-line [SL] records.

Field #

Format

Required

Description

1

Fixed value: L

(tick)

Record type identifier.

2

Numeric [0-9]+

(tick)

L line record number reference within the batch file block it belongs to.

The counter starts at 1, and it increments sequentially by one unit.

3

Fixed value: MerchantAccount

(tick)

Account type.
Defines the type of account the transactions are related to.

4

Alphabetic data [A-Z, a-z]

(tick)

Specifies the merchant account name.

5

Fixed value: AccountUpdater  

(tick)

Processing type.
Defines the type of action that is required for the specified transaction.

6

Alphabetic data [A-Z, a-z]

(tick)

A unique identifier associated to a specific transaction.

7

Alphabetic data [A-Z, a-z]

(error)

EchoData

In this field you can specify any data you may want to be returned with the result file.
When this field is populated, its content is returned exactly as is.
The Adyen system does not use this data.

Maximum character length: 80 characters.

AccountUpdater sub-lines

Account updater requests have two sub-lines.

AccountUpdaterRecurring request

You can make an AccountUpdaterRecurring request when no payment details for the shopper are available.
The AccountUpdaterRecurring request stores shopper payment details in a recurring contract.

Mandatory sub-lines

Field #

Format

Required

Description

1

Fixed value: SL
(tick)

Record type identifier

2

Numeric [0-9]+

(tick)

SL sub-line record number reference within its parent line.

The counter starts at 1, and it increments sequentially by one unit.

3

Fixed value: AccountUpdaterRecurring

(tick)

Transaction type.
Defines the required field types for the specific sub-line.

4

Alphabetic data [A-Z, a-z]

(tick)

A shopper's reference, which is the unique identifier for a shopper.

5
Alphabetic data [A-Z, a-z]
(tick)
Allowed values:
  • If the card details are not stored - The card alias
  • If the card details are stored:
    • recurringDetailReference Or
    • LATEST

Example

FH,1.0,TEST,Company,TestCompany,Default,1,ws@Company.TestCompany,AccountUpdater,FileHeaderEchoData
BH,1,BlockHeaderEchoData
L,1,MerchantAccount,TestMerchant,AccountUpdater,MerchantReference1,EchoData1
SL,1,AccountUpdaterRecurring,s.hopper@email.com,LATEST
BT,1
FT,1

AccountUpdaterSingle request

You can make an AccountUpdaterSingle request when the shopper's card details are at least partially available in your records.

You can send live/actual card numbers with your batch file only if you encrypt the file with PGP before submitting it.

Mandatory sub-lines

This sub-line holds information about single, ad-hoc account update requests.

Field #

Format

Required

Description

1

Fixed value: SL

(tick)

Record type identifier

2

Numeric [0-9]+

(tick)
SL sub-line record number reference within its parent line.

The counter starts at 1, and it increments sequentially by one unit.

3

Fixed value: AccountUpdaterSingle

(tick)

Transaction type.
Defines the required field types for the specific sub-line.

4

Alphabetic data [A-Z, a-z]

(tick)

Card number or card alias.

5

Numeric [0-9]+

(tick)

Expiry month.

  • Format: MM, zero-padded (eg: 03)

6

Numeric [0-9]+

(tick)

Expiry year.

  • Format: YYYY (eg: 2016)

7

Numeric [0-9]+
(error)

CVC code.
Leave this field blank.

8

Alphabetic data [A-Z, a-z]

(tick)

Cardholder name.

9

Numeric [0-9]+

(error)

Start month.

  • Format: MM, zero-padded (eg: 03)

Maestro UK only.

10

Numeric [0-9]+

(error)

Start year.

  • Format: YYYY (eg: 2016)

Maestro UK only.

11

Numeric [0-9]+

(error)

One-digit card issue number.

Maestro UK only.

Example

FH,1.0,TEST,Company,TestCompany,Default,1,ws@Company.TestCompany,AccountUpdater,FileHeaderEchoData
BH,1,BlockHeaderEchoData
L,1,MerchantAccount,TestMerchant,AccountUpdater,MerchantReference1,EchoData1
SL,1,AccountUpdaterSingle,4111111111111111,06,2016,,CardHolderName,,,
BT,1
FT,1

StoreToken request file

storeToken lines

The line record [L] holds the metadata information that applies to its corresponding sub-line [SL] records.

Field #

Format

Required

Description

1

Fixed value: L

(tick)

Record type identifier.

2

Numeric [0-9]+

(tick)

L line record number reference within the batch file block it belongs to.

The counter starts at 1, and it increments sequentially by one unit.

3

Fixed value: MerchantAccount

(tick)

Account type.
Defines the type of account the transactions are related to.

4

Alphabetic data [A-Z, a-z]

(tick)

Specifies the merchant account name.

5

Allowed values:
  • storeToken

(tick)

Processing type.
Defines the type of action that is required for the specified transaction.

6

Alphabetic data [A-Z, a-z]

(tick)

A unique identifier associated to a specific transaction.

As for modification requests, the merchant reference value can either:

  • Keep the same value and refer to the original payment authorisation reference. Or
  • Take a new reference value for the modification request in question.

7

Alphabetic data [A-Z, a-z]

(error)

EchoData

In this field you can specify any data you may want to be returned with the result file.
When this field is populated, its content is returned exactly as is.
The Adyen system does not use this data.

Maximum character length: 80 characters.

StoreToken sub-lines

The number and the type of sub-lines that you need to include.

StoreToken request for payout

Mandatory sub-lines

The sub-lines described below are mandatory when submitting a StoreToken request.

  • StoreToken enables tokenising payment details.
  • Only payment requests submitted after sending the StoreToken request are tokenised.

  • This sub-line specifies transaction amount and customer details.
  • Optional fields: if you do not populate one or more non-mandatory fields and leave them blank, you need in any case to insert delimiting commas because our system expects a preset, fixed number of fields per line/sub-line.

Field #

Format

Required

Description

1

Fixed value: SL (tick)

Record type identifier

2

Numeric [0-9]+

(tick)

SL sub-line record number reference within its parent line.

The counter starts at 1, and it increments sequentially by one unit.

3

Fixed value: ShopperDetails

(tick)

Transaction type.
Defines the required field types for the specific sub-line.

4

Alphabetic data [A-Z, a-z]

(tick)

A shopper's reference, which is the unique identifier for a shopper.

5 Email address (tick)

A shopper's email address.

If you include this subline in your batch file, a recurring payment request is created with the provided payment details.

Field #

Format

Required

Description

1

Fixed value: SL (tick)

Record type identifier

2

Numeric [0-9]+

(tick)

SL sub-line record number reference within its parent line.

The counter starts at 1, and it increments sequentially by one unit.

3

Fixed value: Recurring

(tick)

Transaction type.
Defines the required field types for the specific sub-line.

4

Fixed value: PAYOUT

(tick)

The type of recurring payment.

5

Fixed value: Latest

(tick)

Fixed value.

Besides the required sub-lines described above, a StoreToken request needs to include one of the following payment methods.

For this StoreToken, you need a user role with permission to store payout details.

  • This sub-line holds information about card payments.
  • In an authorisation request for card payments, the Card sub-line needs to be submitted as sub-line 2.

Field #

Format

Required

Description

1

Fixed value: SL

(tick)

Record type identifier

2

Numeric [0-9]+

(tick)
SL sub-line record number reference within its parent line.

The counter starts at 1, and it increments sequentially by one unit.

3

Fixed value: Card

(tick)

Transaction type.
Defines the required field types for the specific sub-line.

4

Numeric [0-9]+

(tick)

Card number.

5

Numeric [0-9]+

(tick)

Expiry month.

  • Format: MM, zero-padded (ex.: 03)

6

Numeric [0-9]+

(tick)

Expiry year.

    • Format: YYYY (ex.: 2016)
7

Numeric [0-9]+

(error)

CVC code.
Leave this field blank.

8

Alphabetic data [A-Z, a-z]

(tick)

Card holder name.

9

Numeric [0-9]+

(error)

Start month.

  • Format: MM, zero-padded (ex.: 03)

Maestro UK only.

10

Numeric [0-9]+

(error)

Start year.

  • Format: YYYY (ex.: 2016)

Maestro UK only.

11

Numeric [0-9]+

(error)

One-digit card issue number.

Maestro UK only.

Example

FH,1.0,TEST,Company,TestCompany,Default,1,storeToken@Company.TestCompany,Payout,FileHeaderEchoData 
BH,1,BlockHeaderEchoData 
L,1,MerchantAccount,TestMerchant,StoreToken,MerchantReference,
SL,1,ShopperDetails,test@adyen.com,test@adyen.com
SL,2,Card,4444333322221111,12,2012,,J. de Tester,,,
SL,3,Recurring,PAYOUT,Latest
BT,1 
FT,1

  • This sub-line holds information about bank transfer payments carried out using the shopper's bank account details.
  • In an authorisation request for bank account payments, the BankAccount sub-line needs to be submitted as sub-line 2.

Field #

Format

Required

Description

1

Fixed value: SL

(tick)

Record type identifier

2

Numeric [0-9]+

(tick)

SL sub-line record number reference within its parent line.

The counter starts at 1, and it increments sequentially by one unit.

3

Fixed value: BankAccount

(tick)

Transaction type.
Defines the required field types for the specific sub-line.

4

Alphabetic data [A-Z, a-z]

(tick)

Two-letter bank account owner name.

  • Format: AA

5

Alphabetic data [A-Z, a-z]

(tick)

Two-letter country code.

The country value format needs to adhere to the ISO 3166-1 alpha-2 standard. An invalid country code results in a transaction/request rejection. You can look up country codes on the ISO web site.

6

Numeric [0-9]+

(tick)

Bank account number.

7

Alphabetic data [A-Z, a-z]

(tick)

Two-letter bank location.

  • Format: AA

8

Alphabetic data [A-Z, a-z]

(tick)

Two-letter bank name.

  • Format: AA

9

Numeric [0-9]+

(tick)

Bank code.

10

Alphabetic data [A-Z, a-z]

(error)

Two-letter check code.

  • Format: AA

Example

FH,1.0,TEST,Company,TestCompany,Default,1,storeToken@Company.TestCompany,Payout,FileHeaderEchoData 
BH,1,BlockHeaderEchoData 
L,1,MerchantAccount,TestMerchant,StoreToken,MerchantReference,
SL,1,ShopperDetails,test@adyen.com,test@adyen.com
SL,2,BankAccount,Simon Hopper,SE,123456789,20010020,Postbank Stockholm,3125876,Hameln
SL,3,Recurring,PAYOUT,Latest
BT,1 
FT,1

  • This sub-line holds information about bank transfer or SEPA Direct Debit (DD) payments carried out using the shopper's IBAN details.
  • In an authorization request for IBAN payments, the IBAN sub-line needs to be submitted as sub-line 2.

Field #

Format

Required

Description

1

Fixed value: SL

(tick)

Record type identifier

2

Numeric [0-9]+

(tick)

SL sub-line record number reference within its parent line.

The counter starts at 1, and it increments sequentially by one unit.

3

Fixed value: IBAN

(tick)

Transaction type.
Defines the required field types for the specific sub-line.

4

Alphabetic data [A-Z, a-z]

(tick)

Bank account owner name.

5

Alphabetic data [A-Z, a-z]

(tick)

Two-letter country code.

The country value format needs to adhere to the ISO 3166-1 alpha-2 standard. An invalid country code results in a transaction/request rejection. You can look up country codes on the ISO web site.

6

Alphabetic data [A-Z, a-z]

(tick)

IBAN code.

7

Alphabetic data [A-Z, a-z]

(error)

BIC code.

Example

FH,1.0,TEST,Company,TestCompany,Default,1,storeToken@Company.TestCompany,Payout,FileHeaderEchoData 
BH,1,BlockHeaderEchoData 
L,1,MerchantAccount,TestMerchant,StoreToken,MerchantReference,
SL,1,ShopperDetails,test@adyen.com,test@adyen.com
SL,2,IBAN,Simon Hopper,GB,GB57RBOS16121110041073,
SL,3,Recurring,PAYOUT,Latest
BT,1 
FT,1

Batch result file

The following fields are included in all batch result files.

The File Header [FH] record contains the data that was passed in the batch request file header.

Field #

Format

Description

1

Fixed value: FH

Record type identifier.

2

Fixed value: 1.0

Version number.
This field enables version control for the release of future enhancements for batch processing.

3

Allowed values:

  • TEST
  • LIVE

It specifies the environment: either test or live/production.

4

Allowed values:
  • MerchantAccount
  • Company

Account type, as submitted in the request file.

5

Alphabetic data [A-Z, a-z]

The merchant or the company account name, as submitted in the request file.

6

Alphabetic data [A-Z, a-z]

The submission platform value provided in the request file.

7

Numeric [0-9]+

The file sequence number value provided in the request file.

8

Alphabetic data [A-Z, a-z]

The WS user name specified to upload the file to the SFTP.

9

Allowed values:

The file type value provided in the request file.

10

Alphabetic data [A-Z, a-z]

The file header EchoData value provided in the corresponding request file.
If you do not pass any value in the corresponding field in the request file, this field is blank.

The File Trailer [FT] record specifies the number of blocks in the file.

Field #

Format

Description

1

Fixed value: FT

Record type identifier

2

Numeric [0-9]+

Number of blocks in the file.

The Block Header [BH] record specifies the information that was passed in the batch request block header.

Field #

Format

Description

1

Fixed value: BH

Record type identifier

2

Numeric [0-9]+

Block number.
Its value increments sequentially by one unit per block.


3

Alphabetic data [A-Z, a-z]

The block header EchoData value provided in the corresponding request file.
If you do not pass any value in the corresponding field in the request file, this field is blank.

The Block Trailer [BT] record specifies the number of lines in the block.

Field #

Format

Description

1

Fixed value: BT

Record type identifier

2

Numeric [0-9]+

Number of line records in the block.


Example

FH,1.0,TEST,MerchantAccount,TestCompany,Default,1,ws@Company.TestCompany,Authorisation,FileHeaderEchoData
BH,1,BlockHeaderEchoData
...
BT,5
FT,1

Authorisation result file

Authorisation line

The line record [L] holds the metadata information that applies to its corresponding sub-line [SL] records.

Field #

Format

Description

1

Fixed value: L

Record type identifier

2

Numeric [0-9]+

L line record number reference within the batch file block it belongs to.

The counter starts at 1, and it increments sequentially by one unit.

3

Fixed value: MerchantAccount

Account type.
Defines the type of account the transactions are related to.

4

Alphabetic data [A-Z, a-z]

Specifies the merchant account name.

5

Fixed value: Authorisation

Processing type.
Defines the type of action that is required for the specified transaction.

6

Alphabetic data [A-Z, a-z]

A unique identifier associated to a specific transaction.

7
Allowed values:
  • Success
  • Authorised
  • Refused
  • Cancelled
  • Received
  • Error

Transaction status.

8

Alphabetic data [A-Z, a-z]

EchoData

In this field you can specify any data you may want to be returned with the result file.
When this field is populated, its content is returned exactly as is.
The Adyen system does not use this data.

Maximum character length: 80 characters.

Authorisation sub-line

Field #

Format

Description

1

Fixed value: SL

Record type identifier.

2

Numeric [0-9]+

SL sub-line record number reference within its parent line.

The counter starts at 1, and it increments sequentially by one unit.

3

Fixed value: PaymentResult

Result type identifier.

4

Numeric [0-9]+

The original payment PSP reference.

5
Alphabetic data [A-Z, a-z]

Authorisation code: 

  • When the payment is authorised successfully, this field holds the authorisation code for the payment. 
  • When the payment is not authorised, this field is empty.

6

Alphabetic data [A-Z, a-z]

Result code, if available.

7

Alphabetic data [A-Z, a-z]

When the payment is not authorised, it is refused, or if an error occurs, this field holds Adyen's mapped reason for the refusal or a description of the error. 

Example

FH,1.0,TEST,Company,TestCompany,Default,206,ws@Company.TestCompany,Authorisation,FileHeaderEchoData 
BH,1,BlockHeaderEchoData 
L,1,MerchantAccount,TestMerchant,Authorisation,9874563210158741,Authorised,EchoData
SL,1,PaymentResult,9874563210158741,85421,100,Approved
L,2,MerchantAccount,TestMerchant,Authorisation,9874563210157874,Refused,
SL,1,PaymentResult,9874563210157874,,140,Invalid expiry date
BT,2 
FT,1

Modification result file

Modification line

The line record [L] holds the metadata information that applies to its corresponding sub-line [SL] records.

Field #

Format

Description

1

Fixed value: L

Record type identifier.

2

Numeric [0-9]+

L line record number reference within the batch file block it belongs to.

The counter starts at 1, and it increments sequentially by one unit.

3

Fixed value: MerchantAccount

Account type.
Defines the type of account the transactions are related to.

4

Alphabetic data [A-Z, a-z]

Specifies the merchant account name.

5

Allowed values:

  • Cancel
  • Refund
  • Capture
  • CaptureOrRefund
  • AuthoriseReferral

Processing type.
Defines the type of action that is required for the specified transaction.

6

Alphabetic data [A-Z, a-z]

A unique identifier associated to a specific transaction.

This field is populated and is returned if an optional merchant reference value is included in the corresponding request file.

7
Allowed values:
  • Success
  • Error
  • Pending

Transaction status.
A Pending status means that the modification request needs to be postponed for processing.



8

Alphabetic data [A-Z, a-z]

EchoData

In this field you can specify any data you may want to be returned with the result file.
When this field is populated, its content is returned exactly as is.
The Adyen system does not use this data.

Maximum character length: 80 characters.

Modification sub-line

Field #

Format

Description

1

Fixed value: SL

Record type identifier.

2

Numeric [0-9]+

SL sub-line record number reference within its parent line.

The counter starts at 1, and it increments sequentially by one unit.

3

Fixed value: ModificationResult

Result type identifier.

4

Numeric [0-9]+

The unique PSP reference identifier for this modification.

5

Numeric [0-9]+

The unique PSP reference identifier for the original payment authorisation.

6

Alphabetic data [A-Z, a-z]

When the payment is not authorised, it is refused, or if an error occurs, this field holds Adyen's mapped reason for the refusal or a description of the error.

Example

FH,1.0,TEST,Company,TestCompany,Default,1,ws@Company.TestCompany,Modification,FileHeaderEchoData 
BH,1,BlockHeaderEchoData 
L,1,MerchantAccount,TestMerchant,Capture,9874560210158741,Success,
SL,1,ModificationResult,9874560210158741,9248732154865245, 
L,2,MerchantAccount,TestMerchant,Capture,9541236985175236,Error,EchoData1 
SL,1,ModificationResult,9541236985175236,9248732154851572,Transaction not found 
L,3,MerchantAccount,TestMerchant,Refund,95412367785175236,Error,EchoData2 
SL,1,ModificationResult,95412367785175236,9358752154851572,Insufficient balance 
BT,3 
FT,1

RefundWithData result file

RefundWithData line

The line record [L] holds the metadata information that applies to its corresponding sub-line [SL] records.

Field #

Format

Description

1

Fixed value: L

Record type identifier.

2

Numeric [0-9]+

L line record number reference within the batch file block it belongs to.

The counter starts at 1, and it increments sequentially by one unit.

3

Fixed value: MerchantAccount

Account type.
Defines the type of account the transactions are related to.

4

Alphabetic data [A-Z, a-z]

Specifies the merchant account name.

5

Fixed value: RefundWithData

Processing type.
Defines the type of action that is required for the specified transaction.

6

Alphabetic data [A-Z, a-z]

A unique identifier associated to a specific transaction.

7
Allowed values:
  • Success
  • Authorised
  • Refused
  • Cancelled
  • Received
  • Error

Transaction status.

8

Alphabetic data [A-Z, a-z]

EchoData

In this field you can specify any data you may want to be returned with the result file.
When this field is populated, its content is returned exactly as is.
The Adyen system does not use this data.

Maximum character length: 80 characters.

RefundWithData sub-line

Field #

Format

Description

1

Fixed value: SL

Record type identifier.

2

Numeric [0-9]+

SL sub-line record number reference within its parent line.

The counter starts at 1, and it increments sequentially by one unit.

3

Fixed value: RefundWithDataResult

Result type identifier.

4

Numeric [0-9]+

The original payment PSP reference.

5

Alphabetic data [A-Z, a-z]

Authorisation code: 

  • When the payment is authorised successfully, this field holds the authorisation code for the payment. 
  • When the payment is not authorised, this field is empty.

6

Alphabetic data [A-Z, a-z]

Result code, if available.

7

Alphabetic data [A-Z, a-z]

When the payment is not authorised, it is refused, or if an error occurs, this field holds Adyen's mapped reason for the refusal or a description of the error.

Example

FH,1.0,TEST,Company,TestCompany,Default,1,ws@Company.TestCompany,RefundWithData,FileHeaderEchoData
BH,1,BlockHeaderEchoData 
L,1,MerchantAccount,TestMerchant,RefundWithData,MerchantReference,Received, 
SL,1,RefundWithDataResult,9913963568780883,,Received, 
BT,1 
FT,1

Payout result file

Payout line

The line record [L] holds the metadata information that applies to its corresponding sub-line [SL] records.

Field #

Format

Description

1

Fixed value: L

Record type identifier

2

Numeric [0-9]+

L line record number reference within the batch file block it belongs to.

The counter starts at 1, and it increments sequentially by one unit.

3

Fixed value: MerchantAccount

Account type.
Defines the type of account the transactions are related to.

4

Alphabetic data [A-Z, a-z]

Specifies the merchant account name.

5

Allowed values:
  • Payout

Processing type.
Defines the type of action that is required for the specified transaction.

6

Alphabetic data [A-Z, a-z]

A unique identifier associated to a specific transaction.

7

Allowed values:

  • Received
  • Success
  • Error

Transaction status.

8

Alphabetic data [A-Z, a-z]

EchoData

In this field you can specify any data you may want to be returned with the result file.
When this field is populated, its content is returned exactly as is.
The Adyen system does not use this data.

Maximum character length: 80 characters.

Payout sub-line

 This sub-line holds information about payout request responses.

Field #

Format

Description

1

Fixed value: SL

Record type identifier.

2

Numeric [0-9]+

SL sub-line record number reference within its parent line.

The counter starts at 1, and it increments sequentially by one unit.

3

Fixed value: PayoutResult

Result type identifier.

4

Numeric [0-9]+

The unique PSP reference identifier for this modification.

5 Alphabetic data [A-Z, a-z] Result code, if available.
6 Numeric [0-9]+

If the original payout request executed a StoreToken operation as well, this is the unique PSP reference identifier for the stored token.

7 Alphabetic data [A-Z, a-z] If the original payout request executed a StoreToken operation as well, this is the result code of the StoreToken operation, if available.

 This sub-line holds information about  StoreToken operation results.

Field #

Format

Description

1

Fixed value: SL

Record type identifier.

2

Numeric [0-9]+

SL sub-line record number reference within its parent line.

The counter starts at 1, and it increments sequentially by one unit.

3

Fixed value: StoreTokenResult

Result type identifier.

4

Numeric [0-9]+

The unique PSP reference identifier for this modification.

5 Alphabetic data [A-Z, a-z] Result code, if available.

Example

FH,1.0,TEST,Company,TestCompany,Default,1,ws@Company.TestCompany,Payout,FileHeaderEchoData 
BH,1,BlockHeaderEchoData 
L,1,MerchantAccount,TestMerchant,Payout,MerchantReference,Received, 
SL,1,PayoutResult,9913958242217674,[payout-submit-received],9913958242210018,Success 
L,2,MerchantAccount,TestMerchant,StoreToken,MerchantReference,Success, 
SL,1,StoreTokenResult,9913952404820409,Success
BT,2 
FT,1 

PayoutModification result file

PayoutModification line

The line record [L] holds the metadata information that applies to its corresponding sub-line [SL] records.

Field #

Format

Description

1

Fixed value: L

Record type identifier.

2

Numeric [0-9]+

L line record number reference within the batch file block it belongs to.

The counter starts at 1, and it increments sequentially by one unit.

3

Fixed value: MerchantAccount

Account type.
Defines the type of account the transactions are related to.

4

Alphabetic data [A-Z, a-z]

Specifies the merchant account name.

5

Allowed values:

  • PayoutConfirm
  • PayoutDecline

Processing type.
Defines the type of action that is required for the specified transaction.

6

Alphabetic data [A-Z, a-z]

A unique identifier associated to a specific transaction.

7
Allowed values:
  • Success
  • Error
  • Pending

Transaction status.
A Pending status means that the modification request needs to be postponed for processing.



8

Alphabetic data [A-Z, a-z]

EchoData

In this field you can specify any data you may want to be returned with the result file.
When this field is populated, its content is returned exactly as is.
The Adyen system does not use this data.

Maximum character length: 80 characters.

PayoutModification sub-line

Field #

Format

Description

1

Fixed value: SL

Record type identifier.

2

Numeric [0-9]+

SL sub-line record number reference within its parent line.

The counter starts at 1, and it increments sequentially by one unit.

3

Fixed value: ModificationResult

Result type identifier

4

Numeric [0-9]+

The unique PSP reference identifier for this modification.

5

Numeric [0-9]+

 The original payout PSP reference.

6

Alphabetic data [A-Z, a-z]

When the payment is not authorised, it is refused, or if an error occurs, this field holds Adyen's mapped reason for the refusal or a description of the error.

Example

FH,1.0,TEST,Company,TestCompany,Default,1,ws@Company.TestCompany,PayoutModification,FileHeaderEchoData
BH,1,BlockHeaderEchoData 
L,1,MerchantAccount,TestMerchant,PayoutConfirm,MerchantReference,Success, 
SL,1,ModificationResult,9913954058480001,9913122736590001, 
BT,1 
FT,1  

AccountUpdater result file

For Account updater, the result file which includes the full PAN (i.e. 'PANChanged') is encrypted.

 If the result file does not include PAN, a non-encrypted result file is created.

Example:

The file is encrypted if the merchant passed full PAN in the request AND the result file has full PAN.

The file is not encrypted if:

  • The merchant passes full PAN in the request and the result file has no PAN.
  • The merchant did not pass full PAN but used ‘AccountUpdaterRecurring’ in the result file.

AccountUpdater line

The line record [L] holds the metadata information that applies to its corresponding sub-line [SL] records.

Field #

Format

Description

1

Fixed value: L

Record type identifier.

2

Numeric [0-9]+

L line record number reference within the batch file block it belongs to.

The counter starts at 1, and it increments sequentially by one unit.

3

Fixed value: MerchantAccount

Account type.
Defines the type of account the transactions are related to.

4

Alphabetic data [A-Z, a-z]

Specifies the merchant account name.

5

Allowed values:

  • ScheduleAccountUpdater
  • AccountUpdaterAutoUpdate

Specifies the requested transaction type:

  • ScheduleAccountUpdater: returned when merchants submit a standard account updater request.

  • AccountUpdaterAutoUpdate: returned when the account updater request is submitted via the Adyen automatic account updater service.

6

Alphabetic data [A-Z, a-z]

A unique identifier associated to a specific transaction.

7

Allowed values:

  • Scheduled
  • Error
  • Success

Transaction status.
A Pending status means that the modification request needs to be postponed for processing.



8

Alphabetic data [A-Z, a-z]

EchoData

In this field you can specify any data you may want to be returned with the result file.
When this field is populated, its content is returned exactly as is.
The Adyen system does not use this data.

Maximum character length: 80 characters.

AccountUpdater sub-line

Field #

Format

Description

1

Fixed value: SL

Record type identifier

2

Numeric [0-9]+

SL sub-line record number reference within its parent line.

The counter starts at 1, and it increments sequentially by one unit.

3

Allowed values:

  • AccountUpdaterResult
  • AccountUpdaterAutoUpdateResult
  • AccountUpdaterResult: returned when merchants submit a standard account updater request.
    When the result type is AccountUpdaterResult, sub-line field #4 (see below) takes the merchant reference as a value.

  • AccountUpdaterAutoUpdateResult: returned when the account updater request is submitted via the Adyen automatic account updater service or when the request is submitted via an API call.
    When the result type is AccountUpdaterAutoUpdateResult, sub-line field #4 (see below) takes the PSP reference as a value.

4

Numeric [0-9]+

This value corresponds to the pspreference in case of a standard account updater, i.e. when: 

  • [L] Line record field #5 is set to either ScheduleAccountUpdater or AccountUpdaterAutoUpdate;
  • [SL] sub-line record field #3 is set to AccountUpdaterResult.

5

Allowed values:

  • Not Submitted
  • Submitted
  • Not Submitted: returned to inform you that Adyen has already received the same request in the past 7 days. 
  • Submitted: returned to inform you that the record was submitted and processed by the scheme.

6

Examples of some possible values:

  • NoChange
  • CloseAccount
  • PANChanged
  • CardExpiryChanged
  • Error

Account Updater action result.
It describes the result of the action the Account Updater executed.
Its value depends on the corresponding type of action.
For further details on account updater actions, see the Account Updater Manual.

In most cases, if the PAN has changed,  month and year change as well.
7 YYYY-MM-DD

Processed date.
The date when Adyen processed the file we received back from the scheme.

8
Alphabetic data [A-Z, a-z]

New alias.
This field is populated only when an existing alias is updated with a new value.
Otherwise, it is empty.

9

Numeric [0-9]+

New expiry month.

  • Format: MM, zero-padded (ex.: 03)
10

Numeric [0-9]+

New expiry year.

  • Format: YYYY (ex.: 2016)
11

Alphabetic data [A-Z, a-z]

Refusal reason.
This field is populated populated when sub-line field #5 in the account updater result is set to Not Submitted.

12
Alphabetic data [A-Z, a-z]

When you update shopper details and include an updated credit card number, the newly specified card PAN is returned in this field.

This is an optional field.
It is included in an account updater result file only if:

  • The batch file the account updater request is included in is encrypted.
  • You specify a new, valid PAN for the card whose details you want to update.
  • The new PAN number for the card is specified in the request in the mandatory AccountUpdaterSingle sub-line, field #4.

Example

FH,1.0,TEST,Company,TestCompany,Default,1,ws@Company.TestCompany,AccountUpdater,FileHeaderEchoData
BH,1,BlockHeaderEchoData
L,1,MerchantAccount,TestMerchant,ScheduleAccountUpdater,MerchantReference1,Success,EchoData
SL,1,AccountUpdaterResult,2814357209923786,Submitted,NoChange,2013-11-13,,,,
L,2,MerchantAccount,TestMerchant,ScheduleAccountUpdater,MerchantReference2,Success,
SL,1,AccountUpdaterResult,2814357209945789,Submitted,CloseAccount,2013-11-13,,,,
L,3,MerchantAccount,TestMerchant,ScheduleAccountUpdater,MerchantReference3,Success,EchoData
SL,1,AccountUpdaterResult,2814348109845790,Submitted,PANChanged,2013-11-13,D123456789,07,2018,
L,4,MerchantAccount,TestMerchant,ScheduleAccountUpdater,MerchantReference4,Success,EchoData
SL,1,AccountUpdaterResult,2814357201045123,Submitted,CardExpiryChanged,2013-09-15,,03,2017,
L,5,MerchantAccount,TestMerchant,ScheduleAccountUpdater,MerchantReference5,Success,EchoData
SL,1,AccountUpdaterResult,2814336809945456,Submitted,Error,2013-09-15,,,,
L,6,MerchantAccount,TestMerchant,ScheduleAccountUpdater,MerchantReference6,Success,EchoData
SL,1,AccountUpdaterResult,2814357318856890,Not Submitted,,,,,No registered account,
BT,6
FT,1 

Batch acknowledgement file

The fields described here are included in the the batch acknowledgement (ACK) file.

After validating the submitted batch request file,an ACK file is generated:

ACK - validation successful

After receiving a batch request file, the Adyen system carries out a series of validation checks.
If all validation checks are successful, a batch acknowledgement (ACK) file is generated and returned with the fields described below.

The File Header [FH] record marks the start of the ACK file.

Field #

Format

Description

1

Fixed value: FH

Record type identifier.

2

Numeric [0-9]+

Version number.
This field enables version control for the release of future enhancements for batch processing.

3

Allowed values:
  • TEST
  • LIVE

It specifies the environment: either test or live/production.

4

Fixed value: Company

Account type.

5

Alphabetic data [A-Z, a-z]

Specifies the company account name.

6

Alphabetic data [A-Z, a-z]

Submission platform.
The value specified in the file should match the corresponding value in the file name.

7

Numeric [0-9]+

File sequence number.
The value specified in the file should match the corresponding value in the file name.

8

Alphabetic data [A-Z, a-z]

The WS user name specified to connect to the Adyen SOAP service.

9

Allowed values:

  • Authorisation
  • Payout
  • RefundWithData
  • Modification
  • PayoutModification
  • AccountUpdater

File type.
Defines the type of transactions that are submitted for further processing.

10

Alphabetic data [A-Z, a-z]
EchoData

In this field you can specify any data you may want to be returned with the result file.
When this field is populated, its content is returned exactly as is.
The Adyen system does not use this data.

Maximum character length: 80 characters.

The File Trailer record specifies the number of blocks and lines in the ACK file.

Field #

Format

Description

1

Fixed value: R

Record type identifier.

2

Numeric [0-9]+

Number of processed blocks.

3
Numeric [0-9]+

Number of processed line records.

This line specifies the number of the next file to process in a batch submission sequence. File sequence numbers are associated with the submission platform the files originate from, and they sequentially increment by one unit after each successful file submission.

The NextFileSubmissionNumber sub-line is always included in an ACK file, regardless of the file validation outcome:

  • When a file in a batch process is submitted successfully and without errors, the submission number for the next file in the process increases sequentially.

  • When a file in a batch process contains errors, the system tries to guess the submission number for the next file in the sequence. Therefore, this value may be incorrect.

A correct file in a batch submission process satisfies the following minimum requirements:

  • The file name adheres to the naming conventions for batch acknowledgement files (ACK).

  • The file data matches the expected data type and format.

The submission number is always incorrect when it is not possible to read or parse the header of a file. This can happen in the following cases:

  • The file sequence number is missing or it is incorrectly formatted in the file name.

  • The submission platform name is missing or it is incorrectly formatted in the file name.

  • A database exception might occur during file insertion.

Field #

Format

Description

1

Fixed value: N

Record type identifier

2

Fixed value: NextFileSubmissionNumber

Record content definition.

3

Numeric [0-9]+

The number corresponding to the next expected file in the submission sequence.

Example

FH,1.0,TEST,Company,TestCompany,CaptureOverAuthAmount,1,ws@Company.TestCompany,Modification,EchoData_BatchAck
R,2,8
N,NextFileSubmissionNumber,2

ACK - validation failed

When one or more validation errors occur, an error line gets generated per line in the request file that did not pass validation.

The File Header record contains marks the start of the ACK file.

Field #

Format

Description

1

Fixed value: E

Record type identifier

2

Allowed values:

  • FH
  • L
  • SL

The record type where the error occurred:

  • FH: the error occurred in the file header.
  • L: the error occurred in a line record.
  • SL: the error occurred in a sub-line record.

3

Numeric [0-9]+

The file line number where the error occurred.

4

Numeric [0-9]+

The error code associated with the error.

5

Alphabetic data [A-Z, a-z]

The error description.

This line specifies the number of the next file to process in a batch submission sequence. File sequence numbers are associated with the submission platform the files originate from, and they sequentially increment by one unit after each successful file submission.

The NextFileSubmissionNumber sub-line is always included in an ACK file, regardless of the file validation outcome:

  • When a file in a batch process is submitted successfully and without errors, the submission number for the next file in the process increases sequentially.

  • When a file in a batch process contains errors, the system tries to guess the submission number for the next file in the sequence. Therefore, this value may be incorrect.

A correct file in a batch submission process satisfies the following minimum requirements:

  • The file name adheres to the naming conventions for batch acknowledgement files (ACK).

  • The file data matches the expected data type and format.

The submission number is always incorrect when it is not possible to read or parse the header of a file. This can happen in the following cases:

  • The file sequence number is missing or it is incorrectly formatted in the file name.

  • The submission platform name is missing or it is incorrectly formatted in the file name.

  • A database exception might occur during file insertion.

Field #

Format

Description

1

Fixed value: N

Record type identifier

2

Fixed value: NextFileSubmissionNumber

Record content definition.

3

Numeric [0-9]+

The number corresponding to the next expected file in the submission sequence.

Example

E,L,5,5000,Invalid Merchant Account 
E,L,6,5000,Invalid Merchant Account 
N,NextFileSubmissionNumber,2