Query Split Payment

This API allows querying of split payment orders and split return orders that have been created in YabandPay.

API URL：https://mapi.yabandpay.com/Payments

Method：POST

POST data type：Json

Parameter Type Description Required
user String UID of the super admin 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 (max 32 characters) Required
reference_id String Merchant-defined split ID (max 32 characters) Required
split_id String ID of the split payment created by the request Required
split_type String Type of split: 0 = Split, 1 = Return. If not provided, all related split and return info for the split_id will be queried. Optional
split_detail_id String Split detail ID, used to query specific details of the split when combined with split_type Optional
refund_split_detail_id String Only valid when split_type is 1 (Return). Used to query details of the return split. Optional

Signature：

Lexicographical sequence and URL key-value format new 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"

Use stringA and secret_key to get stringSign

Get Signature：

"51b50a2a6713676f1dd0a89eb1dc75ba43a0e4870a9630dc76dc300aaaad1889"

Example Request:

{
    "user": "9212776037",
    "sign": "51b50a2a6713676f1dd0a89eb1dc75ba43a0e4870a9630dc76dc300aaaad1889",
    "method": "v3.SplitPayment",
    "time": 1703836221,
    "data": {
        "command": "querySplitPayment",
        "nonce_string": "7vccb9qkplvtxl22km",
        "split_id": "20231229110618372777",
        "reference_id": "123456"
    }
}

Example Response:

{
    "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 ID of the split payment created by the request
trade_id String trade_id of the YabandPay order
split_solution_id String ID of the split solution
state String Status: Processing, Success, Failed, or Cancelled
merchant_mid String MID of the splitting merchant
merchant_name String Name of the splitting merchant
created_at String Creation timestamp
currency String Settlement currency of the order
notify_url String Asynchronous notification URL
split_completed String Whether the split is completed: 0 = No, 1 = Yes
reference_id String Merchant-defined split ID (max 32 characters)
reference String Description (max 128 characters)
receivers String Split receiver information in JSON format
receivers.merchant_mid String MID of the split receiver
receivers.merchant_name String Name of the split receiver
receivers.split_detail_id String Split detail ID created by the request
receivers.detail_reference_id String Merchant-defined split detail ID
receivers.split_type String Split type: Split or Return
receivers.split_amount String Split amount
receivers.role String Role of the split receiver
receivers.result String Status: Processing, Success, Failed, or Cancelled
receivers.description String Description of the split detail
receivers.error_msg String Error message (present only if result is Failed)

results matching ""

    No results matching ""