Documentation/Référence API

API REFERENCE

Notifications asynchrones de répartition des paiements

  • Response Parameters :
{
    "sign": "YOUR_SIGNATURE",
    "data": {
        "user": "9212776037",
        "split_id": "20231229110618372777",
        "trade_id": "67943b0b-ca6b-aa96-5fb1-e354975f1ec4",
        "state": "Processing",
        "merchant_mid": "123",
        "merchant_name": "123",
        "reference_id": "123456",
        "split_solution_id": "104",
        "split_completed": 1,
        "created_at": "1703819178",
        "notify_url": "https://www.yabandpay.com/notify",
        "currency": "EUR",
        "receivers": [
            {
                "merchant_mid": "222",
                "merchant_name": "222",
                "detail_reference_id": "123456-2",
                "split_detail_id": "20231229110618372777-2",
                "split_type": "Split",
                "split_amount": "5.00",
                "role": "1",
                "result": "Processing",
                "description": "分账描述2",
                "error_msg": null
            },
            {
                "merchant_mid": "111",
                "merchant_name": "111",
                "detail_reference_id": "123456-1",
                "split_detail_id": "20231229110618372777-1",
                "split_type": "Split",
                "split_amount": "10.00",
                "role": "2",
                "result": "Processing",
                "description": "分账描述1",
                "error_msg": null
            }
        ],
        "type": "splitPayment"
    }
}
  • Response Parameters
ParamètreTypeDescription
userStringUID du compte super administrateur
split_idStringNuméro d’ordre de répartition du paiement généré lors de sa création
trade_idStringtrade_id de la commande YabandPay
split_solution_idStringID de la règle de répartition du paiement
StatusCodeMessage
stateStringStatus: Processing, Success, Failed, Cancelled
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
split_completedStringIndique si la répartition du paiement est terminée : 0 : Non, 1 : Oui
reference_idStringID de répartition du 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 du paiement
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.roleStringRôle du bénéficiaire de la répartition
receivers.resultStringStatus: Processing, Success, Failed, Cancelled
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