Skip to main content
POST
Cashier Collection Application
All example requests on this page are based on the sandbox (test) environment. Please be careful to distinguish it from the production environment.

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., John Doe

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 October 13, 2026