Documentation/Référence API

API REFERENCE

Retourner une répartition de paiement

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

Retourner une répartition de paiement

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

Request parameters8

Required fields first

回退分账

commandRequiredstringdata.commandreturnSplitPayment
currencyRequiredstringdata.currency订单结算货币,Settlement Currency
notify_urlRequiredstringdata.notify_url异步通知地址
nonce_stringRequiredstringdata.nonce_string随机字符串,不长于32位
split_idRequiredstringdata.split_id创建分账后返回的分账订单id
reference_idRequiredstringdata.reference_id商户方的分账回退id,不长于32位,不能重复
receiversRequiredstringdata.receivers分账接收方信息,json格式
Optional parameters 1
referenceOptionalstringdata.reference描述信息,不长于128位

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

Paramètres

ParameterTypeDescriptionObligatoire
data.commandstringreturnSplitPayment✓
data.currencystring订单结算货币,Settlement Currency✓
data.notify_urlstring异步通知地址✓
data.nonce_stringstring随机字符串,不长于32位✓
data.split_idstring创建分账后返回的分账订单id✓
data.reference_idstring商户方的分账回退id,不长于32位,不能重复✓
data.referencestring描述信息,不长于128位—
data.receiversstring分账接收方信息,json格式✓

Cette API retourne une répartition de paiement YabandPay terminée avec succès.

Conseil

Remarque : Chaque répartition de paiement peut être retournée au maximum 10 fois.

ParamètreTypeDescriptionObligatoire
userStringUID du compte super administrateurObligatoire
signStringSignatureObligatoire
methodStringv3.SplitPaymentObligatoire
timeLongTimestampObligatoire
  • Parameters | Paramètre | Type | Description | Obligatoire | |:--- |:--- |:--- |:--- | | command | String | returnSplitPayment | Obligatoire | | currency | String | Devise de règlement de la commande, Settlement Currency | Obligatoire | | notify_url | String | URL de notification asynchrone | Obligatoire | | nonce_string | String | Chaîne aléatoire de 32 caractères maximum | Obligatoire | | split_id | String | ID de l’ordre de répartition renvoyé lors de sa création | Obligatoire | | reference_id | String | ID unique de retour de répartition du marchand, limité à 32 caractères | Obligatoire | | reference| String | Description, limitée à 128 caractères| Facultatif| | receivers | String | Informations du bénéficiaire de la répartition au format JSON | Obligatoire | | receivers.mid | String | MID du bénéficiaire de la répartition | Obligatoire | | receivers.split_detail_id | String | ID du détail de répartition renvoyé lors de sa création | Obligatoire | | receivers.detail_reference_id | String | Numéro du détail de retour de répartition du bénéficiaire | Obligatoire | | receivers.split_amount | String | Montant réparti | Obligatoire | | receivers.description | String | Description du détail de la répartition | Obligatoire |

Exemple de signature :

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

"command=returnSplitPayment&currency=EUR&method=v3.SplitPayment&nonce_string=qxg9mzdxxh4pyi9fhb&notify_url=https://www.yabandpay.com/notify&receivers=[{"mid":111,"split_amount":2,"split_detail_id":"20231229110618372777-1","detail_reference_id":"123456-1","description":"分账回退描述1"},{"mid":222,"split_amount":1,"split_detail_id":"20231229110618372777-2","detail_reference_id":"123456-1","description":"分账回退描述2"}]&reference=19398394598568&reference_id=123456&split_id=20231229110618372777&time=1703829894&trade_id=67943b0b-ca6b-aa96-5fb1-e354975f1ec4&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": 1703829894,
    "data": {
        "command": "returnSplitPayment",
        "trade_id": "67943b0b-ca6b-aa96-5fb1-e354975f1ec4",
        "notify_url": "https://www.yabandpay.com/notify",
        "reference_id": "123456",
        "reference": "564635235",
        "currency": "EUR",
        "split_id": "20231229110618372777",
        "nonce_string": "qxg9mzdxxh4pyi9fhb",
        "receivers": "[{\"mid\":111,\"split_amount\":2,
        \"split_detail_id\":\"20231229110618372777-1\",\"detail_reference_id\":\"123456-1\",\"description\":\"分账回退描述1\"},{\"mid\":222,\"split_amount\":1,
       \"split_detail_id\":\"20231229110618372777-2\",\"detail_reference_id\":\"123456-1\",\"description\":\"分账回退描述2\"}]"
    }
}

Exemple de réponse :

{
    "status": true,
    "code": "200",
    "data": {
        "user": "9212776037",
        "split_id": "20231229110618372777",
        "trade_id": "67943b0b-ca6b-aa96-5fb1-e354975f1ec4",
        "state": "Success",
        "merchant_mid": "123",
        "merchant_name": "123",
        "reference_id": "123456",
        "reference": "564635235",        
        "split_solution_id": "104",
        "notify_url": "https://www.yabandpay.com/notify",
        "currency": "EUR",
        "created_at": 1703831332,
        "receivers": [
            {
                "merchant_mid": "111",
                "merchant_name": "111",
                "detail_reference_id": "123456-1",
                "split_detail_id": "20231229110618372777-1",
                "refund_split_detail_id": "20231229110618372777-1-1",
                "split_type": "Return",
                "split_amount": "2",
                "result": "Success",
                "description": "分账回退描述1",
                "error_msg": null
            },
            {
                "merchant_mid": "222",
                "merchant_name": "222",
                "detail_reference_id": "123456-1",
                "split_detail_id": "20231229110618372777-2",
                "refund_split_detail_id": "20231229110618372777-2-1",
                "split_type": "Return",
                "split_amount": "1",
                "result": "Success",
                "description": "分账回退描述2",
                "error_msg": null
            }
        ],
        "type": "splitRefund"
    },
    "message": ""
}
  • Response Parameters
ParamètreTypeDescription
userStringUID du compte caissier
split_idStringNuméro d’ordre de répartition du paiement généré lors de sa création
split_solution_idStringID de la règle de répartition du paiement
stateStringStatus: Success or Failed
merchant_midStringMID du marchand qui répartit le paiement
merchant_nameStringNom du marchand qui répartit le paiement
created_atStringHorodatage de création
currencyStringDevise de règlement de la commande, Settlement Currency
notify_urlStringURL de notification asynchrone
reference_idStringID de répartition de paiement du marchand, limité à 32 caractères
referenceStringDescription, limitée à 128 caractères
typeStringType : splitPayment ou splitRefund
receiversStringInformations du bénéficiaire de la répartition au format JSON
receivers.merchant_midStringMID du bénéficiaire de la répartition
receivers.merchant_nameStringNom du marchand bénéficiaire de la répartition
receivers.split_detail_idStringNuméro de détail de la répartition généré lors de sa création
receivers.detail_reference_idStringNuméro de détail de la répartition du marchand
receivers.split_typeStringType de détail de la répartition : Split ou Return
receivers.split_amountStringMontant réparti
receivers.resultStringStatus: Success or Failed
receivers.descriptionStringDescription du détail de la répartition
receivers.error_msgStringMessage d’erreur du détail de la répartition, renseigné en cas d’échec