接口文档_友禾-飞喵-广州友禾信息科技有限公司

接口说明

提交充值订单

请求体(Request Body)

参数名称	数据类型	示例	不为空	描述
out_trade_num	string	GG5822222266	true	商户订单号，由商户自己生成唯一单号。
（同一商户，不能存在相同单号订单，相同订单号不能提单）
product_id	number	68	true	产品ID（代理后台查看）
mobile	string	18866667777	true	充值号码（手机号、电费户、qq号等）
notify_url	string	http://www.abc.com	true	回调地址，用于接收充值状态回调
userid	string	10001	true	商户ID，通过客服或代理后台获取
amount	number	100	false	面值，（不传不校验）如果产品的面值与此参数不同，提单驳回
price	number	94.8	false	最高成本，（不传不校验）如果产品成本超过这个值，提单驳回
area	string	广东	false	电费省份/直辖市，如：四川、北京、上海，仅电费带此参数
ytype	string	1	false	电费验证三要素，1-身份证后6位，2-银行卡后六位,3-营业执照后六位，仅南网电费带此参数
id_card_no	string	123456	false	身份证后6位/银行卡后6位/营业执照后6位，仅南网电费带此参数
city	string	广州	false	地级市名，仅部分南网电费带此参数，是否带此参数需咨询渠道方
param1	string		false	扩展参数，后台查看提交的产品类目是否需要提交此参数
param2	string		false	扩展参数，后台查看提交的产品类目是否需要提交此参数
param3	string	*	false	扩展参数，后台查看提交的产品类目是否需要提交此参数
sign	string	JCXHF8S66BO6MPG5JNW2DGEJ9SB3F7ST	true	签名；签名规则见2.2“签名说明”

请求示例：

out_trade_num=ABC1111&product_id=11&mobile=18899998888&notify_url=http://www.abc.com/yuanren&userid=10001&sign=GZWDK8X7TGJFA8N8O9HILQ6WSI46C8FJ

响应体

● 响应数据格式：JSON，当“http状态非200”或者“响应体无数据时”可能是服务器或其他链路出现故障，无法准确判定是否成功下单，请通过订单查询或者人工方式再次确认状态。

参数名称	类型	示例	不为空	描述
errno	string		true	错误码，0代表成功，非0代表提交失败
errmsg	string		true	错误描述
data	object		true	errno=0时返回数据
⇥ order_number	string		true	系统定单号
⇥ mobile	string		true	充值手机号
⇥ product_id	string		true	产品ID
⇥ total_price	string		true	消费金额
⇥ out_trade_num	string		true	商户订单号
⇥ title	string	*	true	充值产品说明

响应示例：

{

    "errno": 0,

    "errmsg": "下单成功",

    "data": {

        "order_number": "XYZ111111",

        "mobile": "18866667777",

        "product_id": 10001,

        "total_price": "95.00",

        "out_trade_num": "ABC1111",

        "title": "100元话费",

    }

}

2.4 查询用户信息

POSThttp://域名/yrapi.php/index/user

请求体(Request Body)

参数名称	数据类型	示例	不为空	描述
userid	string	1001	true	账号ID
sign	string	JCXHF8S66BO6MPG5JNW2DGEJ9SB3F7ST	true	签名；签名规则见2.2“签名说明”

响应体

● 响应数据格式：JSON

参数名称	类型	示例	不为空	描述
errno	string		true	错误码，0代表成功，非0代表失败
errmsg	string		true	错误描述
data	object		true	errno=0时返回数据
⇥ id	string		true	userid
⇥ username	string		true	名称
⇥ balance	string		true	余额

2.5 获取产品类型和产品分类

POSThttp://域名/yrapi.php/index/typecate

请求体(Request Body)

参数名称	数据类型	示例	不为空	描述
userid	string	1001	true	商户ID
sign	string	JCXHF8S66BO6MPG5JNW2DGEJ9SB3F7ST	true	签名

响应体

● 响应数据格式：JSON

参数名称	类型	示例	不为空	描述
errno	string		true	返回0
errmsg	string		true	错误描述
data	object		true	errno=0时返回数据
⇥ id	string		true	产品类型id
⇥ type_name	string		true	产品类型名称
⇥ cate	array		true	分类列表
⇥⇥ id	int		true	分类ID
⇥⇥ cate	string		true	分类名称
⇥⇥ type	string	*	true	产品类型ID

2.5 获取产品

POSThttp://域名/yrapi.php/index/product

请求体(Request Body)

参数名称	数据类型	示例	不为空	描述
userid	string	10001	true	商户ID
type	int	1	false	产品类型ID,非必须
cate_id	int	10	false	分类ID,非必须
sign	string	JCXHF8S66BO6MPG5JNW2DGEJ9SB3F7ST	true	签名

响应体

● 响应数据格式：JSON

