-开发者中心-API开发文档

API开发文档简介

本文阅读对象：技术架构师、研发工程师、测试工程师、系统运维工程师。通过本文档，商户可了解API系统接入的技术、接入的产品业务、接入的流程、接入规范等信息。以便于商户顺利完成接入工作。

接口申请方式

共有两种接口模式：

（一）普通支付商户
可以获得一个支付商户，目前认证费是0.1元。可在线申请：接入申请，在线申请之后即可登录使用！

（二）合作支付商户
获得一个合作者身份TOKEN，可以集成到你开发的程序里面，通过接口无限申请普通支付商户，并且每个普通支付商户单独结算，相对独立。申请需要进行企业或开发者资质认证，请联系人工申请QQ，申请之后会将合作者身份TOKEN给你！（内测暂不开放）

协议规则

传输方式：HTTPS

数据格式：JSON

签名算法：MD5

字符编码：UTF-8

[API]创建商户

API权限：该API只能合作支付商户调用

URL地址：https://pay.xty.kim/api.php?act=apply&token={合作者身份TOKEN}&url={商户域名}

字段名	变量名	必填	类型	示例值	描述
操作类型	act	是	String	apply	此API固定值
合作者TOKEN	token	是	String	9ddab6c4f2c87ce442de371b04f36d68	需要事先申请
商户域名	url	是	String

返回结果：

字段名	变量名	类型	示例值	描述
返回状态码	code	Int	1	1为成功，其它值为失败
返回信息	msg	String	添加支付商户成功！
商户ID	pid	Int	1001	所创建的商户ID
商户密钥	key	String(32)	89unJUB8HZ54Hj7x4nUj56HN4nUzUJ8i	所创建的商户密钥
商户类型	type	Int	1	此值暂无用

[API]查询商户信息与结算规则

URL地址：https://pay.xty.kim/api.php?act=query&pid={商户ID}&key={商户密钥}

请求参数说明：

字段名	变量名	必填	类型	示例值	描述
操作类型	act	是	String	query	此API固定值
商户ID	pid	是	Int	1001
商户密钥	key	是	String	89unJUB8HZ54Hj7x4nUj56HN4nUzUJ8i

返回结果：

字段名	变量名	类型	示例值	描述
返回状态码	code	Int	1	1为成功，其它值为失败
商户ID	pid	Int	1001	所创建的商户ID
商户密钥	key	String(32)	89unJUB8HZ54Hj7x4nUj56HN4nUzUJ8i	所创建的商户密钥
商户类型	type	Int	1	此值暂无用
商户状态	active	Int	1	1为正常，0为封禁
商户QQ	qq	String	1	商户后台填写的QQ号码
商户余额	money	String	0.00	商户所拥有的余额
结算账号	account	String	pay@v8jisu.cn	结算的支付宝账号
结算姓名	username	String	张三	结算的支付宝姓名
满多少自动结算	settle_money	String	30	此值为系统预定义
手动结算手续费	settle_fee	String	1	此值为系统预定义
每笔订单分成比例	money_rate	String	98	此值为系统预定义

API]修改结算账号

URL地址：https://pay.xty.kim/api.php?act=change&pid={商户ID}&key={商户密钥}&account={结算账号}&username={结算姓名}

注：为了保障资金安全，已经设置结算账号的无法再进行修改，如需修改请联系客服

字段名	变量名	必填	类型	示例值	描述
操作类型	act	是	String	change	此API固定值
商户ID	pid	是	Int	1001
商户密钥	key	是	String	89unJUB8HZ54Hj7x4nUj56HN4nUzUJ8i
结算账号	account	是	String	pay@v8jisu.cn	结算的支付宝账号
结算姓名	username	是	String	张三	结算的支付宝姓名

返回结果：

字段名	变量名	类型	示例值	描述
返回状态码	code	Int	1	1为成功，其它值为失败
返回信息	msg	String	修改收款账号成功！

[API]查询结算记录

URL地址：https://pay.xty.kim/api.php?act=settle&pid={商户ID}&key={商户密钥}&page={页码}&limit={每页数量}

请求参数说明：

字段名	变量名	必填	类型	示例值	描述
操作类型	act	是	String	settle	此API固定值
商户ID	pid	是	Int	1001
商户密钥	key	是	String	89unJUB8HZ54Hj7x4nUj56HN4nUzUJ8i
查询订单数量	limit	否	Int	20	返回的订单数量，最大50
页码	page	否	Int	1	当前查询的页码

返回结果：

字段名	变量名	类型	示例值	描述
返回状态码	code	Int	1	1为成功，其它值为失败
返回信息	msg	String	查询结算记录成功！
结算记录	data	Array	结算记录列表

