API REFERENCE
MobilePay
MobilePay supports creating online payment orders by setting pay_method to online and sub_pay_method to MobilePay.
| Parameter | Type | Description | Required |
|---|---|---|---|
| user | String | Cashier account UID | Required |
| sign | String | Signature | Required |
| method | String | v3.CreatePayments | Required |
| time | Long | Timestamp | Required |
- Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| pay_method | String | online | Required |
| sub_pay_method | String | MobilePay | Required |
| order_id | String | Merchant order ID | Required |
| amount | String | Numeric amount. For example, EUR 24.99 must be written as 24.99 | Required |
| currency | String | EUR | Required |
| description | String | Order description | Required |
| demo | String | Custom field | Optional |
| timeout | String | Expiration time in minutes (0-1440) | Required |
| redirect_url | String | Redirect URL after payment | Optional |
| notify_url | String | Asynchronous notification URL after payment | Required |
Signature example:
Sorted parameters concatenated into a URL-style query string
"amount=1¤cy=EUR&demo=test&description=YabandPay test&method=v3.CreatePayments¬ify_url=https://www.yabandpay.com/notify&order_id=20240726785412369&pay_method=online&redirect_url=https://www.yabandpay.com&sub_pay_method=MobilePay&time=1646388458&timeout=0&user=YOUR_CASHIER_UID"
Sign the resulting stringA using secret_key.
The resulting signature is:
"YOUR_SIGNATURE"
Request example:
{
"user": "YOUR_CASHIER_UID",
"sign": "YOUR_SIGNATURE",
"method": "v3.CreatePayments",
"time": 1646388458,
"data": {
"description": "YabandPay test",
"timeout": "0",
"pay_method": "online",
"sub_pay_method": "MobilePay",
"order_id": "YOUR_ORDER_ID",
"amount": "1",
"currency": "EUR",
"redirect_url": "https://www.yabandpay.com",
"notify_url": "https://www.yabandpay.com/notify",
"demo": "test"
}
}
Response example:
{
"status": true,
"code": "200",
"data": {
"order_id": "YOUR_ORDER_ID",
"trade_id": "23615e31-75e2-45b8-a8ef-6d4175292b44",
"amount": "1.00",
"currency": "EUR",
"url": "https://pay.yabandpay.com/pay_method/bW9iaWxlcGF5/MjM2MTVlMzEtNzVlMi00NWI4LWE4ZWYtNmQ0MTc1MjkyYjQ0",
"state": "processing"
},
"message": ""
}
Additional information:
Response result:
-
If the call succeeds, "status": true is returned.
-
If the call fails, "status": false is returned.
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 |