参数名称	类型	示例	不为空	描述
errno	string		true	错误码，0代表成功，非0代表失败
errmsg	string		true	错误描述
data	object		true	errno=0时返回数据
⇥ id	int		true	分类ID
⇥ cate	string		true	分类名称
⇥ sort	string		true	排序
⇥ type	string		true	产品类型ID
⇥ products	array		true	产品列表
⇥⇥ id	string		true	产品ID,下单报文中用此参数
⇥⇥ name	string		true	产品名称
⇥⇥ desc	string		true	产品说明
⇥⇥ api_open	string		true	自动充值
⇥⇥ isp	string		true	运营商集合（话费、流量有效），1移动,2电信,3联通,4虚拟
⇥⇥ ys_tag	string		true	标签
⇥⇥ price	string		true	价格，下单扣费金额
⇥⇥ y_price	string		true	原价
⇥⇥ max_price	string		true	封顶价格
⇥⇥ type	string		true	产品类型ID
⇥⇥ cate_name	string		true	产品分类名称
⇥⇥ type_name	string		true	产品类型名称

2.6 自发查询订单状态

POSThttp://域名/yrapi.php/index/check

请求体(Request Body)

参数名称	数据类型	示例	不为空	描述
userid	string	10001	true	账户ID
out_trade_nums	string	CZH668877,CZH9988666	true	商户订单号；多个用英文,分割
sign	string	JCXHF8S66BO6MPG5JNW2DGEJ9SB3F7ST	true	签名

响应体

● 响应数据格式：JSON

参数名称	类型	示例	不为空	描述
errno	string	0	true	错误码，0代表成功，非0代表失败
errmsg	string	查询成功	true	错误描述
data	object	*	true	errno=0时返回数据
⇥ order_number	string	CZH1111111	true	系统订单号
⇥ out_trade_num	string	AB882863666	true	商户订单号
⇥ create_time	string	1652403339	true	下单时间
⇥ mobile	string	18866667777	true	手机号
⇥ product_id	string	88	true	产品ID
⇥ charge_amount	float	100	true	充值成功面额
⇥ charge_kami	string	yspm1mkdksald	true	卡密流水
⇥ state	string	1	true	充值状态：-1取消，0充值中，1充值成功，2充值失败，3部分成功

2.7 充值结果通知-异步通知

POST-表单格式
回调地址：订单提交时参数中传的回调的地址

请求体(Request Body)

参数名称	数据类型	示例	不为空	描述
userid	int	10001	true	商户ID
order_number	CZH000000000	string		true
out_trade_num	string	ABC2222	true	商户订单号
otime	number	1652403339	true	成功/失败时间，10位时间戳
state	number	1	true	充值状态；-1取消， 0充值中， 1充值成功，2充值失败，3部分成功（-1,2做失败处理；1做成功处理；3做部分成功处理）
mobile	string	18866667777	true	充值手机号
remark	string	充值成功	true	备注信息
charge_amount	float	100	true	充值成功面额
voucher	string	http://www.abc.com/xxx	true	凭证
charge_kami	string	3etydgd45gf11	true	卡密/流水号
sign	string	DS9V0606ITN8GLJM5M4L4DYWQX0VDMVM	true	签名字符串，用于验签,以保证回调可靠性。

签名规则见：2.2签名说明
注：所有参数都要参与签名，请获取所有参数签名，而不是获取现有参数表中的字段签名，以免回调参数增加时导致签名不通过 |
| … | * | * | * | 更多参数 |

响应体

● 收到回调响应文本“success”，如果不响应系统每隔1分钟会再次发起回调，最多回调5次。

success

php版回调验签示例：



 $apikey="你的秘钥";

 $data = $_POST;//接收所有post的数据

 unset($data['sign']);//删除掉sign字段

 ksort($data);//排序

 $sign_str = urldecode(http_build_query($data)) . '&apikey=' . $apikey;//获得签名原串

 $mysign=strtoupper(md5($sign_str));//签名

 if($mysign==$_POST['sign']){

 //签名正确

 }

2.8 电费支持地区查询

POSThttp://域名/yrapi.php/index/elecity

请求体(Request Body)

参数名称	数据类型	示例	不为空	描述
userid	string	10001	true	账号ID
sign	string	DS9V0606ITN8GLJM5M4L4DYWQX0VDMVM	true	签名；签名规则见2.2“签名说明”

响应体

● 响应数据格式：JSON

参数名称	类型	示例	不为空	描述
errno	string	0	true	错误码，0代表查询成功，非0代表失败
errmsg	string	查询成功	true	错误描述
data	array		true	errno=0时返回数据
⇥ city_name	string	广东	true	地区名称
⇥ sort	int	100	true	排序
⇥ initial	string	G	true	首字母
⇥ need_ytype	Int	1	true	是否三要素认证
⇥ need_city	Int	1	true	是否需要选择城市（当此开关打开以后才有下面的城市列表）
⇥ city	Array		true	支持的地级市
⇥⇥ city_name	string	广州	true	城市名称
⇥⇥ initial	string	G	true	首字母

主题测试文章，只做测试使用。发布者：wry1026，转转请注明出处：https://www.yeohe.cn/4045.html

接口文档

接口说明

请求体(Request Body)

响应体

2.4 查询用户信息

请求体(Request Body)

响应体

2.5 获取产品类型和产品分类

请求体(Request Body)

响应体

2.5 获取产品

请求体(Request Body)

响应体

2.6 自发查询订单状态

请求体(Request Body)

响应体

2.7 充值结果通知-异步通知

请求体(Request Body)

响应体

2.8 电费支持地区查询

请求体(Request Body)

响应体

发表回复

联系我们

020-28185755