描述
本部分内容描述了平台与商家之间的支付宝批量付款申请查询接口, 商家可以通过此接口来查询单笔支付宝单据付款订单的详细信息。
查询接口参数定义
商户查询街口支付平台支付宝批量付款订单信息,调用API必须遵循以下参数规则:
参数 | 格式 | 必填 | 说明 |
---|---|---|---|
merchant_code | String(15) | ဆ | 商家号,商户签约时分配给商家的唯一身份标识。 |
interface_version | String(5) | ဆ | 接口版本,固定值:V1.0(大写) |
sign_type | String(3) | ဆ | 签名类型,固定值:MD5或RSA(大写) |
order_no | String(30) | ဆ | 商家网站平台的批量order_no订单号,由商户保证其唯一性,由字母、数字、下划线组成。 |
sign | String | ဆ |
MD5或RSA签名后字符串,不参与签名,查询订单接口签名要求说明请参考下面。 |
查询订单签名规则
商户查询街口支付平台订单,签名原始串必须遵循以下规则:
1、所有指定签名参数值按照(parmValue1+~|~+parmValue2+~|~+parmValue3+…)拼接而成,每个参数值中间采用分隔符 ~|~ 拼接。
2、签名原始串中,字段名和字段值都采用原始值,不进行URL Encode。
3、参数值区分大小写。
4、签名排列顺序必须按照指定格式排列拼接。见下文。
查询订单请求签名原始串
post 请求 查询订单原始签名串格式如下:
请求订单查询原始签名串街口支付
- merchant_code+"~|~"+interface_version+"~|~"+sign_type+"~|~"+order_no
商户算法签名模型设置为MD5时,采用下面签名算法样例。
MD5查询请求签名街口支付
- sign = Md5(查询代付订单请求签名原始串+"~|~"key=商户MD5密钥)
商户算法签名模型设置为RSA时,采用下面签名算法样例。
请求查询RSA签名算法街口支付
- Java:
- sign = RSAWithSign.signByPrivateKey(请求代付订单查询原始签名串,商户生成的私钥)
- PHP:
- $privatekey = openssl_get_privatekey('商户生成的私钥');
- openssl_sign(请求代付订单查询原始签名串,$sign_info,$privatekey,OPENSSL_ALGO_MD5);
- $sign = base64_encode($sign_info);
查询接口响应返回参数描述
数据将以Json字符串形式在同一会话中同步返回。
查询接口响应返回参数定义
查询接口不管成功与否必返回下面列表中前二个参数必须返回。其他参数错误情况返回null.
参数 | 格式 | 必填 | 说明 |
---|---|---|---|
msgcode | String(20) | | 查询是否成功状态码,取值为“00000” 代表查询成功, 其他错误码代表查询失败。 |
msg | String(20) | | 查询状态错误中文描述(乱码情况可查看文档中错误码对照) |
transfer_status | String(8) | ဆ | 订单处理状态,固定值:SUCCESS(付款完成)、PART_SUCCESS(部分完成)、DEALING(处理中)、WAIT_PAY(等待付款)、FAIL(失败) |
batch_desc | String(200) | ဆ | 订单处理参考描述。 |
merchant_code | String(15) | ဆ | 商家号,商户签约时分配给商家的唯一身份标识。 |
interface_version | String(5) | ဆ | 接口版本,固定值:V1.0(大写) |
batch_gateway_name | String(60) | ဆ | 该批次使用的支付宝渠道名称。 |
order_type | String(60) | ဆ | 支付宝批量付款接口类型。 |
order_no | String(30) | ဆ | 商家网站平台的订单号,由商户保证其唯一性,由字母、数字、下划线组成。 |
order_title | String(50) | ဆ | 转账标题,用于收银台展示标题。 |
trans_amount | String(20) | ဆ | 批次实际成功的总金额,单位为元。 |
trans_count | String(16) | ဆ | 批次实际成功的总笔数。 |
order_remark | String(16) | ဆ | 转账备注。 |
order_success_time | String(16) | ဆ | 转账付款成功时间。 |
payee_info[],以下为多个收款方信息JSON集合 | |||
login_id | String(100) | | 支付宝收款方登录的账号。 |
name | String(120) | | 收款方真实姓名。 |
trans_amount | String(20) | | 每个收款方需要转账的金额,单位为元(最小1元)精确到小数点后两位。 |
status | String(20) | |
单笔转账状态值。 INIT/APPLIED/DEALED:待付款 SUCCESS:处理成功 DISUSE:已废除 FAIL:处理失败 UNKNOWN:未知状态 |
trans_out_bizno | String(50) | | 批量付款单条业务付款支付宝订单号。 |
trans_remark | String(200) | ဆ | 转账备注。 |