HaiPay Integration Environment and Request URLs

Through these API definitions, merchants can use the interfaces in different environments to complete order creation and payment flows. By continuously adding use case scenarios, more cases can be accumulated and refined.

​

APIs

​

Collection

​

Collection Apply

Create a collection order. URL: /{currency}/collect/apply, where is the currency. See Supported Countries and Currencies Request Method: POST Request Parameters: Response:

Parameter		Required	Type	Description
status		Yes	Integer	Response code, 1 = success, 0 = failure
error		No	Integer	Error code, see Error Codes
msg		Yes	String	Error message
data	orderId	Yes	String	Merchant Order ID
	orderNo	Yes	String	Platform Order ID
	payUrl	Yes	String	Collection URL
	exchangeRate	No	String	Exchange rate, returned when user currency differs from merchant base currency
	orderAmount	No	String	Order amount, returned when user currency differs from merchant base currency
	amount	No	String	Transaction amount, returned when user currency differs from merchant base currency
	sign	Yes	String	Signature

Asynchronous Notification When a collection succeeds or fails, we will push the order status. Notifications are sent every 5 minutes, up to 5 times. The pushed data contains details of the current payment attempt, including: payment amountm and handling fee. URL: Provided by merchant, see Merchant Integration Process Request Method: POST Request Parameters:

​

Collection Query

Query a collection order. Request Parameters: Response:

​

Refund Apply

TODO

​

Disbursement

​

Disbursement Apply

Create a disbursement order. URL: /{currency}/pay/apply, where is the currency. See Supported Countries and Currencies Request Method: POST Request Parameters: Response:

​

Disbursement Query

​

Account Balance

​

Query Account

​

Related Topics

• HaiPay API Description and Common Rules
• HaiPay Configuration and Signature Guide
• HaiPay Error Response Reference