有量开放平台
Api
文档
登录
注册
视图
打印
历史
跳到...
店铺管理
社区群聊
会员
商品
消息通知
图片
app客户端
IM用户相关接口
社区主题
微选接口
平台会员
私有文件存储
订单
购物车
运营管理
采购单
idcenter
消息
团队成员
店铺
店铺统计
店铺会员
微分销订单开放接口
微分销
UchatManager
ELK日志查询API
新会员系统
自定义页面
三方接入
开放接口--sku
客服
汇付相关接口
优惠劵
物流信息
微店订单开放接口
支付
地区
供应商
UchatAPI
买卖助理小程序帮买
微信发送消息
开放接口--物流
生鲜APP
开放接口--订单
开放接口--商品
微信群客服
token管理
标签
IM相关接口
社区公众号服务
粮本erp接口
买卖接龙
独立团
Uchat-API
小蜜群接龙
资源计费服务
创建订单
动态
社区好友
公共服务
wechat_notice
团队
微选合作接口
源头速供
用户身份整合
权限信息
消息服务
设置Key
API列表
店铺管理
社区群聊
会员
商品
消息通知
图片
app客户端
IM用户相关接口
社区主题
微选接口
平台会员
私有文件存储
订单
购物车
运营管理
采购单
idcenter
消息
团队成员
店铺
店铺统计
店铺会员
微分销订单开放接口
微分销
UchatManager
ELK日志查询API
新会员系统
自定义页面
三方接入
开放接口--sku
客服
汇付相关接口
优惠劵
物流信息
微店订单开放接口
支付
地区
供应商
UchatAPI
买卖助理小程序帮买
微信发送消息
开放接口--物流
生鲜APP
开放接口--订单
开放接口--商品
微信群客服
token管理
标签
IM相关接口
社区公众号服务
粮本erp接口
买卖接龙
独立团
Uchat-API
小蜜群接龙
资源计费服务
创建订单
动态
社区好友
公共服务
wechat_notice
团队
微选合作接口
源头速供
用户身份整合
权限信息
消息服务
POST
代理商商户开户
/api/hfpay/v1/merchant/agent_merchant_opening
错误代码列表
http状态码
错误码
错误信息
200
Parameter
Value
Type
Description
mer_cust_id
string
商户客户号
mer_name
string
商户全称
mer_short_name
string
商户简称
mer_en_name
string
商户英文名,简称的首字母拼音缩写
reg_fund
string
注册资本(元)
paid_in_fund
string
实缴资本(元)
mer_website
string
网站地址
per_icp_code
string
ICP备案号
est_date
string
成立时间
mer_prov
string
商户所在省份
mer_area
string
商户所在地区
mer_addr
string
商户经营地址
mer_reg_addr
string
商户注册地址
license_type
string
“普通企业”,” 01030100 ” “三证合一”,” 01030101 “
business_code
string
营业执照注册号,商户的营业执照注册号 (证照类型为:普通企业 必填)
institution_code
string
组织机构代码,商户的组织机构代码证 (证照类型为:普通企业 必填)
tax_code
string
税务登记号,商户的税务登记号 (证照类型为:普通企业必填)
social_credit_code
string
统一社会信用代码,商户的统一社会信用代码 (证照类型为:三证合一 必填)
license_start_date
string
证照有效起始日期,精确到年月日,如19701212
license_end_date
string
证照有效结束日期,精确到年月日,如19701212,支持“永久”
business_scope
string
经营范围
stockholders
string
股东,数据格式:[{“name”:”关羽”,”certType”:”01”,”certId”:”330204199008187881”}]
legal_name
string
法人姓名
legal_cert_type
string
法人证件类型,01020100:身份证(默认) 01020101:护照 01020102:军官证 01020103士兵证 01020104:回乡证 01020105警官证 01020106:台胞证 01020107:其他
legal_cert_id
string
法人证件号,法人的证件号码,与证件类型对应
legal_id_start_date
string
法人证件起始日期,精确到年月日,如19701212
legal_id_end_date
string
法人证件结束日期,精确到年月日,如19701212,支持“永久”
legal_mobile
string
法人的手机号码
contact_name
string
联系人姓名
contact_mobile
string
联系人手机号
contact_email
string
联系人邮箱
bank_id
string
开户银行
bank_acct_no
string
开户银行账号
bank_branch
string
开户银行支行名称
bank_prov
string
开户银行省份
bank_area
string
开户银行地区
attach_nos
string
附件编号列表,商户文件上传接口(122)的附件编号列表,多个附件编号之间用逗号隔开,如:abc123或者abc123,abc1234
card_type
string
结算卡对公对私标志 1:对公 2:对私
bg_ret_url
string
商户后台应答地址,通过后台异步通知商户开户结果 注意: 1) 使用时不要包含中文 2) 必须是外网地址
mer_priv
string
商户的自定义字段,该字段在交易完成后由本平台原样返回
extension
string
扩展域,企账通代理商必填,如:{“eacloud”:”proxy”}
执行API
POST
app支付
/api/hfpay/v1/trade/app_pay
错误代码列表
http状态码
错误码
错误信息
200
Parameter
Value
Type
Description
mer_cust_id
string
商户客户号
user_cust_id
string
用户客户号
order_date
string
订单日期
order_id
string
订单号
pay_type
string
04:微信正扫; 05:支付宝正扫; 10 : 微信APP支付; 12:支付宝统一下单; 13:微信公众号; 18:银联正扫; 19:微信小程序。
trans_amt
string
交易金额
in_cust_id
string
入账客户号,非充值交易,入账客户号与分账串必填一个
div_detail
string
分账串([{“divAmt”:”0.05”, “divAcctId”:”216548”, “divCustId”:”6666000000118348”}])
trans_type
string
交易类型(guarantee-担保; recharge-充值; other-其它; 默认other。)
is_raw
string
微信公众号支付支持的参数, 是否原生态(1-是; 0-否; 为空时,默认1。)
app_id
string
APPID,支付类型为微信APP支付时不能为空,商户在微信申请的APPID。
buyer_id
string
买家用户ID,微信公众号支付和小程序支付时,不能为空。
goods_desc
string
商品描述
goods_type
string
商品类型
attach_info
string
附加信可选息
good_tag
string
商品标记
ret_url
string
支付返回地址
bg_ret_url
string
商户后台应答地址
mer_priv
string
商户私有域
dev_info
string
设备信息
div_type
string
01:延时分账
执行API
POST
余额支付
/api/hfpay/v1/trade/balance_pay
错误代码列表
http状态码
错误码
错误信息
200
Parameter
Value
Type
Description
mer_cust_id
string
商户客户号
in_cust_id
string
卖家客户号,由汇付生成,商户的唯一性标识
out_cust_id
string
买家客户号,汇付生成,商户的唯一性标识
trans_amt
string
金额格式是 ###.00
order_id
string
保证订单号和订单日期唯一
order_date
string
保证订单号和订单日期唯一,格式为YYYYMMDD
sms_code
string
商户支付安全配置短信验证时必输
trans_type
string
交易类型,1担保; 2非担保。
ret_url
string
前台返回地址
bg_ret_url
string
通过后台异步通知商户开户结果
mer_priv
string
为商户的自定义字段
执行API
POST
余额查询
/api/hfpay/v1/merchant/balance_query
错误代码列表
http状态码
错误码
错误信息
200
Parameter
Value
Type
Description
mer_cust_id
string
商户客户号
user_cust_id
string
用户客户号,查询商户本身时,同商户客户号
acct_id
string
查询商户本身时,必输
执行API
GET
银行卡检查
/api/hfpay/app/bank_check/card/${card_id}
错误代码列表
http状态码
错误码
错误信息
200
Parameter
Value
Type
Description
card_id
string
card_id
执行API
POST
绑卡
/api/hfpay/v1/merchant/bind_bank_card
错误代码列表
http状态码
错误码
错误信息
200
Parameter
Value
Type
Description
mer_cust_id
string
商户客户号
user_cust_id
string
用户客户号
order_id
string
保证订单号和订单日期唯一
order_date
string
保证订单号和订单日期唯一,格式为YYYYMMDD
bank_id
string
银行代号
card_no
string
银行卡号
dc_flag
string
0:借记卡(固定)
card_prov
string
银行卡开户省份
card_area
string
银行卡开户地区
card_mobile
string
银行预留手机号
bg_ret_url
string
后台返回地址
mer_priv
string
执行API
POST
企业开户
/api/hfpay/v1/merchant/business_opening
错误代码列表
http状态码
错误码
错误信息
200
Parameter
Value
Type
Description
mer_cust_id
string
商户唯一标识号
order_id
string
订单号
order_date
string
订单日期
apply_id
string
企业开户申请号,申请企业开户的唯一标识
operate_type
string
操作类型(00090000-新增; 00090001-修改。)
corp_license_type
string
01030100-普通营业执照企业; 01030101-三证合一企业。
corp_type
string
01030000-普通企业; 01030001-个体户。
corp_name
string
企业的公司全称
business_code
string
营业执照注册号,普通营业执照企业必填
institution_code
string
组织机构代码,普通营业执照企业必填
tax_code
string
税务登记证号,普通营业执照企业必填
social_credit_code
string
统一社会信用 代码,三证合一企业必填, 普通营业执照企业不填
license_start_date
string
证照起始日期,企业的营业证照起始日期, 精确到年月日
license_end_date
string
证照结束日期,企业的营业证照结束日期, 精确到年月日,支持“永久”
corp_business_address
string
企业经营地址
corp_reg_address
string
企业注册地址
corp_fixed_telephone
string
企业固定电话
business_scope
string
企业的经营范围
controlling_shareholder
string
控股股东 (实际控制人):数据格式: [{“name”:”关羽”, “certType”:”01020100”, “certId”:”330204199008187881”}]
legal_name
string
法人姓名
legal_cert_type
string
法人证件类型:01020100:身份证; 01020101:护照; 01020102:军官证; 01020103士兵证; 01020104:回乡证; 01020105警官证; 01020106:台胞证; 01020107:其他。
legal_cert_id
string
法人的证件号码,与证件类型对应
legal_cert_start_date
string
法人证件起始,精确到年月日
legal_cert_end_date
string
法人的证件结束日期,精确到年月日,支持“永久”
legal_mobile
string
法人手机号码
contact_name
string
企业联系人姓名
contact_mobile
string
企业联系人手机号
contact_email
string
企业联系邮箱
bank_acct_name
string
企业开户银行账户名,需与企业名称保持一致
bank_id
string
开户银行代号
bank_acct_no
string
企业开户银行账号
bank_branch
string
企业开户银行的支行名称
bank_prov
string
银行卡开户省份
bank_area
string
银行卡开户地区
industry
string
企业行业类别
ret_url
string
交易结果通过页面方式发送到该地址上
bg_ret_url
string
商户后台应答地址
mer_priv
string
商户的自定义字段,该字段在交易完成后由本平台原样返回
执行API
POST
分账
/api/hfpay/v1/trade/fz
错误代码列表
http状态码
错误码
错误信息
200
Parameter
Value
Type
Description
mer_cust_id
string
商户客户号
order_id
string
商户号+订单号+订单日期唯一
order_date
string
订单日期格式为YYYYMMDD
trans_amt
string
金额格式是 ###.00
old_order_id
string
原订单号
old_order_date
string
原订单日期
div_detail
string
分账串(最多7个,格式如下 [{“divAmt”:”0.05”, “divAcctId”:”216548”, “divCustId”:”6666000000118348”}])
bg_ret_url
string
异步回调
mer_priv
string
商户私有域
extension
string
dev_info
string
执行API
POST
个体户开户
/api/hfpay/v1/merchant/merchant_opening
错误代码列表
http状态码
错误码
错误信息
200
Parameter
Value
Type
Description
mer_cust_id
string
商户客户号
order_id
string
订单号
order_date
string
订单日期YYYYMMDD
apply_id
string
企业开户申请号,申请企业开户的唯一标识
operate_type
string
操作类型(00090000-新增; 00090001-修改。)
user_name
string
个体户名称
business_code
string
营业执照注册号
license_start_date
string
证照起始日期
license_end_date
string
证照结束日期
solo_business_address
string
个体经营地址
solo_reg_address
string
个体注册地址
solo_fixed_telephone
string
个体固定电话
business_scope
string
企业的经营范围
legal_name
string
法人姓名
legal_cert_type
string
法人证件类型
legal_cert_id
string
法人证件号码
legal_cert_start_date
string
法人证件起始
legal_cert_end_date
string
法人证件结束
legal_mobile
string
法人手机号码
contact_name
string
企业联系人姓名
contact_mobile
string
系人手机号
contact_email
string
联系人邮箱
occupation
string
职业
address
string
住址
attach_nos
string
附件编号列表
bg_ret_url
string
mer_priv
string
执行API
POST
订单确认
/api/hfpay/v1/trade/order_affirm
错误代码列表
http状态码
错误码
错误信息
200
Parameter
Value
Type
Description
mer_cust_id
string
商户客户号
old_order_id
string
原订单号,担保交易订单号
old_order_date
string
原订单日期,担保交易订单日期YYYYMMDD
order_id
string
订单号,保证订单号和订单日期唯一
order_date
string
订单日期,保证订单号和订单日期唯一,格式为YYYYMMDD
trans_amt
string
金额格式是 ###.00
in_cust_id
string
卖家编号,由汇付生成,商户的唯一性标识
out_cust_id
string
买家编号,由汇付生成,商户的唯一性标识
bg_ret_url
string
后台异步通知
mer_priv
string
为商户的自定义字段
执行API
POST
对账单下载
/api/hfpay/v1/merchant/order_download
错误代码列表
http状态码
错误码
错误信息
200
Parameter
Value
Type
Description
mer_cust_id
string
商户客户号
order_date
string
对账日期
trans_type
string
01:交易对账文件
执行API
POST
订单查询
/api/hfpay/v1/trade/order_query
错误代码列表
http状态码
错误码
错误信息
200
Parameter
Value
Type
Description
mer_cust_id
string
商户客户号
user_cust_id
string
用户客户号
order_id
string
订单号
order_date
string
订单日期
trans_type
string
交易查询类型01:快捷、网银、扫码; 02:余额支付、采购确认、订单撤销; 03:提现; 04:退货
mer_priv
string
为商户的自定义字段
执行API
POST
订单撤销
/api/hfpay/v1/trade/order_reverse
错误代码列表
http状态码
错误码
错误信息
200
Parameter
Value
Type
Description
mer_cust_id
string
商户号
old_order_id
string
原订单号,担保交易订单号
old_order_date
string
原订单日期,担保交易订单日期YYYYMMDD
order_id
string
订单号,保证订单号和订单日期唯一
order_date
string
订单日期,保证订单号和订单日期唯一,格式为YYYYMMDD
trans_amt
string
金额格式是 ###.00
in_cust_id
string
卖家编号,由汇付生成,商户的唯一性标识
out_cust_id
string
买家编号,由汇付生成,商户的唯一性标识
bg_ret_url
string
后台异步通知
mer_priv
string
为商户的自定义字段
执行API
POST
个人开户
/api/hfpay/v1/merchant/person_opening
错误代码列表
http状态码
错误码
错误信息
200
Parameter
Value
Type
Description
mer_cust_id
商户客户号
order_id
保证订单号和订单日期唯一
order_date
保证订单号和订单日期唯一,格式为 YYYYMMDD
user_name
用户的真实姓名
cert_id
用户的身份证号
user_mobile
用户的手机号
vali_date
填写证件上有效期的截至日期,格式为: YYYYMMDD ,例如: 20290420
cust_prov
用户省份,如上海0031
cust_area
用户地区,如上海3100
cust_address
证件上的住址
occupation
个人职业分类表
user_email
用户的电子邮箱
bg_ret_url
后台异步通知商户开户结果
mer_priv
为商户的自定义字段,该字段在交易完成后由本平台原样返回
执行API
POST
快捷支付
/api/hfpay/v1/trade/quick_pay
错误代码列表
http状态码
错误码
错误信息
200
Parameter
Value
Type
Description
mer_cust_id
商户客户号
user_cust_id
用户客户号
order_id
订单号
order_date
订单日期
ori_order_id
原请求订单单号
ori_order_date
原请求订单日期
sms_code
短信验证码
ret_url
页面返回URL,交易完成后,本平台系统把交易结果通过页面方式,发送到该地址上
request_type
00 : PC端; 01 : 移动端
bg_ret_url
商户后台应答地址
mer_priv
商户的自定义字段,该字段在交易完成后由本平台原样返回
secondary_mer_id
二级商户号,对于开启二级商户模式的商户,必须输入其配下的二级商户号
执行API
POST
退款
/api/hfpay/v1/trade/refund
错误代码列表
http状态码
错误码
错误信息
200
Parameter
Value
Type
Description
mer_cust_id
string
商户客户号
user_cust_id
string
由汇付生成,用户的唯一性标识 对原交易为网银支付、快捷支付时必须;对原交易为扫码支付时可选
order_date
string
保证订单号和订单日期唯一,格式为YYYYMMDD
order_id
string
保证订单号和订单日期唯一;对于退货失败的,支持同订单号同金额的重复请求;新订单号认为是新的退货交易
trans_amt
string
金额格式是 ###.00
org_order_id
string
原交易订单号
org_order_date
string
原交易订单日期
bg_ret_url
string
商户后台应答地址:通过后台异步通知商户结果,注意: 1) 使用时不要包含中文; 2) 必须是外网地址。
mer_priv
string
为商户的自定义字段
div_detail
string
分账串:分账串最多7个,示例如: [{“divAmt”:”0.05”, “divAcctId”:”216548”, “divCustId”:”6666000000118348”}]
执行API
POST
发送快捷支付的短信
/api/hfpay/v1/trade/send_quick_pay_sms_code
错误代码列表
http状态码
错误码
错误信息
200
Parameter
Value
Type
Description
mer_cust_id
商户客户号
user_cust_id
用户客户号
order_id
订单号
order_date
订单日期
trans_amt
交易金额
card_no
银行卡号
card_mobile
银行预留手机号
card_prov
银行卡开户省份
card_area
银行卡开户地区
in_cust_id
入账用户号
div_detail
分账串
trans_type
交易类型(guarantee-担保; recharge-充值; other-其它; 默认other。)
bg_ret_url
商户后台应答地址
mer_priv
商户私有域(为商户的自定义字段,该字段在交易完成后由本平台原样返回)
payer_term_type
付款方交易终端类型
payer_term_no
付款方交易终端编码
goods_short_name
商品简称
执行API
POST
发送短信
/api/hfpay/v1/merchant/send_sms_code
错误代码列表
http状态码
错误码
错误信息
200
Parameter
Value
Type
Description
mer_cust_id
string
商户客户号
user_cust_id
string
用户客户号
order_id
string
订单号
order_date
string
订单日期
user_mobile
string
用户手机号
busi_type
string
业务类型(T11-余额支付; T07-提现; U06-创建子账户)
mer_priv
string
商户的自定义字段,该字段在交易完成后由本平台原样返回
执行API
POST
创建子账号
/api/hfpay/v1/merchant/sub_merchant_create
错误代码列表
http状态码
错误码
错误信息
200
Parameter
Value
Type
Description
mer_cust_id
string
商户客户号
user_cust_id
string
用户客户号
order_id
string
保证订单号和订单日期唯一
order_date
string
保证订单号和订单日期唯一,格式为YYYYMMDD
acct_type
string
100:支付账户;200:非支付账户
sms_code
string
商户支付安全配置短信验证时必输
ret_url
string
通过前台通知商户提现结果
bg_ret_url
string
通过后台异步通知商户提现结果
mer_priv
string
商户私有域
执行API
POST
解签
/api/hfpay/v1/trade/unsgin
错误代码列表
http状态码
错误码
错误信息
200
Parameter
Value
Type
Description
check_value
string
回调加密串
mer_cust_id
string
商户客户号
unsign_type
int
解密类型,1:base64
执行API
POST
解绑
/api/hfpay/v1/merchant/untie_bank_card
错误代码列表
http状态码
错误码
错误信息
200
Parameter
Value
Type
Description
mer_cust_id
string
商户客户号
user_cust_id
string
用户客户号
order_id
string
保证订单号和订单日期唯一
order_date
string
保证订单号和订单日期唯一,格式为YYYYMMDD
bank_id
string
银行代号
card_id
string
绑卡ID
card_mobile
string
银行卡预留手机号
card_buss_type
string
卡业务类型(0:提现;2:快捷。)
bg_ret_url
string
商户后台应答地址
mer_priv
string
商户私有域
执行API
POST
代理商证件上传
/api/hfpay/v1/merchant/upload_agent_file
错误代码列表
http状态码
错误码
错误信息
200
Parameter
Value
Type
Description
mer_cust_id
string
商户客户号
attach_no
string
附件编号
trans_type
string
业务类型,01:代理商开户,02:生利宝开户 03:企业开户, 05:个体工商户开户, 06:批量代发
attach_type
string
附件类型,营业执照注册号:00 组织结构代码证:01 税务登记证号:02 法人证件:03 开户银行许可证:04 统一社会信用代码:05 开户电子协议:08 法人证件反面:09 经营照片:10 经营照片(地址照片):11 经营照片(门面照片):12 其他:99
attach_desc
string
文件描述
file_upload_type
string
上传类型,01:新增 说明(非必填。默认为新增,新增情况下,文件名重复报错;更新情况下文件名重复会更新已上传文件)
file
string
文件名称为 UTF-8 字符集 ,URLEncode 编码后的字符串。
执行API
POST
个人证件上传
/api/hfpay/v1/merchant/upload_card
错误代码列表
http状态码
错误码
错误信息
200
Parameter
Value
Type
Description
mer_cust_id
string
商户客户号
user_cust_id
string
用户客户号
order_id
string
订单号
order_date
string
订单日期YYYYMMDD
cert_id
string
证件号
cert_name
string
证件姓名
cert_type
string
证件类型 00-身份证
source_channel
string
来源渠道 0-PC;1-ANDROID;2-IOS
bg_ret_url
string
通过后台异步通知商户提现结果
file1
string
身份证正面照
file2
string
身份证反面照
执行API
POST
个体工商证件上传
/api/hfpay/v1/merchant/upload_merchant_file
错误代码列表
http状态码
错误码
错误信息
200
Parameter
Value
Type
Description
mer_cust_id
string
商户客户号,由汇付生成,商户的唯一性标识
attach_no
string
附件编号,商户必须保证唯一
trans_type
string
业务类型:05-个体工商户
attach_type
string
附件类型:00-营业执照注册号; 01-组织结构代码证; 02-税务登记证号; 03-法人证件; 04-开户银行许可证; 05-统一社会信用代码; 08-开户电子协议; 09-法人证件反面; 10-经营照片; 11-经营照片(地址照片); 12-经营照片(门面照片); 13-结算卡正面; 14-结算卡反面; 99-其他。
attach_desc
string
文件描述
file
string
文件名称为 UTF-8 字符集 ,URLEncode 编码后的字符串。
file_upload_type
string
01:新增(文件名称不能重复)
执行API
POST
提现
/api/hfpay/v1/trade/withdrawal
错误代码列表
http状态码
错误码
错误信息
200
Parameter
Value
Type
Description
user_cust_id
string
用户客户号
order_id
string
保证订单号和订单日期唯一
order_date
string
保证订单号和订单日期唯一,格式为YYYYMMDD
trans_amt
string
金额格式是 ###.00
cash_bind_card_id
string
提现绑定银行卡ID
cash_type
string
T0:T+0提现; T1:T+1提现。
fee_obj
string
商户指定提现手续费的收取对象,优先级别高于商户配置的收取对象:M:向商户收取;U:向用户收取。
fee_acct_id
string
向商户收取时,必填
sms_code
string
商户支付安全配置短信验证时必输
ret_url
string
通过前台通知商户提现结果
bg_ret_url
string
通过后台异步通知商户提现结果
mer_priv
string
为商户的自定义字段,该字段在交易完成后由本平台原样返回
mer_cust_id
string
执行API
×
设置调用的Key / Secret
Key
Secret
OAuth Token Header