API REFERENCE
Query Devices
Merchants use this API to retrieve the list of pos devices.
API URL (production): https://mapi.yabandpay.com/Payments
API URL (test): https://acc-mapi.yabandpay.com/Payments
| Parameter | Type | Description | Required |
|---|---|---|---|
| user | String | UID of the Merchant-level super administrator account | Required |
| sign | String | Signature | Required |
| method | String | v3.GetPOSList | Required |
| time | Long | Timestamp | Required |
- Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| request_id | String | Unique request ID; a combination of digits and letters at least 24 characters is recommended | Required |
Signature example:
Sorted parameters concatenated into a URL-style query string
"method=v3.GetPOSList&request_id=a7z1lox4l6z6mdx1udgn5gtezasze1x0&time=1560753647&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.GetPOSList",
"time": 1560753647,
"data": {
"request_id": "a7z1lox4l6z6mdx1udgn5gtezasze1x0"
}
}
Response example:
{
"status": true,
"code": "200",
"data": {
"POS": [
{
"tid": "T125118250",
"uid": "T125118250",
"sn": "N62XXXXXXXX",
"model": "N62",
"secretkey": "YOUR_SECRET_KEY",
"store_id": "1265484354",
"store_name": "test store1"
},
{
"tid": "T125118251",
"uid": "T125118251",
"sn": "N62XXXXXXXX",
"model": "N62",
"secretkey": "YOUR_SECRET_KEY",
"store_id": "1265484354",
"store_name": "test store1"
},
{
"tid": "T125118252",
"uid": "T125118252",
"sn": "N62XXXXXXXX",
"model": "N62",
"secretkey": "YOUR_SECRET_KEY",
"store_id": "1265484355",
"store_name": "test store2"
}
]
},
"message": ""
}
Additional information:
Response result:
-
A successful request returns "status": true.
-
A failed request returns "status": false.
Response codes:
| Status | Code | Message |
|---|---|---|
| true | 200 | Success |
| false | -1000 | Internal error |
| false | -3001 | Required field is missing |
| false | -3002 | duplicate request_id |
| false | -403 | The signature Error |
