API REFERENCE
Decrease Authorization
| Parameter | Type | Description | Required |
|---|---|---|---|
| user | String | Cashier account UID | Required |
| sign | String | Signature | Required |
| method | String | v3.PreauthDecrement | Required |
| time | Long | Timestamp | Required |
- Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| trade_id | String | trade_id of the authorization to decrease | Required |
| amount | String | Numeric amount. For example, € 24.99 must be written as 24.99 | Required |
| currency | String | ISO 4217 currency code, such as EUR or CHF | Required |
| description | String | Order description | Required |
| notify_url | String | Asynchronous notification URL after payment completion | Required |
| request_id | String | Unique request id; at least 24 alphanumeric characters are recommended | Required |
Signature example:
Sorted parameters concatenated into a URL-style query string
"amount=0.1¤cy=EUR&description=test&method=v3.PreauthDecrement¬ify_url=https://www.yabandpay.com/notify&request_id=skc5vtsovtetqe09us0jdrqm1vjdeaki&time=1774246236&trade_id=9222e0e1-6ef5-639f-3692-90f1e2a33e68&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.PreauthDecrement",
"time": 1774246236,
"data": {
"description": "test",
"trade_id": "9222e0e1-6ef5-639f-3692-90f1e2a33e68",
"amount": "0.1",
"currency": "EUR",
"notify_url": "https://www.yabandpay.com/notify",
"request_id": "skc5vtsovtetqe09us0jdrqm1vjdeaki"
}
}
Response example:
{
"status": true,
"code": "200",
"data": {
"order_id": "YOUR_ORDER_ID",
"trade_id": "160899f3-f6d9-a8d8-ab5b-82eacdab9c5b",
"amount": "1",
"currency": "EUR",
"state": "authorized"
},
"message": "",
"response_id": "202407111550570060848432"
}
Additional information:
Response result:
-
A successful request returns "status": true.
-
A failed request returns "status": false.
This API decreases the authorization amount. The result is returned synchronously. The decrease must not exceed the authorization amount.
Response codes:
| Status | Code | Message |
|---|---|---|
| true | 200 | |
| false | -1000 | Internal error |
| false | -403 | The signature Error |
| false | -2001 | The user not exist |
| false | -3001 | Required field is missing |
| false | -4118 | Incorrect request ID |
| false | -4024 | The original trade ID is incorrect |
