Optional integration data
1. Delivery and Invoicing data
Some payment methods or features may require you to submit delivery and/or invoicing information. Here below we've listed the relevant fields you may have to submit:
Field / Format | Description |
---|---|
CIVILITY AN, 5 |
Invoicing title (Mr., Mrs, Dr., etc.) |
CUID AN, 50 |
Social security number / company registration number |
ECOM_BILLTO_POSTAL_CITY AN, 40 |
Invoicing city |
ECOM_BILLTO_POSTAL_COUNTRYCODE AN, 2 |
Invoicing country code (BE, FR, NL, DE, etc.) |
ECOM_BILLTO_POSTAL_NAME_FIRST AN, 35 |
Invoicing first name |
ECOM_BILLTO_POSTAL_NAME_LAST AN, 35 |
Invoicing last name |
ECOM_BILLTO_POSTAL_POSTALCODE AN, 10 |
Invoicing postcode |
ECOM_BILLTO_POSTAL_STREET_LINE1 AN, 35 |
Invoicing address |
ECOM_BILLTO_POSTAL_STREET_NUMBER AN, 10 |
Invoicing street number |
ECOM_SHIPTO_DOB yyyy-MM-dd |
Date of birth |
ECOM_SHIPTO_ONLINE_EMAIL AN, 50 |
Delivery e-mail address |
ECOM_SHIPTO_POSTAL_CITY AN, 25 |
Delivery city |
ECOM_SHIPTO_POSTAL_COUNTRYCODE AN, 2 |
Delivery country code (ISO) |
ECOM_SHIPTO_POSTAL_NAME_FIRST AN, 35 |
Delivery first name |
ECOM_SHIPTO_POSTAL_NAME_LAST AN, 35 |
Delivery last name |
ECOM_SHIPTO_POSTAL_NAME_PREFIX AN, 10 |
Delivery civil status (Mr., Mrs, etc.) |
ECOM_SHIPTO_POSTAL_POSTALCODE AN, 10 |
Delivery postcode |
ECOM_SHIPTO_POSTAL_STATE AN, 2 |
Delivery state (ISO code *) |
ECOM_SHIPTO_POSTAL_STREET_LINE1 AN, 35 |
Delivery address |
ECOM_SHIPTO_POSTAL_STREET_NUMBER AN, 10 |
Delivery street number |
ORDERSHIPCOST N |
Delivery cost |
ORDERSHIPMETH AN, 25 |
Delivery method |
ORDERSHIPTAXCODE N |
Delivery tax code |
(*ISO codes for US States can be found here. Example: AL (Alabama), FL (Florida))
2. Order data ("ITEM" parameters)
Some payment methods or features may require you to submit detailed order information. Here below we've listed the relevant fields you may have to submit:
Field / Format | Description |
---|---|
ITEMATTRIBUTESxx AN, 50 |
Item attributes (size, colour etc.) (replace *xx* with a number to send multiple items: ITEMATTRIBUTES1, ITEMATTRIBUTES2, etc.) |
ITEMCATEGORYxx AN, 50 |
Item category (replace *xx* with a number to send multiple items: ITEMCATEGORY1, ITEMCATEGORY2, etc.) |
ITEMCOMMENTSxx AN, 255 |
Item comments (replace *xx* with a number to send multiple items: ITEMCOMMENTS1, ITEMCOMMENTS2, etc.) |
ITEMDESCxx AN, 16 |
Item description (replace *xx* with a number to send multiple items: ITEMDESC1, ITEMDESC2, etc.) |
ITEMDISCOUNTxx N,10 |
Item discount (replace *xx* with a number to send multiple items: ITEMDISCOUNT1, ITEMDISCOUNT2, etc.) |
ITEMIDxx AN, 15 |
Item identification (replace *xx* with a number to send multiple items: ITEMID1, ITEMID2, etc.) |
ITEMNAMExx AN, 40 |
Item name (replace *xx* with a number to send multiple items: ITEMNAME1, ITEMNAME2, etc.) |
ITEMPRICExx N, 50 |
Item price (replace *xx* with a number to send multiple items: ITEMPRICE1, ITEMPRICE2, etc.) |
ITEMQUANTxx N, 50 |
Item quantity (replace *xx* with a number to send multiple items: ITEMQUANT1, ITEMQUANT2, etc.) |
ITEMQUANTORIGxx AN, 50 |
Maximum quantity per item (replace *xx* with a number to send multiple items: ITEMQUANTORIG1, ITEMQUANTORIG2, etc.) |
ITEMUNITOFMEASURExx AN, 50 |
Item Unit of measure (replace *xx* with a number to send multiple items: ITEMUNITOFMEASURE1, ITEMUNITOFMEASURE2, etc.) |
ITEMVATxx N, 50 |
Item VAT amount (replace *xx* with a number to send multiple items: ITEMVAT1, ITEMVAT2, etc.) |
ITEMVATCODExx N, 50 |
Item VAT code (replace *xx* with a number to send multiple items: ITEMVATCODE1, ITEMVATCODE2, etc.) |
ITEMWEIGHTxx N, 10 |
Item weight (replace *xx* with a number to send multiple items: ITEMWEIGHT1, ITEMWEIGHT2, etc.) |
Important: Ascending order of line item fields for SHA calculation
|
3. Travel data
You can send additional data for travel transactions if your acquirer is able to receive and process the data.
The hidden fields for travel data are the following:
<input type="hidden" name="DATATYPE" value="">
<input type="hidden" name="AIAIRNAME" value="">
<input type="hidden" name="AITINUM" value="">
<input type="hidden" name="AITIDATE" value="">
<input type="hidden" name="AICONJTI" value="">
<input type="hidden" name="AIPASNAME" value="">
<input type="hidden" name="AIEXTRAPASNAME1" value="">
<input type="hidden" name="AICHDET" value="">
<input type="hidden" name="AIAIRTAX" value="">
<input type="hidden" name="AIVATAMNT" value="">
<input type="hidden" name="AIVATAPPL" value="">
<input type="hidden" name="AITYPCH" value="">
<input type="hidden" name="AIEYCD" value="">
<input type="hidden" name="AIIRST" value="">
<input type="hidden" name="AIORCITY1" value="">
<input type="hidden" name="AIORCITYL1" value="">
<input type="hidden" name="AIDESTCITY1" value="">
<input type="hidden" name="AIDESTCITYL1" value="">
<input type="hidden" name="AISTOPOV1" value="">
<input type="hidden" name="AICARRIER1" value="">
<input type="hidden" name="AIBOOKIND1" value="">
<input type="hidden" name="AIFLNUM1" value="">
<input type="hidden" name="AIFLDATE1" value="">
<input type="hidden" name="AICLASS1" value="">
Field/ Format | Description |
---|---|
DATATYPE TRAVEL |
"TRAVEL" Mandatory |
AIAIRNAME AN, 20 |
Airline name Optional |
AITINUM AN, 16 |
Ticket number Air+ defines this zone as follows: 3 digits for airline prefix (filled with 0’s if ticket type <> BSP + 10 chars for ticket number). Other acquirers do not split this zone – it is just the ticket number. Mandatory |
AITIDATE MM/DD/YYYY or YYYYMMDD |
Ticket issue date. The default value is the transaction date Optional |
AICONJTI AN, 3 |
Conjunction ticket Optional |
AIPASNAME AN, 49 |
Primary passenger name. The default value is the name of the credit cardholder. Mandatory only for acquirer Bambora |
AIEXTRAPASNAME1 AN, 49 |
Name of extra passenger for PNRs with more than one passenger. This field can be repeated up to 5 times (i.e. for 5 extra passengers), changing the digit at the end of the field name. Mandatory only for acquirer Bambora |
AICHDET AN, 49 |
Charge details. Free text description or reference. Optional |
AIAIRTAX num x100 => no decimals |
Airport taxes Optional |
AIVATAMNT num x100 => no decimals |
VAT amount Optional |
AIVATAPPL D and I |
VAT applicable flag. Supported values:
Optional |
AITYPCH AN, 2 |
Type of charge Optional |
AIEYCD AN, 3 |
Destination area code Optional |
AIIRST AN, 1 |
Destination area code type Optional |
The following fields can be repeated n times, changing the digit at the end of the field name.
Field | Description |
---|---|
AIORCITY1 AN, 3 (IATA) |
Departure airport (short) Mandatory |
AIORCITYL1 AN, 20 |
Departure airport (long) Mandatory |
AIDESTCITY1 AN, 3 (IATA) |
Arrival airport (short) Mandatory |
AIDESTCITYL1 AN, 20 |
Arrival airport (long) Mandatory |
AISTOPOV1 O and X |
Stopover Possible values: the capital letters O and X.
Optional |
AICARRIER1 AN, 4 |
Carrier code Mandatory |
AIBOOKIND1 AN, 2 |
Booking indicator Optional |
AIFLNUM1 AN, 4 |
Flight number Optional |
AIFLDATE1 MM/DD/YY or YYYYMMDD |
Flight date Mandatory only for acquirer Bambora |
AICLASS1 AN, 15 |
Airline class Mandatory only for acquirer Bambora |