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.
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.)
delivery_date
AN
10
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":"STANDARD"}'
- '{"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
M
Shopping cart details
Please refer to "HiPay Enterprise – Payment Gateway – Shopping cart management" technical documentation.
product_category:
- 1 - 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
payment_product_parameters
JSON
Promotional code provided by Oney (e.g.: "merchant_promotion":"AT011")
Mandatory if Pay Later Oney is selected.
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.
(For further details, please refer to the technical documentation.)
Response example
forwarding
https://secure-gateway.hipay-tpp.com/gateway/forward/42a37368e8ff7254b245e524e05fb4b6
true
00001329106
1
132256855183
2018-06-06T09:22:58+0000
2018-06-06T11:22:59+0200
140
Authentication requested
0.00
0.00
0.00
0.00
2
EUR
0.0.0.0
7
4xcb-no-fees
0
ACCEPTED
1528276976
2018-06-06T09:22:58+0000
1
399.50
0.00
0.00
2
EUR
cliente
fr_FR
test@test.com
-
good
abklqsk
1
399.5
399.5
