Skip to main content

Create Deposit Order (CNY)

API for creating a Chinese Yuan (CNY) deposit order.

Request Information​

  • Request URL: /gateway/api/v2/payments
  • Method: POST
  • Content-Type: application/json;charset=utf-8

Request Parameters​

ParameterRequiredTypeDescription
platform_idYesString(6)Merchant ID
service_idYesString(7)Service ID
payment_cl_idYesString(64)Merchant Order ID
amountYesInteger(10)Amount (in cents)
notify_urlYesString(256)Callback URL for transaction results
return_urlNoString(256)Merchant return URL, supported by some payment methods. https only; at most 256 characters; printable ASCII characters only (no spaces). Include the exact provided value in the signature; an unsigned value is ignored
bank_nameNoString(16)Bank code, see Bank List
nameNoString(16)Payer name
request_timeYesInteger(10)Request time (in seconds)
sign_typeNoString(16)Signature type, fixed value HMAC-SHA256
signYesString(32|64)Order Signature

Service IDs​

Service Availability

The following are commonly used Service IDs. Please refer to the service IDs provided by your account manager for actual available services.

  • SVC0001 Bank Card Deposit
  • SVC0002 Bank Card Top-up
  • SVC0008 WeChat QR Code
  • SVC0010 Alipay QR Code
  • SVC0011 Alipay H5

Response Example​

Success Response​

{
"error_code": "0000",
"data": {
"link": "https://pay.example.com/cashier/DEMOPM0123456",
"payment_id": "DEMOPM0123456",
"payment_cl_id": "order_20260112001",
"amount": 10000
}
}

Remarks​

  • Transaction amount is in Chinese Yuan (cents). Please multiply by 100 before passing
  • Request time uses Unix timestamp in seconds
  • Transaction results will be sent to notify_url. See Deposit Notification for parameter specifications
  • return_url is an optional merchant return URL supported by some payment methods. The field is ignored when omitted or not included in the signature
  • Percent-encode non-ASCII URL components before sending. The complete encoded URL must not exceed 256 characters. Sign the final URL value exactly as provided; do not encode or modify it again after signing
  • A user returning to the page specified by return_url does not indicate a successful payment. Use the notify_url notification or the order query API to determine the transaction result