凭据创建请求
受理侧企业可通过调用此接口发起创建凭据请求。
接口说明
- 测试请求URL:
- 生产请求URL:
- 请求方式:POST
业务流程:
- 受理侧企业调用该接口,向慧收钱平台发起凭据请求。
- 慧收钱平台完成凭据生成-凭据标记后,应答受理结果。注意:仅代表受理结果,最终结果以凭据申请结果通知接口为准。
公共请求参数
变量 | 参数名 | 类型[长度限制] | 必填 | 描述 |
---|---|---|---|---|
method | 方法名 | string[1,32是 | ENTERPRISE_PAY_BILL_CREATE | |
version | 版本 | string[1,16] | 是 | 接口版本:1.0 |
format | 请求格式 | string[1,16] | 是 | 业务请求参数格式,支持:JSON |
merchantNo | 商户号 | string[1,16] | 是 | 商户在慧收钱的商户号,由慧收钱生成并下发 |
signType | 加密类型 | string[1,16] | 是 | RSA2:签名机制查看说明 |
signContent | 业务数据 | string | 是 | 业务请求参数 |
sign | 签名数据 | string[1,256] | 否 | 签名数据 |
业务请求参数
变量 | 参数名 | 类型[长度限制] | 必填 | 描述 |
---|---|---|---|---|
transNo | 商户系统内部服务订单号 | string[1,32] | 是 | 商户系统内部服务订单号,要求32个字符内,且在同一个商户号下唯一 |
requestDate | 交易时间 | string[1,14] | 是 | 请求时间,与当前系统时间相差小于10分钟 格式[yyyyMMddHHmmss] 示例值:20190101140908 |
returnUrl | 后端通知地址 | string[1,128] | 是 | 当交易有结果时,慧收钱主动通知商户的地址 示例值:https://www.merchant.com/xxx |
billQty | 凭据数量 | string[1,3] | 是 | 每次请求凭据数量不能超过 100,不建议一次性创建多个 |
billOwnerList | 持有人列表 | array | 是 | 持有人列表大小须等于凭据数量 详见:【凭据持有人列表】 |
billName | 凭据名称 | string[1,16] | 否 | 商户自定义 |
billValidBegin | 凭据开始日期 | string[1,10] | 是 | YYYYMMDD,默认为当日 00:00:00 |
billValidUntil | 凭据结束日期 | string[1,10] | 是 | YYYYMMDD,默认为当日 23:59:59 |
billAmount | 凭据额度 | string[1,11] | 是 | 单位:分 |
billMaxTimes | 凭据最大可用次数 | string[1,3] | 否 | 该字段若为空则不限制凭据使用次数,最大【999】 |
billSingleLimit | 凭据单笔限额 | string[1,11] | 否 | 该字段若为空则不限制凭据单笔使用额度,单位【分】 |
billScanAuth | 凭据扫码权限 | string[1,20] | 否 | ON:开通线下主扫、被扫权限 OFF:关闭线下主扫、被扫权限 当字段凭据扫码权限和场景编号列表同时为空时,允许扫码和所有场景消费 |
merList | 商户列表 | array | 否 | 限制凭据使用的商户范围本域的所有单元信息总长度不超过200字节,最多 10个元素,对于不足15位的商户号需要在右侧填充空格补足到 15位。 格式:”merList”:[“123456789012345”,”2234567890123 “] |
sceneCodeList | 场景编号列表 | array | 否 | 详见:【场景编号列表】 |
note | 备注 | string[1,255] | 否 | |
usageRangeNo | 应用范围编号 | string[1,2] | 否 | 不定时,该字段不要上送限制凭据在指定应用范围使用时,填写应用范围对应的编号(仅数字),限定凭据的使用商户范围、凭据有效期及凭据额度等信息 |
reqReserved | 请求预留字段 | string[1,512] | 否 | json格式 |
merchantKey | 敏感信息加密秘钥 | string[1,255] | 否 | 商户生成随机aes加密秘钥用于对敏感信息加密。 aes加密秘钥需用平台公钥加密传输,平台接收到该参数后解密该字段,用于对敏感信息解密 |
凭据持有人列表:billOwnerList
字段 | 说明 | 类型 | 条件 | 备注 |
---|---|---|---|---|
billOwnerId | 凭据持有人 ID | string[1,50] | 是 | 商户自定义 |
billOwnerNm | 凭据持有人姓名 | string[1,32] | 是 | 需要加密传输 |
billOwnerMobileNo | 凭据持有人手机号 | string[1,20] | 是 | 需要加密传输 |
billOwnerCertifTp | 凭据持有人证件类型 | string[1,2] | 否 | 当使用线上支付接口付款、H5 场景付款或者绑定在云闪付付款时必填 01:身份证 02:军官证 03:护照 04:港澳居民来往内地通行证(回乡证) 05:台湾同胞来往内地通行证(台胞证) 06:警官证 07:士兵证 08:户口簿 09:临时身份证 10:外国人居留证 12:港澳居民居住证 13:台湾居民居住证 99:其他证件 |
billOwnerCertifId | 凭据持有人证件号码 | string[1,20] | 否 | 需要加密传输 当使用线上支付接口付款、H5 场景付款或者绑定在云闪付付款时必填 对应证件类型的证件号码 |
acctRegInfo | 账户注册信息 | string[1,128] | 否 | 详见:【账户注册信息】 |
deviceEnvInfo | 设备环境信息 | string[1,800] | 否 | 详见:【设备环境信息】 |
场景编号列表:sceneCodeList
字段 | 说明 | 类型 | 条件 | 备注 |
---|---|---|---|---|
sceneCode | 场景编号 | string[1,50] | 是 | SCENE001 |
账户注册信息:acctRegInfo
字段 | 说明 | 类型 | 条件 | 备注 |
---|---|---|---|---|
acctRegDate | 账户注册日期 | string[1,8] | 是 | 格式:YYYYMMDD |
acctRegPhone | 账户注册手机号 | string[1,20] | 是 | |
acctRegMail | 账户注册邮箱地址 | string[1,40] | 否 | |
acctInfUpdTM | 账户关键信息修改时间 | string[1,2] | 是 | 原账户用户重要信息(手机号/密码/邮箱)修改时间 最近一次修改距今 X 个月,X 的数值范围 0~24,表示 0~24 个月,大于 24 个月赋值 24。 |
设备环境信息:deviceEnvInfo
字段 | 说明 | 类型 | 条件 | 备注 |
---|---|---|---|---|
deviceType | 设备类型 | string[1,2] | 是 | 1. 手机 2. 平板 3. 手表 4. PC 其他取值保留使用 |
deviceId | 设备标识 | string[1,64] | 是 | 移动终端设备的唯一标识: PC 采集硬盘序列号; 安卓系统采集 IMEI; IOS 系统采集 IDPV; 注:安卓和 IOS 也可采集 BBID 或银联设备指纹 |
deviceLocation | 设备位置信息 | string[1,32] | 是 | 格式为纬度/经度,+表示北纬、东经,-表示南纬、西经。举例:+37.12/-121.23 取值必须位于中国大陆范围内 |
deviceModel | 设备型号 | string[1,256] | 否 | 在设备类型为手机的情况下,上传手机型号。 |
deviceNumber | 设备 SIM 卡号码 | string[1,32] | 否 | 长度为 11 位,多个号码用逗号隔开 |
deviceSIMNumber | 设备 SIM 卡数量 | string[1,8] | 否 | 智能设备中的 SIM 卡数量 |
sourceIp | IP 地址 | string[1,64] | 是 | 设备所在的公网 IP,可用于定位所属区域,兼容 IPV4 和 IPV6。 |
macAddr | MAC 地址 | string[1,64] | 否 | - |
公共响应参数
变量 | 参数名 | 类型[长度限制] | 必填 | 描述 |
---|---|---|---|---|
success | 响应状态 | string[1,32] | 是 | 服务端响应状态,如果为true,则可以调用result;如果为false,则调用errorCode来获取出错信息 |
errorCode | 错误码 | string[1,32] | 否 | 响应码 |
errorMsg | 错误描述 | string[1,128] | 否 | 响应描述 |
result | 响应内容 | string | 否 | 业务响应参数 |
sign | 签名数据 | string[1,256] | 否 | 响应验签数据 |
业务响应参数
字段 | 说明 | 类型 | 条件 | 备注 |
---|---|---|---|---|
tradeNo | 慧收钱交易号 | string[1,32] | 否 | 慧收钱交易号,订单创成功时返回 |
transNo | 商户订单号 | string[1,32] | 是 | 原样返回商户订单号 |
orderStatus | 交易状态 | string[1,16] | 是 | 详见交易状态码 |
respCode | 错误码 | string[1,32] | 否 | |
respMsg | 错误信息 | string[1,128] | 否 |
交易状态码
枚举值 | 描述 |
---|---|
INIT | 初始化 |
PROCESSING | 处理中 |
SUCCESS | 成功 |
FAIL | 失败 |
作者:xiaochen 创建时间:2025-03-07 09:49
最后编辑:xiaochen 更新时间:2025-05-29 18:12
最后编辑:xiaochen 更新时间:2025-05-29 18:12