Parameter reference

3DSECURE boolean

Ask for a 3-D Secure V1 authentication.

Example: true

3DSECUREACSTRANSACTIONID uuid(36)

Universally unique transaction identifier assigned by the ACS to identify a single transaction. Canonical format as defined in IETF RFC 4122.

Example: 4dc406b0-038d-43ef-a96c-c85352c5e2c0

3DSECUREAUTHENTICATIONAMOUNT integer

Amount of the authentication in the smallest money decimal (e.g. cents for euro). Example: 10 EUR is submitted as 1000. Shall be used if the authentication amount differs from the transaction amount. By default, Dalenys considers that the authentication amount equals the transaction amount.

Example: 1000

3DSECUREAUTHENTICATIONDATE datetime(yyyy-MM-dd HH:mm:ss)

3-D Secure authentication date in UTC. May be used if the authentication date differs from the transaction date. By default, Dalenys considers that the authentication date equals the transaction timestamp in UTC.

Example: 2020-12-01 11:00:01

3DSECURECARDENROLLED u, n, y

Card’s enrollment status. Possible values:

u:Card enrolled
n:Card not enrolled
y:Enrollment unavailable

Example: y

3DSECURECAVV hexadecimal string(max 45)

3-D Secure “Cardholder Authentication Verification Value”.

Example: 8c47ab90f2b9c3219208115b182f520360000000

3DSECURECAVVALGORITHM int (1)

3-D Secure “Cardholder Authentication Verification Value” algorithm(0-9).

Example: 3

3DSECURECHALLENGECANCELATION string(2)

Challenge Cancellation Indicator. Mandatory for CB transactions.

Accepted values:

01 = Cardholder selected “Cancel”
02 = 3DS Requestor cancelled Authentication
03 = Transaction Abandoned
04 = Transaction Timed Out at ACS—other timeouts
05 = Transaction Timed Out at ACS—First CReq not received by ACS
06 = Transaction Error
07 = Unknown
08-79 = Reserved for future EMVCo use (values invalid until defined by EMVCo)
80–99 = Reserved for future DS use

Example: 01

3DSECURECHALLENGEWINDOWSIZE 01, 02, 03, 04, 05

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.

By default, Dalenys will set the challenge window size to full size.

Related resolutions (width x height):

01 250 x 400
02 390 x 400
03 500 x 600
04 600 x 400
05 Full screen

Example: 04

3DSECUREDISPLAYMODE main,popup,top,raw

Define the 3-D Secure authentication page display mode:
main: in the current frame;
popup: in a browser popup;
top: in the parent frame (useful in case of iframe integration);
raw: to handle the redirection by yourself.

Example: main

3DSECUREDSTRANSACTIONID uuid(36)

Universally unique transaction identifier assigned by the DS to identify a single transaction. Canonical format as defined in IETF RFC 4122.

Example: 4dc406b0-038d-43ef-a96c-c85352c5e2c0

3DSECUREECI string (1)

Electronic Commerce Indicator.

Example: 5

3DSECUREEXEMPTIONREASON low_value, transaction_risk_analysis, secure_corporate_payments

3-D Secure exemption reason.

low_value = transactions below 30€
transaction_risk_analysis = applicable if payment provider’s fraud rates for card payments do not exceed the following thresholds:
0.13% to exempt transactions below €100
0.06% to exempt transactions below €250
0.01% to exempt transactions below €500
secure_corporate_payments = transactions initiated by a legal person (e.g a business). Includes payments made with virtual cards or B2B Cards.

Example: low_value

3DSECUREMODE sca, frictionless

Applied authentification mode:
sca Strong authentication;
frictionless Frictionless authentication;

Example: sca

3DSECUREOUTOFSCOPEREASON mit, moto, one_leg_out, anonymous_prepaid_card

3-D Secure out of scope reason. Shall be used if the transaction type is out of scope of Strong Customer Authentication (SCA). The following transaction types are out of scope of SCA:

mit Merchant Initiated Transactions
moto Mail Order/Telephone Order
one_leg_out
anonymous_prepaid_card

Example: mit

3DSECUREPREFERENCE sca, frictionless, nopref, scamandate

3DS Requestor Challenge Indicator. Mandatory for CB.
Accepted values:
sca ask for a strong authentication;
frictionless ask for a frictionless authentication;
nopref default value when absent, the decision will be made by Dalenys;
scamandate strong authentication required by regulation

Example: sca

3DSECURERESULT u, a, n, y, Blank (space)

PARes result convert in ASCII hexadecimal. « status » in the MPI response:
u: ACS call carried out;
n: ACS completed;
a: Authentication failed;
y: Authentication success;
Blank (space): ACS Timeout.

Example: Y

3DSECURESCORE string(2)

CB scoring. Mandatory for CB transactions.

Example: 25

3DSECURESDKAPPID uuid(36)

Universally unique ID created upon all installations and updates of the 3DS Requestor App on a Consumer Device. This will be newly generated and stored by the 3DS SDK for each installation or update. Canonical format as defined in IETF RFC 4122.

Example: 4dc406b0-038d-43ef-a96c-c85352c5e2c0

3DSECURESDKENCRYPTEDDATA string(1-64000)

JWE Object as defined in Section 6.2.2.1 containing data encrypted by the SDK for the DS to decrypt. Note: This element is the only field encrypted in this version of the EMV 3-D Secure specification.

Example:

3DSECURESDKEPHEMPUBLICKEY string(1-256)

Public key component of the ephemeral key pair generated by the 3DS SDK and used to establish session keys between the 3DS SDK and ACS. In AReq, this data element is present as its own object.

Example:

3DSECURESDKMAXTIMEOUT integer(1-2)

Indicates maximum amount of time (in minutes) for all exchanges. Must be equal or greater than 5.

Example: 5

3DSECURESDKREFERENCENUMBER string(1-32)

Identifies the vendor and version for the 3DS SDK that is integrated in a 3DS Requestor App, assigned by EMVCo when the 3DS SDK is approved.

Example:

3DSECURESDKTRANSACTIONID uuid(36)

Universally unique transaction identifier assigned by the 3DS SDK to identify a single transaction.

Canonical format as defined in IETF RFC 4122. This may utilise any of the specified versions as long as the output meets specified requirements.

Example: 4dc406b0-038d-43ef-a96c-c85352c5e2c0

3DSECURESTATUS U, N, A, Y, R, I

3-D Secure status:

Y = authentication successful
N = not authenticated
U = authentication unavailable
A = authentication attempted
R = authentication rejected
I = Informational Only

Example: y

3DSECURETRANSACTIONSTATUSREASON string(2)

Transaction status reason. Mandatory for CB transactions.
Accepted values:
01 = Card authentication failed
02 = Unknown Device
03 = Unsupported Device
04 = Exceeds authentication frequency limit
05 = Expired card
06 = Invalid card number
07 = Invalid transaction
08 = No Card record
09 = Security failure
10 = Stolen card
11 = Suspected fraud
12 = Transaction not permitted to cardholder
13 = Cardholder not enrolled in service
14 = Transaction timed out at the ACS
15 = Low confidence
16 = Medium confidence
17 = High confidence
18 = Very High confidence
19 = Exceeds ACS maximum challenges
20 = Non-Payment transaction not supported
21 = 3RI transaction not supported
22–79 = Reserved for EMVCo future use (values invalid until defined by EMVCo)
80–99 = Reserved for DS use

Example: 01

3DSECUREVERSION 1, 2, 2.1.0, 2.2.0

The version of the 3-D Secure protocol that you want to use for the transaction. It will override the setup of the account.

Example: 2

3DSECUREXID string(max 40)

3-D Secure X id
For Visa/JCB/American Express/Diners/Discover cards
The XID shall be a 40-bytes numeric value (ASCII)
For MasterCard cards
The XID field is optional for Mastercard / Maestro transactions with an ECI of 01, but should be populated with a 20-bytes alphanumeric transaction identifier\

Example: 00000000000000000501

ACCOUNTCHANGEDATE date(YYYY-MM-DD)

