Cancel Split Payment
This API allows the cancellation of a split payment order in Processing
status.
API URL:https://mapi.yabandpay.com/Payments
Method:POST
POST data type:Json
Parameter | Type | Description | Required |
---|---|---|---|
user | String | UID of the super admin account | Required |
sign | String | Signature | Required |
method | String | v3.SplitPayment |
Required |
time | Long | Timestamp | Required |
- Request Parameters
Parameter | Type | Description | Required |
---|---|---|---|
command | String | cancelSplitPayment |
Required |
nonce_string | String | Random string (max 32 characters) | Required |
reference_id | String | Merchant-defined split ID (max 32 characters) | Required |
split_id | String | Split payment ID created by the request | Required |
Signature:
Lexicographical sequence and URL key-value format new string
"command=cancelSplitPayment&method=v3.SplitPayment&nonce_string=0y9nydkzlmivuhs5xz&reference_id=123456&split_id=20231229110618372777&time=1703832252&user=9212776037"
Use stringA and secret_key to get stringSign
Get Signature:
"b0b6fa707f3a3826000ce26c8fbf7f851fd703a2f2cd7e8a7a69f718fd28b2eb"
Example Request:
{
"user": "9212776037",
"sign": "b0b6fa707f3a3826000ce26c8fbf7f851fd703a2f2cd7e8a7a69f718fd28b2eb",
"method": "v3.SplitPayment",
"time": 1703832252,
"data": {
"command": "cancelSplitPayment",
"nonce_string": "0y9nydkzlmivuhs5xz",
"split_id": "20231229110618372777",
"reference_id": "123456"
}
}
Example Response:
{
"status": true,
"code": "200",
"data": {
"split_id": "20231229110618372777",
"reference_id": "123456",
"state": "Cancelled",
},
"message": ""
}
- Response Parameters
Parameter | Type | Description |
---|---|---|
split_id | String | ID of the split payment created by the request |
state | String | Status: Cancelled or Failed |
reference_id | String | Merchant-defined split ID (max 32 characters) |
reference | String | Description (max 128 characters) |