Documentation/API Reference

API REFERENCE

Asynchronous payment split notifications

  • 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
ParameterTypeDescription
userStringUID of the super administrator account
split_idStringPayment split order number generated when the payment split is created
trade_idStringtrade_id of the YabandPay order
split_solution_idStringPayment split solution ID
stateStringStatus: Processing, Success, Failed, Cancelled
merchant_midStringmid of the merchant splitting the payment
merchant_nameStringName of the merchant splitting the payment
created_atStringCreation timestamp
currencyStringOrder settlement currency, Settlement Currency
notify_urlStringAsynchronous notification URL
split_completedStringWhether the payment split is complete: 0: No, 1: Yes
reference_idStringMerchant's payment split ID, no longer than 32 characters
referenceStringDescription, no longer than 128 characters
typeStringType: splitPayment or splitRefund
receiversStringPayment split recipient information in JSON format
receivers.merchant_midStringmid of the payment split recipient
receivers.merchant_nameStringMerchant name of the payment split recipient
receivers.split_detail_idStringPayment split detail number generated when the payment split is created
receivers.detail_reference_idStringMerchant's payment split detail number
receivers.split_typeStringPayment split type: Split or Return
receivers.split_amountStringPayment split amount
receivers.roleStringPayment split recipient role
receivers.resultStringStatus: Processing, Success, Failed, Cancelled
receivers.descriptionStringPayment split detail description
receivers.error_msgStringError message for the payment split detail; populated when result is Failed