Whenever you send a request to our platform, you need to provide specific information by using parameters. This accounts for any scenario, such as (just to name a few):

The same principle also applies to our platform sending information to you, i.e. for

To ensure our platform processes your requests correctly, you need to

  • Get all mandatory/recommended/optional parameters from the respective guide
  • Consult this Parameter Cookbook to assign correct values to them

Learn here how to read the individual columns:

  • Field name: Name of the parameter
  • Details: A detailed description about the parameter's purpose in a request
  • Input: Can you send the parameter in a request to our platform? If sent anyway, our platform ignores it 
  • Output: Is the parameter included in notifications sent from our platform?
  • Format: Data type 
  • Max Length: Maximum amount of characters
  • Example: A typical value to give you an idea of the expected value, allowed format and maximum length
Field name Details Input Output Format Max Length Example
AAVADDRESS

Indicates the AAV result for the address (see also AAVCHECK) 

No Yes AN 2 OK
AAVCHECK Result of the automatic address verification. This verification is not supported by all credit card acquirers.

Possible values:
KO: The address has been sent but the acquirer has given a negative response for the address check, i.e. the address is wrong.
OK: The address has been sent and the acquirer has returned a positive response for the address check, i.e. the address is correct OR
The acquirer sent an authorisation code but did not return a specific response for the address check.
NO: All other cases. For instance, no address transmitted; the acquirer has replied that an address check was not possible; the acquirer declined the authorisation but did not provide a specific result for the address check, …
No Yes AN 2 NO
AAVMAIL Authentication procedures for email addresses. Applicable to American Express transactions only. No Yes AN 2 OK,KO
AAVNAME Authentication procedures for cardholder names. Applicable to American Express transactions only. No Yes AN 2 OK,KO
AAVPHONE Authentication procedures for phone numbers. Applicable to American Express transactions only. No Yes AN 2 OK,KO
AAVZIP Indicates the AAV result for the zip code (see also AAVCHECK) No Yes AN 2 KO
ACCEPTANCE Acquirer's acceptance (authorisation) code.

The acquirer sends back this code to confirm the amount of the transaction has been blocked on the card of the customer. The acceptance code is not unique.
No Yes AN 16 04306B
ACCEPTURL URL of the web page to show the customer when the payment is authorised. Yes No AN 200 http://www.myshop.com/accept.html
Account.PSPID Your affiliation name in our system, chosen by yourself when opening your account with us. This is a unique identifier and can’t ever be changed. Yes No AN 30 MyPSPID123
ADDMATCH Indicates whether we consider the billing and shipping address to be identical

1=yes
0=no
Yes No AN 1 1
ADDRMATCH see ADDMATCH Yes No AN 1 1
AIACTIONNUMBER Action Number Yes No AN 17
AIAGIATA IATA Number of agency Yes No AN 8
AIAIRNAME Airline Name Yes No AN 20 Brussels Airlines
AIAIRTAX Airport Taxes Yes No AN 11
AIBOOKIND*XX* Booking Indicator Yes No AN 2
AICARRIER*XX* Carrier code Yes No AN 4 SN
AICHDET Charge Details Yes No AN 49
AICLASS*XX* Airline Class Yes No AN 15
AICONJTI Conjunction Ticket Yes No AN 3
AIDEPTCODE DBI field Department Code Yes No AN 17
AIDESTCITY*XX* Arrival airport (short) Yes No AN 5 BLQ
AIDESTCITYL*XX* Arrival airport (long) Yes No AN 20 Guglielmo Marconi
AIEXTRAPASNAME*XX* Extra Passenger name Yes No AN 49
AIEYCD Destination area code Yes No AN 3
AIFLDATE*XX* Flight Date Yes No YYYYMMDD 20 20120504
AIFLNUM*XX* Flight number Yes No AN 4 1234
AIGLNUM DBI field Account Number Yes No AN 17
AIINVOICE Delivery note/invoice number Yes No AN 17
AIIRST Destination area code type Yes No AN 1
AIORCITY*XX* Departure Airport (short) Yes No AN 5 BRU
AIORCITYL*XX* Departure Airport (Long) Yes No AN 20 Brussels
AIPASNAME Passenger Name Yes No AN 49
AIPROJNUM DBI field Project Number Yes No AN 17
AISTOPOV*XX* Stopover Yes No AN 1
AITIDATE Ticket issue date Yes No Date/Time 20 15/04/2012 13:14:56
AITINUM Ticket Number Yes No AN 16 123
AITINUML*XX* Ticket Number Yes No AN 16 123
AITYPCH Type of Charge Yes No AN 2
AIVATAMNT VAT Amount Yes No AN 11
AIVATAPPL VAT Applicable Yes No AN 1
ALIAS Alias name. After the Alias has been created you can use this Alias to replace the card number in transaction requests.

Avoid using spaces and special characters in the Alias.
Yes Yes AN 50 9897B5BB-4981-4633-BF46-40DCD6DFAB1F
Alias.AliasId Alias name. After the Alias has been created you can use this Alias to replace the card number in transaction requests.

Avoid using spaces and special characters in the Alias.
Yes No AN 30 9897B5BB-4981-4633-BF46-40DCD6DFAB1F
Alias.OrderId Your order number (merchant reference).

This reference is generally used by the merchant to look up his transaction in the back office.
For online, 3-tiers mode, the system also uses this reference to check if a payment is not requested twice for the same order. On request of the merchant the period of this check can be shortened or the check can be disabled.

If the acquirer is technically able to process the transaction, and if there’s no special configuration in the account, this orderID will be sent to the acquirer as reference (ref2) for the transaction. In this case the merchant will receive this ref2 field on his account statements, helping him reconcile his transactions. 
Although our system can accept up to 30 characters, the norm for most acquirers is 10 or 12. The exact accepted length and data validation format depend on the acquirer/bank.If the orderID does not comply to the ref2 rules set by the acquirer, we’ll send our PAYID as ref2 to the acquirer instead.

Avoid using spaces or special characters in the orderID.
Yes No AN 40 Order_789
Alias.StorePermanently Indicate whether you want to store an alias temporarily or indefinitely.

The possible values are:

N": the alias will be deleted after 2 hours

"Y": the alias will be stored indefinitely for future use

This parameter can only be used when Alias Gateway and Alias Manager are used together."
Yes No AN 1 Y or N
ALIASOPERATION Indicates who decide/set the Alias name, the merchant or our system.

Possible values: BYMERCHANT or BYPSP
Yes No AN 10 BYPSP
ALIASPERSISTEDAFTERUSE Indicate whether you want to store an alias temporarily or indefinitely.

The possible values are:

N": the alias will be deleted after 2 hours

"Y": the alias will be stored indefinitely for future use

This parameter can only be used when Alias Gateway and Alias Manager are used together."
Yes No AN 1 Y or N
ALIASUSAGE Short explanation for the customer on why you suggest the creation of an Alias. The text will be shown to the customer in e-Commerce mode. Yes No AN 255 Monthly subscription to lf World.
AMOUNT Amount of the transaction.

When the amount is sent as input, it has to be multiplied by 100 to avoid decimal separator problems.
In general, the acquirer accepts up to 2 decimals, depending on the currency.
Yes Yes N 15 Sent: 12995 Returned: 129.95
AUTHORIZATION CODE (* 100 to avoid decimals). Yes No AN 10 A437956
AUTHORIZATION DATE

See Authorization code. The date/time you received the authorization code.

Yes No MM/DD/YY HH:MM:SS 17 03/15/08 16:07:12
AUTHORIZATION MODE See Authorization code. The way you received the authorization code.

