API REFERENCE
Cancelar uma divisão de pagamentos
Parâmetros
| Parameter | Type | Descrição | Obrigatório |
|---|---|---|---|
| data.command | string | CancelSplitPayment | ✓ |
| data.nonce_string | string | 随机字符串，不长于32位 | ✓ |
| data.reference_id | string | 商户方的分账id,不长于32位 | ✓ |
| data.split_id | string | 创建分账后的分账单号 | ✓ |
Esta API cancela um pedido de divisão de pagamentos da YabandPay cujo status seja Processing.
| Parâmetro | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| user | String | UID da conta de superadministrador | Obrigatório |
| sign | String | Signature | Obrigatório |
| method | String | v3.SplitPayment | Obrigatório |
| time | Long | Timestamp | Obrigatório |
- Parameters
| Parâmetro | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| command | String | CancelSplitPayment | Obrigatório |
| nonce_string | String | Cadeia aleatória com no máximo 32 caracteres | Obrigatório |
| reference_id | String | ID de divisão de pagamentos do estabelecimento, no máximo 32 caracteres | Obrigatório |
| split_id | String | Número do pedido de divisão gerado quando a divisão é criada | Obrigatório |
Signature example:
Parâmetros ordenados concatenados em uma cadeia de consulta no formato de URL
"command=cancelSplitPayment&method=v3.SplitPayment&nonce_string=0y9nydkzlmivuhs5xz&reference_id=123456&split_id=20231229110618372777&time=1703832252&user=9212776037"
Sign stringA using secret_key
A assinatura resultante é:
"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
| Parâmetro | Tipo | Descrição |
|---|---|---|
| split_id | String | Número do pedido de divisão gerado quando a divisão é criada |
| state | String | Status: Cancelled ou Failed |
| reference_id | String | ID de divisão de pagamentos do estabelecimento, no máximo 32 caracteres |
| reference | String | Descrição, no máximo 128 caracteres |