查询类接口¶
qry001 余额查询接口¶
请求参数¶
参数中文名称 | 参数名称 | 数据格式 | 是否必须 | 说明 |
---|---|---|---|---|
版本号 | version | 定长2位String | 必须 | 目前固定为10 |
商户客户号 | mer_cust_id | 定长16位String | 必须 | 由汇付生成,商户的唯一性标识 |
用户客户号 | user_cust_id | 定长16位String | 必须 | 查询商户本身时,同商户客户号 |
账户号 | acct_id | 变长9位String | 可选 | 仅当is_query_guarantee为1时可以不填 |
是否查询担保户 | is_query_guarantee | 变长9位String | 可选 | 1:查询担保户 |
返回参数¶
参数中文名称 | 参数名称 | 数据格式 | 是否必须 | 说明 |
---|---|---|---|---|
应答返回码 | resp_code | 定长6位String | 必须 | |
应答返回描述 | resp_desc | 变长String | 必须 | 返回码的对应中文描述 |
商户客户号 | mer_cust_id | 定长16位String | 必须 | 由汇付生成,商户的唯一性标识 |
用户客户号 | user_cust_id | 定长16位String | 必须 | 查询商户本身时,同商户客户号 |
账户号 | acct_id | 变长9位String | 必须 | |
可用余额 | balance | 变长14位String | 可选 | |
账户余额 | acct_balance | 变长String | 可选 | |
冻结余额 | freeze_balance | 变长String | 可选 | |
账户状态 | acct_stat | 定长1位String | 可选 | N:正常 C:关闭 F:冻结 D:销户 |
账户等级 | acct_level | 定长2位String | 可选 | 01:一类帐户;02:二类帐户;03:三类帐户。 |
账户已用限额 | acct_used_limit | 变长String | 可选 | |
在途资金 | fund_in_transit | 变长String | 可选 |
qry002 卡bin查询¶
请求参数¶
参数中文名称 | 参数名称 | 数据格式 | 是否必须 | 说明 |
---|---|---|---|---|
版本号 | version | 定长2位String | 必须 | 目前固定为10 |
商户客户号 | mer_cust_id | 定长16位String | 必须 | 由汇付生成,商户的唯一性标识 |
银行卡号 | card_no | 变长32位String | 必须 | 8位以下报错 9-32 |
返回参数¶
参数中文名称 | 参数名称 | 数据格式 | 是否必须 | 说明 |
---|---|---|---|---|
应答返回码 | resp_code | 定长6位String | 必须 | |
应答返回描述 | resp_desc | 变长String | 必须 | 返回码的对应中文描述 |
商户客户号 | mer_cust_id | 定长16位String | 必须 | 由汇付生成,商户的唯一性标识 |
用户客户号 | user_cust_id | 定长16位String | 必须 | 查询商户本身时,同商户客户号 |
银行卡号 | card_no | 变长30位String | 必须 | 银行卡号 |
卡bin | card_bin | 变长10位String | 必须 | 2-10位数字 |
银行名称 | bank_name | 变长30位String | 必须 | 发卡银行名称 |
卡类型 | card_type | 定长1位String | 必须 | C: 贷记卡 D:借记卡 S: 准贷记卡 P: 预付费卡 |
银行编号 | bank_no | 定长8位String | 必须 | 8位数字 |
qry003 用户信息查询¶
请求参数¶
参数中文名称 | 参数名称 | 数据格式 | 是否必须 | 说明 |
---|---|---|---|---|
版本号 | version | 定长2位String | 必须 | 目前固定为10 |
商户客户号 | mer_cust_id | 定长16位String | 必须 | 由汇付生成,商户的唯一性标识 |
上级客户号 | upper_huifu_id | 定长16位String | 可选 | 输入了营业执照注册号或统一社会信用代码时有 |
用户客户号 | user_cust_id | 定长16位String | 可选 | 以下四个,有且只有一个必填 |
营业执照注册号 | business_code | 变长30位的String | 可选 | 营业执照注册号 |
统一社会信用代码 | social_credit_code | 变长18位的String | 可选 | 企业的统一社会信用代码 |
证件号 | cert_id | 变长18位的String | 可选 | 个人用户 |
返回参数¶
参数中文名称 | 参数名称 | 数据格式 | 是否必须 | 说明 |
---|---|---|---|---|
应答返回码 | resp_code | 定长6位String | 必须 | C00000–调用成功,其他见返回码附件表 |
应答返回描述 | resp_desc | 变长String | 必须 | 返回码的对应中文描述 |
商户客户号 | mer_cust_id | 定长16位String | 必须 | 由汇付生成,商户的唯一性标识 |
用户客户号 | user_cust_id | 定长16位String | 必须 | |
用户名称 | user_name | 变长50位String | 必须 | 商户传商户名称, 个人个体用户传个人个体用户名称, 企业传企业名称 |
用户角色 | role_type | 定长1位String | 必须 | U:个人用户 C:企业用户 M:商户 S:个体户 |
联系电话掩码 | contact_mobile | 定长11位String | 必须 | |
营业执照号 | business_code | 变长30位String | 可选 | 商户传商户营业执照号, 个人个体用户不传, 企业传企业营业执照号 |
组织机构代码 | institution_code | 变长30位String | 可选 | 商户传商户组织机构代码, 个人个体用户不传, 企业传企业组织机构代码 |
统一社会信用代码 | social_credit_code | 变长30位 String | 可选 | 商户传商户统一社会信用代码, 个人个体用户不传, 企业传企业统一社会信用代码 |
证件类型 | cert_type | 定长2位 String | 必须 | 10:身份证 11:护照 12:军官证 13:士兵证 14:回乡证 15:户口本 16:警官证 17:台胞证 18:组织机构代码 19:营业执照 20:税务登记证 21:统一社会信用代码证 22:其他 |
证件号 | cert_id | 变长18位 String | 必须 | 商户传商户法人证件号, 个人个体用户传个人个体证件号, 企业传企业法人证件号 注:身份证返掩码 |
税务登记证号 | tax_code | 变长30位 String | 可选 | 商户传商户税务登记号, 个人个体用户不传, 企业传企业税务登记号 |
用户子账户 | acct_id_list | String(Json) | 可选 | 内容详看下方列表 |
用户状态标志 | stat_flag | 定长1位String | 可选 | 0关闭;1正常 |
地址 | cust_address | 变长String | 可选 | |
职业 | occupation | 变长String | 可选 | |
密码状态 | pwd_stat | 定长1位String | 必须 | 0:关 1:开 |
子账户列表(acct_id_list)
参数中文名称 | 参数名称 | 数据格式 | 是否必须 | 说明 |
---|---|---|---|---|
账户号 | acctId | 必须 | ||
账户名 | acctName | 必须 | ||
账户业务类型 | acctBusinessType | 11:手续费专户 12:冻结过渡账户 13:专用资金账户 14:担保账户 15:支付账户 16:非支付账户 18:线下收款账户 | 必须 | |
账户状态 | statFlag | 0:关闭 1:开启 | 必须 |
qry004 用户绑卡信息查询¶
请求参数¶
参数中文名称 | 参数名称 | 数据格式 | 是否必须 | 说明 |
---|---|---|---|---|
版本号 | version | 定长2位String | 必须 | 目前固定为10 |
商户客户号 | mer_cust_id | 定长16位String | 必须 | 由汇付生成,商户的唯一性标识 |
用户客户号 | user_cust_id | 定长16位的String | 必须 | 由汇付生成,用户的唯一性标识 |
绑卡Id | bind_card_id | 变长20位String | 可选 |
返回参数¶
参数中文名称 | 参数名称 | 数据格式 | 是否必须 | 说明 |
---|---|---|---|---|
应答返回码 | resp_code | 定长6位String | 必须 | C00000–调用成功,其他见返回码附件表 |
应答返回描述 | resp_desc | 变长String | 必须 | 返回码的对应中文描述 |
商户客户号 | mer_cust_id | 定长16位String | 必须 | 由汇付生成,商户的唯一性标识 |
用户客户号 | user_cust_id | 定长16位的String | 必须 | 由汇付生成,用户的唯一性标识 |
卡列表 | card_list | String(Json) | 必须 | 绑定的银行卡列表 |
卡列表(card_list)
参数中文名称 | 参数名称 | 数据格式 | 是否必须 | 说明 |
---|---|---|---|---|
银行编号 | bankNo | 变长8位String | 可选 | |
银行名称 | bankName | 变长50位String | 可选 | |
银行英文简称 | bankShortChn | 变长50位String | 可选 | |
银行英文简称 | bankShortEng | 变长10位String | 可选 | |
绑卡 ID | bindCardId | 变长20位String | 可选 | 汇付快捷绑卡的 ID |
卡类型 | cardType | 定长1位int | 可选 | 0:对公 1:对私 |
手机号掩码 | cardMobile | 定长11位String | 可选 | 银行卡预留手机号 |
用户卡号掩码 | cardNo | 定长32位String | 可选 | |
快捷卡标志 | qpFlag | 定长1位int | 可选 | 0:关闭 1:开启 |
取现卡标志 | cashFlag | 定长1位int | 可选 | 0:关闭 1:开启 |
代扣卡标志 | awFlag | 定长1位int | 可选 | 0:关闭 1:开启 |
借贷标识 | dcFlag | 定长1位String | 可选 | D:借记 C:贷记 S:准贷记 |
qry005 用户账务流水查询¶
请求参数¶
参数中文名称 | 参数名称 | 数据格式 | 是否必须 | 说明 |
---|---|---|---|---|
版本号 | version | 定长2位String | 必须 | 目前固定为10 |
商户客户号 | mer_cust_id | 定长16位String | 必须 | 由汇付生成,商户的唯一性标识 |
用户客户号 | user_cust_id | 定长16位String | 必须 | 查询商户本身时,同商户客户号 |
账户号 | acct_id | 变长9位String | 必须 | |
产品ID | product_Id | 变长64位String | 可选 | |
产品流水号 | product_req_seq_id | 变长64位String | 可选 | |
交易起始时间 | trans_start_date | 定长8位String | 必须 | 起始时间不超过1个月 |
交易结束时间 | trans_end_date | 定长8位String | 必须 | |
单页记录数 | page_size | 数值 | 必须 | 最大100条 |
页号 | page_num | 数值 | 必须 |
返回参数¶
参数中文名称 | 参数名称 | 数据格式 | 是否必须 | 说明 |
---|---|---|---|---|
应答返回码 | resp_code | 定长6位String | 必须 | |
应答返回描述 | resp_desc | 变长String | 必须 | 返回码的对应中文描述 |
商户客户号 | mer_cust_id | 定长16位String | 必须 | 由汇付生成,商户的唯一性标识 |
用户客户号 | user_cust_id | 定长16位String | 必须 | 查询商户本身时,同商户客户号 |
账户号 | acct_id | 变长9位String | 必须 | |
总条数 | total_count | int | 必须 | |
账务流水 | acct_logs | list | 必须 |
账务流水(acct_logs)
参数中文名称 | 参数名称 | 数据格式 | 是否必须 | 说明 |
---|---|---|---|---|
账务流水号 | acctSeqId | String 12位 | ||
账务时间 | acctDate | String 8位 | ||
账务类型 | transType | String 4位 | ||
借贷标志 | dcFlag | String 1位 | C:贷记(入款) D:借记(出款) | |
金额 | transAmt | String 16位 | ||
手续费金额 | feeAmt | String 16位 | ||
交易后余额 | balanceAmt | String 16位 | ||
产品流水号 | productReqSeqId | String 64位 | ||
目标或源客户号,对应acct的custId2 | targetOrSourceCustId | String 16位 | 1.出账交易的入账客户号 2.入账交易的出账客户号 | |
业务系统的交易类型描述 | bizTransTypeDesc | String 16位 | 返回交易类型的中文描述 | |
交易订单号 | orderId | String 64位 | 商户请求的订单号 | |
支付时间 | payTime | String 64位 |
qry007 支持银行列表查询¶
请求参数¶
参数中文名称 | 参数名称 | 数据格式 | 是否必须 | 说明 |
---|---|---|---|---|
版本号 | version | 定长2位的String | 必须 | 固定为10,如版本升级,能向前兼容 |
商户客户号 | mer_cust_id | 定长16位的String | 必须 | 由汇付生成,商户的唯一性标识 |
卡类型 | card_type | 变长1位的String | 必须 | D:借记 C:贷记 S:准贷记 |
交易类型 | trans_type | 变长1位的String | 必须 | 1:快捷 2:代扣 |
返回参数¶
参数中文名称 | 参数名称 | 数据格式 | 是否必须 | 说明 |
---|---|---|---|---|
应答返回码 | resp_code | 定长6位String | 必须 | C00000–调用成功,其他见返回码附件表 |
应答返回描述 | resp_desc | 变长String | 必须 | 返回码的对应中文描述 |
商户客户号 | mer_cust_id | 定长16位String | 必须 | 由汇付生成,商户的唯一性标识 |
卡类型 | card_type | 变长1位的String | 必须 | D:借记 C:贷记 S:准贷记 |
交易类型 | trans_type | 变长1位的String | 必须 | 1:快捷 2:代扣 |
银行限额列表 | bank_limit_list | json字符串 | 必须 | 见下表 |
银行限额列表(bank_limit_list)
参数中文名称 | 参数名称 | 数据格式 | 是否必须 | 说明 |
---|---|---|---|---|
银行编号 | bankNo | 定长8位String | 必须 | |
银行名称 | bankName | 变长50位String | 必须 | |
银行中文简称 | bankShortChn | 变长50位String | 必须 | |
银行英文简称 | bankShortEng | 变长50位String | 必须 | |
日交易限额 | dayLimit | 变长14位String | 必须 | |
单笔交易金额下限 | onceLimitLow | 变长14位String | 必须 | |
单笔交易金额上限 | onceLimitHigh | 变长14位String | 必须 |
qry008 交易状态查询接口¶
请求参数¶
参数中文名称 | 参数名称 | 数据格式 | 是否必须 | 说明 |
---|---|---|---|---|
版本号 | version | 定长2位String | 必须 | 目前固定为10 |
商户客户号 | mer_cust_id | 定长16位String | 必须 | 由汇付生成,商户的唯一性标识 出账方商户客户号 |
原交易订单号 | order_id | 变长50位String | 可选 | 查询微信订单时,order_id与party_order_id二传一,查询其他订单时,order_id必填 |
原交易订单日期 | order_date | 定长8位String | 可选 | 传入order_id时,必须传入order_date |
交易类型 | trans_type | 变长2位String | 必须 | 1:网银支付 3:快捷支付 4:代扣支付 5:微信正扫 6:支付宝正扫 7:银联正扫 8:微信app支付 9:支付宝app支付 10:支付宝统一下单 11:微信公众号支付 12:微信小程序 13:余额支付 14:延时分账确认 15:取现 16:转账 17:退款 18:退货 19:代发查询 20:直接代扣 21:微信正扫(直连) 22:微信app支付(直连) 23:银联app支付 24:apple支付 27:微信H5支付(直连) 28:支付宝app支付(直连) 29:众邦虚拟账户余额支付 30:众邦虚拟账户取现 31:聚合扫码支付 32:钱包聚合收银台 33:凯德美团线下打款预下单 34:垫资(线下打款) 35:还款(线下打款) 37:聚分期 |
微信订单号 | party_order_id | 变长64位String | 可选 | 查询微信订单时,order_id与party_order_id二传一,查询其他订单时,party_order_id字段不生效 |
商户私有域 | mer_priv | 变长120位String | 可选 | |
扩展域 | extension | 变长512位String | 可选 |
返回参数¶
参数中文名称 | 参数名称 | 数据格式 | 是否必须 | 说明 |
---|---|---|---|---|
应答返回码 | resp_code | 定长6位String | 必须 | |
应答返回描述 | resp_desc | 变长String | 必须 | 返回码的对应中文描述 |
商户客户号 | mer_cust_id | 定长16位String | 必须 | 由汇付生成,商户的唯一性标识 |
用户客户号 | user_cust_id | 定长16位String | 可选 | 由汇付生成,用户唯一性标识 |
订单号 | order_id | 变长50位String | 必须 | |
订单日期 | order_date | 定长8位String | 必须 | |
交易类型 | trans_type | 定长2位String | 必须 | |
交易状态 | trans_stat | 定长1位String | 必须 | I:初始 P:处理中 S:成功 F:失败 |
交易返回码 | trans_resp_code | 定长6位String | 可选 | 数据库中的返回码,没有就不返 |
交易返回描述 | trans_resp_desc | 变长String | 可选 | 数据库中的返回描述 |
手续费金额 | fee_amt | 变长14位String | 可选 | |
手续费账户号 | fee_acct_id | 变长9位String | 可选 | |
手续费客户号 | fee_cust_id | 定长16位String | 可选 | |
银行返回描述 | bg_bank_message | 变长200位String | 可选 | |
交易金额 | trans_amt | 变长14位的String | 可选 | 泛指交易金额,金额格式必须是###.00,比如2.00,2.01 |
原交易流水号 | platform_seq_id | 定长18位String | 必须 | 原交易返回的“本平台交易唯一标识号” |
外部订单流水号 | out_trans_id | 变长64位String | 可选 | 指支付宝、微信、银联流水号 out_trans_id |
分账账户串 | div_detail | 变长String | 可选 | 库表中的分账串 |
付款方银行编号 | payer_bank_no | 变长String | 可选 | |
付款方银行账户 | payer_card_num | 变长32位String | 可选 | |
付款方银行账户名 | payer_acct_nm | 变长String | 可选 | |
商户私有域 | mer_priv | 变长120位String | 可选 | |
扩展域 | extension | 变长512位String | 可选 | |
微信订单号 | party_order_id | 变长64位String | 可选 |
分账账户串(div_detail)
参数中文名称 | 参数名称 | 数据格式 | 是否必须 | 说明 |
---|---|---|---|---|
分账客户号 | divCustId | 定长16位String | 必须 | |
分账账户号 | divAcctId | 变长9位String | 必须 | 返回码的对应中文描述 |
分账金额 | divAmt | 定长2位String | 必须 | 由汇付生成,商户的唯一性标识 |
qry009 开户状态查询¶
请求参数¶
参数中文名称 | 参数名称 | 数据格式 | 是否必须 | 说明 |
---|---|---|---|---|
版本号 | version | 定长2位String | 必须 | 目前固定为10 |
商户客户号 | mer_cust_id | 定长16位String | 必须 | 由汇付生成,商户的唯一性标识 出账方商户客户号 |
原交易订单号 | order_id | 变长50位String | 必填 | |
原交易订单日期 | order_date | 定长8位String | 必须 | |
交易类型 | trans_type | 定长2位String | 必须 | 1:企业开户申请 2:个体户开户申请 3:消费分期代扣签约 4:非消费分期代扣签约 5:快捷绑卡 6:取现绑卡 7:个人开户 |
商户私有域 | mer_priv | 变长120位String | 可选 | |
扩展域 | extension | 变长512位String | 可选 |
返回参数¶
参数中文名称 | 参数名称 | 数据格式 | 是否必须 | 说明 |
---|---|---|---|---|
应答返回码 | resp_code | 定长6位String | 必须 | |
应答返回描述 | resp_desc | 变长String | 必须 | 返回码的对应中文描述 |
商户客户号 | mer_cust_id | 定长16位String | 必须 | 由汇付生成,商户的唯一性标识 |
用户客户号 | user_cust_id | 定长16位String | 可选 | 开户成功必返 |
订单号 | order_id | 变长50位String | 必须 | |
订单日期 | order_date | 定长8位String | 必须 | |
交易类型 | trans_type | 定长2位String | 必须 | |
交易状态 | trans_stat | 定长1位String | 必须 | I:初始 P:处理中 S:成功 F:失败 |
交易返回码 | trans_resp_code | 定长6位String | 可选 | 数据库中的返回码,没有就不返 |
交易返回描述 | trans_resp_desc | 变长String | 可选 | 数据库中的返回描述 |
手续费金额 | fee_amt | 变长14位String | 可选 | |
手续费账户号 | fee_acct_id | 变长9位String | 可选 | |
手续费客户号 | fee_cust_id | 定长9位String | 可选 | |
原交易流水号 | platform_seq_id | 定长18位String | 必须 | 原交易返回的“本平台交易唯一标识号” |
账户信息 | acct_id | 变长9位String | 可选 | 默认账户号 |
线下开通账户号 | offline_acct_id | 变长9位String | 可选 | 开通线下时的线下收款账户 |
绑卡id | bind_card_id | 变长20位String | 可选 | 绑卡成功必返 |
商户私有域 | mer_priv | 变长120位String | 可选 | |
扩展域 | extension | 变长512位String | 可选 | |
扩展域 | bank_virtual_acct_num | 变长512位String | 可选 |
file02 文件下载接口¶
请求参数¶
参数中文名称 | 参数名称 | 数据格式 | 是否必须 | 说明 |
---|---|---|---|---|
版本号 | version | 定长2位String | 必须 | 目前固定为 10 |
商户客户号 | mer_cust_id | 定长16位String | 必须 | 由汇付生成,商户的唯一性标识 |
对账文件日期 | file_date | 定长2位String | 必须 | 格式为YYYYMMDD,例如:20160307 |
文件大类 | file_type | 变长2位的String | 必须 | 1:对账单文件 2:收益文件; |
返回参数¶
参数中文名称 | 参数名称 | 数据格式 | 是否必须 | 说明 |
---|---|---|---|---|
应答返回码 | resp_code | 定长6位String | 必须 | C00000–调用成功 |
应答返回描述 | resp_desc | 变长String | 必须 | 返回码的对应中文描述 |
商户客户号 | mer_cust_id | 定长16位String | 必须 | 由汇付生成,商户的唯一性标识 |
文件信息列表 | file_infos | Json字符串 | 必须 | 返回文件信息列表json字符串 |
文件列表(file_infos) 对账文件模板
参数中文名称 | 参数名称 | 数据格式 | 是否必须 | 说明 |
---|---|---|---|---|
文件类型 | fileType | 变长String | 可选 | 1:充值对账(含:网银充值,快捷充值) 2:取现对账 3:支付对账(含:网银支付,快捷支付,协议代扣,直接代扣,APP支付) 4:转账对账 5:订单确认对账 6:退款退货对账 7:代发对账 8:定向支付对账 9:企账通支付对账 10:企账通分账明细对账 22:银行虚拟户取现对账 |
文件地址 | fileUrl | 变长String | 可选 | 文件查看下载地址 |
文件序号 | fileSeq | 变长String | 可选 | 同类型的序号从 1 开始 |
文件后缀 | fileSuff | 变长String | 可选 | 文件的后缀名 |
文件名称 | fileName | 变长String | 可选 | 文件的名称 |
qry011 免密授权查询接口¶
请求参数¶
参数中文名称 | 参数名称 | 数据格式 | 是否必须 | 说明 |
---|---|---|---|---|
版本号 | version | 定长2位String | 必须 | 目前固定为10 |
商户客户号 | mer_cust_id | 定长16位String | 必须 | 商户的唯一标识 |
用户客户号 | user_cust_id | 定长16位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 | 必须 | 用户的唯一标识; |
授权方式 | auth_type | 定长1位String | 可选 | 部分授权:1,全部授权:2 |
开通提现免密 | cash_free_pwd_flag | 定长1位String | 可选 | 开启:1,关闭:0 |
开通余额支付免密 | pay_free_pwd_flag | 定长1位String | 可选 | 开启:1,关闭:0 |
单笔免密最高金额 | single_free_pwd_amt | 变长14位String | 可选 | |
单日免密最高金额 | day_free_pwd_amt | 变长14位String | 可选 | |
单月免密最高金额 | month_free_pwd_amt | 变长14位String | 可选 | |
免密协议有效期 | agree_vali_date | 定长8位String | 可选 | 例如:20190101 |
商户私有域 | mer_priv | 变长120位String | 可选 | 为商户的自定义字段,该字段在交易完成后由本平台原样返回 |
扩展域 | extension | 变长512位String | 可选 | 用于扩展请求参数 |
file05 电子凭证下载接口¶
功能说明¶
提供给商户下载电子凭证。支持生成支付类(含充值),代发,转账,取现,退款退货回执单。原交易订单为担保订单或延时订单时,交易阶段必填,退款退货订单时可选。
注意:获取到文件下载地址请尽快操作下载,地址有效时长为 600 秒。
调用方式:后台返回(异步)
调用地址:
请求参数¶
参数中文名称 | 参数名称 | 数据格式 | 是否必须 | 说明 |
---|---|---|---|---|
版本号 | version | 定长2位String | 必须 | 目前固定为10 |
商户客户号 | mer_cust_id | 定长16位String | 必须 | 由汇付生成,商户的唯一性标识 出账方商户客户号 |
交易订单号 | order_id | 变长50位String | 必须 | |
交易订单日期 | order_date | 定长8位String | 必须 | 保证订单号和订单日期唯一,格式为YYYYMMDD |
原交易订单号 | org_order_id | 变长String | 可选 | 多个订单用都逗号分隔,如0001,0002,0003,表示生产原交易订单日期下的这几个回执单 |
原交易订单日期 | org_order_date | 定长8位String | 必须 | 原交易订单日期,格式为YYYYMMDD,如果不传原交易订单号,则生产这天所有的回执单 |
交易阶段 | guarantee_stage | 定长1位String | 可选 | 交易订单号为担保订单或延时订单时必填,A:担保入账;B:担保出账;C:担保完成 |
异步通知地址 | bg_ret_url | 变长128位String | 必须 | 通过后台异步通知商户结果,注意: 1) 使用时不要包含中文; 2) 必须是外网地址。 |
商户私有域 | mer_priv | 变长120位String | 可选 | 用于扩展请求参数 |
扩展域 | extension | 变长512位String | 可选 | 为商户的自定义字段,该字段在交易完成后由本平台原样返回 |
同步返回参数¶
参数中文名称 | 参数名称 | 数据格式 | 是否必须 | 说明 |
---|---|---|---|---|
应答返回码 | resp_code | 定长6位String | 必须 | C00002–已受理,其他见返回码附件表 |
应答返回描述 | resp_desc | 变长String | 必须 | 返回码的对应中文描述 |
商户客户号 | mer_cust_id | 定长16位String | 必须 | 由汇付生成,商户的唯一性标识 |
交易订单号 | order_id | 变长50位String | 必须 | |
交易订单日期 | order_date | 定长8位String | 必须 | 保证订单号和订单日期唯一,格式为YYYYMMDD |
原交易订单号 | org_order_id | 变长String | 可选 | 多个用都逗号分隔,如0001,0002,0003 |
原交易订单日期 | org_order_date | 定长8位String | 必须 | 原交易订单日期,格式为YYYYMMDD |
交易阶段 | guarantee_stage | 定长1位String | 可选 | 交易订单号为担保订单或延时订单时必填,A:担保入账;B:担保出账;C:担保完成 |
无效订单号 | error_order_id | 变长 String | 可选 | 多个用都逗号分隔,如0001,0002,0003 |
异步通知地址 | bg_ret_url | 变长128位String | 必须 | 通过后台异步通知商户结果,注意: 1) 使用时不要包含中文; 2) 必须是外网地址。 |
商户私有域 | mer_priv | 变长120位String | 可选 | 用于扩展请求参数 |
扩展域 | extension | 变长512位String | 可选 | 为商户的自定义字段,该字段在交易完成后由本平台原样返回 |
异步返回参数¶
参数中文名称 | 参数名称 | 数据格式 | 是否必须 | 说明 |
---|---|---|---|---|
应答返回码 | resp_code | 定长6位String | 必须 | C00000–调用成功,其他见返回码附件表 |
应答返回描述 | resp_desc | 变长String | 必须 | 返回码的对应中文描述 |
商户客户号 | mer_cust_id | 定长16位String | 必须 | 由汇付生成,商户的唯一性标识 |
交易订单号 | order_id | 变长50位String | 必须 | |
交易订单日期 | order_date | 定长8位String | 必须 | 保证订单号和订单日期唯一,格式为YYYYMMDD |
原交易订单号 | org_order_id | 变长String | 可选 | 多个用都逗号分隔,如0001,0002,0003 |
原交易订单日期 | org_order_date | 定长8位String | 必须 | 原交易订单日期,格式为YYYYMMDD |
交易阶段 | guarantee_stage | 定长1位String | 可选 | 交易订单号为担保订单或延时订单时必填,A:担保入账;B:担保出账;C:担保完成 |
无效订单号 | error_order_id | 变长 String | 可选 | 多个用都逗号分隔,如0001,0002,0003 |
文件下载url | download_url | 变长 String | 可选 | 回执单文件下载地址 |
异步通知地址 | bg_ret_url | 变长128位String | 必须 | 通过后台异步通知商户结果,注意: 1) 使用时不要包含中文; 2) 必须是外网地址。 |
商户私有域 | mer_priv | 变长120位String | 可选 | 用于扩展请求参数 |
扩展域 | extension | 变长512位String | 可选 | 为商户的自定义字段,该字段在交易完成后由本平台原样返回 |
qry013 商户入驻状态查询¶
请求参数¶
参数中文名称 | 参数名称 | 数据格式 | 是否必须 | 说明 |
---|---|---|---|---|
版本号 | version | 定长2位String | 必须 | 目前固定为10 |
商户客户号 | mer_cust_id | 定长16位String | 必须 | 商户的唯一标识 |
入驻订单号 | order_id | 变长50位String | 必须 | |
入驻订单日期 | order_date | 定长8位String | 必须 | |
支付通道 | pay_way | 定长1位String | 必须 | 1:支付宝 2:微信 |
返回参数¶
参数中文名称 | 参数名称 | 数据格式 | 是否必须 | 说明 |
---|---|---|---|---|
应答返回码 | resp_code | 定长6位String | 必须 | 代表调用成功,实际入驻状态参照stat字段 |
应答返回描述 | resp_desc | 变长String | 必须 | 返回码的对应中文描述,不代表入驻状态 |
商户客户号 | mer_cust_id | 定长16位的String | 必须 | 商户的唯一标识 |
入驻订单号 | order_id | 变长50位String | 必须 | |
入驻订单日期 | order_date | 定长8位String | 必须 | |
支付通道 | pay_way | 定长1位String | 必须 | 1:支付宝 2:微信 |
入驻状态 | stat | 定长1位String | 可选 | I:初始 P:处理中 S:成功 F:失败 |
状态描述 | message | 变长String | 可选 | 失败时,返回后台错误信息 |
qry014 众邦虚拟账户余额查询接口¶
请求参数¶
参数中文名称 | 参数名称 | 数据格式 | 是否必须 | 说明 |
---|---|---|---|---|
版本号 | version | 定长2位String | 必须 | 目前固定为10 |
商户客户号 | mer_cust_id | 定长16位String | 必须 | 由汇付生成,商户的唯一性标识 |
众邦虚拟账户号 | card_num | 变长32位String | 必须 |
返回参数¶
参数中文名称 | 参数名称 | 数据格式 | 是否必须 | 说明 |
---|---|---|---|---|
应答返回码 | resp_code | 定长6位String | 必须 | |
应答返回描述 | resp_desc | 变长String | 必须 | 返回码的对应中文描述 |
商户客户号 | mer_cust_id | 定长16位String | 必须 | 由汇付生成,商户的唯一性标识 |
可用余额 | balance | 变长String | 可选 | |
账户余额 | acct_balance | 变长String | 可选 | |
冻结余额 | freeze_balance | 变长String | 可选 | |
账户状态 | acct_stat | 定长1位String | 可选 | N:正常 C:关闭 |
qry015 众邦虚拟账户到账查询接口¶
请求参数¶
参数中文名称 | 参数名称 | 数据格式 | 是否必须 | 说明 |
---|---|---|---|---|
版本号 | version | 定长2位String | 必须 | 目前固定为10 |
商户客户号 | mer_cust_id | 定长16位String | 必须 | 由汇付生成,商户的唯一性标识 |
请求日期 | mer_date | 定长8位String | 必须 | 商户发起接口调用时的当前系统日期,格式:yyyyMMdd |
打款日期 | arrival_date | 定长8位String | 必须 | 商户众邦虚拟账户实际收到打款的日期,格式:yyyyMMdd |
打款金额 | arrival_amt | 变长14位String | 可选 | 示例:0.00,单位:元,传入该参数时会匹配对应金额的到账记录,不传入该参数,会返回打款日期内所有的到账记录 |
返回参数¶
参数中文名称 | 参数名称 | 数据格式 | 是否必须 | 说明 |
---|---|---|---|---|
应答返回码 | resp_code | 定长6位String | 必须 | |
应答返回描述 | resp_desc | 变长String | 必须 | 返回码的对应中文描述 |
商户客户号 | mer_cust_id | 定长16位String | 必须 | 由汇付生成,商户的唯一性标识 |
业务流水号 | req_serial_no | 变长String | 可选 | 汇付生成的系统流水号 |
请求日期 | mer_date | 变长String | 必须 | yyyyMMdd |
到账记录列表 | arrival_notice_infos | json串list | 可选 |
到账记录列表(arrival_notice_infos)
参数中文名称 | 参数名称 | 数据格式 | 是否必须 | 说明 |
---|---|---|---|---|
打款卡号 | pay_acct | 变长32位String | 可选 | 付款方银行卡号 |
打款金额 | arrival_amt | 变长14位String | 可选 | 示例:0.00,单位:元 |
打款日期 | arrival_date | 定长8位String | 可选 | 格式:yyyyMMdd |