Recurring CSV Format
Field Index | Field Name | Field Format |
1 | Reference_No | 20 characters maximum |
2 | Customer_Ref | 20 characters maximum |
3 | Reference_3 | 30 characters maximum |
4 | Cardholdername | 30 characters maximum |
5 | Transaction code |
Applicable transaction types are 00-Purchase, 01-Pre-Authorization, and 03-Forced Post |
6 | Cardnumber | 16 digit card number |
7 | Amount | 0.00 format |
8 | Expiry Date | MMYY (no slash) |
9 | Authorization Number | 6 digit maximum |
10 | Not used, but delimiter required | N/A |
11 | Recurring Indicator | enter "R" for true (no quotes), otherwise false |
12 | Plan Start Date | YYYY-MM-DD (only read from the first line of the file, any additional instances are ignored) |
13 | Plan End Date | YYYY-MM-DD (only read from the first line of the file, any additional instances are ignored) |
14 | Not used, but delimiter required | N/A |
15 | Address (AVS) | 28 characters maximum |
16 | Postal Code (AVS) | 10 characters maximum |
17 | Soft Descriptor DBA Name | 38 characters maximum |
18 | Soft Descriptor Street | 38 characters maximum |
19 | Soft Descriptor City | 21 characters maximum |
20 | Soft Descriptor Region Code | 3 characters maximum |
21 | Soft Descriptor Postal Code | 15 characters maximum |
22 | Soft Descriptor Country Code | 3 characters maximum |
23 | Soft Descriptor MID | 15 characters maximum |
24 | Soft Descriptor MCC | 4 characters maximum |
25 | Soft Descriptor Merchant Contact Info | 32 characters maximum |
26 | DCC Opt-In | 1 character, "Y" or "N". Optional field. Used for Dynamic Currency Conversion (DCC) |
27 | Fee Override Amount | 0.00 format - uses Gateway fee configuration if left blank |
28 | Special Payment | Character "B" to mark Special Payment transaction. Optional field. If Special Payment can't be applied to the transaction due to feature-related conditions, the field will be ignored. |
Sample Data:
ref_no-1,cust_ref_a,ref_3_a,John Doe,00,4111111111111111,19.95,0315,,,R,2013-06-15,2014-06-01,,,
ref_no-2,cust_ref_b,ref_3_b,Jane Doe,00,4111111111111111,1.95,0514,,,R,,,,,
Sample with DCC Opt_in only
ref_no-1,cust_ref_a,ref_3_a,John Doe,00,5405331111111117,19.90,0416,,,,,,,,,,,,,,,,,,Y
Sample with Fee Overide Only
ref_no-1,cust_ref_a,ref_3_a,John Doe,00,4111111111111111,19.91,0315,,,,,,,,,,,,,,,,,,N,1.50
Please note the following with both "DCC Opt-In" and "Fee Override":
Only one, either DCC or Fees could possibly be active at any given time. Since both fields are optional, if you specify a value for either where that feature is not enabled, it will be ignored. Thus, whichever feature is enabled is what will be applied in this case. In fact, if neither DCC nor Fees are enabled for the terminals, then BOTH would be ignored.
Please note the following for CSV file upload:
- Passing the “DCC Opt-In” property (key) is optional. However, if the “DCC Opt-In” key is being passed, then the value pair field must have the “Y” or “N” indicator. If NO “DCC Opt-In” property(key) is passed, then the default value assumed is "N".
- If the merchant uploads a CSV File with the “DCC Opt-In” field set to “Y” and DCC has not been enabled on their account then the transaction(s) will fail.
- Passing the "DCC Opt-In" property is optional. In the case of no "DCC Opt-in" property (key) being passed, the default value pair would be "N".
Sample with Special Payment
ref_no-1,cust_ref_a,ref_3_a,John Doe,00,4111111111111111,16.90,0819,,,R,2016-10-16,,,,,,,,,,,,,,,,B
Level 2 / Level 3 Support
Four empty fields followed by lines with: "TAX,,,,SHIP-TO,,,,L3-DATA,,,,L3-LINE-ITEM
Field Index | Field Name | Field Format |
1 | TAX | one number |
2 | SHIP-TO |
Name, Customer Number, Address, City, State, ZIP, Country, Email, Phone |
3 |
L3-DATA |
Discount, Duty, Freight, Ship-From-ZIP |
4 |
L3-LINE-ITEM |
Commodity Code, Discount, Description, Product Code, Quantity, Unit Cost, Units of Measure Code |
Please note the following for Level 2 / Level 3 CSV file upload:
TAX and SHIP-TO go under Level 2 data.
L3-DATA and L3-LINE-ITEM go under Level 3 (terminal needs to be enabled)
Note: There can be more than one Line Item.
Sample data with Level 2 / Level 3 Support:
ref_no_1,cust_ref_2,91525,Visa L3 line items,00,4000180001234568,40.66,1119,,,,08-06-2015,08-06-2015,0
,,,,TAX,12.34
,,,,SHIP-TO,Ship Name,C123,12 3 Street,Great City,CA,12345,US,email@email.com,123-123-123
,,,,L3-DATA,10.00,12.01,13.02,90210
,,,,L3-LINE-ITEM,00514,,A line item,315,1,1,ACR
,,,,L3-LINE-ITEM,00521,1.50,A 2nd item,045,2,2,ASM
,,,,L3-LINE-ITEM,00528,0.50,A 3rd item,081,3,3,ASV
,,,,L3-LINE-ITEM,02039,0,A 4th item,042,4,4,AMP
,,,,L3-LINE-ITEM,03118,0,A 5th item,314,5,5,AMH
,,,,L3-LINE-ITEM,03196,9.01,A 6th item,300,6,6,ARE
Quick Key CSV Format
Field Index | Field Name | Field Format |
1 | Reference_No | 20 characters maximum |
2 | Customer_Ref | 20 characters maximum |
3 | Reference_3 | 30 characters maximum |
4 | Cardholdername | 30 characters maximum |
5 | Transactioncode | Applicable transaction type is 00-Purchase |
6 | Cardnumber | 16 digit card number |
7 | Amount | 0.00 format |
8 | Expiry Date | MMYY (no slash) |
9 | Authorization Number | 6 digit maximum |
10 | Not used, but delimiter required | N/A |
11 | Recurring Indicator | enter "R" for true (no quotes), otherwise false |
12 | Not used, but delimiter required | N/A |
13 | Not used, but delimiter required | N/A |
14 | Not used, but delimiter required | N/A |
15 | Address (AVS) | 28 characters maximum |
16 | Postal Code (AVS) | 10 characters maximum |
17 | Not used, but delimiter required | N/A |
18 | Not used, but delimiter required | N/A |
19 | Not used, but delimiter required | N/A |
20 | Not used, but delimiter required | N/A |
21 | Not used, but delimiter required | N/A |
22 | Not used, but delimiter required | N/A |
23 | Not used, but delimiter required | N/A |
24 | Not used, but delimiter required | N/A |
25 | Not used, but delimiter required | N/A |
26 | DCC Opt-In | 1 character, "Y" or "N". Optional field. Used for Dynamic Currency Conversion (DCC) |
27 | Fee Override Amount | 0.00 format - uses Gateway fee configuration if left blank |
28 | Special Payment | Character "B" to mark Special Payment transaction. Optional field. If Special Payment can't be applied to the transaction due to feature-related conditions, the field will be ignored. |
Sample data:
DCC
ref_no_1,cust_ref_1,46615,Obfutty Vola,00,6011000990139424,48.86,1019,,,,08-06-2008,08-06-2008,0,,,,,,,,,,,,Y
dcc_opt_out,cust_ref_2,91525,Sentable Vola,00,4005000000000007,40.66,1119,,,,08-06-2008,08-06-2008,0,,,,,,,,,,,,N
dcc_opt_in,cust_ref_3,12742,Futery Mexico Peso,00,4001000000000001,19.44,1219,,,,08-06-2008,08-06-2008,0,,,,,,,,,,,,Y
dcc_not_available,cust_ref_4,91395,Troon Heber,00,4000000000000002,38.55,0119,,,,08-06-2008,08-06-2008,0,,,,,,,,,,,,N
dcc_opt_in,cust_ref_5,17781,Paripygy Euro,00,5105000000000003,38.88,0218,,,,08-06-2008,08-06-2008,0,,,,,,,,,,,,Y
Fees
ref_1,cust_ref_1,46615,Obfutty Vola,00,6011000990139424,48.86,1019,,,,08-06-2008,08-06-2008,0,,,,,,,,,,,,,1.99
ref_2,cust_ref_2,91525,Sentable Vola,00,4005000000000007,40.66,1119,,,,08-06-2008,08-06-2008,0,,,,,,,,,,,,,2.99
ref_3,cust_ref_3,12742,Futery Mexico Peso,00,4001000000000001,19.44,1219,,,,08-06-2008,08-06-2008,0,,,,,,,,,,,,,3.99
ref_4,cust_ref_4,91395,Troon Heber,00,4000000000000002,38.55,0119,,,,08-06-2008,08-06-2008,0,,,,,,,,,,,,,4.99
ref_no_fees,cust_ref_5,17781,Paripygy Euro,00,5105000000000003,38.88,0218,,,,08-06-2008,08-06-2008,0,,,,,,,,,,,,,
Please note the following with both "DCC Opt-In" and "Fee Override":
Only one, either DCC or Fees could possibly be active at any given time. Since both fields are optional, if you specify a value for either where that feature is not enabled, it will be ignored. Thus, whichever feature is enabled is what will be applied in this case. In fact, if neither DCC nor Fees are enabled for the terminals, then BOTH would be ignored.