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.

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

File Header [FH]

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 payments platform does not use this data.

Maximum character length: 80 characters.

File Trailer [FT]

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.

Block Header [BH]

Notifies the Adyen payments platform 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 payments platform does not use this data.

Maximum character length: 80 characters.

Block Trailer [BT]

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 payments platform can then fetch the file and add it to the processing queue.