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.

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:

It identifies the merchant account the transactions refers to;
It specifies the file submission number;
It defines the transaction type that needs to be processed.

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	Fixed value: `Company`	Account type.
5	Alphanumeric	Specifies the company account name.
6	Alphanumeric	Submission platform. The value specified in the file should match the corresponding value in the file name.
7	Numeric	File sequence number. The value specified in the file should match the corresponding value in the file name.
8	Alphanumeric	The username of the API credential linked to your Adyen company account.
9	Allowed values: Authorisation Payout RefundWithData Modification PayoutModification AccountUpdater	File type. Defines the type of transactions that are submitted for further processing.
10	Alphanumeric	`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`		Record type identifier.
2	Numeric		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	Description
1	Fixed value: `BH`	Record type identifier.
2	Numeric	Block number.
Its value increments sequentially by one unit per block.
3	Alphanumeric	`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`		Record type identifier.
2	Numeric		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.