### 協議規則
傳輸方式：HTTP
數據格式：JSON
簽名算法：MD5
字符編碼：UTF-8
### 頁面跳轉支付
此接口可用于用戶前臺直接發起支付，使用form表單跳轉或拼接成url跳轉。
URL地址：https://epay.jbyun.top/submit.php
請求方式：POST 或 GET（推薦POST，不容易被劫持或屏蔽）
請求參數說明：
| 字段名 | 變量名 | 必填 | 類型 | 示例值 | 描述 |
| --- | --- | --- | --- | --- | --- |
| 商戶ID | pid | 是 | Int | 1001 | |
| 支付方式 | type | 是 | String | alipay | [支付方式列表](https://epay.jbyun.top/doc.html#pay4) |
| 商戶訂單號 | out\_trade\_no | 是 | String | 20160806151343349 | |
| 異步通知地址 | notify\_url | 是 | String | http://www.pay.com/notify\_url.php | 服務器異步通知地址 |
| 跳轉通知地址 | return\_url | 是 | String | http://www.pay.com/return\_url.php | 頁面跳轉通知地址 |
| 商品名稱 | name | 是 | String | VIP會員 | 如超過127個字節會自動截取 |
| 商品金額 | money | 是 | String | 1.00 | 單位：元，最大2位小數 |
| 業務擴展參數 | param | 否 | String | 沒有請留空 | 支付后原樣返回 |
| 簽名字符串 | sign | 是 | String | 202cb962ac59075b964b07152d234b70 | 簽名算法[點此查看](https://epay.jbyun.top/doc.html#pay3) |
| 簽名類型 | sign\_type | 是 | String | MD5 | 默認為MD5 |
### API接口支付
此接口可用于服務器后端發起支付請求，會返回支付二維碼鏈接或支付跳轉url。
URL地址：https://epay.jbyun.top/mapi.php
請求方式：POST
請求參數說明：
| 字段名 | 變量名 | 必填 | 類型 | 示例值 | 描述 |
| --- | --- | --- | --- | --- | --- |
| 商戶ID | pid | 是 | Int | 1001 | |
| 支付方式 | type | 是 | String | alipay | [支付方式列表](https://epay.jbyun.top/doc.html#pay4) |
| 商戶訂單號 | out\_trade\_no | 是 | String | 20160806151343349 | |
| 異步通知地址 | notify\_url | 是 | String | http://www.pay.com/notify\_url.php | 服務器異步通知地址 |
| 跳轉通知地址 | return\_url | 否 | String | http://www.pay.com/return\_url.php | 頁面跳轉通知地址 |
| 商品名稱 | name | 是 | String | VIP會員 | 如超過127個字節會自動截取 |
| 商品金額 | money | 是 | String | 1.00 | 單位：元，最大2位小數 |
| 用戶IP地址 | clientip | 是 | String | 192.168.1.100 | 用戶發起支付的IP地址 |
| 設備類型 | device | 否 | String | pc | 根據當前用戶瀏覽器的UA判斷，
傳入用戶所使用的瀏覽器
或設備類型，默認為pc
[設備類型列表](https://epay.jbyun.top/doc.html#pay5) |
| 業務擴展參數 | param | 否 | String | 沒有請留空 | 支付后原樣返回 |
| 簽名字符串 | sign | 是 | String | 202cb962ac59075b964b07152d234b70 | 簽名算法[點此查看](https://epay.jbyun.top/doc.html#pay3) |
| 簽名類型 | sign\_type | 是 | String | MD5 | 默認為MD5 |
返回結果（json）：
| 字段名 | 變量名 | 類型 | 示例值 | 描述 |
| --- | --- | --- | --- | --- |
| 返回狀態碼 | code | Int | 1 | 1為成功，其它值為失敗 |
| 返回信息 | msg | String | | 失敗時返回原因 |
| 訂單號 | trade\_no | String | 20160806151343349 | 支付訂單號 |
| 支付跳轉url | payurl | String | https://epay.jbyun.top/pay/wxpay/202010903/ | 如果返回該字段，則直接跳轉到該url支付 |
| 二維碼鏈接 | qrcode | String | weixin://wxpay/bizpayurl?pr=04IPMKM | 如果返回該字段，則根據該url生成二維碼 |
| 小程序跳轉url | urlscheme | String | weixin://dl/business/?ticket=xxx | 如果返回該字段，則使用js跳轉該url，可發起微信小程序支付 |
注：payurl、qrcode、urlscheme 三個參數只會返回其中一個
### 支付結果通知
通知類型：服務器異步通知（notify\_url）、頁面跳轉通知（return\_url）
請求方式：GET
請求參數說明：
| 字段名 | 變量名 | 必填 | 類型 | 示例值 | 描述 |
| --- | --- | --- | --- | --- | --- |
| 商戶ID | pid | 是 | Int | 1001 | |
| 易支付訂單號 | trade\_no | 是 | String | 20160806151343349021 | 彼云易支付訂單號 |
| 商戶訂單號 | out\_trade\_no | 是 | String | 20160806151343349 | 商戶系統內部的訂單號 |
| 支付方式 | type | 是 | String | alipay | [支付方式列表](https://epay.jbyun.top/doc.html#pay4) |
| 商品名稱 | name | 是 | String | VIP會員 | |
| 商品金額 | money | 是 | String | 1.00 | |
| 支付狀態 | trade\_status | 是 | String | TRADE\_SUCCESS | 只有TRADE\_SUCCESS是成功 |
| 業務擴展參數 | param | 否 | String | | |
| 簽名字符串 | sign | 是 | String | 202cb962ac59075b964b07152d234b70 | 簽名算法[點此查看](https://epay.jbyun.top/doc.html#pay3) |
| 簽名類型 | sign\_type | 是 | String | MD5 | 默認為MD5 |
收到異步通知后，需返回success以表示服務器接收到了訂單通知
### MD5簽名算法
1、將發送或接收到的所有參數按照參數名ASCII碼從小到大排序（a-z），sign、sign\_type、和空值不參與簽名！
2、將排序后的參數拼接成URL鍵值對的格式，例如`a=b&c=d&e=f`，參數值不要進行url編碼。
3、再將拼接好的字符串與商戶密鑰KEY進行MD5加密得出sign簽名參數，`sign = md5 ( a=b&c=d&e=f + KEY )`（注意：+ 為各語言的拼接符，不是字符！），md5結果為小寫。
4、具體簽名與發起支付的示例代碼可下載SDK查看。
### 支付方式列表
| 調用值 | 描述 |
| --- | --- |
| alipay | 支付寶 |
| wxpay | 微信支付 |
| qqpay | QQ錢包 |
### 設備類型列表
| 調用值 | 描述 |
| --- | --- |
| pc | 電腦瀏覽器 |
| mobile | 手機瀏覽器 |
| qq | 手機QQ內瀏覽器 |
| wechat | 微信內瀏覽器 |
| alipay | 支付寶客戶端 |
* * *
### \[API\]查詢商戶信息
URL地址：https://epay.jbyun.top/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 | 商戶密鑰 |
| 商戶狀態 | active | Int | 1 | 1為正常，0為封禁 |
| 商戶余額 | money | String | 0.00 | 商戶所擁有的余額 |
| 結算方式 | type | Int | 1 | 1:支付寶,2:微信,3:QQ,4:銀行卡 |
| 結算賬號 | account | String | admin@pay.com | 結算的支付寶賬號 |
| 結算姓名 | username | String | 張三 | 結算的支付寶姓名 |
| 訂單總數 | orders | Int | 30 | 訂單總數統計 |
| 今日訂單 | order\_today | Int | 15 | 今日訂單數量 |
| 昨日訂單 | order\_lastday | Int | 15 | 昨日訂單數量 |
### \[API\]查詢結算記錄
URL地址：https://epay.jbyun.top/api.php?act=settle&pid={商戶ID}&key={商戶密鑰}
請求參數說明：
| 字段名 | 變量名 | 必填 | 類型 | 示例值 | 描述 |
| --- | --- | --- | --- | --- | --- |
| 操作類型 | act | 是 | String | settle | 此API固定值 |
| 商戶ID | pid | 是 | Int | 1001 | |
| 商戶密鑰 | key | 是 | String | 89unJUB8HZ54Hj7x4nUj56HN4nUzUJ8i | |
返回結果：
| 字段名 | 變量名 | 類型 | 示例值 | 描述 |
| --- | --- | --- | --- | --- |
| 返回狀態碼 | code | Int | 1 | 1為成功，其它值為失敗 |
| 返回信息 | msg | String | 查詢結算記錄成功！ | |
| 結算記錄 | data | Array | 結算記錄列表 | |
### \[API\]查詢單個訂單
URL地址：https://epay.jbyun.top/api.php?act=order&pid={商戶ID}&key={商戶密鑰}&out\_trade\_no={商戶訂單號}
請求參數說明：
| 字段名 | 變量名 | 必填 | 類型 | 示例值 | 描述 |
| --- | --- | --- | --- | --- | --- |
| 操作類型 | act | 是 | String | order | 此API固定值 |
| 商戶ID | pid | 是 | Int | 1001 | |
| 商戶密鑰 | key | 是 | String | 89unJUB8HZ54Hj7x4nUj56HN4nUzUJ8i | |
| 系統訂單號 | trade\_no | 選擇 | String | 20160806151343312 | |
| 商戶訂單號 | out\_trade\_no | 選擇 | String | 20160806151343349 | |
提示：系統訂單號 和 商戶訂單號 二選一傳入即可，如果都傳入以系統訂單號為準！
返回結果：
| 字段名 | 變量名 | 類型 | 示例值 | 描述 |
| --- | --- | --- | --- | --- |
| 返回狀態碼 | code | Int | 1 | 1為成功，其它值為失敗 |
| 返回信息 | msg | String | 查詢訂單號成功！ | |
| 易支付訂單號 | trade\_no | String | 2016080622555342651 | 彼云易支付訂單號 |
| 商戶訂單號 | out\_trade\_no | String | 20160806151343349 | 商戶系統內部的訂單號 |
| 支付方式 | type | String | alipay | [支付方式列表](https://epay.jbyun.top/doc.html#pay4) |
| 商戶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為未支付 |
| 業務擴展參數 | param | String | | 默認留空 |
| 支付者賬號 | buyer | String | | 默認留空 |
### \[API\]批量查詢訂單
URL地址：https://epay.jbyun.top/api.php?act=orders&pid={商戶ID}&key={商戶密鑰}
請求參數說明：
| 字段名 | 變量名 | 必填 | 類型 | 示例值 | 描述 |
| --- | --- | --- | --- | --- | --- |
| 操作類型 | 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 | | 訂單列表 |
