Adyen Batch Submission Format Version 1.41 Adyen B.V.
Table of Contents Introduction............................................................................................................................................................. 3 Audience............................................................................................................................................................ 3 Changelog..................................................................................................................................................
Introduction Introduction This document describes the batch file submission format for processing batched payments and modifications through Adyen. If batch file submission is enabled for your account you can upload the file in the CA Backoffice by selecting the “BATCHES” menu. Batches should contain either payments or modifications. Mixing payments and modifications in one file is not permitted. The latest version of this document is available by contacting Adyen Support at https://support.adyen.
File Structure File Structure The file should be delivered in CSV (Comma Separated Values) format as per RFC 4180 with the exception that no multi-line fields are allowed and that a variable number of fields per line are used. Also note that no header record is used. A file has the following structure: File Header [FH] Block Header [BH] Line Item [L] {1,n} Block Trailer [BT] {1,n} File Trailer [FT] Line items are grouped in blocks per currency - for each currency a seperate block should be used.
File Header [FH] Record File Header [FH] Record Field # Format Optional Description 1 fixed “FH” N record type identifier 2 variable [A-z0-9] N merchant account name 3 numeric N file submission number 4 fixed “FH” N end-of-record type identifier FH,ExampleMerchant,201,FH Example 1: File Header [FH] Record File Trailer [FT] Record Field # Format Optional Description 1 fixed “FT” N record type identifier 2 variable [A-z0-9] N merchant account name 3 numeric N file submiss
Block Trailer [BT] Record Block Trailer [BT] Record Field # Format Optional Description 1 fixed “BT” N record type identifier 2 variable [A-z0-9]+ N merchant account name 3 numeric N file submission number 4 numeric (fixed 1) N block number 5 numeric N number of lines records in block 6 numeric N sum of the line item amounts in block 7 [A-Z]{3} N 3 letter currency code (EUR, GBP, USD, etc..
Line [L] Record Line [L] Record Depending on the command (payment method or modification) the L record has different specific fields.
Line [L] Record ELV (DE) Fields These are the fields for the payment method “elv” (field # 4). Field # Format Optional Description 12 [0-9]+ N bank account number (Kontonr.) 13 [0-9]+ N bank location id (BankLeitzahl) 14 [A-z0-9-. ]+ N bank account owner name 15 [A-z0-9-. ]+ N bank name 16 [A-z0-9-. ]+ N bank city L,1,ExampleMerchant,elv,1999,EUR,DD5401_22,user10,karlbecker@test.
Line [L] Record Please note that when supplying billing address you must either populate all the billing address fields or none. A partially filled address will fail validation and not be process correctly. Copyright © Adyen B.V.
Modifications Modifications If you are submitting modifications the contents of field #4 can be one of cancel, capture, refund, cancelOrRefund, or authoriseReferral (see the Adyen Merchant Integration Manual for more information on modifications). Fields 7 through 11 should be left blank. For cancel and cancelOrRefund field 5 (the amount) should be set to 0, but the currency code (field 6) should match the original transaction.
Example File Below is a modification batch submission file example containing a capture, cancel and refund in a single EUR block. FH,ExampleMerchant,5,FH BH,ExampleMerchant,5,1,BH L,1,ExampleMerchant,capture,6000,EUR,,,,,,1312563136350028,,L L,2,ExampleMerchant,cancel,0,EUR,,,,,,1412563070430299,,L L,3,ExampleMerchant,refund,2200,EUR,,,,,,1412563167350061,,L BT,ExampleMerchant,5,1,3,8200,EUR,BT FT,ExampleMerchant,5,1,FT Example 10: File - Modification Batch Copyright © Adyen B.V.
