Aller au contenu principal
English (US) Italiano Português

HiPay Enterprise – API omnicanal

Service endpoints

There are two endpoints (base URLs) to which you can make your API calls:

  • Stage, if you are testing your integration,
  • and Production, when you have finished testing and want your application to go live.
Environment Endpoint

Stage

 https://stage-secure-gateway.hipay-tpp.com/rest/v1/order

Production

 https://secure-gateway.hipay-tpp.com/rest/v1/order

 

Request parameters

First, please read the documentation for omnichannel APIs on our Developer Portal.

Then, for further details, please refer to the technical documentation.

Format abbreviation

Description

AN

Alphanumeric characters (a-z, A-Z, 0-9)

A

Alphabetic characters only (a-z, A-Z)

N

Numeric characters only

R

Decimal number with explicit decimal point, signed

 

To generate a POS order, you must send the following parameters in your transaction creation call.

 

Payment settings

Field name Format Length Description
orderid AN  32 Unique order ID
eci N [string]  2

Only one possible value:

10

(Point of sale payment)
description AN  128

Short description of the order
long_description AN  -

Additional description of the order
currency A 3

Base currency for this order (default to EUR)
This three-character currency code complies with ISO 4217.
amount R
  -

Order total amount
initialize_payment_terminal N  1

Only one possible value:

1
payment_terminal_id N  - 

Provided by HiPay

(please contact our technical support team by submitting a request)
store_id N  -

Provided by HiPay

(please contact our technical support team by submitting a request)
order_point A  -

Only one possible value:

Store

(Point of sale payment)
pos_transaction_lifetime N  -

Recommended and maximum value:

60
custom_data JSON  -

You can use this parameter to submit custom values you wish to show in HiPay's back office transaction details, to receive back in the API response messages and in the notifications or to activate specific anti-fraud rules.

E.g.:
custom_data => {
"shipping_method":"click and collect",
"first_order":"0",
"products_list":"First product, Second
product, Third product"}

 

Customer information (not displayed on the POS terminal)

Field name Format Length Description
email AN - Customer's email address
phone AN
 - Customer's phone number
birthdate N 8 Customer's birthdate (YYYYMMDD)
For fraud detection purposes
gender A 1

Gender of the customer

(M = male, F = female)
firstname AN
 - Customer's first name
lastname AN - Customer's last name
streetaddress AN - Customer's street address
city AN - Customer's city
state AN - State of the country
zipcode AN - Zip or postal code of the customer
country A 2 Country code of the customer
This two-letter country code complies
with ISO 3166-1 (alpha 2).
shipto_firstname AN - First name of the order's recipient
shipto_lastname AN - Last name of the order's recipient
shipto_streetaddress AN - Street address where the order is to be shipped
shipto_city AN - City where the order is to be shipped
shipto_state AN - State where the order is to be shipped
shipto_zipcode AN - Zip or postal code where the order is to be shipped
shipto_country A 2

Country code where the order is to be shipped

This two-letter country code complies with ISO 3166-1 (alpha 2).
cid AN - Unique customer ID

 

API response fields

{
 "state": "pending",
 "reason": "",
 "forwardUrl": "",
 "test": "true",
 "mid": "00001234567",
 "attemptId": "1",
 "authorizationCode": "",
 "transactionReference": "800000021115",
 "dateCreated": "2018-03-28T15:10:49+0000",
 "dateUpdated": "2018-03-28T17:10:50+0200",
 "dateAuthorized": "",
 "status": "174",
 "message": "Awaiting Terminal",
 "authorizedAmount": "0.00",
 "capturedAmount": "0.00",
 "refundedAmount": "0.00",
 "creditedAmount": "0.00",
 "decimals": "2",
 "currency": "EUR",
 "ipAddress": "0.0.0.0",
 "ipCountry": "",
 "deviceId": "",
 "cdata1": "",
 "cdata2": "",
 "cdata3": "",
 "cdata4": "",
 "cdata5": "",
 "cdata6": "",
 "cdata7": "",
 "cdata8": "",
 "cdata9": "",
 "cdata10": "",
 "avsResult": "",
 "cvcResult": "",
 "eci": "10",
 "paymentProduct": "",
 "paymentMethod": "",
 "threeDSecure": "",
 "fraudScreening": {
 "scoring": "0",
 "result": "NOT_LAUNCHED",
 "review": ""
 },
 "order": {
 "id": "HIPAYTEST_1522249708_3",
 "dateCreated": "2018-03-28T15:10:48+0000",
 "attempts": "1",
 "amount": "125.00",
 "shipping": "0.00",
 "tax": "0.00",
 "decimals": "2",
 "currency": "EUR",
 "customerId": "",
 "language": "fr_FR",
 "email": ""
 },
 "debitAgreement": {
 "id": "",
 "status": ""
 }
}

 

Articles associés