Possible value:
‘TEL’ for telephone
Yes No AN 3 TEL
BACKURL URL of the web page to display to the customer when he clicks the back button on our secure payment page. Yes No AN 200 http://www.myshop.com/selectPM.html
BGCOLOR Background colour on the payment page. Yes No AN N/A Blue #0000FF
BIC Bank Identifier Code (used for Direct Debits transactions) Yes Yes 11 GEBABEBB36A
BIN First 6 digits of a credit card number. Can be used to identify the brand and issuing bank. No Yes N 6 444444
BRAND

Brand of a credit/debit/purchasing card.

You can consult a list of BRAND values in Support > Integration and user manuals > Technical guides > Payment Methods Processing/Procedures

If you send the BRAND field without sending a value in the PM field (‘CreditCard’ or ‘Purchasing Card’), the BRAND value will not be taken into account.

Yes Yes AN 25 VISA
browserAcceptHeader Exact content of the HTTP accept headers as sent to the merchant from the Cardholder’s browser.
If the total length of the accept header sent by the browser exceeds 2048 characters, the 3DS Server truncates the excess portion
Yes No AN 2048
browserColorDepth Value representing the bit depth of the color palette for displaying images, in bits per pixel. Obtained from Cardholder browser using the screen color Depth property.
Values accepted:
1 = 1 bit
4 = 4 bits
8 = 8 bits
15 = 15 bits
16 = 16 bits
24 = 24 bits
32 = 32 bits
48 = 48 bits
Yes No AN 2 1
browserJavaEnabled Boolean that represents the ability of the cardholder browser to execute Java. Value is returned from the navigator java Enabled property (possible values TRUE or FALSE). Yes No A 5 TRUE
browserLanguage Value representing the browser language as defined in IETF BCP47. Returned from navigator language property. Yes No AN 8 en
browserScreenHeight Total height of the Cardholder’s screen in pixels. Value is returned from the screen height property. Between 0 and 999999 Yes No AN 6 1024
browserScreenWidth Total width of the cardholder’s screen in pixels. Value is returned from the screen width property Between 0 and 999999 Yes No AN 6 1024
browserTimeZone Time difference between UTC time and the Cardholder browser local time, in minutes between -840 and 720 Yes No AN 3 -840
browserUserAgent Exact content of the HTTP user-agent header.
Note: If the total length of the User- Agent sent by the browser exceeds 2048 characters, the 3DS Server truncates the excess portion.
Yes No AN 2048
BUTTONBGCOLOR Button background colour on the payment page. Yes No AN N/A Black #000000
BUTTONTXTCOLOR Button text colour on the payment page. Yes No AN N/A White #FFFFFF
CANCELURL URL of the web page to show the customer when he cancels the payment. Yes No AN 200 http://www.myshop.com/cancel.html
Card.Brand Brand of a credit/debit/purchasing card.

You can consult a list of BRAND values on Support > Integration and user manuals > Technical guides > Payment Methods Processing/Procedures@

If you send the BRAND field without sending a value in the PM field (‘CreditCard’ or ‘Purchasing Card’), the BRAND value will not be taken into account.
Yes No AN 25 Visa
Card.PaymentMethod

Payment Method.

You can consult a list of PM values on Support > Integration and user manuals > Technical guides > Payment Methods Processing/Procedures

Yes No AN 26 CreditCard
CARDNO Card number or account number.

The rules on how our system has to mask credit card numbers - in any output, display or email - are set by PCI.

For VISA, VISA PC, MASTERCARD, MASTERCARD PC and MASTERCARD PC CM CIC the 4 last digits will be visible.

For all other brands/payment methods the part that is masked depends on the length of the card number or account number:

If the number is longer than 15 digits: the 6 first and 2 last digits are visible, with xxxxxxxx (8x) in the middle.
If the number is from 12 to 15 digits long: the first 4 and last 2 digits are visible, with xxxxxx (6x) in the middle.
If the number is from 8 to 11 digits long: the first 2 and last 2 digits are visible, with xxxx (4x) in the middle.
If the number is from 4 to 7 digits long: the first and last digit is visible, with xx (2x) in the middle.
If the number is less than 4 digits long, the whole number will be masked.

The account number will never be visible for offline bank transfer and Payment on Delivery.

