文档中心/API 接口

API REFERENCE

回退分账

POSThttps://mapi.yabandpay.com/Payments
实际接口
API PLAYGROUND · 实际接口

回退分账

POSThttps://mapi.yabandpay.com/Payments
填写凭据后自动签名

请求参数8

先填写必填项

回退分账

command必填stringdata.commandreturnSplitPayment
currency必填stringdata.currency订单结算货币,Settlement Currency
notify_url必填stringdata.notify_url异步通知地址
nonce_string必填stringdata.nonce_string随机字符串,不长于32位
split_id必填stringdata.split_id创建分账后返回的分账订单id
reference_id必填stringdata.reference_id商户方的分账回退id,不长于32位,不能重复
receivers必填stringdata.receivers分账接收方信息,json格式
可选参数 1
reference可选stringdata.reference描述信息,不长于128位

凭据仅在当前页面使用。secret_key 不保存,也不发送给文档服务器。

此接口对YabandPay分账成功的分账单进行回退

小贴士

注意: 每个分账只能最多只能回退10次。

参数类型描述是否必填
userString超级管理员账号的UID必填
signString签名必填
methodStringv3.SplitPayment必填
timeLong时间戳必填
  • 参数
参数类型描述是否必填
commandStringreturnSplitPayment必填
currencyString订单结算货币,Settlement Currency必填
notify_urlString异步通知地址必填
nonce_stringString随机字符串,不长于32位必填
split_idString创建分账后返回的分账订单id必填
reference_idString商户方的分账回退id,不长于32位,不能重复必填
referenceString描述信息,不长于128位选填
receiversString分账接收方信息,json格式必填
receivers.midString分账接收方的mid必填
receivers.split_detail_idString创建分账后返回的分账明细id必填
receivers.detail_reference_idString分账接收方的分账回退明细单号必填
receivers.split_amountString分账金额必填
receivers.descriptionString分账明细描述必填

签名示例:

拼接为URL方式并排序后的字符串

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

得到的 stringA 使用 secret_key做签名

得到的签名如下:

"YOUR_SIGNATURE"

提交示例:

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

返回示例:

{
    "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": ""
}
  • 返回参数
参数类型描述
userString收银员账号的UID
split_idString创建分账后的分账单号
split_solution_idString分账方案id
stateString状态有Success或Failed
merchant_midString分账商户的mid
merchant_nameString分账商户的商户名
created_atString创建时间戳
currencyString订单结算货币,Settlement Currency
notify_urlString异步通知地址
reference_idString商户方的分账id,不长于32位
referenceString描述信息,不长于128位
typeString类型,有splitPayment和splitRefund
receiversString分账接收方信息,json格式
receivers.merchant_midString分账接收方的mid
receivers.merchant_nameString分账接收方的商户名
receivers.split_detail_idString创建分账后的分账明细单号
receivers.detail_reference_idString商户方的分账明细单号
receivers.split_typeString分账类型Split或Return
receivers.split_amountString分账金额
receivers.resultString状态有Success或Failed
receivers.descriptionString分账明细描述
receivers.error_msgString分账明细错误信息,result 状态为 Failed 时有值