API REFERENCE

Return a payment split

YabandPay documentation·Updated Oct 26, 2026

This API returns a successfully completed YabandPay payment split.

Tip

Note: Each payment split can be returned a maximum of 10 times.

Parameter	Type	Description	Required
user	String	UID of the super administrator account	Required
sign	String	Signature	Required
method	String	v3.SplitPayment	Required
time	Long	Timestamp	Required

Parameters

Parameter	Type	Description	Required
command	String	returnSplitPayment	Required
currency	String	Order settlement currency, Settlement Currency	Required
notify_url	String	Asynchronous notification URL	Required
nonce_string	String	Random string, no longer than 32 characters	Required
split_id	String	Payment split order ID returned when the payment split is created	Required
reference_id	String	Merchant's unique payment split return ID, no longer than 32 characters	Required
reference	String	Description, no longer than 128 characters	Optional
receivers	String	Payment split recipient information in JSON format	Required
receivers.mid	String	mid of the payment split recipient	Required
receivers.split_detail_id	String	Payment split detail ID returned when the payment split is created	Required
receivers.detail_reference_id	String	Payment split return detail number for the recipient	Required
receivers.split_amount	String	Payment split amount	Required
receivers.description	String	Payment split detail description	Required

Signature example:

Sorted parameters concatenated into a URL-style query string

"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"

Sign stringA using secret_key

The resulting signature is:

"YOUR_SIGNATURE"

Request example:

{
    "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\"}]"
    }
}

Response example:

{
    "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

Parameter	Type	Description
user	String	UID of the cashier account
split_id	String	Payment split order number generated when the payment split is created
split_solution_id	String	Payment split solution ID
state	String	Status: Success or Failed
merchant_mid	String	mid of the merchant splitting the payment
merchant_name	String	Name of the merchant splitting the payment
created_at	String	Creation timestamp
currency	String	Order settlement currency, Settlement Currency
notify_url	String	Asynchronous notification URL
reference_id	String	Merchant's payment split ID, no longer than 32 characters
reference	String	Description, no longer than 128 characters
type	String	Type: splitPayment or splitRefund
receivers	String	Payment split recipient information in JSON format
receivers.merchant_mid	String	mid of the payment split recipient
receivers.merchant_name	String	Merchant name of the payment split recipient
receivers.split_detail_id	String	Payment split detail number generated when the payment split is created
receivers.detail_reference_id	String	Merchant's payment split detail number
receivers.split_type	String	Payment split type: Split or Return
receivers.split_amount	String	Payment split amount
receivers.result	String	Status: Success or Failed
receivers.description	String	Payment split detail description
receivers.error_msg	String	Error message for the payment split detail; populated when result is Failed