The account number for Direct Debits transactions will be masked when the transaction is in status 4 – order stored, if the buyer has to send a signed fax to confirm the payment.
Yes Yes AN 21 XXXXXXXXXXXX1111
CATALOGURL Merchant’s catalog URL. Yes No AN 200 http://www.myshop.com/shop.html
CAVV_3D Cardholder Authentication Verification Value. It is a cryptographic value, derived by the Issuer during payment authentication, that provides evidence of the results of payment authentication during the transaction. No Yes AN 300
CAVVALGORITHM_3D The algorithm that was used for generating the CAVV. No Yes N 1 5
CCCTY Country where the card was issued, in ISO 3166-1-alpha-2 code values (http://www.iso.org/iso/country_codes/iso_3166_code_lists.htm). If this parameter is not available, “99” will be returned in the response.

This credit card country check is based on externally provided listings, so there is a slight risk since we rely on the correctness of this list. The check gives positive results in 94% of all cases.
No Yes AN 2 US
CH_AUTHENTICATION_INFO 3DSv2 feedback parameter.
Contains detailed information from your customers issuer when they reject your customers transactions.
Note that not all issuers share information about why they decline transactions. Therefore, in some cases, CH_AUTHENTICATION_INFO is empty
No Yes AN 128 Please contact your bank for further information.
CIVILITY Civility of the customer (Mr., Mrs, Miss, Herr, etc.) Yes No AN 5 Mr.
CN Card holder (customer) name.

Special characters are allowed, but quotes must be avoided. Most acquirers don’t check the customer name since names can be written in different ways.
Yes Yes AN Min. 2 - Max. 35 John Doe
COF_INITIATOR

Credential-on-file initiator
Possible values:
CIT: A transaction initiated by a cardholder.
MIT: A transaction initiated by a merchant.
More details available in e-Commerce and DirectLink guides on our support site.
The default values are flagged if you don’t add any parameters. However, if you want to change it, you can overwrite these default values by sending the new parameters.
Examples:
Applies when an alias is used or created:
COF_INITIATOR = CIT
COF_TRANSACTION = FIRST
COF_SCHEDULE = UNSCHED
Applies to a first scheduled payment / subscription:
COF_INITIATOR = CIT
COF_TRANSACTION = FIRST
COF_SCHEDULE = SCHED
Applies to recurring (nonscheduled) transaction when an alias is used or created:
COF_INITIATOR = MIT
COF_TRANSACTION = SUBSEQ
COF_SCHEDULE = UNSCHED
Applies to installment:
COF_INITIATOR = MIT
COF_TRANSACTION = SUBSEQ
COF_SCHEDULE = SCHED

Yes No 3 CIT,MIT
COF_SCHEDULE Credential-on-file scheduled" or "unscheduled"
Possible values:
SCHED: A scheduled transaction.
UNSCHED: An unscheduled transaction.
More details available in e-Commerce and DirectLink guides on our support site.
The default values are flagged if you don’t add any parameters. However, if you want to change it, you can overwrite these default values by sending the new parameters.
Examples:
Applies when an alias is used or created:
COF_INITIATOR = CIT
COF_TRANSACTION = FIRST
COF_SCHEDULE = UNSCHED
Applies to a first scheduled payment / subscription:
COF_INITIATOR = CIT
COF_TRANSACTION = FIRST
COF_SCHEDULE = SCHED
Applies to recurring (unscheduled) transaction when an alias is used or created:
COF_INITIATOR = MIT
COF_TRANSACTION = SUBSEQ
COF_SCHEDULE = UNSCHED
Applies to installment:
COF_INITIATOR = MIT
COF_TRANSACTION = SUBSEQ
COF_SCHEDULE = SCHED
Yes No 7 SCHED,UNSCHED
COF_TRANSACTION Credential-on-file transaction"
Possible values:
FIRST: First of a series of transactions.
SUBEQ: Subsequent series of transactions.
More details available in e-Commerce and DirectLink guides on our support site.
The default values are flagged if you don’t add any parameters. However, if you want to change it, you can overwrite these default values by sending the new parameters.
Examples:
Applies when an alias is used or created:
COF_INITIATOR = CIT
COF_TRANSACTION = FIRST
COF_SCHEDULE = UNSCHED
Applies to a first scheduled payment / subscription:
COF_INITIATOR = CIT
COF_TRANSACTION = FIRST
COF_SCHEDULE = SCHED
Applies to recurring (unscheduled) payment when an alias is used or created:
COF_INITIATOR = MIT
COF_TRANSACTION = SUBSEQ
COF_SCHEDULE = UNSCHED
Applies to installment:
COF_INITIATOR = MIT
COF_TRANSACTION = SUBSEQ
COF_SCHEDULE = SCHED
Yes No 5 FIRST,SUBSEQ
COM Order description

The com field is sometimes transmitted to the acquirer (depending on the acquirer), in order to be shown on the account statements of the merchant or the customer.
Yes No AN 100 Three telephone cards
COMPLUS Field to submit a value you wish to receive back in the post sale request or output.

COMPLUS is different from “com” in the sense that the COMPLUS field is longer, however, the COMPLUS info will not be shown in the back-office.
Can be used to get back session info, order content or user info after the transaction.
Yes Yes AN 1000 Three telephone cards
CREDITCODE

Code to indicate the payment modality of a payment method. This parameter is used only with specific payment methods (referenced in the dedicated guides)

Yes No N 3 001
CUID

The Client Unique Identifier (CUI) is an identifier allocated by the merchant to his customer. It can be a name, client number, e-mail address etc.

Yes No AN 50 2014101512366
CURRENCY Currency of the transaction.

Currency of the amount in alphabetic ISO code as can be found on http://www.currency-iso.org/iso_index/iso_tables/iso_tables_a1.htm

The possible currencies on our platform are: AED, ANG, ARS, AUD, AWG, BGN, BRL, BYR, CAD, CHF, CNY, CZK, DKK, EEK, EGP, EUR, GBP, GEL, HKD, HRK, HUF, ILS, ISK, JPY, KRW, LTL, LVL, MAD, MXN, NOK, NZD, PLN, RON, RUB, SEK, SGD, SKK, THB, TRY, UAH, USD, XAF, XOF, XPF and ZAR

If a merchant wants to accept payments in a currency that is not in our list, he can ask us to add the currency.

The currencies a merchant can accept payments in depend on the contract with his acquirer.

If the merchant wants to accept a currency that is not supported by his acquirer, we can set a dynamic currency conversion on our side (this is a paying option).
Yes Yes AN 3 EUR
CVC Card Validation Code. This verification code is an authentication code uniquely linked to the card number, but is not part of the card number itself. Depending on the brand, this code has a different name (CVC2 or Card Validation Code for MasterCard, CVV2 or Card Verification Value for VISA, CID or Card Identification Number for American Express). However, the code is generally referred to as “CVC”.
Depending on the card brand, the verification code will be a 3 or 4 digit code on the front or rear of the card, an issue number, a start date or a date of birth:

VISA and MasterCard: 3 digit code on the rear of the card on the signature strip (after the full customer account number or after the last 4 digits of the customer account number).

American Express: 4 digit code above the account number on the front of the card.

Aurora, Aurore and Cofinoga: birth date (DD/MM/YYYY or DDMMYYYY).
Yes No N 5 758
CVCCHECK Result of the card verification code check. Only a few acquirers return specific CVC check results. For most acquirers, the CVC is assumed to be correct if the transaction is succesfully authorised.

Possible values:

KO: The CVC has been sent but the acquirer has given a negative response to the CVC check, i.e. the CVC is wrong.
OK: The CVC has been sent and the acquirer has given a positive response to the CVC check, i.e. the CVC is correct OR
The acquirer sent an authorisation code, but did not return a specific result for the CVC check.
NO: All other cases. For instance, no CVC transmitted, the acquirer has replied that a CVC check was not possible, the acquirer declined the authorisation but did not provide a specific result for the CVC check, …
No Yes AN 2 OK
DATATYPE The value is TRAVEL if you provide travel data to our system and is a mandatory field Yes No AN 6 TRAVEL
DATEIN check-in date Yes No dd/MM/yyyy 10 40658
DATEOUT check-out date Yes No dd/MM/yyyy 10 40659
DCC_COMMPERCENTAGE eDCC commission percentage No Yes N
DCC_CONVAMOUNT eDCC converted amount No Yes N
DCC_CONVCCY eDCC destination currency No Yes AN 3 EUR
DCC_EXCHRATE eDCC exchange rate No Yes N
DCC_EXCHRATESOURCE eDCC source of conversion rate No Yes N 50
DCC_EXCHRATETS eDCC timestamp of the conversion rate No Yes N
DCC_INDICATOR eDCC indicator No Yes N
DCC_MARGINPERCENTAGE eDCC margin percentage No Yes N
DCC_VALIDHOURS eDCC validity (in hours) of the conversion rate, starting from the date/time defined in DCC_EXCHRATETS No Yes N
DECLINEURL URL of the web page to show the customer when the acquirer rejects the authorisation more than the maximum of authorised tries (10 by default, but can be changed in the technical information page). Yes No AN 200 http://www.myshop.com/decline.html
DEVICE In order to display a payment page adapted for mobile devices, send the value "mobile". Only works with Paypal/Postfinance Payment/Bancontact/Mister Cash methods. Yes No AN 6 mobile
DIGESTCARDNO SHA digest of the card number used during transaction No Yes AN 128 68BFB396F35AF3876FC509665B3DC23A0930AAB1
ECI Electronic Commerce Indicator. The ECI indicates the security level at which the payment information is processed between the cardholder and merchant.

A default ECI value can be set in the Technical Information page. An ECI value sent along in the transaction, will overwrite the default ECI value.

It is the merchant's responsibility to give correct ECI values for the transactions. For e-Commerce, our system sets ECI value 5, 6 or 7 depending on the 3-D Secure authentication result.

Possible values:

0 - Swiped

The merchant took the customer's credit card and swiped it through a machine that read the magnetic strip data of the card.

1 - Manually keyed (MOTO) (card not present)

The merchant received the customer's financial details over the phone or via fax/mail, but does not have the customer's card at hand.

2 - Recurring (from MOTO)

The customer's first transaction was a Mail Order / Telephone Order transaction, i.e. the customer gave his financial details over the phone or via mail/fax to the merchant. The merchant either stored the details himself or had these details stored in our system using an Alias and is performing another transaction for the same customer (recurring transaction).

3 - Installment payments

Partial payment of goods/services that have already been delivered, but will be paid for in several spread payments.

4 - Manually keyed, card present

The customer is physically present in front of the merchant. The merchant has the customer's card at hand. The card details are manually entered, the card is not swiped through a machine.

5 - Cardholder identification successful

The cardholder's 3-D Secure identification was successful, i.e. there was a full authentication. (Full thumbs up)

6 - Merchant supports identification but not cardholder, The merchant has a 3-D Secure contract, but the cardholder's card is not 3-D Secure or is 3-D Secure but the cardholder is not yet in possession of the PIN (Half thumbs up). Conditional payment guarantee rules apply.

7 - E-commerce with SSL encryption

The merchant received the customer's financial details via a secure (SSL encrypted) website (either the merchant's website or our secure platform).