The date the cardholder made a change to his/her account on the merchant’s website, including billing or shipping address, new means of payment, or adding new user(s).

Example: 2018-01-10

ACCOUNTCREATIONDATE date(YYYY-MM-DD)

The date on which the cardholder opened his/her account on the merchant site.

Example: 2018-01-10

ACCOUNT_KEY string (16)

Account’s key associated with an IDENTIFIER.

Example: Y#iK*h-fZ>E<:7Ai

AGEVERIFICATION boolean

Ask for a legal age verification.

Example: true

ALIAS string(1-40)

Identifier of a previously processed payment method.

Example: A1-fc5bafe3-8c12-4314-95c7-2e15ec3220e0

ALIASMODE oneclick, subscription

Indicates the ALIAS usage mode:
oneclick indicates a one click or an online transaction;
subscription indicates an offline transaction.

Example: oneclick

AMOUNT integer

The transaction amount in the smallest money decimal (e.g. cents for euro).

Example: 1000

AMOUNTS hash

A hash of keys / values where keys are dates and values are the amounts to process:
Dates have to be in format YYYY-MM-DD;
Amounts in the smallest money decimal (e.g. cents for euro);
See the dedicated section.

Example: {#<Date: 2016-01-01 ((2457389j,0s,0n),+0s,2299161j)>=>50000, #<Date: 2016-02-01 ((2457420j,0s,0n),+0s,2299161j)>=>20000, #<Date: 2016-03-01 ((2457449j,0s,0n),+0s,2299161j)>=>10000}

APIKEY string (16)

The API key, private or public value (depending on the API KEY type) associated with an APIKEYID.

Example: a1b2c3d4e5f6g7h8

APIKEYID string (36)

ID used to authenticate a transaction using APIKEY.

Example: a688b3a1-d227-4cdd-9454-5d7cfcc74ef9

ASKIBAN boolean

Displays a dedicated input field.

Example: true

AUTHORIZATIONTYPE preauthorization, finalauthorization

Type of authorization to process.

Example: finalauthorization

AVSCODE string(1)

The Address Verification System result code. See the Address Verification System result codes section.

Example: A

AVSMESSAGE string(1, 255)

The Address Verification System result message. See the Address Verification System result codes section.

Example: A

AVSPOSTALCODE string(1-9)

The address postal code to submit to the Address Verification System.

Example: 10007

AVSSTREETNAME string(4-50)

The address street name to submit to the Address Verification System.

Example: Champs élysées

AVSSTREETNUMBER integer

The address street number to submit to the Address Verification System.

Example: 42

BANK string(8-11)

Bank Identifier Code (BIC).

Example: ABNANL2A

BILLINGADDRESS string(1-50)

The billing address. Be careful not to integrate any line breaks.

Example: 285 Fulton Street

BILLINGCITY string(1-255)

The billing city.

Example: New York

BILLINGCOUNTRY string(2)

The country code (ISO_3166-1_alpha-2).

Example: US

BILLINGFIRSTNAME string(1-15)

The first name part of the billing address.

Example: John

BILLINGLASTNAME string(1-15)

The last name part of the billing address.

Example: Doe

BILLINGMOBILEPHONE string(1-32)

Billing mobile phone number in international (E.164) format.

Example: +33666666666

BILLINGPHONE string(1-32)

Billing phone number in international (E.164) format.

Example: +33111111111

BILLINGPOSTALCODE string(1-9)

The billing postal code.

Example: 10007

BILLINGSTATE string(max 3)

The state or province of the Cardholder billing address. It is different from the country code, and should be the country subdivision code defined in ISO 3166-2 (cf https://www.iso.org/obp/ui/en/#iso:pub:PUB500001:en).
If you do not provide a value, Dalenys will use a default value for each country.

Example: IDF

BILLINGTITLE mr, miss, mrs

The title used for the billing address name.

Example: mr

CALLBACKURL string(1-32)

Web services callback URL (mutually exclusive with MAILTO). Exports destination URL.

Example: http://mydomain.com/webservices/callbacks

CARDCODE string(12-19)

The user’s bank card’s Primary Account Number (PAN).

Example: 1111222233334444

CARDCOUNTRY string(2)

The country code (format ISO_3166-1_alpha-2).

Example: US

CARDCVV string(3-4)

The user’s bank card’s cryptogram.

Example: 123

CARDENROLLDATE date(YYYY-MM-DD)

Date that the payment account was enrolled in the cardholder’s account with the 3DS Requestor.

Example: 2018-01-01

CARDFULLNAME string(1-255)

The holder’s full name (as described on the payment method). For 3-D Secure operations, the field CARDFULLNAME can only contain the following characters : [a-zA-Z1-9 -]

Example: JOHN SNOW

CARDNETWORK VISA, AMERICAN EXPRESS, MASTERCARD, BANCONTACT, CB, UNKNOWN

The cardholder’s bank card network.

Example:

CARDTYPE string

The payment method type.

Example: VISA

CARDVALIDITYDATE date(MM-YY)

Card expiry date. In case of Network Token Transaction, provide Network Token Expiration Date

Example: 12-17

CART[X][BRAND] string(1-100)

Article brand.

Example: Micropple

CART[X][CATEGORY] computersandsoftware, electronics, appliances, homeandgarden, fashion, healthandbeauty, jewellery, sport, leisureandhobbies, carsandmotorbikes, furniture, kidsandbaby, videogamesandconsoles, toysandgames, pets, foodanddrink, giftandflowers, entertainment, travel, auctionsandgroupbuying, servicesforindividuals, servicesforprofessionals

Article category.

Example: electronics

CART[X][DELIVERYEXPECTEDDATE] date(YYYY-MM-DD)

Delivery Date.

Example: 2017-06-20

CART[X][DELIVERYEXPECTEDDELAY] int (1-3)

Number of days for delivery; must be greater than 0.

Example: 2

CART[X][DELIVERYLABEL] string(1-100)

Delivery method name or description.

Example: Micropple store

CART[X][DELIVERYSPEED] standard,express

Speed of the delivery method. (Specify EXPRESS if under 48h).

Example: express

CART[X][DELIVERYTYPE] storepickup, networkpickup, travelpickup, billingaddress, carrier, edelivery, other

Delivery method:

storepickup: collection of the goods in the merchant store
networkpickup: collection in a third party point (like ups, alveol, etc.)
travelpickup: collection in an airport, train station or travel agency
billingaddress: carrier such as La Poste, Colissimo, UPS, DHL…or any private carrier using billing address
carrier: carrier such as La Poste, Colissimo, UPS, DHL…or any private carrier using shipto address
edelivery: electronic ticket issuance, download, etc.

Example: storepickup

CART[X][DISCOUNT] float

Applied discount in percentage. The decimal separator is the dot symbol.

Example: 10.5

CART[X][FEES] integer

Marketplace fees in cents.

Example: 2000

CART[X][MERCHANTITEMID] string

Item ID in the merchant system.

Example: REF-123456

CART[X][NAME] string

Item name.

Example: Laser printer

CART[X][PRICE] int

Unit price in cents, including potential taxes and discounts.

Example: 20000

CART[X][QUANTITY] integer

Quantity of this item.

Example: 3

CART[X][SUBMERCHANTEXTERNALID] string(1-64)

Submerchant account identifier in the marketplace. This field allow a special value “OPERATOR” when the item is sold by the marketplace itself (and not a sub-merchant).

Example: shop1.com

CART[X][TAX] float

Applied taxes in percentage. The decimal separator is the dot symbol.

Example: 19.5

CART[X][TOTALAMOUNT] integer

Total amount based on PRICE, QUANTITY. Also FEES when applied.

Example: 60000

CLIENTACCEPTHEADER string(max 2048)

Browser HTTP accept header. Mandatory for server to server requests.

Example: application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5

CLIENTADDRESS string(1-510)

The user’s address.

Example: 285 Fulton Street.

CLIENTAUTHMETHOD guest, credentials, federated, issuer, thirdparty, fido

Mechanism used by the Cardholder to authenticate.
Accepted values:
guest: No merchant authentication occurred (i.e. cardholder “logged in” as guest);
credentials: Login to the cardholder account at the merchant system using merchant’s own credentials;
federated: Login to the cardholder account at the merchant system using federated ID;
issuer: Login to the cardholder account at the merchant system using issuer credentials;
thirdparty: Login to the cardholder account at the merchant system using third-party authentication;
fido: Login to the cardholder account at the merchant system using FIDO Authenticator;

Example: credentials

CLIENTBENEFICIARYID int (11) or email

The user’s identifier for this payment method.

Example: john.snow@example.com

CLIENTDOB date(YYYY-MM-DD)

The user’s date of birth.

Example: 1982-06-20

CLIENTEMAIL email(5-255)

The user’s email.

Example: john.snow@example.com

CLIENTGENDER m, f

The cardholder gender.

Example: f

CLIENTIDENT string(1-255)

Unique identifier of the user in your application (e.g. a login or a primary key).

Example: john.snow

CLIENTIP ipv4

The user’s public IP address.

Example: 10.1.1.1

CLIENTJAVAENABLED yes, no

Boolean that represents the ability of the cardholder browser to execute Java. Value is returned from the navigator.javaEnabled property.

Example: `no`

CLIENTREFERRER string(1-255)

The user’s HTTP referrer URL.

Example: https://your_shop.com/order?id=1234

CLIENTSCREENCOLORDEPTH int(1-2)

Value representing the bit depth of the colour palette for displaying images, in bits per pixel.
Obtained from Cardholder browser using the screen.colorDepth property.
Accepted values:
1 = 1 bit
4 = 4 bits
8 = 8 bits
15 = 15 bits
16 = 16 bits
24 = 24 bits
32 = 32 bits
48 = 48 bits

Example: 32

CLIENTSCREENHEIGHT int(1-6)

Total height of the Cardholder’s screen in pixels. Value is returned from the screen.height property.

Example: 1280

CLIENTSCREENWIDTH int(1-6)

Total width of the cardholder’s screen in pixels. Value is returned from the screen.width property.

Example: 1024

CLIENTUSERAGENT string(1-255)

The HTTP user agent.

Example: Mozilla/5.0 (Windows NT 6.1; WOW64; rv:47.0) Gecko/20100101 Firefox/47.0

COLUMNS string(

Column list to be included in an export. (List of compatible columns)

Example: IDENTIFIER;DATE;TRANSACTIONID;ORDERID;OPERATIONTYPE;AMOUNT;CURRENCY;BILLINGFEES INCL. VAT;EXECCODE;CLIENTEMAIL;CLIENTADDRESS;CARDFULLNAME;CARDTYPE;CARDCOUNTRY;3DSECURE;3DSGLOBALSTATUS;RULE APPLIED;SCHEDULE;RETRY

COMPRESSION zip,gzip,bzip

The compression method.

Example: zip

CREATEALIAS boolean

Ask for a payment method ALIAS creation. Caution: this parameter is mutually exclusive with DISPLAYCREATEALIAS. See the dedicated section.

Example: true

DATE date(YYYY-MM)

Required and mutually exclusive with STARTDATE and ENDDATE. Month or day of data to be exported, formatted YYYY-MM or YYYY-MM-DD.

Example: 2016-12

DELIVERYEMAIL email(5-255)

For Electronic delivery, the email address to which the merchandise was delivered.

Example: john.snow@example.com

DELIVERYTIMEFRAME electronic,sameday,overnight,longer,

Indicates the merchandise delivery timeframe.

Example: sameday

DESCRIPTION string(1-510)

A short description of the operation, can be used to trigger fraud actions. Don’t hesitate to ask your Payment Manager for some advice on this topic.

Example: Knows nothing

DESCRIPTOR string

The transaction label sent to the bank network. The transaction will display with this label on the user’s bank statement.

Example: myshop.com

DISPLAYCHARGEDTRANSACTION yes, no

allows to list all charged transactions regardless of their status. Default value = no

Example: no

DISPLAYCREATEALIAS boolean

Display a checkbox on the hosted form to ask the user to save his card data for future usage. Caution: this parameter is mutually exclusive with CREATEALIAS. See the dedicated section.

Example: true

ENDDATE date(YYYY-MM-DD)

Required and mutually exclusive with DATE, works in pairs with STARTDATE. Period end date.

Example: 2017-01-31

EXTERNALENTITYID int (1-10)

Merchant account’s reference

Example:

EXTERNALREFERENCE int (9)

Transaction’s reference (string left padded with 0 of 9 digits)

Example: 19

EXTRADATA string(1-255)

Free field (Dalenys will send you back the content of the EXTRADATA you specified ahead).

Example: referrer=myshop.com;order=premium

FEES integer

Marketplace fees in cents.

Example: 2000

FILEHASH string(64)

File verification signature.

Example: 62efb12401dcbdfc61fea9de67e77c44f4e0d0ec78208f37ac0830b16ee9e41d

GIFTCARDAMOUNT integer

For prepaid or gift card purchase, the purchase amount total of prepaid or gift card(s) in minor units (cents).

Example: 100

GIFTCARDCOUNT int(1-2)

For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased.

Example: 2

GIFTCARDCURRENCY string(3)

For prepaid or gift card purchase, the currency code of the card as defined in ISO 4217.

Example: EUR

HASH string(64)

The transaction’s hash as described in the dedicated section.

Example: 15477dcb8687adf90fa51e418f3c1a2d025f40b177a978c2734514734633b3c4

HFTOKEN string(1-36)

A token to use with hosted fields integration. This token replaces card holder data in a hosted field payment request.

Example: 17730892-b3f7-4411-bc81-557471ffcede

HIDECARDFULLNAME no, yes

Hide the fullname input on the hosted form. You must supply the CARDFULLNAME. See the dedicated section for more informations.

Example: true

HIDECLIENTEMAIL no, yes

Hide the CLIENTEMAIL input on the hosted form. You must supply the CLIENTEMAIL. See the dedicated section for more informations.

Example: true

HOMEPHONE string(max 32)

The home phone number provided by the Cardholder in international (E.164) format.

Example: +33133333333

IBAN string(1-34)

IBAN

Example: DE11888888889999999999

IDENTIFICATIONDOCID string(1-32)

Identification number of the holder’s ID document.

Example: 42798

IDENTIFICATIONDOCTYPE taxstatement

Holder’s ID document type.

Example: taxstatement

IDENTIFIER string(1-32)

Your processing account technical identifier.

Example: Demo Shop

INITIALSCHEMETRANSACTIONID string(1-55)

Card scheme transaction identifier (Mastercard Trace-ID or Visa Transaction ID). Submit the original scheme transaction ID of the initial recurring payment. If provided by the card scheme, the original scheme transaction ID will be returned in the transaction notification in “SCHEMETRANSACTIONID” field.

Example: 2MCGNM21OX0729

ITEMAVAILABILITY yes, no

Indicates whether Cardholder is placing an order for merchandise with a future availability or release date.

Example: true

LANGUAGE fr, en, de, es, it, nl, zh, ru, pt, sk

Configure the hosted form display language.

Example: en

LAST12MONTHSTRANSACTIONCOUNT int(1-3)

Number of transactions (successful and abandoned) for this cardholder account with the 3DS Requestor across all payment accounts in the previous year.

Example: 4

LAST24HOURSADDCARDATTEMPTS int(1-3)

Number of “Add Card” attempts in the last 24 hours.

Example: 2

LAST24HOURSTRANSACTIONCOUNT int(1-3)

Number of transactions (successful and abandoned) for this cardholder account with the 3DS Requestor across all payment accounts in the previous 24 hours.

Example: 4

LAST6MONTHSPURCHASECOUNT int(1-4)

Number of purchases with this cardholder account during the previous six months.

Example: 4

MAILTO email

Web services callback email (mutually exclusive with CALLBACKURL).

Example: john.doe@email.com

MERCHANTITEMID string

Item ID in the merchant system.

Example: REF-123456

METADATA string(1-255)

Additional transactional data. Contact your account manager for more informations.

Example: @METADATA-MYWEBSITE

MOBILEPHONE string(max 32)

The mobile phone number provided by the Cardholder in international (E.164) format.

Example: +33633333333

NETWORKTOKENCODE string(11-19)

A network token

Example: 1111222233334444

NETWORKTOKENECI string(2)

Elecronic Commerce Identifier

Example: 06

NETWORKTOKENTAVV base64(28)

Token Authorization Verification Value. Mandatory for oneclick Transaction.

Example: AAEBAwQjS1AAXXXXXXXJYe09bQA=

NETWORKTOKENTRID string(11)

Token Requestor ID

Example: 11222444555

OPERATIONTYPE authorization, payment, capture, refund, credit, void

The action you want to process.

Example: payment

ORDERID string(1-40)

Unique ID associated to an order in the merchant’s database (as specified in your initial POST request)

Example: 1234

PASSWORDCHANGEDATE date(YYYY-MM-DD)

The date the cardholder made a password change or account reset on the merchant site.

Example: 2018-01-10

PAYMENTOPTION facilypay-3x, facilypay-3xsansfrais, facilypay-4x, facilypay-4xsansfrais, cofidis-3xcb, cofidis-4xcb, cofidis-4xpaypal, cofidis-1euro

Specific options for certain payment methods.

Example: facilypay-3x

PREORDERDATE date(YYYY-MM-DD)

For a pre-ordered purchase, the expected date that the merchandise will be available.

Example: 2018-02-01

PRESCORINGCODE string(max 20)

Cofidis scoring value.

Example: PS2110531

RECURRINGEXPIRY date(YYYY-MM-DD)

Date after which no further authorisations shall be performed in a recurring payment workwlow.

Example: 2020-01-04

RECURRINGFREQUENCY int(1-4))

Indicates the minimum number of days between authorisations.

Example: 10

RECURRINGSEQUENCE int(1-2)

Number (n+1) of times the registered card is used for a financial transaction, considering that the very first time is the initial transaction during which the card is registered (tokenized).

Example: RECURRINGSQUENCE=1 -> initial transaction during wich the card is tokenized ; RECURRINGSQUENCE=2 -> first time the card token is used ; RECURRINGSQUENCE=3 -> second time the card token is used ; etc

REDIRECTURLCANCEL string(1-2048)

URL to redirect end-user to after a cancellation.

Example: http://mydomain.com/cancel

REDIRECTURLSUCCESS string(1-2048)

URL to redirect end-user to after a successful payment.

Example: http://mydomain.com/purchase-confirmation

REORDERINGITEM yes, no

Indicates whether the cardholder is reordering previously purchased merchandise.

Example: false

SCHEDULEID string(2-32)

Schedule identifier.

Example: A123456

SCOPE CLIENTSGROUP,CLIENT, ACCOUNT

Account hierarchy to be exported.

Example: CLIENTSGROUP

SELECTEDBRAND cb, visa, vpay, electron, mastercard, maestro

Preferred brand. (Please see the dedicated documentation)

Example: cb

SHIPTOADDRESS string(1-50)

The shipping address.

Example: 55 rue de la liberté

SHIPTOADDRESSDATE date(YYYY-MM-DD)

Date when the shipping address used for this transaction was first used with the 3DS Requestor.

Example: 2018-04-02

SHIPTOADDRESSTYPE billing, verified, new, storepickup, edelivery, travelpickup, other

Shipping indicator. The parameter DELIVERYEMAIL is mandatory when edelivery mode is set.
The other ship to address fields are optional when ‘storepickup’, travelpickup or other is set.
Possible values:
billing: Ship to cardholder’s billing address
verified: Ship to another verified address on file with merchant
new: Ship to address that is different than the cardholder’s billing address
storepickup: Pick-up at local store (Store address shall be populated in shipping address fields)
edelivery: Digital goods (includes online services, electronic gift cards and redemption codes)
travelpickup: Travel and Event tickets, not shipped
other: Other (for example, Gaming, digital services not shipped, emedia subscriptions, etc.)

Example: verified

SHIPTOCITY string(1-255)

The shipping city.

Example: New York

SHIPTOCOMPANYNAME string(1-50)

Name of the company.

Example: MyShop.com

SHIPTOCOUNTRY string(2)

The country code (ISO_3166-1_alpha-2 format)

Example: US

SHIPTOFIRSTNAME string(1-15)

Holder’s first name in the shipping address.

Example: John

SHIPTOLASTNAME string(1-30)

Holder’s last name in the shipping address.

Example: Doe

SHIPTOMOBILEPHONE string(1-32)

Shipping mobile phone number in international (E.164) format.

Example: +33666666666

SHIPTOPHONE string(1-32)

Shipping phone number in international (E.164) format.

Example: +33111111111

SHIPTOPOSTALCODE string(1-9)

The shipping postal code.

Example: 10007

SHIPTOSTATE string(max 3)

The state or province of the Cardholder shipping address. It is different from the country code, and should be the country subdivision code defined in ISO 3166-2 (cf https://www.iso.org/obp/ui/en/#iso:pub:PUB500001:en).
If you do not provide a value, Dalenys will use a default value for each country.

Example: IDF

SHIPTOTITLE mr, miss, mrs

Holder’s title in the shipping address.

Example: mr

STARTDATE date(YYYY-MM-DD)

Required and mutually exclusive with DATE, works in pairs with ENDDATE. Period start date.

Example: 2016-12-01

SUBMERCHANTEXTERNALID string(1-64)

Submerchant account identifier in the marketplace. This field allow a special value “OPERATOR” when the item is sold by the marketplace itself (and not a sub-merchant).

Example: shop1.com

SUBSCRIBERACCOUNT string(1-34)

Subscriber’s IBAN.

Example: DE11888888889999999999

SUBSCRIBERDOB date(YYYY-MM-DD)

Subscriber’s date of birth.

Example: 1982-06-20

SUBSCRIBERNAME string(1-255)

Subscriber’s name.

Example: John Doe

SUBSCRIBERZIPCODE string(1-9)

Subscriber’s address postal code.

Example: 75008

SUSPICIOUSACCOUNTACTIVITY yes, no

Indicates whether the 3DS Requestor has experienced suspicious activity (including previous fraud) on the cardholder account.

Example: `no`

TERMINALID integer

Dalenys terminal id.

Example: 1

TIMEZONE string(1-128)

Timezone / default value : UTC. Please see the Data sheet dedicated list of available timezones.

Example: Europe/Paris

TRANSACTIONEXPIRATIONDATE datetime(yyyy-MM-dd HH:mm:ss)

Form expiration date. By default, the date is UTC, the timezone can be specified by using the TIMEZONE parameter.

Example:

TRANSACTIONID string(1-32)

Unique Dalenys transaction ID. Make sure to store this ID in your database.

Example: A1123456

TRAVELAGENCYCODE string(1-8)

Travel agency code

Example: 12345678

TRAVELAGENCYNAME string(1-25)

Travel agency name

Example: Travel Agency

TRAVELDEPARTUREDATE YYYY-MM-DD

Travel departure date

Example: 2020-12-01

TRAVELLEGS[X][DEPARTUREDATE] date(YYYY-MM-DD)

Departure date.

Example: 2018-12-01

TRAVELLEGS[X][DESTINATIONLOCATIONCODE] string(64)

Destination airport/city IATA code (IATA 3-letter codes format).

Example: JFK

TRAVELLEGS[X][EXCHANGEABLE] boolean

Ticket exchangeability flag.

Example: yes

TRAVELLEGS[X][INSURANCE] boolean

Travel insurance flag.

Example: yes

TRAVELLEGS[X][MEANTRANSPORT] plane, train, road, boat

Mean of transport.

Example: plane

TRAVELLEGS[X][ORIGINLOCATIONCODE] string(64)

Origin airport/city IATA code (IATA 3-letter codes format).

Example: CDG

TRAVELLEGS[X][PASSENGERCOUNT] int(1-3)

Number of travelers.

Example: 4

TRAVELLEGS[X][RANK] int(1-2)

Journey numbering from the first one to the last one.

Example: 3

TRAVELLEGS[X][SERVICECLASS] First class, Second class, Business, Economic, 0

Ticket category (“0” if no class)

Example: First class

TRAVELLEGS[X][TRAVELCARRIERCODE] string(2)

Travel carrier code

Example: AA

TRAVELLEGS[X][TRAVELCARRIERNUMBER] string(1-5)

Flight number excluding carrier code

Example: 81

TRAVELLEGS[X][TRAVELDESTINATIONLOCATIONCODE] string(3)

Destination airport/city IATA code

Example: JFK

TRAVELLEGS[X][TRAVELFAREBASISCODE] string(1-6)

Fare basis code

Example: VLVA2FI

TRAVELLEGS[X][TRAVELORIGINLOCATIONCODE] string(3)

Origin airport/city IATA code

Example: CDG

TRAVELLEGS[X][TRAVELSERVICECLASS] string(1-2)

Service class

Example: V

TRAVELLEGS[X][TRAVELSTOPOVERCODE] string(1)

Stop over code

Example: N

TRAVELPASSENGERDOB date(YYYY-MM-DD)

Traveler date of birth.

Example: 1976-07-06

TRAVELPASSENGERFIRSTNAME string(1-50)

Traveler first name.

Example: John

TRAVELPASSENGERLASTNAME string(1-50)

Traveler last name.

Example: Doe

TRAVELPASSENGERNAME string(1-20)

Passenger name

Example: JC Denton

TRAVELSTAYS[X][ARRIVALDATE] date(YYYY-MM-DD)

Arrival date.

Example: 2018-12-01

TRAVELSTAYS[X][DEPARTUREDATE] date(YYYY-MM-DD)

Departure date.

Example: 2018-12-01

TRAVELSTAYS[X][INSURANCE] boolean

Travel insurance flag.

Example: yes

TRAVELSTAYS[X][LOCATION] string(1-50)

Place of residence (City, place…).

Example: Hotel Central of New York

TRAVELSTAYS[X][PASSENGERCOUNT] int(1-3)

Number of travelers.

Example: 4

TRAVELSTAYS[X][ROOMCOUNT] string(1-3)

Number of rooms.

Example: 2

TRAVELSTAYS[X][TYPE] hotel, rental, tour/trip, other

Stay Type

Example: hotel

TRAVELSTAYS[X][VEHICLERENT] boolean

Vehicle rental flag.

Example: yes

TRAVELTICKETNUMBER string

Ticket/document number, or PNR locator code.

Example: 1059127084903

USETEMPLATE web, mobile

Which custom payment form to use.

Example: web

VERSION 3.0

The API protocol version.

Example: 3.0

WORKPHONE string(max 32)

The work phone number provided by the Cardholder in international (E.164) format.

Example: +33633333333

XPAYECI string (1)

ECI indicator, as defined by 3-D Secure. The card network may add an ECI indicator to the card data. This indicator is then included in the payment token. If you receive an ECI indicator, you must pass it on to your payment processor; otherwise, the transaction fails.

Example: 5

XPAYSOLUTION apple, samsung, android

Mobile payment solution identifier.

Example: apple

XPAYTOKEN string (no limit)

Online payment cryptogram, as defined by 3-D Secure. A Base64 encoded string.

Example: ANm+396YW5O2AASyysq9AoABFA==

XPAYTYPE browser, in_app

Type of transaction processed.

Example: browser

3DSECURE no, yes

Merchant’s request for 3D Secure authentication.

Example: true

3DSECUREAUTHENTICATIONSTATUS y, n, u, a, c, r, i, empty

Authentication status:
y: authentication successful
n: not authenticated
u: unavailable
a: attempted
c: cardholder challenge required
r: rejected
i: Informational Only
empty: no 3-D Secure

Example: y

3DSECUREFEE string (1-64)

Additional fee per transaction on arbitration for submission to a strong authentication challenge.

Example:

3DSECUREMODE sca, frictionless

sca ask for a strong authentication;
frictionless ask for a frictionless authentication

Example: sca

3DSECURESIGNATURESTATUS y, n

Signature verification status. Possible values are:
y: signature is present in PARes message
n: no signature present in PARes message

Example: y

3DSECUREVERSION 1, 2

The version of the 3-D Secure protocol that you want to use for the transaction. It will override the setup of the account.

Example: 2

3DSECURE_XID hexadecimal (40 max)

3-D Secure X id.

Example:

3DSGLOBALSTATUS ok, not_enrolled, unavailable, not_required, ko

Global status.

Example: ok

ALIAS string(1-40)

Identifier of a previously processed payment method.

Example: A1-fc5bafe3-8c12-4314-95c7-2e15ec3220e0

AMOUNT integer

The transaction amount in the smallest money decimal (e.g. cents for euro).

Example: 1000

BANK string(8-11)

Bank Identifier Code (BIC).

Example: ABNANL2A

BATCHID string(1-32)

Batch request identifier.

Example: A1234

CARD3DSECUREENROLLED y, n, u

Card 3-D Secure enrollment status. Possible values are:
y: Card enrolled
n: Card not enrolled
u: Enrollment unavailable

Example: y

CARDCODE string(12-19)

Last 4 digits of holder’s card. It is possible to receive the truncated pan (6 first digits, some X, 4 last digits) in a CARDCODE parameter by asking the activation of the option to your payment manager and by using a secure NOTIFICATION_URL (https).

Example: XXXXXXXXXXXX4444

CARDCOUNTRY string(2)

The country code (format ISO_3166-1_alpha-2).

Example: US

CARDFULLNAME string(1-255)

The holder’s full name (as described on the payment method).

Example: JOHN SNOW

CARDNETWORK VISA, AMERICAN EXPRESS, MASTERCARD, BANCONTACT, CB, UNKNOWN

The cardholder’s bank card network.

Example:

CARDTYPE string

The payment method type.

Example: VISA

CARDUSAGE enterprise, debit, credit, prepaid

Card product code.

Example:

CARDVALIDITYDATE date(MM-YY)

Card expiry date.

Example: 12-17

CHARGEBACKDATE date(YYYY-MM-DD)

Chargeback date.

Example: 2017-05-25

CHARGEBACKTYPE chargeback, representment

Chargeback type.

Example: chargeback

CLIENTEMAIL email(5-255)

The user’s email.

Example: john.snow@example.com

CLIENTIDENT string(1-255)

Unique identifier of the user in your application (e.g. a login or a primary key).

Example: john.snow

CURRENCY string(3)

Currency code (ISO 4217 format).

Example: EUR

CVVRESPONSECODE M, N, P, S, U, X, Y, Z

Authentication status:

M = CVV2/CVC2 Matches
N = CVV2/CVC2 does not Match
P = Not processed
S = The CVV2 should be on the card but the merchant indicates it is not.
U = CVV2/CVC2 Unavailable – issuer does not support this parameter
X = No information (only for JCB)
Y = CVC1 Incorrect
Z = Information not provided

Example: M

DESCRIPTION string(1-510)

A short description of the operation, can be used to trigger fraud actions. Don’t hesitate to ask your Payment Manager for some advice on this topic.

Example: Knows nothing

DESCRIPTOR string

The transaction label sent to the bank network. The transaction will display with this label on the user’s bank statement.

Example: myshop.com

EXECCODE string(4)

The operation result code. (See the complete list of execution code)

Example: 0000

EXTERNALENTITYID int (1-10)

Merchant account’s reference

Example:

EXTERNALREFERENCE int (9)

Transaction’s reference (string left padded with 0 of 9 digits)

Example: 19

EXTRADATA string(1-255)

Free field (Dalenys will send you back the content of the EXTRADATA you specified ahead).

Example: referrer=myshop.com;order=premium

HASH string(64)

The transaction’s hash as described in the dedicated section.

Example: 15477dcb8687adf90fa51e418f3c1a2d025f40b177a978c2734514734633b3c4

IBAN string(1-34)

IBAN

Example: DE11888888889999999999

IDENTIFIER string(1-32)

Your processing account technical identifier.

Example: YOUR_IDENTIFIER

INITIALSCHEMETRANSACTIONID string(1-55)

Scheme transaction ID of the first transaction used to store the card information.

Example: 11034331402111290210

LANGUAGE fr, en, de, es, it, nl, zh, ru, pt, sk

Configure the hosted form display language.

Example: en

MESSAGE string(no length limit)

The operation result description linked to EXECCODE.

Example: The transaction has been accepted

METADATA string(1-255)

Additional transactional data. Contact your account manager for more informations.

Example: @METADATA-MYWEBSITE

OPERATIONTYPE authorization, payment, capture, refund, credit, void

The action you want to process.

Example: payment

ORDERID string(1-40)

Unique ID associated to an order in the merchant’s database (as specified in your initial POST request)

Example: 1234

PP_ADDRESS_STATUS none, confirmed, unconfirmed

Status of street address on file with PayPal.

Example: `confirmed`

PP_PAYER_ID string(13)

ID of Paypal payer’s account

Example: A12345BCD6789

PP_PAYER_STATUS none, canceled-reversal, completed, denied, expired, failed, in-progress, partially-refunded, pending, refunded, reversed, processed, voided, completed-funds-held

The status of the payment.

Example: completed

PP_PROTECTION_ELIGIBILITY eligible, partiallyeligible, ineligible

The kind of seller protection in force for the transaction.

Example: eligible

PP_PROTECTION_ELIGIBILITY_TYPE itemnotreceivedeligible, unauthorizedpaymenteligible, ineligible

The kind of seller protection in force for the transaction.

Example: itemnotreceivedeligible

PP_SHIP_TO_CITY string(40 Bytes)

Shipping city.

Example: New York City

PP_SHIP_TO_COUNTRYCODE string(2)

Country code.

Example: NY

PP_SHIP_TO_NAME string(1-32)

Holder’s shipping last name.

Example: John Doe

PP_SHIP_TO_STREET string(1-100)

Shipping street address.

Example: Fulton St

PP_SHIP_TO_ZIP string(1-20)

U.S. ZIP code or other country-specific postal code.

Example: 10007

PP_TRANSACTION_ID string(20 max)

Unique transaction ID of the payment.

Example: a1B2c3D4e5F6g7H8

REDIRECTHTML string(no length limit)

HTML content to display to the user to continue the processing. The string is base64 encoded.

Example:

REDIRECTPOSTPARAMS string(no length limit)

The content is string URL encoded and contains the POST parameters to send to the REDIRECTURL.

Example: p1=v1&p2=v2

REDIRECTURL string(no length limit)

The url to redirect the user to continue the processing.

Example: http://some_url?p1=v1

REPORT string(1-50)

Report CSV file name

Example: csv_file.csv

REPORTHASH string(64)

Report CSV file signature (a sha256 of the report file).

Example: 62efb12401dcbdfc61fea9de67e77c44f4e0d0ec78208f37ac0830b16ee9e41d.

REQUESTID string(1-32)

Unique Dalenys WebTPE request ID. Make sure to store this ID in your database.

Example: W1234

SCHEMETRANSACTIONID string(1-55)

Scheme transaction ID, retrieved in response to the authorization request.

Example: 11034331402111290210

SELECTEDBRAND cb, visa, vpay, electron, mastercard, maestro

Preferred brand.

Example: CB

SHORTNAME string (1-64)

POI Short Name (POS only).

Example: store1

STAN int(6)

System Trace Audit Number.

Example: 123456

SUBMERCHANT COUNTRY string

Country of the Submerchant

Example: FR

SUBMERCHANT DOING BUSINESS AS string

Commercial name of Submerchant

Example: Example Startup

SUBMERCHANT MCC string

Merchant Category Code of the Submerchant

Example: 5945

SUBMERCHANT NAME string

Legal name of Submerchant

Example: Example Startup Inc.

SUBMERCHANT ONLINE CHANNEL boolean

Indicates the Submerchant’s e-commerce activity (true/false)

Example: true

SUBMERCHANT POS CHANNEL boolean

Indicates the Submerchan’s proximity activity (true/false)

Example: false

SUBMERCHANT STATUS string

Indicates the status of the Submerchant (Enabled / Disabled)

Example: ENABLED

SUBMERCHANT WEBSITE string

Website of the Submerchant

Example: https://www.test.com

TAGS string(no max length)

Tags set by the Dalenys’s rule engine

Example: POTENTIAL FRAUD=Volume&TO BE CHECKED=Custom 1

TERMINALID integer

Dalenys terminal id.

Example: 1

TRANSACTIONID string(1-32)

Unique Dalenys transaction ID. Make sure to store this ID in your database.

Example: A1123456

VERSION 3.0

The API protocol version.

Example: 3.0

3DSECI string (1)

Electronic Commerce Indicator.

Example: 5

3DSECURE no, yes

Ask for a 3-D Secure authentication.

Example: true

3DSECUREAUTHENTICATIONSTATUS y, n, u, a, c, r, i, empty

Authentication status:

y = authentication successful
n = not authenticated
u = unavailable
a = attempted
c = cardholder challenge required
r = rejected
i = Informational Only
empty = no 3-D Secure

Example: y

3DSECUREFEE string (1-64)

Additional fee per transaction on arbitration for submission to a strong authentication challenge.

Example:

3DSECURESIGNATURESTATUS y, n

Signature status.

Example: y

3DSGLOBALSTATUS ok, not_enrolled, unavailable, not_required, rejected

Global status.

Example: ok

3DSLIABILITYSHIFT ‘yes’, ‘no’

3D-Secure Liability Shift.

Example:

ADDITIONAL DATA string

Bank response additional data from authorization request.

Example:

ALIAS string(1-40)

Identifier of a previously processed payment method.

Example: A1-fc5bafe3-8c12-4314-95c7-2e15ec3220e0

ALIASMODE oneclick, subscription

Indicates the ALIAS usage mode:
oneclick indicates a one click or an online transaction;
subscription indicates an offline transaction.

Example: oneclick

AMOUNT integer

The transaction amount in the smallest money decimal (e.g. cents for euro).

Example: 1000

AMOUNT IN BILLING CURRENCY integer

Transaction amount in the billing currency.

Example:

ARN string

Acquirer Reference Number.

Example:

AUTHENTICATION string

Cardholder authentication mechanism.

Example: 3DSECURE

AUTHORIZATION NUMBER string

Authorization number (POS only).

Example:

AUTHORIZATIONTYPE preauthorization, finalauthorization

Type of authorization to process.

Example: finalauthorization

AUTHORIZEDBY string

Authorization transaction ID (captures only).

Example:

AVS CODE string(1)

The Address Verification System result code. See the Address Verification System result codes section.

Example: A

AVS MESSAGE string(1, 255)

The Address Verification System result message. See the Address Verification System result codes section.

Example: A

BANK COLLECTION NUMBER string(1-50)

Bank collection number (POS only).

Example:

BILLING ADDRESS string(1-50)

The billing address as specified by the merchant in the original payment request.

Example:

BILLING CITY string(1-25)

The billing city as specified by the merchant in the original payment request.

Example: New York

BILLING COUNTRY string(2)

The billing country (ISO_3166-1_alpha-2) as specified by the merchant in the original payment request.

Example: USA

BILLING CURRENCY string(3)

Billing and payment currency.

Example: EUR

BILLING FIRST NAME string(1-15)

The first name part of the billing address as specified by the merchant in the original payment request.

Example: John

BILLING LAST NAME string(1-15)

The last name part of the billing address as specified by the merchant in the original payment request.

Example: Doe

BILLING MOBILE PHONE string(1-32)

Billing mobile phone number in international format as specified by the merchant in the original payment request.

Example: 33111111111

BILLING NETWORK string(1-10)

Billing network.

Example:

BILLING PHONE string(1-32)

Billing phone number in international format as specified by the merchant in the original payment request.

Example: 33111111111

BILLING POSTAL CODE string(1-9)

The billing postal code as specified by the merchant in the original payment request.

Example:

BILLING TITLE mr, miss, mrs

The title used for the billing address name.

Example: mr

BILLING VAT FEES integer

Billing fees on transaction (VAT fees).

Example:

BILLINGFEES EX. VAT integer

Billing fees on transaction (ex. VAT).

Example:

BILLINGFEES EXCHANGE RATE integer

Exchange rate used to calculate the fee in billing currency

Example:

BILLINGFEES INCL. VAT integer

Billing fees on transaction (incl. VAT).

Example:

BRAND string

Equipement brand (POS only).

Example:

CAPTUREBY string

Capture transaction IDs (separated by commas) if this transaction is captured (authorization only).

Example:

CARD PRODUCT consumer,corporate

Card product.

Example:

CARD SERVICE TYPE debit,credit,prepaid,universal

Card service type

Example:

CARD SUBTYPE string

Card type (advanced).

Example:

CARD3DSECUREENROLLED y, n, u

Card 3-D Secure enrollment status.

Example: y

CARDBANK string

Cardholder’s bank.

Example: BNPPARIBAS

CARDCODE string(12-19)

Last 4 digits of holder’s card.

Example: XXXXXXXXXXXX4444

CARDCODE 6X4 string(12-19)

First six and last 4 digits of holder’s card.

Example: 111122XXXXXX4444

CARDCOUNTRY string(2)

The country code (format ISO_3166-1_alpha-2).

Example: US

CARDFULLNAME string(1-255)

The holder’s full name (as described on the payment method).

Example: JOHN SNOW

CARDTYPE string

The payment method type.

Example: VISA

CARDVALIDITYDATE date(MM-YY)

Card expiry date.

Example: 12-17

CB2A int(2)

Bank response code from authorization request.

Example:

CHARGEBACK CODE string(1-255)

Chargeback reason code.

Example:

CHARGEBACK REASON string(1-255)

Chargeback reason details.

Example:

CHARGEBACKAMOUNT integer

The chargeback amount in the smallest money decimal (e.g. cents for euro).

Example: 1000

CHARGEBACKDATE date(YYYY-MM-DD)

Chargeback date.

Example: 2017-05-25

CHARGEBACKSTATUS first chargeback, representment, first chargeback cancellation, second chargeback, second chargeback cancellation, retrieval request, pre-compliance issuer, pre-compliance acquirer, compliance, pre-arbitration, arbitration

Chargeback type.

Example: chargeback

CHARGED_DATE date(YYY-MM-DD)

Date of commission payment to the merchant.

Example: 2017-05-25

CHARGED_REFERENCE string(0-45)

Reference of the transfer in which commissions were taken for the transaction.

Example: 20170926.150.18168221583972500

CLIENTADDRESS string(1-510)

The user’s address.

Example: 285 Fulton Street.

CLIENTDOB date(YYYY-MM-DD)

The user’s date of birth.

Example: 1982-06-20

CLIENTEMAIL email(5-255)

The user’s email.

Example: john.snow@example.com

CLIENTIDENT string(1-255)

Unique identifier of the user in your application (e.g. a login or a primary key).

Example: john.snow

CLIENTIP ipv4

The user’s public IP address.

Example: 10.1.1.1

CLIENTREFERRER string(1-255)

The user’s HTTP referrer URL.

Example: https://your_shop.com/order?id=1234

CLIENT_IDENTIFIER string

Client export identifier (Export Sevices only).

Example: Dalenys IDENTIFIER

CLIENT_INTERNAL_ID string(1-125)

Unique Client identifier.

Example:

CLIENT_USER_AGENT string(1-255)

The HTTP user agent.

Example: Mozilla/5.0 (Windows NT 6.1; WOW64; rv:47.0) Gecko/20100101 Firefox/47.0

COLLECTION DATE datetime(yyyy-MM-dd HH:mm:ss)

Settlement date.

Example: 2017-05-01

COLLECTION NUMBER integer

Settlement number (only for POS transactions)

Example:

CSF float

Fees charged by the card schemes (Visa or Mastercard).

Example:

CURRENCY string(3)

Currency code (ISO 4217 format).

Example: EUR

CVVRESPONSECODE M, N, P, S, U, X, Y, Z

Authentication status:

M = CVV2/CVC2 Matches
N = CVV2/CVC2 does not Match
P = Not processed
S = The CVV2 should be on the card but the merchant indicates it is not.
U = CVV2/CVC2 Unavailable – issuer does not support this parameter
X = No information (only for JCB)
Y = CVC1 Incorrect
Z = Information not provided

Example: M

DATE date(YYYY-MM)

Required and mutually exclusive with STARTDATE and ENDDATE. Month or day of data to be exported, formatted YYYY-MM ou YYYY-MM-DD.

Example: 2016-12

DESCRIPTION string(1-510)

A short description of the operation, can be used to trigger fraud actions. Don’t hesitate to ask your Payment Manager for some advice on this topic.

Example: Knows nothing

DESCRIPTOR string

The transaction label sent to the bank network. The transaction will display with this label on the user’s bank statement.

Example: myshop.com

EPT RANK int(3)

Payment terminal rank (only for POS transactions).

Example:

EXECCODE string(4)

The operation result code. (See the complete list of execution code)

Example: 0000

EXTERNALREFERENCE int (9)

Transaction’s reference (string left padded with 0 of 9 digits)

Example: 19

EXTRADATA string(1-255)

Free field (Dalenys will send you back the content of the EXTRADATA you specified ahead).

Example: referrer=myshop.com;order=premium

FINANCIALSTATE being processed,collected,paid, charged

Transaction financial state (‘Being processed’; ‘Collected’ ; ‘Paid’; ‘Charged’).

Example: `paid`

FORM ATTEMPT 1,2,3,4

Form attempt number

Example: some of stuff

IDENTIFIER string(1-32)

Your processing account technical identifier.

Example: YOUR_IDENTIFIER

INITIALSCHEMETRANSACTIONID string(1-55)

Scheme transaction ID of the first transaction used to store the card information.

Example: 11034331402111290210

INTERCHANGE FEE integer

Interchange fee.

Example:

IP COUNTRY ipv4

holder’s IP country.

Example: 120.1.1.1

ITP string(12)

Terminal application identification at point of acceptance (POS only)

Example: 552904001002

LANGUAGE fr, en, de, es, it, nl, zh, ru, pt, cs

Configure the hosted form display language.

Example: en

LAST NOTIFICATION CONTENT string(1-45)

Last notification content.

Example: OK

LAST NOTIFICATION HTTP CODE sent,succeeded,pending,failure

Last notification http code.

Example: `sent`

LAST NOTIFICATION RESULT sent,succeeded,pending,failure

Last notification result.

Example: `sent`

LOCATION string(1-35)

Equipment location: open field that can be modified on the POS inventory page of your dashboard (POS only).

Example:

MERCHANT COUNTRY string(2)

Merchant’s country used in the interchange calculation.

Example: FR

MESSAGE string(no length limit)

The operation result description linked to EXECCODE.

Example: The transaction has been accepted

METADATA string(1-255)

Additional transactional data. Contact your account manager for more informations.

Example: @METADATA-MYWEBSITE

MID integer

Merchant Identification.

Example:

MODEL int(3)

Equipment model (POS only).

Example:

NATURE arbitration, chargeback, chargeback reversal, pre-arbitration, rdr, rdr reversal, retrieval request, representment, representment reversal

Nature of the operation. Same as OPERATIONTYPE until a specific event from the chargeback workflow occurs. In this case, indicates ‘retrieval request’, ‘chargeback’ or ‘representment’.

Example: `chargeback`

NFC y,n

Contactless transaction (POS only)(‘yes’; ‘no’).

Example: y

OPERATIONTYPE authorization, payment, capture, refund, credit, void

The action you want to process.

Example: payment

OPPOTOTA_ENTRY_DATE datetime(yyyy-MM-dd HH:mm:ss)

Oppotota entry date.

Example: 2017-05-01

OPPOTOTA_REASON lost,stolen,did not reach cardholder,counterfeit,misuse

Oppotota reason.

Example:

ORDERID string(1-40)

Unique ID associated to an order in the merchant’s database (as specified in your initial POST request)

Example: 1234

PAYMENT METHOD TYPE CARDS, INTERNATIONAL_CARDS, AMEX, PAYPAL, BCMC, IDEAL, GIROPAY, SOFORT, KLARNA_INVOICE, PAYSAFECARD, TITRE_RESTAURANT, PRZELEWY, SDD, MULTIBANCO, FACILYPAY, APPLEPAY, COFIDIS, POSTFINANCE, CASINO

Indicates the type of the payment method used for the transaction.

Example: PAYPAL

PAYMENT OPTION facilypay-3x, facilypay-3xsansfrais, facilypay-4x, facilypay-4xsansfrais

Facily Pay payment options.

Example: facilypay-3x

POS TERMINAL TYPE ept,mpos, kiosk

POS terminal type (‘EPT’; ‘mPOS’; ‘Kiosk’)(POS only)

Example: `ept`

PP_ADDRESS STATUS none, confirmed, unconfirmed

Status of street address on file with PayPal.

Example: `confirmed`

PP_PAYER ID STATUS string(13)

ID of Paypal payer’s account

Example: A12345BCD6789

PP_PAYER STATUS none, canceled-reversal, completed, denied, expired, failed, in-progress, partially-refunded, pending, refunded, reversed, processed, voided, completed-funds-held

The status of the payment.

Example: completed

PP_PROTECTION ELIGIBILITY eligible, partiallyeligible, ineligible

The kind of seller protection in force for the transaction.

Example: eligible

PP_PROTECTION ELIGIBILITY TYPE itemnotreceivedeligible, unauthorizedpaymenteligible, ineligible

The kind of seller protection in force for the transaction.

Example: itemnotreceivedeligible

PP_SHIP TO CITY string(40 Bytes)

Shipping city.

Example: New York City

PP_SHIP TO COUNTRY CODE string(2)

Country code.

Example: NY

PP_SHIP TO NAME string(1-32)

Holder’s shipping last name.

Example: John Doe

PP_SHIP TO STREET string(1-100)

Shipping street address.

Example: Fulton St

PP_SHIP TO ZIP CODE string(1-20)

U.S. ZIP code or other country-specific postal code.

Example: 10007

PP_TRANSACTION ID string(20 max)

Unique transaction ID of the payment.

Example: a1B2c3D4e5F6g7H8

PRESCORINGCODE string(20 max)

Cofidis scoring value.

Example: PS2110531

REASON string(1-125)

Rule Description.

Example:

REF ARCH string(1-12)

Retrieval reference number.

Example:

REFUND TRANSFER REFERENCE string(1-32)

Refund transfer reference.

Example: A1123456

REFUND TRANSFER STATUS pending,failed,succeeded

Refund transfer status (‘Pending’, ‘Failed’, ‘Succeeded’).

Example: `pending`

REFUNDED string

Refunded transaction ID, if OPERATIONTYPE=’refund’.

Example: A1234

REFUNDEDBY string(0-n)

Refund transaction IDs (separated by commas ,) if this transaction is refunded.

Example:

REFUNDTYPE refund,cancel

Refund type (‘refund’;’cancel’).

Example: `refund`

RETRY string(no length limit)

Payment schedule information (retry number - number of retries).

Example: 1-4 | 1-3 | 2-3

RULE APPLIED string(1-125)

Rule applied by fraud rule engine.

Example:

RULE IDS string(1-255)

Rule IDs applied by fraud rule engine.

Example:

SALE REFERENCE IDENTIFICATION string(1-12)

A reference sent by the cash desk. Corresponds to the Order ID in the Dalenys Dashboard. (POS only)

Example: CO25953200

SALE REFERENCE NUMBER string(1-12)

ID of the Transaction generated by the cash desk. Corresponds to the Sale ID in the Dalenys Dashboard. (POS only)

Example: DZ20855100

SCHEDULE string(no length limit)

Payment schedule information (installment number - number of instalments).

Example: 1-4 | 1-3 | 2-3

SCHEDULEID string(2-32)

Schedule identifier.

Example: A123456

SCHEMETRANSACTIONID string(1-55)

Scheme transaction ID, retrieved in response to the authorization request.

Example: 11034331402111290210

SERIAL NUMBER string(12)

Payment terminal serial number (POS only).

Example:

SHIP TO ADDRESS string(1-50)

The shipping address.

Example: 55 rue de la liberté

SHIP TO CITY string(1-255)

The shipping city.

Example: New York

SHIP TO COMPANY NAME string(1-50)

Name of the receiving company.

Example: MyShop.com

SHIP TO COUNTRY string(2)

The shipping country (ISO_3166-1_alpha-2 format).

Example: US

SHIP TO FIRST NAME string(1-15)

Holder’s first name in the shipping address.

Example: John

SHIP TO LAST NAME string(1-30)

Holder’s last name in the shipping address.

Example: Doe

SHIP TO MOBILE PHONE string(1-32)

Shipping mobile phone number in international format.

Example: 33111111111

SHIP TO PHONE string(1-32)

Shipping phone number in international format.

Example: 33111111111

SHIP TO POSTAL CODE string(1-9)

The shipping postal code.

Example: 10007

SHIP TO TITLE mr, miss, mrs

Holder’s title in the shipping address..

Example: mr

SHORTNAME string (1-64)

POI Short Name (POS only).

Example: store1

SIRET string

SIRET number.

Example: 012345678912345

SUBMERCHANT COUNTRY string

Country of the Submerchant

Example: FR

SUBMERCHANT DOING BUSINESS AS string

Commercial name of Submerchant

Example: Example Startup

SUBMERCHANT MCC string

Merchant Category Code of the Submerchant

Example: 5945

SUBMERCHANT NAME string

Legal name of Submerchant

Example: Example Startup Inc.

SUBMERCHANT ONLINE CHANNEL boolean

Indicates the Submerchant’s e-commerce activity (true/false)

Example: true

SUBMERCHANT POS CHANNEL boolean

Indicates the Submerchan’s proximity activity (true/false)

Example: false

SUBMERCHANT STATUS string

Indicates the status of the Submerchant (Enabled / Disabled)

Example: ENABLED

SUBMERCHANT WEBSITE string

Website of the Submerchant

Example: https://www.test.com

SUBMERCHANTS EXTERNAL IDS string(32)

Sub-merchants external ID as received in the transaction request.

Example:

TAGS string(no max length)

Tags set by the Dalenys’s rule engine

Example: POTENTIAL FRAUD=Volume&TO BE CHECKED=Custom 1

TERMINAL ID ans8

Card acceptor terminal identification (field 41 CB2A) (POS only)

Example: 04884583

TRADE NAME

Trade name.

Example:

TRANSACTION EXPIRATION DATE datetime(yyyy-MM-dd HH:mm:ss)

Transaction expiration date.

Example:

TRANSACTION ORIGIN DIRECTLINK, FORM, EXTRANET, BATCH, REDIRECTION, POS, DIRECT_SUBMIT, VAD_INTERNAL, PRT_RECEIVER, MULTIBANCO_MEPS, HOSTED_FIELD, POS_INTERNATIONAL

Indicates the origin of the transaction.

Example: POS

TRANSACTIONID string(1-32)

Unique Dalenys transaction ID. Make sure to store this ID in your database.

Example: A1123456

TRANSFER REFERENCE string(1-45)

Transfer reference.

Example:

UDV string(10)

Dalenys merchant account.

Example:

VERSION 3.0

The API protocol version.

Example: 3.0

VOIDED string(1-40)

Voided transaction ID.

Example: A1234

VOIDEDBY string(1-40)

Void transaction ID.

Example: A1234

VOIDTYPE authorization,capture,payment,refund,credit

Void type.

Example: capture