Skip to main content
POST
HKD Collection Application

Secret Key & Private Key (Generate Signature)

Body

application/json
appId
integer
required

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

orderId
string
required

Merchant order number

Maximum string length: 48
name
string
required

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

phone
string
required

Real phone number

email
string<email>
required

Valid email address

amount
string
required

Transaction amount, up to 2 decimal places

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

Transaction type

inBankCode
string
required
callBackUrl
string<uri>
required

Redirect URL after successful payment

callBackFailUrl
string<uri>
required

Redirect URL after failed payment

partnerUserId
string
required

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
required

Signature

cancelUrl
string<uri>

Cancel payment redirect URL. If provided, users can click back on the payment page and be redirected to this URL

notifyUrl
string<uri>

Notification URL

subject
string

Payment note

body
string

Payment details

Response

200 - application/json
status
string

1: Normal, 0: Exception

error
string

Error code

msg
string

Error description

data
object
Last modified on July 16, 2026