Documentation/Référence API

API REFERENCE

Annuler une répartition de paiement

POSThttps://mapi.yabandpay.com/Payments
Live API
API PLAYGROUND · Live API

Annuler une répartition de paiement

POSThttps://mapi.yabandpay.com/Payments
Automatically signed with your credentials

Request parameters4

Required fields first

取消分账

commandRequiredstringdata.commandCancelSplitPayment
nonce_stringRequiredstringdata.nonce_string随机字符串,不长于32位
reference_idRequiredstringdata.reference_id商户方的分账id,不长于32位
split_idRequiredstringdata.split_id创建分账后的分账单号

Credentials stay on this page. Your secret key is never stored or sent to the documentation server.

Paramètres

ParameterTypeDescriptionObligatoire
data.commandstringCancelSplitPayment✓
data.nonce_stringstring随机字符串,不长于32位✓
data.reference_idstring商户方的分账id,不长于32位✓
data.split_idstring创建分账后的分账单号✓

Cette API annule un ordre de répartition de paiement YabandPay dont le statut est Processing.

ParamètreTypeDescriptionObligatoire
userStringUID du compte super administrateurObligatoire
signStringSignatureObligatoire
methodStringv3.SplitPaymentObligatoire
timeLongTimestampObligatoire
  • Parameters | Paramètre | Type | Description | Obligatoire | |:--- |:--- |:--- |:--- | | command | String | CancelSplitPayment | Obligatoire | | nonce_string | String | Chaîne aléatoire de 32 caractères maximum | Obligatoire | | reference_id | String | ID de répartition de paiement du marchand, limité à 32 caractères | Obligatoire | | split_id | String | Numéro d’ordre de répartition du paiement généré lors de sa création | Obligatoire |

Exemple de signature :

Paramètres triés et concaténés dans une chaîne de requête au format URL

"command=cancelSplitPayment&method=v3.SplitPayment&nonce_string=0y9nydkzlmivuhs5xz&reference_id=123456&split_id=20231229110618372777&time=1703832252&user=9212776037"

Signer stringA avec secret_key

La signature obtenue est :

"YOUR_SIGNATURE"

Exemple de requête :

{
    "user": "9212776037",
    "sign": "YOUR_SIGNATURE",
    "method": "v3.SplitPayment",
    "time": 1703832252,
    "data": {
        "command": "cancelSplitPayment",
        "nonce_string": "0y9nydkzlmivuhs5xz",
        "split_id": "20231229110618372777",
        "reference_id": "123456"
    }
}

Exemple de réponse :

{
    "status": true,
    "code": "200",
    "data": {
        "split_id": "20231229110618372777",
        "reference_id": "123456",
        "state": "Cancelled"},
    "message": ""
}
  • Response Parameters
ParamètreTypeDescription
split_idStringNuméro d’ordre de répartition du paiement généré lors de sa création
stateStringStatus: Cancelled or Failed
reference_idStringID de répartition de paiement du marchand, limité à 32 caractères
referenceStringDescription, limitée à 128 caractères