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.

 

Request parameters

To create an Oney Facily Pay transaction on the HiPay Enterprise Payment Gateway, you must send these mandatory/complementary parameters in your transaction creation call.

 

(For further details, please refer to the technical documentation.)

 

delivery_date

AN

M

Estimated delivery date

YYYY-MM-DD

delivery_method

JSON

M

Delivery method mode & shipping

Here are the accepted values:

• '{"mode":"STORE","shipping":"STANDARD"}'
• '{"mode":"STORE","shipping":"EXPRESS"}'
• '{"mode":"STORE","shipping":"PRIORITY24H"}'
• '{"mode":"STORE","shipping":"PRIORITY2H"}'
• '{"mode":"STORE","shipping":"PRIORITY1H"}'
• '{"mode":"STORE","shipping":"INSTANT"}'
• '{"mode":"CARRIER","shipping":"EXPRESS"}'
• '{"mode":"CARRIER","shipping":"PRIORITY24H"}'
• '{"mode":"CARRIER","shipping":"PRIORITY2H"}'
• '{"mode":"CARRIER","shipping":"PRIORITY1H"}'
• '{"mode":"CARRIER","shipping":"INSTANT"}'
• '{"mode":"RELAYPOINT","shipping":"STANDARD"}'
• '{"mode":"RELAYPOINT","shipping":"EXPRESS"}'
• '{"mode":RELAYPOINT","shipping":"PRIORITY24H"}'
• '{"mode":"RELAYPOINT","shipping":"PRIORITY2H"}'
• '{"mode":"RELAYPOINT","shipping":"PRIORITY1H"}'
• '{"mode":"RELAYPOINT","shipping":"INSTANT"}'
• '{"mode":"ELECTRONIC","shipping":"STANDARD"}'
• '{"mode":"ELECTRONIC","shipping":"EXPRESS"}'
• '{"mode":"ELECTRONIC","shipping":"PRIORITY24H"}'
• '{"mode":"ELECTRONIC","shipping":"PRIORITY2H"}'
• '{"mode":"ELECTRONIC","shipping":"PRIORITY1H"}'
• '{"mode":"ELECTRONIC","shipping":"INSTANT"}'
• '{"mode":"TRAVEL","shipping":"STANDARD"}'
• '{"mode":"TRAVEL","shipping":"EXPRESS"}'
• '{"mode":"TRAVEL","shipping":"PRIORITY24H"}'
• '{"mode":"TRAVEL","shipping":"PRIORITY1H"}'
• '{"mode":"TRAVEL","shipping":"INSTANT"}'

carrier_description

A

   

Description of the carrier