9 - Recurring (from e-commerce)

The customer's first transaction was an e-Commerce transaction, i.e. the customer entered his financial details himself on a secure website (either the merchant's website or our secure platform). The merchant either stored the details himself or had these details stored in our system using an Alias and is now performing another transaction for the same customer (recurring transaction), using the Alias details.
Yes No N 2 4
ECI_3D

5: cardholder identification successful

6: proof of authentication attempt
12: issuer is not enrolled
91: Cardholder identification failed. Transaction is declined (status 2)
92: ACS page temporarily unavailable, but continue anyway

No Yes N 2 5
ECOM_BILLTO_POSTAL_CITY Invoicing City Yes No AN 25 Brussels
ECOM_BILLTO_POSTAL_COUNTRYCODE Invoicing Country Yes No AN 2 BE
ECOM_BILLTO_POSTAL_COUNTY Invoicing county Yes No AN 25 South Yorkshire (UK)
ECOM_BILLTO_POSTAL_NAME_FIRST First name of the billed customer Yes No AN 35 Bill
ECOM_BILLTO_POSTAL_NAME_LAST Last name of the billed customer Yes No AN 35 Smith
ECOM_BILLTO_POSTAL_POSTALCODE Invoicing Postal Code Yes No AN 10 1200
ECOM_BILLTO_POSTAL_STREET_LINE1

Billing address, first line

Yes No AN 60 Billing Street
ECOM_BILLTO_POSTAL_STREET_LINE2

Billing address, second line

Yes No AN 60 Building 123
ECOM_BILLTO_POSTAL_STREET_NUMBER House number of invoicing address Yes No AN 10 1
ECOM_CONSUMER_GENDER Gender Yes No AN (M or F) 1 F
ECOM_CONSUMERID Customer identification on the merchant's system. Yes No AN 50 Customer1
ECOM_PAYMENT_CARD_VERIFICATION See 'CVC'. Yes No N 5 758
ECOM_SHIPMETHODDETAILS Identification of collection point Yes No AN 50
ECOM_SHIPTO_COMPANY Delivery address: Company Yes No AN 50 My Company
ECOM_SHIPTO_DOB

Date of Birth

Yes No dd/MM/yyyy 10 01/01/2001
ECOM_SHIPTO_ONLINE_EMAIL E-mail address Yes No AN 50 bill@smith.com
ECOM_SHIPTO_POSTAL_CITY Shipping city Yes No AN 25 Brussels
ECOM_SHIPTO_POSTAL_COUNTRYCODE Shipping Country code Yes No AN 2 BE
ECOM_SHIPTO_POSTAL_COUNTY Delivery county Yes No AN 25 Bailey (US, TX)
ECOM_SHIPTO_POSTAL_NAME_FIRST First name of shipped customer Yes No AN 35 Bill
ECOM_SHIPTO_POSTAL_NAME_LAST Last name of shipped customer Yes No AN 35 Smith
ECOM_SHIPTO_POSTAL_NAME_PREFIX Prefix of the Shipped customer Yes No AN 10 Mr.
ECOM_SHIPTO_POSTAL_POSTALCODE Shipment postal code Yes No AN 10 1200
ECOM_SHIPTO_POSTAL_STATE Delivery State, ISO code Yes No AN 2 CA (California)
ECOM_SHIPTO_POSTAL_STREET_LINE1 Shipping address, first line Yes No AN 35 Ship street
ECOM_SHIPTO_POSTAL_STREET_LINE2 Shipping address, second line Yes No AN 35 Building 2
ECOM_SHIPTO_POSTAL_STREET_NUMBER House number of shipping address Yes No AN 10 2
ECOM_SHIPTO_TELECOM_FAX_NUMBER Fax Number of shipping address Yes No AN 20 +32 2 123 4567
ECOM_SHIPTO_TELECOM_PHONE_NUMBER Phone Number of shipping address Yes No AN 20 +32 2 123 456
ED

Expiry date. This date must not be in the past, compared to the date the transaction is processed in our system.

When there is no expiry date available (e.g. for bank transfers) the value 9999 is used.

