文档中心/API 接口

API REFERENCE

创建分账

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

创建分账

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

请求参数10

先填写必填项

创建分账

command必填stringdata.commandcreateSplitPayment
trade_id必填stringdata.trade_id已支付订单YabandPay订单的trade_id
split_solution_id必填stringdata.split_solution_id后台配置的分账方案id
currency必填stringdata.currency原始订单的结算货币,Settlement Currency
notify_url必填stringdata.notify_url分账异步通知地址
nonce_string必填stringdata.nonce_string随机字符串,不长于32位
split_completed必填integerdata.split_completed是否完成分账,0 : 否,1 : 是
reference_id必填stringdata.reference_id商户方自定义的分账id,不长于32位,不能重复
receivers必填stringdata.receivers分账接收方信息,由二维数组通过json_encode转换的json字符串,json格式
可选参数 1
reference可选stringdata.reference描述信息,不长于128位

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

小贴士

YabandPay将从下面IP地址返回异步通知,建议加入防火墙白名单。

8.211.41.31 8.211.10.244 8.211.8.123

此接口对YabandPay已成功支付的订单创建分账

小贴士

注意: 1.每个支付订单创建最多10次分账;

2.调用接口前需要先配置分账方案,并获得批准;

3.如果 split_completed 为 1 后表示完成分账,后续不能再次发起任何分账。

参数类型描述是否必填
userString超级管理员账号的UID必填
signString签名必填
methodStringv3.SplitPayment必填
timeLong时间戳必填
  • 参数
参数类型描述是否必填
commandStringcreateSplitPayment必填
trade_idString已支付订单YabandPay订单的trade_id必填
split_solution_idString后台配置的分账方案id必填
currencyString原始订单的结算货币,Settlement Currency必填
notify_urlString分账异步通知地址必填
nonce_stringString随机字符串,不长于32位必填
split_completedString是否完成分账,0 : 否,1 : 是必填
reference_idString商户方自定义的分账id,不长于32位,不能重复必填
referenceString描述信息,不长于128位选填
receiversString分账接收方信息,由二维数组通过json_encode转换的json字符串,json格式需要分账时必填,只想把订单状态设置为已完成分账并且不需要分账接收方信息时请不要传该参数
receivers.midString分账接收方的mid需要分账时必填
receivers.detail_reference_idString自定义的分账接收方的分账明细单号需要分账时必填
receivers.split_amountString分账金额,例如24.99 应该写成24.99需要分账时必填
receivers.roleString分账接收方角色需要分账时必填
receivers.descriptionString分账明细描述需要分账时选填

接收方角色

receivers.role 参数描述
1子商户
2供应商
3经销商
4代扣代缴税款服务
5技术服务
6网红
7其他

签名示例:

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

"command=createSplitPayment&currency=EUR&method=v3.SplitPayment&nonce_string=1704693939376&notify_url=https://www.yabandpay.com/notify&receivers=[{"mid":104006,"split_amount":0.01,"role":7,"detail_reference_id":"123456-2","description":"分账描述2"}]&reference=1704693939376&reference_id=1704693939376&split_completed=0&split_solution_id=102&time=1704693939&trade_id=23a199b8-b82b-81b0-a4cd-8485ca4feb3c&user=9212776037"

得到的 stringA 使用 secret_key做签名

得到的签名如下:

"YOUR_SIGNATURE"

提交示例:

{
    "user": "9212776037",
    "sign": "YOUR_SIGNATURE",
    "method": "v3.SplitPayment",
    "time": 1704693939,
    "data": {
        "command": "createSplitPayment",
        "trade_id": "23a199b8-b82b-81b0-a4cd-8485ca4feb3c",
        "split_solution_id": "102",
        "currency": "EUR",
        "notify_url": "https://www.yabandpay.com/notify",
        "nonce_string": "1704693939376",
        "split_completed": 0,
        "reference_id": "1704693939376",
        "reference": "1704693939376",
        "receivers": "[{\"mid\":104006,\"split_amount\":0.01,\"role\":7,\"detail_reference_id\":\"123456-2\",\"description\":\"分账描述2\"}]"
    }
}

返回示例:

{
    "status": true,
    "code": "200",
    "data": {
        "user": "9212776037",
        "split_id": "20240108162134979318",
        "trade_id": "23a199b8-b82b-81b0-a4cd-8485ca4feb3c",
        "split_solution_id": "102",
        "state": "Processing",
        "merchant_mid": "102300",
        "merchant_name": "Yaband Telecom B.V.",
        "created_at": "1704702094",
        "currency": "EUR",
        "notify_url": "https://www.yabandpay.com/notify",
        "split_completed": 0,
        "reference_id": "1704693939376",
        "reference": "1704693939376",
        "receivers": [
            {
                "merchant_mid": "104006",
                "merchant_name": "ybtest",
                "split_detail_id": "20240108162134979318-1",
                "detail_reference_id": "123456-2",
                "split_type": "Split",
                "split_amount": "0.01",
                "role": "7",
                "result": "Processing",
                "description": "分账描述2",
                "error_msg": null
            }
        ],
        "type": "splitPayment"
    },
    "message": ""
}
  • 返回参数
参数类型描述
userString收银员账号的UID
split_idString创建分账后的分账单号
trade_idStringYabandPay订单的trade_id
split_solution_idString分账方案id
stateString状态有Processing,Success,Failed,Cancelled
merchant_midString分账商户的mid
merchant_nameString分账商户的商户名
created_atString创建时间戳
currencyString订单结算货币,Settlement Currency
notify_urlString异步通知地址
split_completedString是否完成分账, 0 :否,1 :是
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.roleString分账接收方角色
receivers.resultString状态有Processing、Success、Failed、Cancelled
receivers.descriptionString分账明细描述
receivers.error_msgString分账明细错误信息,result 状态为 Failed 时有值