Create Deposit Order (CNY)
Create a CNY (Chinese Yuan) deposit order.
Request Information
- Request URL:
/gateway/api/v1/payments - Request Method:
POST - Content-Type:
application/json;charset=utf-8
Request Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
| platform_id | Yes | String(7) | Merchant ID |
| service_id | Yes | String(7) | Service ID |
| payment_cl_id | Yes | String(32) | Merchant Order ID |
| amount | Yes | Integer(10) | Amount (in cents) |
| notify_url | Yes | String(256) | Transaction result notification URL |
| name | No | String(16) | Remitter name (required for real-name verification channels) |
| last_number | No | String(6) | Last 6 digits of remitter account |
| request_time | Yes | Integer(10) | Request time (Unix timestamp in seconds) |
| sign | Yes | String(32) | Order Signature |
Request Example
{
"amount": "50000",
"bank_id": "BK0002",
"last_number": "123456",
"name": "test_name",
"notify_url": "https://xxx.xx/notification",
"payment_cl_id": "DEVPM00014581",
"platform_id": "PF0002",
"request_time": "1595504136",
"service_id": "SVC0001",
"sign": "c81634c1769044eac9e9628a2292f557"
}
Response Example
Bank Card Deposit
{
"error_code": "0000",
"data": {
"link": "http://xxx.xxx.xx/gateway/portal/v1/payments/GqhJK1nePB",
"payment_info": {
"amount": 50000,
"display_amount": 49996,
"payment_id": "PM00161864",
"payment_cl_id": "DEVPM00014581",
"receiver": {
"card_name": "Test Receiving Card 01",
"card_number": "201408150955",
"bank_name": "China Construction Bank",
"bank_branch": "Test Branch 01",
"bank_logo": "https://apimg.alipay.com/combo.png?d=cashier&t=CCB"
},
"sender": {
"card_name": "test_name",
"card_number": "*************123456",
"bank_name": "Agricultural Bank of China",
"bank_logo": "https://apimg.alipay.com/combo.png?d=cashier&t=ABC",
"bank_link": "https://perbank.abchina.com/EbankSite/startup.do?r=6CD8F48924CC703B"
},
"token": "26022"
}
}
}
Alipay Deposit
Important Notice
Merchants using Alipay may randomly receive either Alipay transfer or QR code mode responses. Your integration should be able to handle both response formats.
One of the following fields will be returned:
qr_code_url(QR code content) returned → Alipay QR scanaccount_code(Alipay account),account_name(Alipay nickname) returned → Alipay transfer
{
"error_code": "0000",
"data": {
"link": "https://demo.payment.com/index.html",
"payment_info": {
"amount": 273081,
"display_amount": 273081,
"payment_id": "KUITECPM02239985",
"payment_cl_id": "test_1706530149_10",
"token": "No memo required",
"account_code": "2827147939@qq.com",
"account_name": "Guo",
"qr_code_url": "https://qr.alipay.com/tsx11102hlw8nncztyzu9e0"
}
}
}
WeChat Deposit (QR Code Mode)
Important Notice
WeChat may randomly return one of four payment code types. Fields may be optional.
One of the following fields will be returned:
qr_code_url(QR code content) returned → WeChat QR scanaccount_code(WeChat account/number/payment code),account_name(WeChat nickname) returned → WeChat transfer
{
"error_code": "0000",
"data": {
"link": "https://demo.payment.com/index.html",
"payment_info": {
"amount": 273081,
"display_amount": 273081,
"payment_id": "KUITECPM02239985",
"payment_cl_id": "test_1706530149_10",
"token": "No memo required",
"account_code": "18857799168",
"account_name": "Ye Xiaoguo",
"qr_code_url": "https://qr.alipay.com/tsx11102hlw8nncztyzu9e0"
}
}
}
Error Response Example
{
"error_code": "0004",
"error_msg": "Signature verification failed!"
}
Response Parameter Description
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code |
| error_msg | String | Error message (returned when error_code is not "0000") |
| link | String | Order payment URL |
| amount | Int | Submitted amount |
| display_amount | Int | Floating adjusted payment amount |
Remarks
- Merchant ID is a unique identifier assigned by the system. If not obtained, please contact system personnel.
- Service ID options:
SVC0001(Bank Card Deposit)SVC0008(WeChat QR)SVC0010(Alipay QR)- For more, refer to Service ID List
- Bank ID: you can pass
bank_idorbank_code, refer to Bank List - Transaction amount unit is CNY (cents)
- Request time uses Unix timestamp in seconds
- Transaction results will be notified to
notify_url. Please provide a publicly accessible full URL (only http and https protocols supported). See parameter specs in Transaction Result Notification