Yes Yes Input: MM/YY or MMYY Output: MMYY 7 1224
EMAIL Customer’s email address. If you are requesting 3DSv2.1, please ensure that the format of the email is valid, otherwise the authentication process will fall back to 3DS 1.0. Yes No AN 50 John.Doe@test.com
EXCEPTIONURL URL of the web page to show the customer when the payment result is uncertain. Yes No AN 200 http://www.myshop.com/exception.html
EXCLPMLIST List of Payment methods that should NOT be displayed on the payment page Yes No AN 500 VISA;MasterCard;American Express
FLAG3D Fixed value: 'Y' Instructs our system to perform 3-D Secure identification if necessary. Yes No AN 1 Y
FONTTYPE Font type/family used on the payment page. Yes No AN N/A Arial
GLOBORDERID Global order reference grouping several orders together, allows you to request a maintenance operation on these transactions together later on. Yes No AN 15 neworders15
HOMEURL Merchant’s homepage URL. Yes No AN 200 http://www.myshop.com
HTML_ANSWER BASE64 encoded html code to be added in the html page returned to the customer.
This tag is added as a child of the global tag XML . The field HTML_ANSWER contains HTML code that has to be added in the html page returned to the browser’s client.
This code will automatically load the issuer bank identification page in a pop-up the main window, depending on the WIN3-D Secure parameter value.
To avoid any interference between the html tags included in the content of the XML tag HTML_ANSWER, with the rest of the XML returned as a response to the DirectLink request, the HTML_ANSWER content is BASE64 encoded by our system before returning the response. Consequently, this must be BASE64 Decoded before including it in the html page sent to the cardholder.
No Yes AN N/A
HTTP_ACCEPT The Accept request-header field in the cardholder browser, used to specify certain media types which are acceptable for the response. This value is used by the issuer to check if the cardholder browser is compatible with the issuer identification system. Yes No AN 500 Accept: */*
HTTP_USER_AGENT The User-Agent request-header field in the cardholder browser, containing information about the user agent originating the request. This value is used by the issuer to check if the cardholder browser is compatible with the issuer identification system. Yes No AN 255 User-Agent: Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.0)
IP Customer’s IP address, as detected by our system in a 3-tier integration, or sent to us by the merchant in a 2-tier integration Yes Yes AN 20 192.168.1.1
IPCTY Originating country of the IP address in ISO 3166-1-alpha-2 code values (http://www.iso.org/iso/country_codes/iso_3166_code_lists.htm). If this parameter is not available, “99” will be returned in the response.

There are 4 specific IP codes which refer to IP addresses for which the country of origin is uncertain:

  • A1: Anonymous proxy. Anonymous proxies are Internet access providers that allow Internet users to hide their IP address.
  • AP: Asian Pacific region
  • EU: European network
  • A2: Satellite providers

The IP check is based on externally provided IP listings, so there is a slight risk since we rely on the correctness of this list. The check gives positive results in 94% of all cases.
No Yes AN 2 UK
ISSUERID To pre-select a bank for an iDEAL transaction that matches the bank's BIC. Yes No N 10 ABNANL2A
ITEMATTRIBUTES*XX* Item Attributes
replace *XX* with a number to submit several items
Yes No AN 50
ITEMCATEGORY*XX* Item Category
replace *XX* with a number to submit several items
Yes No AN 50
ITEMCOMMENTS*XX* Item Comments
replace *XX* with a number to submit several items
Yes No AN 255
ITEMDESC*XX* Item Description
replace *XX* with a number to submit several items
Yes No AN 16
ITEMDISCOUNT*XX* Item Discount
replace *XX* with a number to submit several items
Yes No N
ITEMID*XX* Item Identifier
replace *XX* with a number to submit several items
Yes No AN 15
ITEMNAME*XX* Item Name
replace *XX* with a number to submit several items
Yes No AN 40
ITEMPRICE*XX* Item Price
replace *XX* with a number to submit several items
Yes No N
ITEMQUANT*XX* Item Quantity
replace *XX* with a number to submit several items
Yes No N
ITEMQUANTORIG*XX* Maximum quantity per item Yes No N
ITEMUNITOFMEASURE*XX* Item Unit of measure (to be used in conjunction with ITEMWEIGHT*XX*) Yes No AN 50
ITEMVAT*XX* Item VAT Amount Yes No N
ITEMVATCODE*XX* Item VAT Code Yes No N
ITEMWEIGHT*XX* Item Weight Yes No N
LANGUAGE The payment page languages currently offered to the buyer (card holder / account holder).

The format is language_Country".
The language value is based on ISO 639-1.
The country value is based on ISO 3166-1.

Default language used if no language value or if an invalid language value is sent:
en_US (English)

Other available languages are:
ar_AR (Arabic)
cs_CZ (Czech)
da_DK (Danish)
de_DE (German)
el_GR (Greek)
es_ES (Spanish)
fi_FI (Finnish)
fr_FR (French)
he_IL (Hebrew)
hu_(HU hungarian)
it_IT (Italian)
ja_JP (Japanese)
ko_KR (Korean)
nl_BE (Flemish)
nl_NL (Dutch)
no_NO (Norwegian)
pl_PL (Polish)
pt_PT (Portugese)
ru_RU (Russian)
se_SE (Swedish)
sk_SK (Slovak)
tr_TR (Turkish)
zh_CN (Simplified Chinese)"
Yes No AN 5 fr_FR
Layout.Language The payment page languages currently offered to the buyer (card holder / account holder).

The format is language_Country".
The language value is based on ISO 639-1.
The country value is based on ISO 3166-1.

Default language used if no language value or if an invalid language value is sent:
en_US (English)

Other available languages are:
ar_AR (Arabic)
cs_CZ (Czech)
da_DK (Danish)
de_DE (German)
el_GR (Greek)
es_ES (Spanish)
fi_FI (Finnish)
fr_FR (French)
he_IL (Hebrew)
hu_(HU hungarian)
it_IT (Italian)
ja_JP (Japanese)
ko_KR (Korean)
nl_BE (Flemish)
nl_NL (Dutch)
no_NO (Norwegian)
pl_PL (Polish)
pt_PT (Portugese)
ru_RU (Russian)
se_SE (Swedish)
sk_SK (Slovak)
tr_TR (Turkish)
zh_CN (Simplified Chinese)"
Yes No AN 5 en_US
LOGO Logo to display on the payment page. Yes No AN N/A myshoplo.gif or https://www.myshop.com/myshoplo.gif
MANDATEID Direct Debits DE/NL: Unique mandate reference Yes Yes AN 35
Mpi. provisionAttemptsInTheLast24Hours

Number of Add Card
attempts in the last 24 hours.
Between 0 and 999

mpiunique

Yes No AN 3 10
Mpi.cardholderAccountAgeIndicator

Cardholder Account Age Indicator
Card holder account is a client account a card holder registered with a 3DS requestor (e.g. at a merchant's homepage) while the payment account is the cardholder’s account with the issuer. The card holder account” refers to the payment card number which is defined by ISO/IEC 7812.

Length of time that the cardholder has had the account with the merchant.
01 = No account (guest check-out)
02 = Created during this transaction
03 = Less than 30 days
04 = 30−60 days
05 = More than 60 days

Length of time that the cardholder has had the account with the merchant.
01 = No account (guest check-out)
02 = Created during this transaction
03 = Less than 30 days
04 = 30−60 days
05 = More than 60 days

Yes No 01
Mpi.cardholderAccountChange

Cardholder Account Change
Card holder account is a client account a card holder registered with a 3DS requestor (e.g. at a merchant's homepage) while the payment account is the cardholder's account with the issuer. The card holder account” refers to the payment card number which is defined by ISO/IEC 7812.

Date that the cardholder's account with the merchant was last changed, including Billing or Shipping address, new payment account or new user(s) added.

Yes No YYYYMMDD 8 20190101
Mpi.cardholderAccountChangeIndicator

Card holder account is a client account a card holder registered with a 3DS requestor (e.g. at a merchant's homepage) while the payment account is the cardholder's account with the issuer. The card holder account” refers to the payment card number which is defined by ISO/IEC 7812.

01 = Changed during this transaction
02 = Less than 30 days
03 = 30−60 days
04 = More than 60 days

Yes No AN 2 01
Mpi.cardholderAccountDate

Card holder account is a client account a card holder registered with a 3DS requestor (e.g. at a merchant's homepage) while the payment account is the cardholder's account with the issuer. The card holder account” refers to the payment card number which is defined by ISO/IEC 7812.

Date that the cardholder opened the account with the merchant.

"
Yes No YYYYMMDD 8 20190101
Mpi.cardholderAccountPasswordChangeIndicator

Card holder account is a client account a card holder registered with a 3DS requestor (e.g. at a merchant's homepage) while the payment account is the cardholder's account with the issuer. The card holder account refers to the payment card number which is defined by ISO/IEC 7812.

Indicates the length of time since the cardholder's account with the merchant had a password change or account reset.

Length: 2 characters Data Type: String Values accepted:
01 = No change
02 = Changed during this transaction
03 = Less than 30 days
04 = 30−60 days
05 = More than 60 days

Yes No AN 2 01
Mpi.challengeWindowSize

Dimensions of the challenge window that has been displayed to the Cardholder. The ACS shall reply with content that is formatted to appropriately render in this window to provide the best possible user experience. Preconfigured sizes are width x height in pixels of the window displayed in the Cardholder browser window.
01 = 250 x 400
02 = 390 x 400
03 = 500 x 600
04 = 600 x 400
05 = Full screen

Yes No AN 2 01
Mpi.deliveryEmailAddress For Electronic delivery, the email address to which the merchandise was delivered. Yes No AN 254 example@example.com
Mpi.deliveryTimeframe

Indicates the merchandise delivery timeframe.
01 = Electronic Delivery
02 = Same day shipping
03 = Overnight shipping
04 = Two-day or more shipping

Yes No AN 2 01
Mpi.giftCardAmount For prepaid or gift card purchase, the purchase amount total of prepaid or gift card(s) in major units (for example, USD 123.45 is 123). Between 0 and 999999999999999 Yes No AN 15 123
Mpi.giftCardCount For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased. Between 0 and 99 Yes No AN 2 10
Mpi.giftCardCurrency For prepaid or gift card purchase, the currency code of the card as defined in ISO 4217 Yes No AN 3 USD
Mpi.HomePhone.countryCode Country code of a home phone
ITU-E.164 country code
Yes No AN 3 55
Mpi.HomePhone.subscriber Home phone (without country code) Yes No AN 15 1234
Mpi.merchantFraudRate Merchant Fraud Rate in the EEA (all EEA card fraud divided by all EEA card volumes) calculated as per PSD2 Regulatory Technical Standards (RTS).
Make sure to calculate the rate according to PSD2 RTS Article 19 regulation, as neither MasterCard nor we will validate the score.
Values accepted:
1 (represents fraud rate less than or equal to 1 basis point [bp], which is 0.01%)
2 (represents fraud rate between 1 bp + - and 6 bps)
3 (represents fraud rate between 6 bps + - and 13 bps)
4 (represents fraud rate between 13 bps + - and 25 bps)
5 (represents fraud rate greater than 25 bps)
Yes No AN 2 1
Mpi.MobilePhone.countryCode Country code of a mobile phone
ITU-E.164 country code
Yes No AN 3 55
Mpi.MobilePhone.subscriber Mobile phone (without country code) Yes No AN 15 1234
Mpi.numberOfPurchaseWithAccountInTheLastSixMonths

Card holder account is a client account a card holder registered with a 3DS requestor (e.g. at a merchant's homepage) while the payment account is the cardholder's account with the issuer. The card holder account refers to the payment card number which is defined by ISO/IEC 7812.

Number of purchases with this cardholder account during the previous six months. Between 0 and 9999

Yes No AN 4 10
Mpi.paymentAccountAge

Card holder account is a client account a card holder registered with a 3DS requestor (e.g. at a merchant's homepage) while the payment account is the cardholder's account with the issuer. The card holder account refers to the payment card number which is defined by ISO/IEC 7812.

Date that the payment account was enrolled in the cardholder’s account with the merchant.

Yes No YYYYMMDD 8 20190101
Mpi.paymentAccountAgeIndicator

Card holder account is a client account a card holder registered with a 3DS requestor (e.g. at a merchant's homepage) while the payment account is the cardholder's account with the issuer. The card holder account refers to the payment card number which is defined by ISO/IEC 7812.

Indicates the length of time that the payment account was enrolled in the cardholder's account with the merchant.
01 = No account (guest check-out)
02 = During this transaction
03 = Less than 30 days
04 = 30−60 days
05 = More than 60 days

Yes No AN 2 01
Mpi.preOrderDate For a pre-ordered purchase, the expected date that the merchandise will be available. Yes No YYYYMMDD 8 20190101
Mpi.preOrderPurchaseIndicator

Indicates whether Cardholder is placing an order for merchandise with a future availability or release date.
01 = Merchandise available
02 = Future availability

Yes No AN 2 01
Mpi.reorderItemsIndicator

Indicates whether the cardholder is reordering previously purchased merchandise.
01 = First time ordered
02 = Reordered

Yes No AN 2 01
Mpi.secureCorporatePayment Secure Corporate Payment
Indicates that dedicated payment processes and procedures were used and that potential secure corporate payment exemption applies.
Send this field only with Y if the acquirer exemption field is blank, as acquirer exemption and secure payment are mutually exclusive.
However, the directory server (DS) will not validate the conditions in the extension. The DS will pass data as sent.
You can optionally indicate if they apply to the dedicated processes and protocols as per PSD2 RTS Article 17, which would potentially allow the issuer to claim the secure corporate payment exemption.
Value accepted: Y / N
Yes No 1 Y
Mpi.shippingAddressUsage

Date when the shipping address used for this transaction was first used with the merchant.

Yes No AN 8 20190101
Mpi.shippingAddressWasFirstUsed

Indicates when the shipping address used for this transaction was first used with the merchant.
01 = This transaction
02 = Less than 30 days
03 = 30−60 days
04 = More than 60 days

Yes No AN 2 01
Mpi.shippingIndicator Indicates shipping method chosen for the transaction. Merchants must choose the Shipping Indicator code that most accurately describes the cardholder’s specific transaction, not their general business.
If one or more items are included in the sale, use the Shipping Indicator code for the physical goods, or if all digital goods, use the Shipping Indicator code that describes the most expensive item.
01 = Ship to cardholder’s billing address
02 = Ship to another verified address on file with merchant
03 = Ship to address that is different than the cardholder’s billing address
04 = Ship to Store” / Pick-up at local store (Store address shall be populated in shipping address fields)
05 = Digital goods (includes online
06 = Travel and Event tickets
Yes No AN 2 01
Mpi.shippingNameAndCardholderNameAreIdentical Indicates if the Cardholder Name on the account is identical to the shipping Name used for this transaction (possible values TRUE or FALSE). Yes No A 5 TRUE
Mpi.suspiciousAccountActivityDetected Indicates whether the merchant has experienced suspicious activity (including previous fraud) on the cardholder account (possible values TRUE or FALSE). Yes No A 5 TRUE
Mpi.threeDSRequestorAuthenticationData Data that documents and supports a specific authentication process. In the current version of the specification, this data element is not defined in detail; however the intention is that for each merchant Authentication Method, this field carries data that the ACS can use to verify the authentication process. For example, for method:
02—field can carry generic merchant authentication information
03—data element can carry information about the provider of the federated ID and related information
04—data element can carry the FIDO attestation data (including the signature)
In future versions of the specification, these details are expected to be included
Yes No AN 2048
Mpi.threeDSRequestorAuthenticationMethod

Mechanism used by the Cardholder to authenticate to the merchant.
occurred (i.e. cardholder logged in” as guest)
02 = Login to the cardholder account at the merchant system using merchant’s own credentials
03 = Login to the cardholder account at the merchant system using federated ID
04 = Login to the cardholder account at the merchant system using issuer credentials
05 = Login to the cardholder account at the merchant system using third- party authentication
06 = Login to the cardholder account at the merchant system using FIDO Authenticator
07–79 = Reserved for EMVCo future use (values invalid until defined by EMVCo)
80–99 = Reserved for DS use"

Yes No AN 2 02
Mpi.threeDSRequestorAuthenticationTimestamp

Date and time in UTC of the cardholder authentication (format YYYYMMDDHHMMSS).

Yes No Date/Time 14 20190101235959
Mpi.threeDSRequestorChallengeIndicator

Indicates whether a challenge is requested for this transaction. For example:
For 01-PA, a merchant may have concerns about the transaction, and request a challenge.
For 02-NPA, a challenge may
be necessary when adding a new card to a wallet.
For local/regional mandates or other variables.
• 01 = No preference
• 02 = No challenge requested
• 03 = Challenge requested: merchant Preference
• 04 = Challenge requested: Mandate
• 05–79 = Reserved for EMVCo future use (values invalid until defined by EMVCo)
• 80-99 = Reserved for DS use
Note: If the element is not provided, the expected action is that the ACS would interpret as 01 = No preference.

Yes No AN 2 02
Mpi.threeDSRequestorPriorAuthenticationData Data that documents and supports a specific authentication process. In the current version of the specification, this data element is not defined in detail; however the intention is that for each merchant Authentication Method,these fields carry data that the ACS can use to verify the authentication process. Yes No AN 2048
Mpi.threeDSRequestorPriorAuthenticationMethod

Mechanism used by the Cardholder to previously authenticate to the merchant.
01 = Frictionless authentication occurred by ACS
02 = Cardholder challenge occurred by ACS
03 = AVS verified
04 = Other issuer methods
05–79 = Reserved for EMVCo future use (values invalid until defined by EMVCo)
80–99 = Reserved for DS use

Yes No AN 2 02
Mpi.threeDSRequestorPriorAuthenticationTimestamp

Date and time in UTC of the prior cardholder authentication (format YYYYMMDDHHMMSS).

Yes No Date/Time 14 20190101235959
Mpi.threeDSRequestorPriorReference This data element provides additional information to the ACS to determine the best approach for handing a request.
This data element contains an ACS Transaction ID for a prior authenticated transaction (for example, the first recurring transaction that was authenticated with the cardholder).
Yes No AN 36
Mpi.transactionActivityInTheLast24Hours Number of transactions (successful and abandoned) for this cardholder account with the merchant across all payment accounts in the previous 24 hours.
Between 0 and 999
Yes No AN 3 10
Mpi.transactionActivityLastYear Number of transactions (successful and abandoned) for this cardholder account with the merchant across all payment accounts in the previous year.
Between 0 and 999
Yes No AN 3 10
Mpi.transactionType

Identifies the type of transaction being authenticated.
01 = Goods/ Service Purchase
03 = Check Acceptance
10 = Account Funding
11 = Quasi-Cash Transaction
28 = Prepaid Activation and Load

Yes No AN 2 01
Mpi.WorkPhone.countryCode Country code of a work phone ITU-E.164 country code Yes No AN 3 55
Mpi.WorkPhone.subscriber Phone used for work purposes (without country code) Yes No AN 15 1234
NCERROR

Error code.

A list with error codes is available via Support > Integration and user manuals > User guides > List of the payment statuses and error codes
The value of this parameter is 0 or empty if not applicable.

No Yes AN 10 30141001
NCERRORPLUS

Error description of the NCERROR code.

A list with descriptions is available via Support > Integration and user manuals > User guides > List of the payment statuses and error codes
The value of this parameter is 0 or empty if not applicable.

No Yes AN 255 Invalid card number
NCSTATUS Error status. In general this is the first digit of the NCERROR. No Yes AN 4 3
OPERATION The operation defines the type of requested transaction. The payment procedure configured in the Technical Information page will define the default transaction operation for a new order.  An operation value sent along in the transaction, will overwrite the default value.

Possible values for new orders:

RES: request for authorisation.
SAL: request for direct sale (payment), i.e. an authorisation automatically followed by a payment.
RFD: refund, not linked to a previous payment, so not a maintenance operation on an existing transaction. (you cannot use this operation without specific permission from your acquirer)

The possible values for maintenance operations are:

REN: renewal of authorisation, if the original authorisation is no longer valid.
DEL: delete authorisation, leaving the transaction open for possible further maintenance operations.
DES: delete authorisation, closing the transaction after this operation.
SAL: partial data capture (payment), leaving the transaction open for a possible other data capture.
SAS: (last) partial or full data capture (payment), closing the transaction (for further data captures) after this data capture.
RFD: partial refund (on a paid order), leaving the transaction open for a possible other refund.
RFS: (last) partial or full refund (on a paid order), closing the transaction after this refund.

Last (or only) operations change the global transaction status, whereas partial operations do not.

PAU: Request for pre-authorisation.

In agreement with your acquirer you can use this operation code to temporarily reserve funds on a customer's card.

Should you try to pre-authorise transactions via acquirers or with card brands that don't support pre-authorisation, these transactions will not be blocked but processed as normal authorisations (=RES).

Pre-authorisation cannot be set as the default in your Ingenico account.
Yes No A 3 RFD
ORDERID Your order number (merchant reference).

This reference is generally used by the merchant to look up his transaction in the back office.
For online, 3-tiers mode, the system also uses this reference to check if a payment is not requested twice for the same order. On request of the merchant the period of this check can be shortened or the check can be disabled.

If the acquirer is technically able to process the transaction, and if there’s no special configuration in the account, this orderID will be sent to the acquirer as reference (ref2) for the transaction. In this case the merchant will receive this ref2 field on his account statements, helping him reconcile his transactions. 
Although our system can accept up to 30 characters, the norm for most acquirers is 10 or 12. The exact accepted length and data validation format depend on the acquirer/bank.If the orderID does not comply to the ref2 rules set by the acquirer, we’ll send our PAYID as ref2 to the acquirer instead.

Avoid using spaces or special characters in the orderID.
Yes Yes 40 AB5456CB896
ORDERSHIPCOST - Yes No AN 10
ORDERSHIPTAXCODE - Yes No AN 10
OWNERADDRESS Customer’s address. Yes No AN 35 102 First Avenue
OWNERCTY Customer’s country.

Country in ISO 3166-1-alpha-2 code as can be found on https://www.iban.com/country-codes 
Yes No AN 2 BE
OWNERTELNO Customer’s phone number.

Special characters (+ or/ for instance) are allowed in this field. It’s best to be consistent in the way you send the phone numbers. 
Yes No AN 30 Batch:20 3222869611
OWNERTOWN Customer’s town. Yes No AN 25 Brussels
OWNERZIP Customer’s ZIP code. Yes No AN 10 1000
Parameters.AcceptUrl URL of the web page to show the customer when the payment is authorised. Yes No AN 255 http://www.myshop.com/accept.html
Parameters.ExceptionUrl URL of the web page to show the customer when the payment result is uncertain. Yes No AN 255 http://www.myshop.com/exception.html
Parameters.ExcludedPaymentMethods List of Payment methods that should NOT be displayed on the payment page Yes No AN 50 Diners;American Express
Parameters.ParamPlus Field to submit some parameters and their values you wish to receive back in the post sale request or final redirection. Cfr. Advanced e-Commerce

Structure :
paramname=paramvalue&paramname=paramvalue&…
Yes No AN 1000 SessionID=126548354&ShopperID=73541312
PARAMPLUS Field to submit some parameters and their values you wish to receive back in the post sale request or final redirection. Cfr. Advanced e-Commerce

Structure :
paramname=paramvalue&paramname=paramvalue&…
Yes Yes AN 1000 SessionID=126548354&ShopperID=73541312
PARAMVAR The variable part to include in the URL's used for post sale and/or Cancel-Deny requests. PARAMVAR is case sensitive and requires at least 2 chars. Yes No AN 50 webshop1
PAYID

Our system’s unique transaction reference.

The PAYID currently consists of 10 digits, but it’s an increasing number.
In the test environment the PAYID currently holds 10 digits.

Yes Yes N N/A 3126514264
PAYIDSUB History number of the operation on the PAYID. You can perform several financial operations (authorisation, payment, refund, etc.) on the same order (PAYID). Each financial operation is identified by the PAYID/PAYIDSUB. Yes Yes N N/A 1
PAYMENTOCCURRENCE Code to indicate the number of payment occurrences. This parameter is used only with specific payment methods (referenced in the dedicated guides). Yes No N 2 42
PM

Payment Method.

You can consult a list of PM values via Support > Integration and user manuals > Technical guides > Payment Methods Processing/Procedures

anchorvalue

Yes Yes AN 25 CreditCard
PMLIST

List of selected payment methods and/or card brands to show on the payment page. Separated by a semi-colon.

You can consult a list of PM and BRAND values on Support > Integration and user manuals > Technical guides > Payment Methods Processing/Procedures
 

Yes No AN 200 VISA;MasterCard;American Express
PMLISTTYPE Way to list the payment method icons on the payment page. Yes No N N/A 2
PSPID Your affiliation name in our system, chosen by yourself when opening your account with us. This is a unique identifier and can’t ever be changed. Yes No AN 30 JDoeSHOP
PSWD Password for the PSPID (default user) or a specific UserID. Yes No AN N/A BluEPr1nT8?
RECIPIENTACCOUNTNUMBER MCC 6012 retailers: Visa Additional Authorisation Data Recipient’s account number OR partially masked credit card number Yes No AN 10 12345ABCDZ6789
RECIPIENTDOB

MCC 6012 retailers: Visa Additional Authorisation Data Recipient’s date of birth

Yes No dd/MM/yyyy 10 03/02/1982
RECIPIENTLASTNAME MCC 6012 retailers: Visa Additional Authorisation Data Recipient’s surname Yes No AN 6
RECIPIENTZIP MCC 6012 retailers: Visa Additional Authorisation Data Recipient’s postcode Yes No AN 6 W1A 1AA
REF_CUSTOMERID todo Yes No AN 20 Abc-1234_5/2
REMOTE_ADDR IP address of the customer (only for Fraud Detection Module). For interfaces where our system handles the dialog with the customer (e.g. e-Commerce) the REMOTE_ADDR is directly captured by us. For other interfaces, the merchant needs to send the customer's IP address with the transaction details.

If the country check of the IP address is not necessary, send value 'NONE'.
Yes No AN N/A 212.23.45.96
RTIMEOUT Request timeout for a transaction, in seconds. The value should be between 30 and 90. The default value is 90.

When using http components for interfases such as DirectLink the merchant needs to make sure the timeout of the http component is longer than the value he sets as RTIMEOUT for the transaction.
Yes No N 2 45
SCO_CATERY Scoring categories. See the Advanced Fraud Detection Module: Scoring documentation.

Possible values: G (green), O (orange), R (red).
No Yes AN 1 G
SCORING Final score of a transaction. See the Advanced Fraud Detection Module: Scoring documentation. No Yes N 4 17
SEQUENCETYPE

Possible values to indicate the Direct Debit (NL) transaction type:


- FRST: First collection of a series of Direct Debit instructions

- RCUR: Direct Debit instructions where the debtor's authorisation is used for regular Direct Debit transactions initiated by the creditor

- FNAL: First collection of a series of Direct Debit instructions (afterwards same MandateID can't be used anymore)

- OOFF: Direct Debit instruction where the debtor's authorisation is used to initiate one single Direct Debit transaction
Yes Yes AN 4 FRST
SHASIGN

String hashed using the Secure Hash Algorithm.

The SHASIGN in the hidden fields is for the SHA-in signature (data check before the payment).
The merchant gets a SHASIGN as return in case he uses a SHA-out signature (origin check of the return).

Yes Yes AN 128 172386BFF99BC8F899035E356497D4334958F2D4
ShaSignature.ShaSign String hashed using the Secure Hash Algorithm.

The SHASIGN in the hidden fields is for the SHA-in signature (data check before the payment).
The merchant gets a SHASIGN as return in case he uses a SHA-out signature (origin check of the return).
Yes No AN 128 172386BFF99BC8F899035E356497D4334958F2D4
SIGNDATE Direct Debits NL: Date the mandate was signed by the buyer. Yes Yes YYYYMMDD 8 20140131
STATUS Status of the payment.

0

Incomplete or invalid

1

Cancelled by client

2

Authorisation refused

4

Order stored

41

Waiting client payment

5

Authorised

51

Authorisation waiting

52

Authorisation not known

59

Author. to get manually

6

Authorised and canceled

61

Author. deletion waiting

62

Author. deletion uncertain

63

Author. deletion refused

7

Payment deleted

71

Payment deletion pending

72

Payment deletion uncertain

73

Payment deletion refused

74

Payment deleted (not accepted)

75

Deletion processed by merchant

8

Refund

81

Refund pending

82

Refund uncertain

83

Refund refused

84

Payment declined by the acquirer (will be debited)

85

Refund processed by merchant

9

Payment requested

91

Payment processing

92

Payment uncertain

93

Payment refused

94

Refund declined by the acquirer

95

Payment processed by merchant

97-99

Being processed (intermediate technical status)



The table above summarises the possible statuses of the payments.

Statuses in 1 digit are 'normal' statuses:
  • 0 means the payment is invalid (e.g. data validation error) or the processing is not complete either because it is still underway, or because the transaction was interrupted. If the cause is a validation error, an additional error code (*) (NCERROR) identifies the error.
  • 1 means the customer cancelled the transaction.
  • 2 means the acquirer did not authorise the payment.
  • 5 means the acquirer authorised the payment.
  • 9 means the payment was captured.
Statuses in 2 digits correspond either to 'intermediary' situations or to abnormal events. When the second digit is:
  • 1, this means the payment processing is on hold.
  • 2, this means an unrecoverable error occurred during the communication with the acquirer. The result is therefore not determined. You must therefore call the acquirer's helpdesk to find out the actual result of this transaction.
  • 3, this means the payment processing (capture or cancellation) was refused by the acquirer whilst the payment had been authorised beforehand. It can be due to a technical error or to the expiration of the authorisation. You must therefore call the acquirer's helpdesk to find out the actual result of this transaction.
  • 4, this means our system has been notified the transaction was rejected well after the transaction was sent to your acquirer.
  • 5, this means our system hasn’t sent the requested transaction to the acquirer since the merchant will send the transaction to the acquirer himself, like he specified in his configuration.
No Yes N 2 9
STATUS_3D N: identification failed
Y: identification successful
A: proof of authentication attempt
U: directory server unavailable
Yes No AN 1 N
SUB_AM Subscription amount Yes No N N/A 100
SUB_AMOUNT Subscription amount Yes No N N/A 100
SUB_COM order description Yes No AN 100 One telephone card
SUB_COMMENT subscription comment Yes No AN 200 Monthly subscription to lf World.
SUB_CUR subscription currency Yes No AN 3 EUR
SUB_ENDDATE

subscription end date

Yes No yyyy-MM-dd 10 2021-01-01
SUB_ORDERID order ID of the subscription Yes No AN 40 order 123
SUB_PERIOD_MOMENT moment of a subscription payment, depending on sub_period_unit Yes No N N/A 1
SUB_PERIOD_NUMBER interval between each occurrence of subscription payment Yes No N N/A 15
SUB_PERIOD_UNIT unit of interval between each occurrence of subscription payment Yes No AN 2 d
SUB_STARTDATE

start date of a subscription

Yes No yyyy-MM-dd 10 2021-01-01
SUB_STATUS status of a subscription Yes No AN 1 0
SUBBRAND This field is returned if the subbrand of a main brand is used. Subbrands can be e.g. prepaid versions of credit cards (Visa/MasterCard Prepaid etc.), corporate cards or cards with special privileges (MasterCard Platinum, Visa Infinite etc.).

For this field to be returned, it needs to be added to the Dynamic e-Commerce parameters in the Transaction feedback tab of your Technical information page.
No Yes AN 25 VISA VPAY; CIRRUS
SUBSCRIPTION_ID Unique identifier of a subscription. Yes Yes AN 50 subscription1
TAXINCLUDED - Yes No AN 1 1
TBLBGCOLOR Table background colour on the payment page. Yes No AN N/A LightYellow #FFFFE0
TBLTXTCOLOR Table text colour on the payment page. Yes No AN N/A Blue #0000FF
TITLE Title on the payment page. Yes No AN N/A John's bait shop
TP Template URL (including http(s)://)/name.

When we proposed to host the merchant’s template on our server, the merchant only needs to enter his filename in the tp field instead of the whole URL, that way the merchant’s URL will become a static URL on our side.
Yes No AN N/A http://www.myshop.com/template.html
TRXDATE

Transaction date.

No Yes MM/DD/YY N/A 12/25/20
TXTCOLOR Text colour on the payment page. Yes No AN N/A DarkGreen #006400
USERID Username as specified in the account’s user management page.

The default UserID for an account is the same as the account’s PSPID. If the UserID field is left empty when making a payment request via e-Commerce or when logging in, we’ll take the PSPID field value as value for the UserID.

Avoid using spaces and special characters in the USERID.
Yes No AN Min. 5 and Max. 30 JohnD
VC Virtual Card type. Virtual cards are in general virtual, single-use credit card numbers, which can only be used on one predefined online shop. No Yes AN 3 NO
WIN3DS Way to show the identification page for 3-D Secure or for the KBC, CBC, Dexia and ING paybuttons to the customer.

Possible values : MAINW, POPUP, POPIX (DirectLink only)
Yes No AN 6 MAINW