130 alphanumeric characters, only comprised of a-zA-Z0-9 characters and unencoded accented characters. Encoded characters (e.g.: ') and special characters (e.g.: &, #, |, etc.) are not allowed. 

accept_url

AN

M

Mandatory if not configured in the back office

decline_url

AN

M

Mandatory if not configured in the back office

exception_url

AN

M

Mandatory if not configured in the back office

cancel_url

AN

M

Mandatory if not configured in the back office

basket

JSON

 

Shopping cart details

Please refer to "HiPay Enterprise – Payment Gateway – Shopping cart management" technical documentation.

product_category:

• 1: food & drinks
• 2: auto & motorcycle
• 3: culture & entertainment
• 4: home & garden
• 5: home appliances
• 6: bidding and multi purchasing
• 7: flowers & gifts
• 8: computers & software
• 9: health & beauty
• 10: personal services
• 11: professional services
• 12: sport
• 13: clothing & accessories
• 14: travel & tourism
• 15: hifi, photo & video
• 16: telephone & communication

 

 

Request example

 {
  "email": "john.doe@hipay.com",
  "cid": "1234567",
  "eci": "7",
  "gender": "M",
  "firstname": "john",
  "lastname": "doe",
  "birthdate": "19771215",
  "streetaddress": "Rue de la Paix",
  "zipcode": "75001",
  "city": "Paris",
  "msisdn": "0152211335",
  "description": "This is the description of my order",
  "ipaddr": "77.156.225.124",
  "currency": "EUR",
  "payment_product": "3xcb-no-fees",
  "orderid": "578cdb0fda266",
  "language": "fr_FR",
  "country": "FR",
  "amount": "250.50",
  "shipto_gender": "M",
  "shipto_phone": "0152211335",
  "shipto_msisdn": "0152211335",
  "order_category_code": "5734",
  "delivery_date": "2017-12-31",
  "delivery_method":'{"mode":"STORE","shipping":"INSTANT"}',
  "carrier_description":"click & collect",
  "accept_url":"https://www.mysite.com/accept",
  'decline_url":"https://www.mysite.com/decline",
  'exception_url":"https://www.mysite.com/exception",
  'cancel_url":"https://www.mysite.com/cancel",
		   

  "basket": [
    {
      "european_article_numbering": "4711892728946",
      "product_reference": "NF-a1690",
      "name": "My first product",
      "type": "good",
      "quantity": 1,
      "unit_price": 8.99,
      "discount": 0,
      "tax_rate": "8.20",
      "total_amount": 8.99
    },

    {
      "european_article_numbering": "4713716322385",
      "product_reference": "NF-a0351",
      "name": "My second product",
      "type": "good",
      "quantity": 4,
      "unit_price": 10.5,
      "discount": -2.5,
      "tax_rate": "20",
      "total_amount": 39.5
    },

    {
      "product_reference": "SHIP-e23a6",
      "name": "Shippingfees",
      "type": "fee",
      "quantity": 1,
      "unit_price": 10,
      "discount": 0,
      "tax_rate": "0",
      "total_amount": 10
    },

    {
     "product_reference": "DISC-00f5a",
      "name": "Birthdaygift",
      "type": "discount",
      "quantity": 1,
      "unit_price": 0,
      "discount": -5.5,
      "tax_rate": "0",
      "total_amount": -5.5
    }

  ]
}

 

API response

This service creates an order and returns a forward URL. This forward URL is dedicated to display an Oney Facily Pay payment page. After payment form validation, the checkout is processed and the user is being returned to your website.

(For further details, please refer to the technical documentation.) 

 

Response example

{
"state":"forwarding",
"reason":"",
"forwardUrl":"https:\/\/secure-gateway.hipay-tpp.com\/gateway\/forward\/2x624359465x03f51x0533x9",
"test":"false",
"mid":"00001234567",
"attemptId":"1",
"authorizationCode":"",
"transactionReference":"134374306000",
"dateCreated":"2017-03-20T10:22:04+0000",
"dateUpdated":"2017-03-20T10:22:06+0000",
"dateAuthorized":"",
"status":"142",
"message":"Authorization Requested",
"authorizedAmount":"0.00",
"capturedAmount":"0.00",
"refundedAmount":"0.00",
"creditedAmount":"0.00",
"decimals":"2",
"currency":"EUR",
"ipAddress":"77.156.225.124",
"ipCountry":"",
"deviceId":"",
"cdata1":"My data 1",
"cdata2":"My data 2",
"cdata3":"My data 3",
"cdata4":"My data 4",
"cdata5":"",
"cdata6":"",
"cdata7":"",
"cdata8":"",
"cdata9":"",
"cdata10":"",
"avsResult":"",
"cvcResult":"",
"eci":"7",
"paymentProduct":"3xcb-no-fees",
"paymentMethod":"",
"threeDSecure":"",
"fraudScreening":{"scoring":"0","result":"AUTHENTICATE","review":""},
"order":{"id":"578cdb0fda266","dateCreated":"2017-03-20T10:22:04+0000","attempts":"1","amount":"250.50","shipping":"0.00","tax":"0.00","decimals":"2","currency":"EUR","customerId":"1234567","language":"fr_FR","email":"john.doe@hipay.com"},
"debitAgreement":{"id":"","status":""}
}