查询分账
此接口对YabandPay已创建的分账单、分账回退单进行查询
API URL:https://mapi.yabandpay.com/Payments
Method:POST
POST data type:Json
参数 | 类型 | 描述 | 是否必填 |
---|---|---|---|
user | String | 超级管理员账号的UID | 必填 |
sign | String | 签名 | 必填 |
method | String | v3.SplitPayment | 必填 |
time | Long | 时间戳 | 必填 |
- 参数
参数 | 类型 | 描述 | 是否必填 |
---|---|---|---|
command | String | querySplitPayment | 必填 |
nonce_string | String | 随机字符串,不长于32位 | 必填 |
reference_id | String | 商户方的分账id,不长于32位 | 必填 |
split_id | String | 创建分账后的分账单号 | 必填 |
split_type | String | 分账类型, 0 :Split 分账 , 1 : Return 分账回退,只提供这2种类型。如果没有传,则查询 split_id 所有分账单和回退信息 | 选填 |
split_detail_id | String | 创建分账后的分账单号的分账单的明细,可配合 split_type 查询对应分账单的明细的信息 | 选填 |
refund_split_detail_id | String | 只有 split_type 类型为分账回退时才有效,查询对应分账回退单的明细的信息 | 选填 |
签名示例:
拼接为URL方式并排序后的字符串
"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"
得到的 stringA 使用 secret_key做签名
得到的签名如下:
"3d36cdb1f9cdaa2eec717adccaac4e51d109cbd8fec757ca407cba67e4bcb877"
提交示例:
{
"user": "9212776037",
"sign": "3d36cdb1f9cdaa2eec717adccaac4e51d109cbd8fec757ca407cba67e4bcb877",
"method": "v3.SplitPayment",
"time": 1703836221,
"data": {
"command": "querySplitPayment",
"nonce_string": "7vccb9qkplvtxl22km",
"split_id": "20231229110618372777",
"reference_id": "123456"
}
}
返回示例:
{
"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": ""
}
- 返回参数
参数 | 类型 | 描述 |
---|---|---|
user | String | 收银员账号的UID |
split_id | String | 创建分账后的分账单号 |
trade_id | String | YabandPay订单的trade_id |
split_solution_id | String | 分账方案id |
state | String | 状态有Processing,Success,Failed,Cancelled |
merchant_mid | String | 分账商户的mid |
merchant_name | String | 分账商户的商户名 |
created_at | String | 创建时间戳 |
currency | String | 订单结算货币,Settlement Currency |
notify_url | String | 异步通知地址 |
split_completed | String | 是否完成分账, 0 :否,1 :是 |
reference_id | String | 商户方的分账id,不长于32位 |
reference | String | 描述信息,不长于128位 |
receivers | String | 分账接收方信息,json格式 |
receivers.merchant_mid | String | 分账接收方的mid |
receivers.merchant_name | String | 分账接收方的商户名 |
receivers.split_detail_id | String | 创建分账后的分账明细单号 |
receivers.detail_reference_id | String | 商户方的分账明细单号 |
receivers.split_type | String | 分账类型Split或Return |
receivers.split_amount | String | 分账金额 |
receivers.role | String | 分账接收方角色 |
receivers.result | String | 状态有Processing、Success、Failed、Cancelled |
receivers.description | String | 分账明细描述 |
receivers.error_msg | String | 分账明细错误信息,result 状态为 Failed 时有值 |