[API]查询单个订单

URL地址：https://pay.xty.kim/api.php?act=order&pid={商户ID}&key={商户密钥}&out_trade_no={商户订单号}

请求参数说明：

字段名	变量名	必填	类型	示例值	描述
操作类型	act	是	String	order	此API固定值
商户ID	pid	是	Int	1001
商户密钥	key	是	String	89unJUB8HZ54Hj7x4nUj56HN4nUzUJ8i
商户订单号	out_trade_no	是	String	20160806151343349

返回结果：

字段名	变量名	类型	示例值	描述
返回状态码	code	Int	1	1为成功，其它值为失败
返回信息	msg	String	查询订单号成功！
易支付订单号	trade_no	String	2016080622555342651	订单号
商户订单号	out_trade_no	String	20160806151343349	商户系统内部的订单号
支付方式	type	String	alipay	alipay:支付宝,tenpay:财付通, qqpay:QQ钱包,wxpay:微信支付
商户ID	pid	Int	1001	发起支付的商户ID
创建订单时间	addtime	String	2016-08-06 22:55:52
完成交易时间	endtime	String	2016-08-06 22:55:52
商品名称	name	String	VIP会员
商品金额	money	String	1.00
支付状态	status	Int	0	1为支付成功，0为未支付

[API]批量查询订单

URL地址：https://pay.xty.kim/api.php?act=orders&pid={商户ID}&key={商户密钥}&page={页码}&limit={每页数量}

请求参数说明：

字段名	变量名	必填	类型	示例值	描述
操作类型	act	是	String	orders	此API固定值
商户ID	pid	是	Int	1001
商户密钥	key	是	String	89unJUB8HZ54Hj7x4nUj56HN4nUzUJ8i
查询订单数量	limit	否	Int	20	返回的订单数量，最大50
页码	page	否	Int	1	当前查询的页码

返回结果：

字段名	变量名	类型	示例值	描述
返回状态码	code	Int	1	1为成功，其它值为失败
返回信息	msg	String	查询结算记录成功！
订单列表	data	Array		订单列表

[API]二维码下单接口

此接口可用于服务器后端发起支付请求，会返回支付二维码链接

URL地址：https://pay.xty.kim/qrcode.php?pid={商户ID}&type={支付方式}&out_trade_no={商户订单号}&notify_url={服务器异步通知地址}&name={商品名称}&money={金额}&sign={签名字符串}&sign_type=MD5

发起支付请求

URL地址：https://pay.xty.kim/submit.php

POST数据：pid={商户ID}&type={支付方式}&out_trade_no={商户订单号}&notify_url={服务器异步通知地址}&return_url={页面跳转通知地址}&name={商品名称}&money={金额}&sitename={网站名称}&sign={签名字符串}&sign_type=MD5

字段名	变量名	必填	类型	示例值	描述
商户ID	pid	是	Int	1001
支付方式	type	是	String	alipay	qqpay:QQ钱包,wxpay:微信支付
商户订单号	out_trade_no	是	String	20160806151343349
异步通知地址	notify_url	是	String	http:///notify_url.php	服务器异步通知地址
商品名称	name	是	String	VIP会员
商品金额	money	是	String	1.00
签名字符串	sign	是	String	202cb962ac59075b964b07152d234b70	签名算法与支付宝签名算法相同
签名类型	sign_type	是	String	MD5	默认为MD5

返回结果：

字段名	变量名	类型	示例值	描述
返回状态码	code	Int	1	1为成功，其它值为失败
返回信息	msg	String	下单成功！
订单号	trade_no	String	20160806151343349
商户订单号	out_trade_no	String	20160806151343349
二维码链接	code_url	String	weixin://wxpay/bizpayurl?pr=04IPMKM

支付结果通知

通知类型：服务器异步通知（notify_url）、页面跳转通知（return_url）

请求方式：GET

字段名	变量名	必填	类型	示例值	描述
商户ID	pid	是	Int	1001
易支付订单号	trade_no	是	String	20160806151343349021	订单号
商户订单号	out_trade_no	是	String	20160806151343349	商户系统内部的订单号
支付方式	type	是	String	alipay	alipay:支付宝,tenpay:财付通, qqpay:QQ钱包,wxpay:微信支付, alipaycode:支付宝扫码,jdpay:京东支付
商品名称	name	是	String	VIP会员
商品金额	money	是	String	1.00
支付状态	trade_status	是	String	TRADE_SUCCESS
签名字符串	sign	是	String	202cb962ac59075b964b07152d234b70	签名算法与支付宝签名算法相同
签名类型	sign_type	是	String	MD5	默认为MD5

SDK下载

点击下载