HiPay Enterprise – 3x 4x Oney & more

To pay with Oney, you can choose between multiple payment products:

3xcb (France, Belgium, Italy, Spain),
3xcb-no-fees (France, Belgium, Italy, Spain, Portugal),
4xcb (France, Italy, Spain),
4xcb-no-fees (France, Italy, Spain, Portugal),
credit-long (payment with more monthly installments).

Additionally, the Pay Later Oney solution is also available and allows you to pay 30, 60 or 90 days after your purchase. To use Pay Later Oney, you need to choose between any of the five abovementioned products, then select Pay Later Oney.

Please note that if Pay Later Oney is selected, the payment_product_parameters field (see the table below) becomes mandatory.

For further assistance, please contact your technical account manager.

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

To create a 3x 4x Oney 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.)

Format Abbreviations

Abbreviation	Description
A	Alphabetic characters only (a-z, A-Z)
AN	Alphanumeric characters (a-z, A-Z, 0-9)
N	Numeric characters only
R	Decimal number with explicit decimal point, signed
JSON	JavaScript Object Notation

Order Category Codes

Code	Description	Code	Description
0	Services aux particuliers	5734	Informatique & logiciels
4722	Voyage & tourisme	5941	Sport
4812	Téléphonie & communication	5946	Hifi, photo & vidéos
5193	Fleurs & cadeaux	5651	Vêtements & accessoires
5200	Electroménager	7278	Enchères et achats groupés
5261	Maison & jardin	7298	Santé & beauté
5499	Alimentation & gastronomie	7361	Services aux professionnels
5571	Auto & moto	7929	Culture & divertissements

Main Parameters

Parameter	Format	Length	Status	Description
`delivery_date`	AN	10	Mandatory	Estimated delivery date (`YYYY-MM-DD`).
`delivery_method`	JSON	-	Mandatory	Delivery method mode & shipping (see accepted values below).
`carrier_description`	A	130	Optional	Description of the carrier. Only `a-zA-Z0-9` and unencoded accented characters allowed. No special (`&`, `#`, `
`accept_url`	AN	-	Mandatory*	Mandatory if not configured in the back office.
`decline_url`	AN	-	Mandatory*	Mandatory if not configured in the back office.
`exception_url`	AN	-	Mandatory*	Mandatory if not configured in the back office.
`cancel_url`	AN	-	Mandatory*	Mandatory if not configured in the back office.
`basket`	JSON	-	Mandatory	Shopping cart details (see categories below).
`payment_product_parameters`	JSON	-	Conditional	Promotional code provided by Oney (e.g.: `{"merchant_promotion":"AT011"}`). Mandatory if Pay Later Oney is selected.

Accepted `delivery_method` Values

The JSON object requires a mode and shipping key. Valid combinations include:

STORE: STANDARD, EXPRESS, PRIORITY24H, PRIORITY2H, PRIORITY1H, INSTANT
CARRIER: STANDARD, EXPRESS, PRIORITY24H, PRIORITY2H, PRIORITY1H, INSTANT
RELAYPOINT: STANDARD, EXPRESS, PRIORITY24H, PRIORITY2H, PRIORITY1H, INSTANT
ELECTRONIC: STANDARD, EXPRESS, PRIORITY24H, PRIORITY2H, PRIORITY1H, INSTANT
TRAVEL: STANDARD, EXPRESS, PRIORITY24H, PRIORITY1H, INSTANT

Basket `product_category` Codes

Home & Gardening | 2. Clothing & Accessories | 3. Home appliances | 4. Sports & Recreations | 5. Babies & Children | 6. Hi-Fi, Photo & Video equipment | 7. IT equipment | 8. Phone & Internet services | 9. Physical goods: Books, Media, Music & Movies | 10. Digital goods: Books, Media, Music & Movies | 11. Consoles & Video games | 12. Gifts & Flowers | 13. Health & Beauty | 14. Car & Motorcycle | 15. Traveling | 16. Food & Gastronomy | 17. Auctions & Group buying | 18. Services to professionals | 19. Services to individuals | 20. Culture & Entertainment | 21. Games (digital goods) | 22. Games (physical goods) | 23. Ticketing | 24. Opticians, Opticians Goods and Eyeglasses

API 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_firstname": "john",
  "shipto_lastname": "doe",
  "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",
  "payment_product_parameters": {
    "merchant_promotion": "AT011"
  },
  "basket": [
    {
      "product_category": "8",
      "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
    }
  ]
}

API response

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