API REFERENCE

Query a payment split

YabandPay documentation·Updated Oct 26, 2026

This API queries existing YabandPay payment split orders and payment split return orders.

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	querySplitPayment	Required
nonce_string	String	Random string, no longer than 32 characters	Required
reference_id	String	Merchant's payment split ID, no longer than 32 characters	Required
split_id	String	Payment split order number generated when the payment split is created	Required
split_type	String	Payment split type: 0: Split (payment split), 1: Return (payment split return). Only these 2 types are supported. If omitted, all payment splits and return information for split_id are queried.	Optional
split_detail_id	String	Detail of the payment split order generated when the payment split is created; can be used with split_type to query the corresponding payment split order details	Optional
refund_split_detail_id	String	Only effective when split_type indicates a payment split return; queries the corresponding payment split return order details	Optional

Signature example:

Sorted parameters concatenated into a URL-style query string

"command=querySplitPayment&method=v3.SplitPayment&nonce_string=7vccb9qkplvtxl22km&reference_id=123456&split_id=20231229110618372777&time=1703836221&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": 1703836221,
    "data": {
        "command": "querySplitPayment",
        "nonce_string": "7vccb9qkplvtxl22km",
        "split_id": "20231229110618372777",
        "reference_id": "123456"
    }
}

Response example:

{
    "status": true,
    "code": "200",
    "data": {
        "split_id": "20231229110618372777",
        "state": "Success",
        "merchant_mid": "123",
        "merchant_name": "123",
        "reference_id": "123456",
        "reference": "5464654561",
        "split_solution_id": "104",
        "created_at": "1703819178",
        "notify_url": null,
        "currency": "EUR",
        "receivers": [
            {
                "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.00",
                "role": "1",
                "result": "Success",
                "description": "分账回退描述2",
                "error_msg": null
            },
            {
                "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.00",
                 "role": "2",
                "result": "Success",
                "description": "分账回退描述1",
                "error_msg": null
            },
            {
                "merchant_mid": "222",
                "merchant_name": "222",
                "detail_reference_id": "123456-2",
                "split_detail_id": "20231229110618372777-2",
                "refund_split_detail_id": "",
                "split_type": "Split",
                "split_amount": "5.00",
                "role": "1",
                "result": "Success",
                "description": "分账描述2",
                "error_msg": null
            },
            {
                "merchant_mid": "111",
                "merchant_name": "111",
                "detail_reference_id": "123456-1",
                "split_detail_id": "20231229110618372777-1",
                "refund_split_detail_id": "",
                "split_type": "Split",
                "split_amount": "10.00",
                "role": "2",
                "result": "Success",
                "description": "分账描述1",
                "error_msg": null
            }
        ],
        "split_completed": 1
    },
    "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
trade_id	String	trade_id of the YabandPay order
split_solution_id	String	Payment split solution ID
state	String	Status: Processing, Success, Failed, Cancelled
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
split_completed	String	Whether the payment split is complete: 0: No, 1: Yes
reference_id	String	Merchant's payment split ID, no longer than 32 characters
reference	String	Description, no longer than 128 characters
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.role	String	Payment split recipient role
receivers.result	String	Status: Processing, Success, Failed, Cancelled
receivers.description	String	Payment split detail description
receivers.error_msg	String	Error message for the payment split detail; populated when result is Failed