The total order amount.
It should be calculated as a sum of the items purchased, plus the shipping fee (if present), plus the tax fee (if present). This is the final price that the consumer will pay.
Category of this order.
The order or product categories are attached to, and depend upon, the merchant site's category. You can obtain the list of order and product category ID's for the merchant site at this URL:
https://payment.hipay.com/order/list-categories/id/[PRODUCTION_WEBSITEID]
https://test-payment.hipay.com/order/list-categories/id/[STAGE_WEBSITEID]
The currency specified in your HiPay Professional account.
This three-character currency code complies with ISO 4217 (eg. "EUR").
The customer's e-mail address.
The IP address of your customer making a purchase.
The order short description.
Email used by HiPay Professional to post operation notifications.
Date and time of execution of the payment.
Formatted in MySQL DATETIME format Y-m-dTH:i:s
(eg.: "2014-12-25T10:57:55").
Custom data.
You may use these parameters to submit values you wish to receive back in the API response messages or in the notifications (eg. you can use these parameters to get back session data, order content or user info).
Locale code of your customer.
It may be used for sending confirmation emails to your customer or for displaying payment pages.
Examples:
Indicate if you want to capture the payment manually or automatically.
false
: indicates transaction is sent for authorization, and if approved, is automatically submitted
for capture.true
: indicates this transaction is sent for authorization only. The transaction will not be sent for
settlement until the transaction is submitted for capture manually by the Merchant.Merchants' comment concerning the order.
Age category of your order.
Accepted values :
+12
" For ages 13 and over+16
" For ages 16 and over+18
" For ages 18 and overALL
" For all agesThe URL to return your customer to once the payment process is completed successfully.
The order Notification (callback) URL.
This URL will be used by our server to send you information in order to update your database.
The URL to return your customer to when he or her decides to abort the payment.
The URL to return your customer to after the acquirer declines the payment.
This URL is where the logo you want to appear on your payment page is located.
Important: HTTPS protocol is required.
ID of the website created on merchant's account.
Get it from the dashboard Websites.
Generated using TypeDoc
HipayClient.createOrder