Warning

Before reading this document, please make sure to review API Description Guide

Collection API

Collection Request

Description:

• Create a collection order

URL:

• HKD: /hkd/collect/apply
  Note: appId HKD, amount HKD, settlement HKD

• USD: /usd/collect/apply
  Note: appId USD, amount USD, settlement USD

Parameters:

Name	Required	Type	Description
appId	Yes	Long	Business ID (retrieved from the backend, must correspond to the currency in the URL)
orderId	Yes	String	Merchant order number (must be unique, max length: 48)
name	Yes	String	Customer name, recommended to use the real name. Format: firstName + lastName separated by a space, e.g. Donald John Trump
phone	Yes	String	Real phone number (format reference: Phone Format)
email	Yes	String	Valid email address
amount	Yes	String	Transaction amount, up to 2 decimal places
payType	Yes	String	Transaction type
inBankCode	Yes	String	Payment method
callBackUrl	Yes	String	Redirect URL after successful payment
callBackFailUrl	Yes	String	Redirect URL after failed payment
notifyUrl	No	String	Notification URL
subject	No	String	Payment note
body	No	String	Payment details
partnerUserId	Yes	String	Unique user identifier (e.g., userId). Must be valid, otherwise it may affect risk control. Allowed characters: digits, letters, and common symbols -~!@#$%&*()_
sign	Yes	String	Signature

Response Data

Name	Type	Description
orderId	String	Merchant order number (must be unique)
orderNo	String	Platform order number
payUrl	String	Payment URL
sign	String	Signature

---

Collection Query

Description:

• Query collection order

URL:

• HKD: /hkd/collect/query

• USD: /usd/collect/query

Parameters:

Name	Required	Type	Description
appId	Yes	Long	Business ID (retrieved from the backend, must correspond to the currency in the URL)
orderId	Yes	String	Merchant order number
orderNo	No	String	Platform order number (faster response)
sign	Yes	String	Signature

Response Data

Name	Type	Description
orderId	String	Merchant order number (must be unique)
orderNo	String	Platform order number
amount	String	Transaction amount
actualAmount	String	Amount received
fee	String	Fee
status	Integer	Status (0: Not started, 1: Processing, 2: Success (final), 3: Failed (final), -1: Pending confirmation)
payTime	String	Payment success time (present when status=2), format: yyyy-MM-dd HH:mm:ss (local currency time)
errorMsg	String	Error message (present when status=3)
sign	String	Signature

---

Payment Methods

HKD

payType	inBankCode	Limit	Description
EWALLET	WXPAY_SCANCODE	1~1000	Hong Kong WeChat Pay (QR code)
EWALLET	ALIPAY_HKD	1~1000	Hong Kong Alipay
BANK_TRANSFER	CREDIT_CARD_HKD	1~7000	Credit Card

USD

payType	inBankCode	Limit	Description
BANK_TRANSFER	PAYME_USD	1~1000	Hong Kong PayMe
BANK_TRANSFER	ALIPAY_USD	1~1000	Hong Kong Alipay
EWALLET	GOOGLE_PAY	0.99~1000	Google Pay
EWALLET	APPLE_PAY	0.99~1000	Apple Pay
EWALLET	HK_WXPAY_SCANCODE_USD	0.99~1000	Hong Kong WeChat Pay (QR code)