Create Withdrawal Order (CNY - Alipay)
API for creating a Chinese Yuan (CNY) Alipay withdrawal order.
Request Information
- Request URL:
/gateway/api/v2/payouts - 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, use fixed value SVC0033 |
| payout_cl_id | Yes | String(32) | Merchant Order ID |
| amount | Yes | Integer(10) | Amount (in cents) |
| notify_url | No | String(256) | Callback URL for transaction results |
| alipay_account_name | Yes | String | Alipay account |
| alipay_surname | Yes | String | First character of Alipay account holder's surname |
| request_time | Yes | Integer(10) | Request time (in seconds) |
| sign_type | No | String(16) | Signature type: HMAC-SHA256 (recommended) or MD5 (default) |
| sign | Yes | String(32|64) | Order Signature |
Request Example
{
"amount": "50000",
"alipay_account_name": "test_name",
"alipay_surname": "test",
"notify_url": "https://xxx.xx/notification",
"payout_cl_id": "DEVPOT00143538",
"platform_id": "PF0002",
"request_time": "1595504997",
"service_id": "SVC0033",
"sign": "8ac38fb87c2bcce4cf36627d4f8aa747"
}
Response Example
Success Response
{
"error_code": "0000",
"data": {
"payout_id": "POT00000001"
}
}
Error Response Example
{
"error_code": "0004",
"error_msg": "验签错误!"
}
Response Parameters
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code, see Global Error Codes |
| error_msg | String | Error message (returned when error_code is not "0000") |
| payout_id | String | Platform Order ID |
Remarks
Important Notice
Due to uncontrollable factors such as network fluctuations, high concurrency, or attacks, if you encounter timeouts, HTTP 500 errors, blank responses, or network delays when calling the withdrawal API, please use the order query API status as the basis for determination, or contact the operations team with the merchant order number for manual inquiry to confirm whether the withdrawal order has failed. This platform assumes no responsibility for losses caused by rejecting withdrawal orders without confirmation from the operations team!
- Merchant ID is a unique identifier assigned by the system. Please contact system personnel if you have not obtained one
- Service ID should be
SVC0033(Alipay Withdrawal) - Transaction amount is in Chinese Yuan (cents)
- Request time uses Unix timestamp in seconds
- A response of "0000" only indicates the API call was successful; it does not represent the transaction status. Please call the query API to confirm the result
- If no server response is received under any circumstances (e.g., 5xx HttpStatus...), you must call the query API or wait for the callback. Do not treat it as a failed order