API REFERENCE
Cancel a payment split
This API cancels a YabandPay payment split order with the status Processing.
| Parameter | Type | Description | Required |
|---|---|---|---|
| user | String | UID of the super administrator account | Required |
| sign | String | Signature | Required |
| method | String | v3.SplitPayment | Required |
| time | Long | Timestamp | Required |
- Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| command | String | CancelSplitPayment | Required |
| nonce_string | String | Random string, no longer than 32 characters | Required |
| reference_id | String | Merchant's payment split ID, no longer than 32 characters | Required |
| split_id | String | Payment split order number generated when the payment split is created | Required |
Signature example:
Sorted parameters concatenated into a URL-style query string
"command=cancelSplitPayment&method=v3.SplitPayment&nonce_string=0y9nydkzlmivuhs5xz&reference_id=123456&split_id=20231229110618372777&time=1703832252&user=9212776037"
Sign stringA using secret_key
The resulting signature is:
"YOUR_SIGNATURE"
Request example:
{
"user": "9212776037",
"sign": "YOUR_SIGNATURE",
"method": "v3.SplitPayment",
"time": 1703832252,
"data": {
"command": "cancelSplitPayment",
"nonce_string": "0y9nydkzlmivuhs5xz",
"split_id": "20231229110618372777",
"reference_id": "123456"
}
}
Response example:
{
"status": true,
"code": "200",
"data": {
"split_id": "20231229110618372777",
"reference_id": "123456",
"state": "Cancelled"},
"message": ""
}
- Response parameters
| Parameter | Type | Description |
|---|---|---|
| split_id | String | Payment split order number generated when the payment split is created |
| state | String | Status: Cancelled or Failed |
| reference_id | String | Merchant's payment split ID, no longer than 32 characters |
| reference | String | Description, no longer than 128 characters |
