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 an Alipay e-commerce 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
Field name
Format
Req.
Description
orderid
AN
M
Order ID
operation
A
M
sale authorization
payment_product
AN
M
alipay-ecommerce
description
AN
M
Description of the order
currency
A
E.g.: USD
amount
R
M
Transaction amount Decimal number with explicit decimal point, signed (e.g.: 66.00)
cid
AN
Customer ID
email
AN
Customer's email address
phone
N
Customer's phone number
birthdate
AN
Customer's birthdate (YYYYMMDD)
gender
A
Gender of the customer(M = male, F = female, U = unknown)
firstname
A
Customer's first name
lastname
A
Customer's last name
streetaddress
AN
Customer's billing address
city
A
City of the customer's billing address
zipcode
N
Postal code of the customer's billing address
country
A
Country code of the customer's billing address This two-letter country code complies with ISO 3166-1 (alpha 2).
shipto_firstname
A
First name of the order's recipient
shipto_lastname
A
Last name of the order's recipient
shipto_streetaddress
AN
Recipient's shipping address
shipto_city
AN
City of the recipient's shipping address
shipto_zipcode
N
Postal code of the recipient's shipping address
shipto_country
A
Country code of the recipient's shipping address This two-letter country code complies with ISO 3166-1 (alpha 2).
eci
N
7: E-commerce with SSL/TLS Encryption
delivery_date
AN
YYYY-MM-DD
Request example
{
currency:USD
payment_product:alipay-ecommerce
orderid:
amount:39.25
description:Alipay e-commerce test
eci:7
long_description:Detailed description
operation:sale
}
API response
This service returns a forward URL, where you must redirect your customers to complete the payment.
(For further details, please refer to the technical documentation.)
Response example
forwarding
https://stage-secure-gateway.hipay-tpp.com/gateway/forward/987654321a123b0b1fabcd98a7654321
true
00001234455
1
400000112233
2018-06-07T12:48:03+0000
2018-06-07T14:48:04+0200
140
Authentication requested
0.00
0.00
0.00
0.00
2
USD
0.0.0.0
7
alipay-ecommerce
0
ACCEPTED
1231230123
2018-06-07T12:48:03+0000
1
39.25
0.00
0.00
2
USD
