Skip to main content
POST
/
global
/
cashier
/
collect
/
apply
Cashier Collection Application
curl --request POST \
  --url https://uat-interface.haipay.asia/global/cashier/collect/apply \
  --header 'Content-Type: application/json' \
  --data '
{
  "appId": 123,
  "orderId": "<string>",
  "name": "<string>",
  "email": "jsmith@example.com",
  "amount": "<string>",
  "currency": "<string>",
  "callBackUrl": "<string>",
  "callBackFailUrl": "<string>",
  "subject": "<string>",
  "region": "<string>",
  "partnerUserId": "<string>",
  "sign": "<string>",
  "notifyUrl": "<string>",
  "body": "<string>"
}
'
{
  "status": "1",
  "error": "00000000",
  "msg": "",
  "data": {}
}

Secret Key & Private Key (Generate Signature)

Body

application/json
appId
integer
required

Business ID (retrieved from the backend; must use the Cashier-specific APPID, currency is CASHIER)

orderId
string
required

Merchant order ID

Maximum string length: 48
name
string
required

User full name (recommended to use real name). Format: firstName + lastName, separated by a space, e.g., Donald John Trump

email
string<email>
required

Valid email address

amount
string
required

Transaction amount (accurate to two decimals; do not use punctuation symbols such as “,”)

Pattern: ^\d+\.\d{2}$
currency
string
required

Transaction currency. Supported: USD (minimum 0.99 USD). For other currencies, see Region Codes.

Required string length: 3
callBackUrl
string<uri>
required

Redirect URL after successful payment

callBackFailUrl
string<uri>
required

Redirect URL after failed payment

subject
string
required

Payment note (transaction title, product name, reason for payment, etc.)

region
string
required

use 2-letter code

Required string length: 2
partnerUserId
string
required

Unique user identifier (e.g., userId), used for risk control. Must be real/valid, otherwise it may affect transactions. Allowed format: numbers, letters, or symbols -~!@#$%&*()_.

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

Signature

notifyUrl
string<uri>

Callback URL

body
string

Detailed remarks

Response

200 - application/json
status
string
default:1

1: Normal, 0: Exception

error
string
default:00000000

Error code

msg
string
default:""

Error description

data
object
Last modified on April 10, 2026