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 https://stage-secure-gateway.hipay-tpp.com/rest/v1/hpayment
Production
https://secure-gateway.hipay-tpp.com/rest/v1/order https://secure-gateway.hipay-tpp.com/rest/v1/hpayment
Request parameters
To create a WeChat Pay 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
wechatpay
description
AN
M
Description of the order
long_description
AN
Detailed description of the order
currency
A
M
Required value: EUR
amount
R
M
Transaction amount Decimal number with explicit decimal point, signed (e.g.: 66.00)
email
AN
Customer's email address
phone
N
Customer's phone number
birthdate
AN
Customer's birthdate (YYYYMMDD)
firstname
AN
M
Customer's first name
lastname
AN
M
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). Required value: CN
shipto_firstname
AN
First name of the order's recipient
shipto_lastname
AN
Last name of the order's recipient
shipto_phone
N
Recipient's phone number
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
AN
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
accept_url
AN
M
Mandatory if not configured in the back office
decline_url
AN
M
Mandatory if not configured in the back office
pending_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
Request example
{
orderid:
operation:sale
payment_product:wechatpay
description:WeChat Pay test
long_description:Detailed description
currency:EUR
amount:200
accept_url:https://www.mysite.com/accept
decline_url:https://www.mysite.com/decline
pending_url:https://www.mysite.com/pending
exception_url:https://www.mysite.com/exception
cancel_url:https://www.mysite.com/cancel
firstname:John
lastname:DOE
country:CN
eci:7
}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
800000112233
2018-11-05T17:45:17+0000
2018-11-05T18:45:18+0100
140
Authentication requested
0.00
0.00
0.00
0.00
2
EUR
0.0.0.0
7
wechatpay
0
ACCEPTED
1231230123
2018-11-05T17:45:17+0000
1
100.00
0.00
0.00
2
EUR
