API REFERENCE
H5 Payments
Tip
Note: WeChat does not support H5 payments by default. Apply to YabandPay to activate this feature before use.
| Parameter | Type | Description | Required |
|---|---|---|---|
| user | String | Cashier account UID | Required |
| sign | String | Signature | Required |
| method | String | v3.CreatePaymentsWechatH5Pay | Required |
| time | Long | Timestamp | Required |
- Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| pay_method | String | online | Required |
| sub_pay_method | String | WeChat Pay | Required |
| order_id | String | Merchant order ID | Required |
| amount | String | Amount as a numeric string. For example, enter 24.99 for € 24.99. CNY amount >=1; EUR amount >=0.1. | Required |
| currency | String | E currency code, ISO 4217, such as EUR or CHF | Required |
| description | String | Order description | Required |
| demo | String | Custom field | Optional |
| timeout | String | Expiration time in minutes (0-1440) | Required |
| notify_url | String | Asynchronous notification URL after payment | Required |
| redirect_url | String | Redirect URL after payment | Optional |
| ip_address | String | Ip address | Required |
Signature example:
Sorted parameters concatenated into a URL-style query string
"amount=0.1¤cy=EUR&demo=test&description=YabandPay test&ip_address=127.0.0.1&method=v3.CreatePaymentsWechatH5Pay¬ify_url=https://www.yabandpay.com/notify&order_id=202487816549841654&pay_method=online&redirect_url=https://www.yabandpay.com&sub_pay_method=WeChat Pay&time=1555498137&timeout=0&user=YOUR_CASHIER_UID"
Sign stringA using secret_key
The resulting signature is:
"YOUR_SIGNATURE"
Request example:
{
"user": "YOUR_CASHIER_UID",
"sign": "YOUR_SIGNATURE",
"method": "v3.CreatePaymentsWechatH5Pay",
"time": 1555498137,
"data": {
"amount": "0.1",
"currency": "EUR",
"demo": "test",
"description": "YabandPay test",
"notify_url": "https://www.yabandpay.com/notify",
"order_id": "YOUR_ORDER_ID",
"pay_method": "online",
"redirect_url": "https://www.yabandpay.com",
"sub_pay_method": "WeChat Pay",
"timeout": "0",
"ip_address" : "127.0.0.1"
}
}
Response example:
{
"status": true,
"code": "200",
"data": {
"order_id": "YOUR_ORDER_ID",
"trade_id": "ced03b0a-3bb1-ce9b-237e-eed85f4b7e33",
"amount": "0.10",
"currency": "EUR",
"parameters": {
"pay_url": "https://pay.yabandpay.com/payments/wechat_native_callback/order/M80d5a3f88dfb16716f04479e36dda8d79fbea0dc52cf8d902bd3330bb41"
},
"state": "processing"
},
"message": ""
}
Pass the pay_url parameter to the corresponding H5 interface to launch WeChat Pay.
Additional information:
Response result:
-
A successful request returns "status": true.
-
A failed request returns "status": false.
We strongly recommend using both Query Order and Asynchronous Notifications to keep payment statuses accurate and up to date.
Response codes:
| Status | Code | Message |
|---|---|---|
| true | 200 | Success |
| false | -1000 | Internal error |
| false | -3001 | Required field is missing |
| false | -403 | The signature Error |
| false | -4011 | Not support the payment method |
