Bootstrap test
New fields to integrate into existing /order and /hpayment APIs
Merci de vous assurer que vous avez bien intégré ces champs obligatoires: https://support.hipay.com/hc/en-us/articles/115005181065-HiPay-Enterprise-Hosted-Fields-integration-
First
Field
<>/th>
Sub-field 1
<>/th>
Sub-field 2
<>/th>
Required
<>/th>
Description
<>/th>
Format
<>/th>
Value/Example
<>/th>
account_info
//Information about the customer's account on the merchant's website//
<>/th>
customer
//Information about the customer's online account//
<>/th>
account_possession
<>/th>
no*
<>/th>
Length of time since the customer has his account on the merchant's website
<>/th>
Integer (1)
<>/th>
1 = guest
2 = created during this transaction
3 = less than 30 days
4 = 30 - 60 days
5 = more than 60 days
<>/th>
account_change
<>/th>
no*
<>/th>
Date of the last change on the customer's account
<>/th>
YYYYMMDD
Integer
<>/th>
20180507
<>/th>
account_change_duration
<>/th>
no*
<>/th>
Length of time since the customer made a modification on his account
<>/th>
Integer (1)
<>/th>
1 = changed during this transaction
2 = less than 30 days
3 = 30 - 60 days
4 = more than 60 days
<>/th>
opening_account_date
<>/th>
no*
<>/th>
Date when the customer created his account on the merchant's website
<>/th>
YYYYMMDD
Integer
<>/th>
20180507
<>/th>
password_change
<>/th>
no*
<>/th>
Date when the customer changed his password
<>/th>
YYYYMMDD
Integer
<>/th>
20180507
<>/th>
password_change_duration
<>/th>
no*
<>/th>
Length of time since the customer changed his account password on the merchant's website
<>/th>
Integer (1)
<>/th>
1 = no change
2 = changed during this transaction
3 = less than 30 days
4 = 30 - 60 days
5 = more than 60 days
<>/th>
purchase
//Information about previous purchases and payment attempts made by the customer//
<>/th>
count
<>/th>
no*
<>/th>
Number of order(s) made by the customer during the previous six months
<>/th>
Integer (4)
<>/th>
2
<>/th>
card_stored_24h
<>/th>
no*
<>/th>
Number of Add card attempt(s) on the customer's account within the last 24 hours
<>/th>
Integer (3)
<>/th>
0
<>/th>
payment_attempts_24h
<>/th>
no*
<>/th>
Number of transaction(s) (successful or abandoned) made by the customer within the last 24 hours among merchant's payments
<>/th>
Integer (3)
<>/th>
0
<>/th>
payment_attempts_1y
<>/th>
no*
<>/th>
Number of transaction(s) (successful or abandoned) made by the customer within the year among merchant's payments
<>/th>
Integer (3)
<>/th>
0
<>/th>
payment
//Information about customer's card saving on the merchant's site//
<>/th>
enrollment_date
<>/th>
no*
<>/th>
Date when the customer saved his payment card on his account
<>/th>
YYYYMMDD
Integer
<>/th>
20180507
<>/th>
age_duration
<>/th>
no*
<>/th>
Length of time since the customer saved his payment card on his account
<>/th>
Integer (1)
<>/th>
1 = guest
2 = during this transaction
3 = less than 30 days
4 = 30 - 60 days
5 = more than 60 days
<>/th>
shipping
//Information about shipping data//
<>/th>
shipping_used_date
<>/th>
no*
<>/th>
Date when the customer's shipping address was used for the first time
<>/th>
YYYYMMDD
Integer
<>/th>
20180507
<>/th>
address_usage_duration
<>/th>
no*
<>/th>
Indicates when the shipping address used for this transaction was used for the first time on the merchant's website
<>/th>
Integer (1)
<>/th>
1 = this transaction
2 = less than 30 days
3 = 30 - 60 days
4 = more than 60 days
<>/th>
name_indicator
<>/th>
no*
<>/th>
Indicates if the name of the customer on his account is the same as the name on the address for this transaction
<>/th>
Integer (1)
<>/th>
1 = account name identical to shipping name
2 = account name different from shipping name
<>/th>
suspicious_activity
<>/th>
no*
<>/th>
Indicates if the merchant has experienced suspicious activity (including fraud) on this customer account
<>/th>
Integer (1)
<>/th>
1 = no suspicious activity has been observed
2 = suspicious activity has been observed
<>/th>
device_channel
//Device from which the transaction is initiated//
<>/th>
-
<>/th>
-
<>/th>
yes for the /order APIno for the /hpayment API
<>/th>
Channel through which the transaction is being processed
<>/th>
Integer (1)
<>/th>
1 = App-based (APP)
2 = Browser (BRW)
3 = 3DS Requestor Initiated (3RI = MIT)
<>/th>
browser_info
//User's browser information//
<>/th>
java_enabled
<>/th>
-
<>/th>
yes
<>/th>
Boolean that represents the ability of the customer's browser to execute Java
<>/th>
Boolean
<>/th>
true / false
<>/th>
javascript_enabled
<>/th>
-
<>/th>
yes
<>/th>
Boolean that represents the ability of the customer's browser to execute JavaScript
<>/th>
Boolean
<>/th>
true / false
<>/th>
language
<>/th>
-
<>/th>
yes
<>/th>
Value that represents the browser's language as defined in IETF BCP47
<>/th>
String (1 - 8)
<>/th>
fr
<>/th>
color_depth
<>/th>
-
<>/th>
only if javascript_enabled = yes
<>/th>
Value that represents the depth of the color palette for displaying images, in bits per pixel
<>/th>
Integer (1 - 2)
<>/th>
1 = 1 bit
4 = 4 bits
8 = 8 bits
15 = 15 bits
16 = 16 bits
24 = 24 bits
32 = 32 bits
48 = 48 bits
<>/th>
screen_height
<>/th>
-
<>/th>
only if javascript_enabled = yes
<>/th>
Total height of the customer's screen (in pixels)
<>/th>
Integer (1 - 6)
<>/th>
<>/th>
screen_width
<>/th>
-
<>/th>
only if javascript_enabled = yes
<>/th>
Total width of the customer’s screen (in pixels)
<>/th>
Integer (1 - 6)
<>/th>
<>/th>
timezone
<>/th>
-
<>/th>
only if javascript_enabled = yes
<>/th>
Time-zone offset in minutes between UTC and the cardholder's browser local time
<>/th>
String (1 - 5)
<>/th>
300
<>/th>
previous_auth_info
//Information about previous authentications of the customer on the merchant's website//
<>/th>
transaction_reference
<>/th>
-
<>/th>
no*
<>/th>
PSP reference for the previous authenticated transaction
<>/th>
String (16)
<>/th>
800000987283
<>/th>
method
<>/th>
-
<>/th>
no*
<>/th>
Authentication method for the previous authenticated transaction
<>/th>
Integer (1)
<>/th>
1 = Frictionless authentication occurred
2 = Cardholder challenge occurred
3 = Address verified
4 = Other issuer method
<>/th>
timestamp
<>/th>
-
<>/th>
no*
<>/th>
Date and time of the previous authenticated transaction
<>/th>
YYYYMMDDHHMM
Integer
<>/th>
201905071508
<>/th>
merchant_risk_statement
//Information about the order of the customer, enabling to perform transaction risk analysis//
<>/th>
email_delivery_address
<>/th>
-
<>/th>
no*
<>/th>
Email address to which the goods must be sent (electronic delivery)
<>/th>
String (254)
<>/th>
jane.doe@test.com
<>/th>
delivery_time_frame
<>/th>
-
<>/th>
no*
<>/th>
Indicates when the goods must be received by the customer
<>/th>
Integer (1)
<>/th>
1 = electronic delivery
2 = same day shipping
3 = overnight shipping
4 = two-day or more shipping
<>/th>
purchase_indicator
<>/th>
-
<>/th>
no*
<>/th>
Availability of the goods
<>/th>
Integer (1)
<>/th>
1 = merchandise available
2 = future availability
<>/th>
pre_order_date
<>/th>
-
<>/th>
no*
<>/th>
Pre-ordered purchase: expected date when the merchandise will be available
<>/th>
YYYYMMDD
Integer (8)
<>/th>
20190925
<>/th>
reorder_indicator
<>/th>
-
<>/th>
no*
<>/th>
Unicity of the order for the customer
<>/th>
Integer (1)
<>/th>
1 = first time ordered
2 = reordered
<>/th>
shipping_indicator
<>/th>
-
<>/th>
no*
<>/th>
Address to which the merchandise must be delivered
<>/th>
Integer (1)
<>/th>
1 = ship to cardholder's billing address
2 = ship to another verified address on file with the merchant
3 = ship to an address that is different from the cardholder's billing address
4 = ship to store / pick up at local store
5 = digital goods
6 = travel and event tickets, not shipped
7 = other (gaming, digital services not shipped, e-media subscription)
<>/th>
gift_card
//Only for transactions made with a gift card//
<>/th>
amount
<>/th>
no*
<>/th>
Amount of the gift card
<>/th>
Number
<>/th>
15.00
<>/th>
count
<>/th>
no*
<>/th>
Number of gift card(s) purchased
<>/th>
Integer
<>/th>
0
<>/th>
currency
<>/th>
no*
<>/th>
Currency of the gift card
<>/th>
string (3)
<>/th>
EUR
<>/th>
sdk_info
//Information about the SDK installed on the customer's smartphone (APP only)//
<>/th>
option
//Information to provide only when using a mobile application//
<>/th>
interface
<>/th>
only if device_channel = APP
<>/th>
Type of SDK interface supported by the customer's smartphone to display further authentication information
<>/th>
Integer (1)
<>/th>
1 = Native
2 = HTML
3 = Both
<>/th>
ui_type
<>/th>
only if device_channel = APP
<>/th>
Type of UI supported by the customer's smartphone to display further authentication information
<>/th>
Integer (1)
<>/th>
1 = Text
2 = Single select
3 = Multi select
4 = OOB
5 = other HTML (valid only for HTML UI)
<>/th>
app_id
<>/th>
-
<>/th>
only if device_channel = APP
<>/th>
Unique ID created upon installation of the merchant's application on the customer's smartphone
<>/th>
string (36)
<>/th>
ABCD12345
<>/th>
recurring_info
//Information about recurring transaction//
<>/th>
expiration_date
<>/th>
-
<>/th>
no*
<>/th>
Date after which no further authorizations shall be performed (in case of a recurring transaction)
<>/th>
YYYYMMDD
Integer
<>/th>
20180507
<>/th>
frequency
<>/th>
-
<>/th>
no*
<>/th>
Indicates the minimum number of day(s) between authorizations (in case of a recurring transaction)
<>/th>
Integer (4)
<>/th>
31
<>/th>
exemption
<>/th>
-
<>/th>
-
<>/th>
no*
<>/th>
Exemption(s) declared by the merchant
<>/th>
String
<>/th>
It is through this field that you will be able to provide your exemption requests: for more details, please contact HiPay's technical team.
<>/th>
Objects
Description
account_info
Mark<>/th>
device_channel
Jacob<>/th>
browser_info
Larry the Bird<>/th>
preview_auth_info
Larry the Bird<>/th>
merchant_risk_statement
Jacob<>/th>
sdk_info
Larry the Bird<>/th>
reccuring_info
Larry the Bird<>/th>
exemption
Larry the Bird<>/th>
*not required, but recommended
Important upcoming dates
-
Early September 2019:
Possibility to test the new fields arising from DSP2 in the /order and /hpayment APIs
-
September 14, 2019:
The new standards in terms of strong authentication (Regulatory Technical Standards – RTS) linked to DSP2 will come into force in Europe.
