钱包类接口¶
w00001 钱包开通¶
请求参数¶
| 参数中文名称 | 参数名称 | 数据格式 | 是否必须 | 说明 |
|---|---|---|---|---|
| 版本号 | version | 定长2位String | 必须 | 目前固定为10 |
| 商户客户号 | mer_cust_id | 定长16位String | 必须 | 商户的唯一标识 |
| 订单日期 | order_date | 定长8位String | 必须 | 格式为YYYYMMDD，例如：20160307 |
| 订单号 | order_id | 变长50位String | 必须 | 由商户生成，必须保证唯一，50位内的字母或数字组合 |
| 页面返回URL | ret_url | 变长128位String | 可选 | 本平台把交易结果通过页面方式返回商户 |
| 商户私有域 | mer_priv | 变长120位String | 可选 | 为商户的自定义字段，该字段在交易完成后由本平台原样返回 |
| 扩展域 | extension | 变长512位String | 可选 | 用于扩展请求参数 |
| 商户后台应答地址 | bg_ret_url | 变长128位String | 可选 | 通过后台异步通知商户开户结果 注意： 1) 使用时不要包含中文 2) 必须是外网地址 |
异步同步返回参数¶
| 参数中文名称 | 参数名称 | 数据格式 | 是否必须 | 说明 |
|---|---|---|---|---|
| 应答返回码 | resp_code | 定长6位String | 必须 | –调用成功，其他见返回码附件表 |
| 应答返回描述 | resp_desc | 变长String | 必须 | 返回码的对应中文描述 |
| 商户客户号 | mer_cust_id | 定长16位String | 必须 | 商户的唯一标识 |
| 用户客户号 | user_cust_id | 定长16位String | 必须 |
|
| 订单日期 | order_date | 定长8位String | 必须 | |
| 订单号 | order_id | 变长50位String | 必须 | 由商户生成，必须保证唯一，50位内的字母或数字组合 |
| 商户私有域 | mer_priv | 变长120位String | 可选 | 为商户的自定义字段，该字段在交易完成后由本平台原样返回 |
| 扩展域 | extension | 变长512位String | 可选 | 用于扩展请求参数 |
w00002 我的钱包¶
请求参数¶
| 参数中文名称 | 参数名称 | 数据格式 | 是否必须 | 说明 |
|---|---|---|---|---|
| 版本号 | version | 定长2位String | 必须 | 目前固定为10 |
| 商户客户号 | mer_cust_id | 定长16位String | 必须 | 商户的唯一标识 |
| 用户客户号 | user_cust_id | 定长16位String | 必须 | |
| 页面返回URL | ret_url | 变长128位String | 可选 | 通过该地址，在钱包首页上可以返回商户指定地址 |
| 商户私有域 | mer_priv | 变长120位String | 可选 | 为商户的自定义字段，该字段在交易完成后由本平台原样返回 |
| 扩展域 | extension | 变长512位String | 可选 | 用于扩展请求参数 |
| 交易发生地 | transaction_addr | 定长64位String | 必填 | 例如：上海 |
| 用途 | purpose | 定长256位String | 必填 | 例如：其他 |
pay018 钱包聚合收银台¶
功能说明¶
商户调用该接口，跳转至汇付的 H5 收银台，收银台支持快捷支付、微信公众号支付、支付宝服务窗支付，并可自动识别微信/支付宝浏览器，适配不同的支付方式
调用方式：页面返回（同步，异步）
调用地址：
请求参数¶
| 参数中文名称 | 参数名称 | 数据格式 | 是否必须 | 说明 |
|---|---|---|---|---|
| 商户客户号 | mer_cust_id | 定长16位String | 必须 | 商户客户号 |
| 版本号 | version | 定长2位String | 必须 | 固定10 |
| 订单日期 | order_date | 定长8位String | 必须 | 格式:20180101 |
| 订单号 | order_id | 变长50位String | 必须 | 订单号 |
| 用户客户号 | user_cust_id | 定长16位String | 可选 | 出账方客户号 |
| 入账客户号 | in_cust_id | 定长16位String | 可选 | 支付时选填，与分账串不能同时填 |
| 入账账户号 | in_acct_id | 变长9位String | 可选 | 支付时选填，与分账串不能同时填 |
| 分账区分 | div_type | 定长1位String | 可选 | 延时分账=1；实时分账=0 延时分账时，in_cust_id、in_acct_id、div_details必须为空 默认实时分账 |
| 分账账户串 | div_details | 变长512位String | 可选 | 支付分账串 |
| 交易金额 | trans_amt | 变长14位String | 必须 | 带2位小数，格式：12.00 |
| 手续费扣款客户号 | fee_cust_id | 定长16位String | 可选 | fee_cust_id、fee_acct_id要么同时为空，要么同时不为空 |
| 手续费扣款账户号 | fee_acct_id | 变长9位String | 可选 | fee_cust_id、fee_acct_id要么同时为空，要么同时不为空 |
| 后台返回地址 | bg_ret_url | 变长128位的String | 可选 | 如果不传，则不会发送异步通知 |
| 商户私有域 | mer_priv | 变长120位的String | 可选 | |
| 扩展域 | extension | 变长512位的String | 可选 | 为商户的自定义字段，该字段在交易完成后由本平台原样返回 |
| 商品标记 | goods_tag | 变长32位String | 可选 | 微信公众号使用 |
| 附加信息 | attach_info | 变长128位String | 可选 | 微信公众号支付的参数 |
| 商品描述 | goods_desc | 变长127位String | 必须 | |
| 商品类型 | goods_type | 定长4位String | 可选 | MCC码 |
| 支付返回地址 | ret_url | 变长128位的String | 可选 | 微信公众号支付时，必须输入 用于微信支付成功后跳转的页面； 支付宝统一下单时，必须输入； |
| 设备信息 | dev_info_json | 变长1000位String | 必须 | json格式如：{“ipAddr”:”10.99.195.11”,”devType”:”2”,”MAC”:”D4-81-D7-F0-42-F8”,”IMEI”:”3553200846666033”}；注：ipAddr和devType必填，MAC和IMEI 二选一必填，见下文 |
| 扫码模式 | scan_mode | 定长1位String | 可选 | 不填：通用 1：线上 2：线下 3：线上停车场 注：通用模式不等于线上线下模式 只有微信正扫、微信app支付、微信公众号支付、小程序支付、微信正扫(直连)、微信app支付(直连)、微信H5支付(直连)才区分通用/线上/线下 |
| 交易发生地 | transaction_addr | 定长64位String | 必填 | 例如：上海 |
| 用途 | purpose | 定长256位String | 必填 | 例如：其他 |
分账串格式： 注：分账串最大支持5个
| 参数中文名称 | 参数名称 | 数据格式 | 是否必须 | 说明 |
|---|---|---|---|---|
| 分账客户号 | divCustId | 定长16位String | 必须 | |
| 分账账户号 | divAcctId | 定长9位String | 必须 | |
| 分账金额 | divAmt | 变长14位String | 必须 | 泛指交易金额，金额格式必须是###.00，比如2.00，2.01 |
设备信息：
| 字段 | 字段描述 | 是否必 |
|---|---|---|
| devType | 设备类型 1.电脑；2.手机 | 必填 |
| ipAddr | IP地址 | 必填 |
| MAC | MAC地址 | 选填 |
| IMEI | IMEI码 | 选填 |
| devSysType | 设备系统类型 1.IOS；2.安卓；3.windows | 选填 |
| UUID | UUID | 选填 |
| IMSI | IMSI码 | 选填 |
| ICCID | ICCID码 | 选填 |
| MEID | MEID码 | 选填 |
| SEID | SEID | 选填 |
| ipType | IP地址类型代理、家庭、办公环境、网吧、学校等，直接给中文名称 | 选填 |
| ipProvName | IP省 | 选填 |
| ipCityName | IP市 | 选填 |
| ipAreaName | IP地区 | 选填 |
| ipProvCode | IP省编码 | 选填 |
| ipCityCode | IP市编码 | 选填 |
| ipAreaCode | IP地区编码 | 选填 |
| cenX | 定位（经度） | 选填 |
| cenY | 定位（纬度） | 选填 |
| provName | 定位地址（省） | 选填 |
| cityName | 定位地址（市） | 选填 |
| areaName | 定位地址（区） | 选填 |
| provCode | 定位（省编码） | 选填 |
| cityCode | 定位（市编码） | 选填 |
| areaCode | 定位（区编码） | 选填 |
| unDevCode | 用户交易设备（唯一识别码） | 选填 |
| serviceProviderIp | 商户服务IP地址 | 选填 |
| merUrl | 商户网址 | 选填 |
返回参数¶
| 参数中文名称 | 参数名称 | 数据格式 | 是否必须 | 说明 |
|---|---|---|---|---|
| 应答返回码 | resp_code | 定长6位String | 必须 | |
| 应答返回描述 | resp_desc | 变长String | 必须 | 返回码的对应中文描述 |
| 商户客户号 | mer_cust_id | 定长16位String | 可选 | 商户客户号 |
| 用户客户号 | user_cust_id | 定长16位String | 可选 | 开户场合，仅限于快捷支付成功后返回 |
| 交易状态 | trans_stat | 定长1位String | 可选 | |
| 入账客户号 | in_cust_id | 定长16位String | 可选 | |
| 入账账户号 | in_acct_id | 变长9位String | 可选 | |
| 分账账户串 | div_details | 变长512位String | 可选 | |
| 订单号 | order_id | 变长50位String | 可选 | |
| 订单日期 | order_date | 定长8位String | 可选 | 格式：yyyyMMdd |
| 银行代号 | bank_id | 定长8位String | 可选 | |
| 交易金额 | trans_amt | 变长14位String | 可选 | 格式12.10 |
| 手续费客户号 | fee_cust_id | 定长16位String | 可选 | |
| 手续费账户号 | fee_acct_id | 变长9位String | 可选 | |
| 手续费金额 | fee_amt | 变长14位String | 可选 | |
| 前台返回地址 | ret_url | 变长128位String | 可选 | |
| 后台返回地址 | bg_ret_url | 变长128位String | 可选 | 如果不传，则不会发送异步通知 |
| 商户私有域 | mer_priv | 变长120位String | 可选 | |
| 扩展域 | extension | 变长512位String | 可选 | 为商户的自定义字段，该字段在交易完成后由本平台原样返回 |
| 本平台交易唯一标识号 | platform_seq_id | 变长30位String | 可选 | |
| 外部订单流水号 | out_trans_id | 变长64位String | 可选 | 外部订单流水号，指支付宝，微信流水号 |
| 外部商家订单号 | party_order_id | 变长64位String | 可选 | 第三方订单号 |
| 支付类型 | pay_type | 变长2位String | 可选 | 12：快捷支付 22：支付宝统一下单 23：微信公众号支付 30：余额支付 |
pay029 支付宝短链预下单¶
请求参数¶
| 参数中文名称 | 参数名称 | 数据格式 | 是否必须 | 说明 |
|---|---|---|---|---|
| 商户客户号 | mer_cust_id | 定长16位String | 必须 | 商户客户号 |
| 版本号 | version | 定长2位String | 必须 | 固定10 |
| 订单日期 | order_date | 定长8位String | 必须 | 格式:20210101 |
| 订单号 | order_id | 变长50位String | 必须 | 订单号 |
| 用户客户号 | user_cust_id | 定长16位String | 可选 | 出账方客户号 |
| 入账客户号 | in_cust_id | 定长16位String | 可选 | 支付时选填，与分账串不能同时填 |
| 入账账户号 | in_acct_id | 变长9位String | 可选 | 支付时选填，与分账串不能同时填 |
| 分账区分 | div_type | 定长1位String | 可选 | 延时分账=1；实时分账=0 延时分账时，in_cust_id、in_acct_id、div_details必须为空 默认实时分账 |
| 分账账户串 | div_details | 变长512位String | 可选 | 支付分账串 |
| 交易金额 | trans_amt | 变长14位String | 必须 | 带2位小数，格式：12.00 |
| 手续费扣款客户号 | fee_cust_id | 定长16位String | 可选 | fee_cust_id、fee_acct_id要么同时为空，要么同时不为空 |
| 手续费扣款账户号 | fee_acct_id | 变长9位String | 可选 | fee_cust_id、fee_acct_id要么同时为空，要么同时不为空 |
| 后台返回地址 | bg_ret_url | 变长128位的String | 可选 | 如果不传，则不会发送异步通知 |
| 商户私有域 | mer_priv | 变长120位的String | 可选 | |
| 扩展域 | extension | 变长512位的String | 可选 | 为商户的自定义字段，该字段在交易完成后由本平台原样返回 |
| 花呗分期数 | hb_installment_num | 定长1位String | 可选 | 支付宝花呗分期分期数，暂时只支持3、6、9、12 |
| 订单超时时间 | order_expire_time | 定长14位String | 可选 | 格式：yyyyMMddHHmmss |
| 商品描述 | goods_desc | 变长127位String | 必须 | |
| 商品类型 | goods_type | 定长4位String | 可选 | MCC码 |
| 支付返回地址 | ret_url | 变长128位的String | 可选 | |
| 设备信息 | dev_info_json | 变长1000位String | 必须 | json格式如：{“ipAddr”:”10.99.195.11”,”devType”:”2”,”MAC”:”D4-81-D7-F0-42-F8”,”IMEI”:”3553200846666033”}；注：ipAddr和devType必填，MAC和IMEI 二选一必填，见下文 |
| 扫码模式 | scan_mode | 定长1位String | 可选 | 不填：通用 1：线上 2：线下 注：通用模式不等于线上线下模式 |
| 交易发生地 | transaction_addr | 定长64位String | 必填 | 例如：上海 |
| 用途 | purpose | 定长256位String | 必填 | 例如：其他 |
| 对手方ip | user_ip_addr | 变长20位String | 必填 |
分账串格式： 注：分账串最大支持5个
| 参数中文名称 | 参数名称 | 数据格式 | 是否必须 | 说明 |
|---|---|---|---|---|
| 分账客户号 | divCustId | 定长16位String | 必须 | |
| 分账账户号 | divAcctId | 定长9位String | 必须 | |
| 分账金额 | divAmt | 变长14位String | 必须 | 泛指交易金额，金额格式必须是###.00，比如2.00，2.01 |
设备信息：
| 字段 | 字段描述 | 是否必 |
|---|---|---|
| devType | 设备类型 1.电脑；2.手机 | 必填 |
| ipAddr | IP地址 | 必填 |
| MAC | MAC地址 | 选填 |
| IMEI | IMEI码 | 选填 |
| devSysType | 设备系统类型 1.IOS；2.安卓；3.windows | 选填 |
| UUID | UUID | 选填 |
| IMSI | IMSI码 | 选填 |
| ICCID | ICCID码 | 选填 |
| MEID | MEID码 | 选填 |
| SEID | SEID | 选填 |
| ipType | IP地址类型代理、家庭、办公环境、网吧、学校等，直接给中文名称 | 选填 |
| ipProvName | IP省 | 选填 |
| ipCityName | IP市 | 选填 |
| ipAreaName | IP地区 | 选填 |
| ipProvCode | IP省编码 | 选填 |
| ipCityCode | IP市编码 | 选填 |
| ipAreaCode | IP地区编码 | 选填 |
| cenX | 定位（经度） | 选填 |
| cenY | 定位（纬度） | 选填 |
| provName | 定位地址（省） | 选填 |
| cityName | 定位地址（市） | 选填 |
| areaName | 定位地址（区） | 选填 |
| provCode | 定位（省编码） | 选填 |
| cityCode | 定位（市编码） | 选填 |
| areaCode | 定位（区编码） | 选填 |
| unDevCode | 用户交易设备（唯一识别码） | 选填 |
| serviceProviderIp | 商户服务IP地址 | 选填 |
| merUrl | 商户网址 | 选填 |
同步返回参数¶
| 参数中文名称 | 参数名称 | 数据格式 | 是否必须 | 说明 |
|---|---|---|---|---|
| 应答返回码 | resp_code | 定长6位String | 必须 | |
| 应答返回描述 | resp_desc | 变长String | 必须 | 返回码的对应中文描述 |
| 商户客户号 | mer_cust_id | 定长16位String | 必须 | 商户客户号 |
| 用户客户号 | user_cust_id | 定长16位String | 可选 | |
| 支付宝短链 | alipay_short_chain | 变长String | 可选 | |
| 订单超时时间 | order_expire_time | 定长14位String | 可选 | 格式：yyyyMMddHHmmss |
| 订单日期 | order_date | 定长8位String | 必须 | 格式:yyyyMMdd |
| 订单号 | order_id | 变长50位String | 必须 | 订单号 |
| 商户私有域 | mer_priv | 变长120位的String | 可选 | |
| 扩展域 | extension | 变长512位的String | 可选 | 为商户的自定义字段，该字段在交易完成后由本平台原样返回 |
支付异步返回参数¶
| 参数中文名称 | 参数名称 | 数据格式 | 是否必须 | 说明 |
|---|---|---|---|---|
| 应答返回码 | resp_code | 定长6位String | 必须 | |
| 应答返回描述 | resp_desc | 变长String | 必须 | 返回码的对应中文描述 |
| 商户客户号 | mer_cust_id | 定长16位String | 可选 | 商户客户号 |
| 用户客户号 | user_cust_id | 定长16位String | 可选 | |
| 入账客户号 | in_cust_id | 定长16位String | 可选 | |
| 入账账户号 | in_acct_id | 变长9位String | 可选 | |
| 分账账户串 | div_details | 变长512位String | 可选 | |
| 订单号 | order_id | 变长50位String | 可选 | |
| 订单日期 | order_date | 定长8位String | 可选 | 格式：yyyyMMdd |
| 交易金额 | trans_amt | 变长14位String | 可选 | 格式12.10 |
| 手续费客户号 | fee_cust_id | 定长16位String | 可选 | |
| 手续费账户号 | fee_acct_id | 变长9位String | 可选 | |
| 手续费金额 | fee_amt | 变长14位String | 可选 | |
| 前台返回地址 | ret_url | 变长128位String | 可选 | |
| 后台返回地址 | bg_ret_url | 变长128位String | 可选 | 如果不传，则不会发送异步通知 |
| 商户私有域 | mer_priv | 变长120位String | 可选 | |
| 扩展域 | extension | 变长512位String | 可选 | 为商户的自定义字段，该字段在交易完成后由本平台原样返回 |
| 本平台交易唯一标识号 | platform_seq_id | 变长30位String | 可选 | |
| 外部订单流水号 | out_trans_id | 变长64位String | 可选 | 外部订单流水号，指支付宝，微信流水号 |
| 外部商家订单号 | party_order_id | 变长64位String | 可选 | 第三方订单号 |
| 支付类型 | pay_type | 变长2位String | 可选 | 22：支付宝统一下单 |