跳转到主要内容
POST
/
hkd
/
collect
/
apply
HKD Collection Application
curl --request POST \
  --url https://uat-interface.haipay.asia/hkd/collect/apply \
  --header 'Content-Type: application/json' \
  --data '
{
  "appId": 123,
  "orderId": "<string>",
  "name": "<string>",
  "phone": "<string>",
  "email": "jsmith@example.com",
  "amount": "<string>",
  "payType": "<string>",
  "inBankCode": "<string>",
  "callBackUrl": "<string>",
  "callBackFailUrl": "<string>",
  "partnerUserId": "<string>",
  "sign": "<string>",
  "notifyUrl": "<string>",
  "subject": "<string>",
  "body": "<string>"
}
'
{
  "status": "<string>",
  "error": "<string>",
  "msg": "<string>",
  "data": {
    "orderId": "<string>",
    "orderNo": "<string>",
    "payUrl": "<string>",
    "sign": "<string>"
  }
}

​
密钥私钥(生成签名)

请求体

application/json
​
appId
integer
必填

Business ID (retrieved from the backend, must correspond to the currency in the URL)

​
orderId
string
必填

Merchant order number

Maximum string length: 48
​
name
string
必填

Customer name, recommended to use the real name. Format: firstName + lastName separated by a space, e.g. Donald John Trump

​
phone
string
必填

Real phone number

​
email
string<email>
必填

Valid email address

​
amount
string
必填

Transaction amount, up to 2 decimal places

Pattern: ^\d+\.?\d{0,2}$
​
payType
string
必填

Transaction type

​
inBankCode
string
必填
​
callBackUrl
string<uri>
必填

Redirect URL after successful payment

​
callBackFailUrl
string<uri>
必填

Redirect URL after failed payment

​
partnerUserId
string
必填

Unique user identifier (e.g., userId). Must be valid, otherwise it may affect risk control. Allowed characters: digits, letters, and common symbols -~!@#$%&*()_

Pattern: ^[A-Za-z0-9\-~!@#$%&*()_]+$
​
sign
string
必填

Signature

​
notifyUrl
string<uri>

Notification URL

​
subject
string

Payment note

​
body
string

Payment details

响应

200 - application/json
​
status
string

1: Normal, 0: Exception

​
error
string

Error code

​
msg
string

Error description

​
data
object
Last modified on April 10, 2026