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 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 |
Field name |
Format |
Length |
Req. |
Description |
||||||||||||||||||||||||||||||||||
orderid |
AN |
|
M |
|||||||||||||||||||||||||||||||||||
operation |
A |
|
M |
|
||||||||||||||||||||||||||||||||||
payment_product |
AN |
|
M |
Payment product You can choose between:
Pay Later Oney is available with any of the five abovementioned products. |
||||||||||||||||||||||||||||||||||
description |
AN |
50 |
M |
|||||||||||||||||||||||||||||||||||
currency |
A |
3 |
E.g.: EUR |
|||||||||||||||||||||||||||||||||||
amount |
R |
15,2 |
M |
Use decimal point as separator |
||||||||||||||||||||||||||||||||||
cid |
AN |
8 |
M | |||||||||||||||||||||||||||||||||||
language |
AN |
|
E.g.: fr_FR |
|||||||||||||||||||||||||||||||||||
|
AN |
|
M |
|||||||||||||||||||||||||||||||||||
phone |
N |
|
M |
|
||||||||||||||||||||||||||||||||||
birthdate |
AN |
|
YYYYMMDD |
|||||||||||||||||||||||||||||||||||
gender |
A |
|
M |
Gender of the customer (M = male, F = female, U = unknown) |
||||||||||||||||||||||||||||||||||
firstname |
AN |
32 |
M |
Customer’s first name | ||||||||||||||||||||||||||||||||||
lastname |
AN |
32 |
M |
Customer’s last name | ||||||||||||||||||||||||||||||||||
streetaddress |
AN |
38 |
M |
Customer’s billing address | ||||||||||||||||||||||||||||||||||
streetaddress2 |
AN |
38 |
|
Additional information for the customer’s billing address (e.g.: building, floor, flat, etc.) | ||||||||||||||||||||||||||||||||||
city |
AN |
32 |
M |
City of the customer’s billing address | ||||||||||||||||||||||||||||||||||
zipcode |
N |
10 |
M |
Postal code of the customer’s billing address
|
||||||||||||||||||||||||||||||||||
country |
AN |
3 |
M |
Country code of the customer’s billing address This two-letter country code complies with ISO 3166-1 (alpha 2). |
||||||||||||||||||||||||||||||||||
msisdn |
N |
|
||||||||||||||||||||||||||||||||||||
ipaddrr |
AN |
|
||||||||||||||||||||||||||||||||||||
shipto_firstname |
AN |
32 |
M |
First name of the order’s recipient | ||||||||||||||||||||||||||||||||||
shipto_lastname |
AN |
32 |
M |
Last name of the order’s recipient | ||||||||||||||||||||||||||||||||||
shipto_gender |
A |
1 |
M |
Gender of the order’s recipient (M = male, F = female, U = unknown) |
||||||||||||||||||||||||||||||||||
shipto_phone |
N |
|
Phone number of the recipient:
|
|||||||||||||||||||||||||||||||||||
shipto_msisdn |
N |
|
Mobile phone number of the recipient:
|
|||||||||||||||||||||||||||||||||||
shipto_streetaddress |
AN |
38 |
M |
Recipient’s shipping address (e.g.: relay parcel address, etc.) | ||||||||||||||||||||||||||||||||||
shipto_streetaddress2 |
AN |
38 |
|
Additional information for the recipient’s shipping address (e.g.: relay parcel name, building, floor, flat, etc.) | ||||||||||||||||||||||||||||||||||
shipto_city |
AN |
32 |
M |
City of the recipient’s shipping address | ||||||||||||||||||||||||||||||||||
shipto_zipcode |
N |
10 |
M |
Postal code of the recipient’s shipping address:
|
||||||||||||||||||||||||||||||||||
shipto_country |
AN |
3 |
M |
Country code of the recipient’s shipping address This two-letter country code complies with ISO 3166-1 (alpha 2). |
||||||||||||||||||||||||||||||||||
eci |
N |
|
1: MO/TO (Mail Order/Telephone Order) 2: MO/TO - Recurring 7: E-commerce with SSL/TLS Encryption 9: Recurring E-commerce |
|||||||||||||||||||||||||||||||||||
order_category_code |
N |
4 |
M |
Order category list:
|
||||||||||||||||||||||||||||||||||
delivery_date |
AN |
10 |
M |
Estimated delivery date YYYY-MM-DD |
||||||||||||||||||||||||||||||||||
delivery_method |
JSON |
|
M |
Delivery method mode & shipping Here are the accepted values:
|
||||||||||||||||||||||||||||||||||
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:
|
||||||||||||||||||||||||||||||||||
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
<response>
<state>forwarding</state>
<reason/>
<forward_url>https://secure-gateway.hipay-tpp.com/gateway/forward/42a37368e8ff7254b245e524e05fb4b6</forward_url>
<test>true</test>
<mid>00001329106</mid>
<attempt_id>1</attempt_id>
<authorization_code/>
<transaction_reference>132256855183</transaction_reference>
<date_created>2018-06-06T09:22:58+0000</date_created>
<date_updated>2018-06-06T11:22:59+0200</date_updated>
<date_authorized/>
<status>140</status>
<message>Authentication requested</message>
<authorized_amount>0.00</authorized_amount>
<captured_amount>0.00</captured_amount>
<refunded_amount>0.00</refunded_amount>
<credited_amount>0.00</credited_amount>
<decimals>2</decimals>
<currency>EUR</currency>
<ip_address>0.0.0.0</ip_address>
<ip_country/>
<device_id/>
<cdata1>
<![CDATA[]]>
</cdata1>
<cdata2>
<![CDATA[]]>
</cdata2>
<cdata3>
<![CDATA[]]>
</cdata3>
<cdata4>
<![CDATA[]]>
</cdata4>
<cdata5>
<![CDATA[]]>
</cdata5>
<cdata6>
<![CDATA[]]>
</cdata6>
<cdata7>
<![CDATA[]]>
</cdata7>
<cdata8>
<![CDATA[]]>
</cdata8>
<cdata9>
<![CDATA[]]>
</cdata9>
<cdata10>
<![CDATA[]]>
</cdata10>
<avs_result/>
<cvc_result/>
<eci>7</eci>
<payment_product>4xcb-no-fees</payment_product>
<payment_method/>
<three_d_secure/>
<fraud_screening>
<scoring>0</scoring>
<result>ACCEPTED</result>
<review/>
</fraud_screening>
<order>
<id>
<![CDATA[1528276976]]>
</id>
<date_created>
<![CDATA[2018-06-06T09:22:58+0000]]>
</date_created>
<attempts>
<![CDATA[1]]>
</attempts>
<amount>
<![CDATA[399.50]]>
</amount>
<shipping>
<![CDATA[0.00]]>
</shipping>
<tax>
<![CDATA[0.00]]>
</tax>
<decimals>
<![CDATA[2]]>
</decimals>
<currency>
<![CDATA[EUR]]>
</currency>
<customer_id>
<![CDATA[cliente]]>
</customer_id>
<language>
<![CDATA[fr_FR]]>
</language>
<email>
<![CDATA[test@test.com]]>
</email>
</order>
<debit_agreement>
<id/>
<status/>
</debit_agreement>
<basket>
<item>
<type>
<![CDATA[good]]>
</type>
<product_reference>
<![CDATA[abklqsk]]>
</product_reference>
<quantity>
<![CDATA[1]]>
</quantity>
<unit_price>
<![CDATA[399.5]]>
</unit_price>
<total_amount>
<![CDATA[399.5]]>
</total_amount>
</item>
</basket>
</response>
Commentaires
0 commentaire
Cet article n'accepte pas de commentaires.