554106

Adyen Batch Submission Format Manual

7
Zoom out
Zoom in
Previous page
1/11
Next page
Adyen Batch Submission Format
Version 1.41
Adyen B.V.
Table of Contents
Introduction............................................................................................................................................................. 3
Audience............................................................................................................................................................ 3
Changelog.......................................................................................................................................................... 3
File Structure...........................................................................................................................................................4
File Header [FH] Record........................................................................................................................................... 5
File Trailer [FT] Record.............................................................................................................................................5
Block Header [BH] Record........................................................................................................................................5
Block Trailer [BT] Record.......................................................................................................................................... 6
Line [L] Record......................................................................................................................................................... 7
Common Fields...................................................................................................................................................7
Direct Debit (NL) Fields.......................................................................................................................................7
ELV (DE) Fields................................................................................................................................................... 8
Credit Card Fields................................................................................................................................................8
Modifications......................................................................................................................................................... 10
Example File.......................................................................................................................................................... 10
2 Copyright © Adyen B.V. 2010
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.com/
Audience
This is a technical manual aimed at IT personnel involved in integrating merchants' data with Adyen.
Changelog
Version Date Changes
1.41 2010-07-22 • Added changelog and audience sections
• Manual reviewed for English and layout consistency
Copyright © Adyen B.V. 2010 3
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:
Line items are grouped in blocks per currency - for each currency a seperate block should be used.
Each file submitted has an associated file submission number which increments by exactly one. A file is
rejected if it has a submission number that was previously used or a gap in submission numbers (e.g. 201
followed by 203).
The same merchant account name must be used throughout each file. If you have batch payments for another
merchant account they should be submitted in a separate file.
4 Copyright © Adyen B.V. 2010
File Trailer [FT]
File Header [FH]
Block Trailer [BT]
Block Header [BH]
Line Item [L]
{1,n}
{1,n}
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 submission number
4 numeric N number of blocks in file
5 fixed “FT” N end-of-record type identifier
FT,ExampleMerchant,201,1,FT
Example 2: Field Trailer [FT] Record
Block Header [BH] Record
Field # Format Optional Description
1 fixed “BH” 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 fixed “BH” N end-of-record type identifier
BH,ExampleMerchant,201,1,BH
Example 3: Block Header [BH] Record
Copyright © Adyen B.V. 2010 5
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..)
8 fixed “BT” N end-of-record type identifier
BT,ExampleMerchant,201,1,3,4398,EUR,BT
Example 4: Block Trailer [BT] Record
6 Copyright © Adyen B.V. 2010
Line [L] Record
Line [L] Record
Depending on the command (payment method or modification) the L record has different specific fields.
Common Fields
Field # Format Optional Description
1 fixed “L” N record type identifier
2 numeric N L record number within block (starts at 1, increment by 1)
3 variable [A-z0-9]+ N merchant account name
4 variable [A-z0-9]+ N payment method / modification type
5 numeric N amount in minor units (cents)
6 [A-Z]{3} N 3 letter currency code (EUR, GBP, USD, etc..)
7 any characters N/Y merchant transaction reference (blank for modifications,
required for payments)
8 any characters Y shopper reference/id (blank for modifications)
9 email address Y shopper email (blank for modifications)
10 [A-z0-9.,-? ]+ Y shopper statement (blank for modifications)
11 [Ecommerce|Moto|
ContAuth]
Y shopper interaction flagging (additional authorisation
required to override, leave blank otherwise)
<payment method specific fields – see below>
n fixed “L” N end-of-record type identifier
Direct Debit (NL) Fields
These are the fields for the payment method “directdebit_NL” (field # 4).
Field # Format Optional Description
12 [0-9]+ N bank account number
13 [A-z0-9-. ]+ N bank account owner name
14 [A-Z]{2} N country code (only “NL” supported)
L,1,ExampleMerchant,directdebit_NL,1999,EUR,DD5401_22,user10,j.janssen@test.com,Test Product
6,,123456789,Jan Janssen,NL,L
Example 5: Line [L] Record – Direct Debit
Copyright © Adyen B.V. 2010 7
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.com,Test Product
6,,1234567890,12345678,Karl Becker,Test Bank,Koln,L
Example 6: Line [L] Record – elv
Credit Card Fields
These are the fields for the payment method “card” (field # 4).
Field # Format Optional Description
12 [0-9]+ N card number
13 [0-9]{2} N expiry month (zero padded, e.g. 03)
14 [0-9]{4} N expiry year (e.g. 2012)
15 [0-9]{3,4} N cvc code
16 any characters N card holder name
17 [0-9]{2} Y start month (Maestro UK/Solo only) (e.g. 06)
18 [0-9]{4} Y start year (Maestro UK/Solo only) (e.g. 2009)
19 [0-9]{1} Y issue number (Maestro UK/Solo only)
20 any characters Y billing address street
21 any characters Y billing address house number or name
22 any characters Y billing address city
23 any characters Y billing address ZIP/postal code
24 any characters Y billing address province/county
25 [A-Z]{2} Y billing address country code (ISO, e.g. GB,NL)
L,1,ExampleMerchant,card,1999,EUR,DD5401_22,user10,r.johnson@test.com,Test Product
6,,4111111111111111,12,2012,737,R. JOHNSON,,,,Marylebone High Street,11,London,W1U 4RY,London,GB,L
Example 7: Line [L] Record – Credit Card
8 Copyright © Adyen B.V. 2010
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. 2010 9
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.
Two specific fields are used for modifications:
Field # Format Optional Description
12 [0-9]+ N original (psp) reference of the payment
13 [A-z0-9]+ Y/N Authorisation code (only for authoriseReferral)
L,3,ExampleMerchant,refund,2200,EUR,,,,,,1312563136350028,,L
L,2,ExampleMerchant,cancel,0,EUR,,,,,,1412563070430299,,L
Example 8: Modifications – Refund (1
st
line) and Cancel (2
nd
line)
Example File
The following file is a complete payment batch submission file for a merchant ExampleMerchant. The file
submission number is 201 and there are four payments in two blocks. The EUR block contains one
directdebit_NL, elv and credit card payment with a total sum of 5997 minor units (the total value is 59.97 EUR).
The GBP block has a singe credit card payment for 1999 minor units (the total value is 19.99 GBP) and has
billing address data included.
FH,ExampleMerchant,201,FH
BH,ExampleMerchant,201,1,BH
L,1,ExampleMerchant,directdebit_NL,1999,EUR,DD5401,user10,j.janssen@test.com,Test Product
6,123456789,Jan Janssen,NL,L
L,2,ExampleMerchant,elv,1999,EUR,DD5422,user11,karlbecker@test.com,Test Product
6,,1234567890,12345678,Karl Becker,Test Bank,Koln,L
L,3,ExampleMerchant,card,1999,EUR,DD5474,user12,jdupont@test.com,Test Product
6,,5555444433331111,12,2012,737,J. DUPONT,,,,,,,,,,L
BT,ExampleMerchant,201,1,3,5997,EUR,BT
BH,ExampleMerchant,201,2,BH
L,1,ExampleMerchant,card,1999,GBP,DD5666,user16,r.johnson@test.com,Test Product
6,,4111111111111111,12,2012,737,R. JOHNSON,,,,Marylebone High Street,11,London,W1U 4RY,London,GB,L
BT,ExampleMerchant,201,2,3,1999,GBP,BT
FT,ExampleMerchant,201,1,FT
Example 9: File - Payment Batch
10 Copyright © Adyen B.V. 2010
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. 2010 11
… 7 …


Need help? Post your question in this forum.

Forumrules


Report abuse

Libble takes abuse of its services very seriously. We're committed to dealing with such abuse according to the laws in your country of residence. When you submit a report, we'll investigate it and take the appropriate action. We'll get back to you only if we require additional details or have more information to share.

Product:

For example, Anti-Semitic content, racist content, or material that could result in a violent physical act.

For example, a credit card number, a personal identification number, or an unlisted home address. Note that email addresses and full names are not considered private information.

Forumrules

To achieve meaningful questions, we apply the following rules:

Register

Register getting emails for Adyen Batch Submission Format at:


You will receive an email to register for one or both of the options.


Get your user manual by e-mail

Enter your email address to receive the manual of Adyen Batch Submission Format in the language / languages: English as an attachment in your email.

The manual is 0,16 mb in size.

 

You will receive the manual in your email within minutes. If you have not received an email, then probably have entered the wrong email address or your mailbox is too full. In addition, it may be that your ISP may have a maximum size for emails to receive.

The manual is sent by email. Check your email

If you have not received an email with the manual within fifteen minutes, it may be that you have a entered a wrong email address or that your ISP has set a maximum size to receive email that is smaller than the size of the manual.

The email address you have provided is not correct.

Please check the email address and correct it.

Your question is posted on this page

Would you like to receive an email when new answers and questions are posted? Please enter your email address.



Info