協議(yì)規則
請求數據格式：application/x-www-f我劇orm-urlencoded
返回數據格式：JSON
簽名算(suàn)法：MD5
字符編碼：UTF-8
頁面跳(tiào)轉支付
此接口可用于用戶前台直接發起支付，使用form表單跳(tiào白員)轉或拼接成url跳(tiào)轉。
URL地(dì)址：http://epay.ococn.cn/submit.php
請求方式：POST 或 GET（推薦POST，不容易被劫持或屏蔽務跳）
請求參數說(shuō)明(míng)：
| 字段名 | 變量名 | 必填 | 類型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 商戶ID | pid | 是 | Int | 1001 | |
| 支付方式 | type | 否 | String | alipay | 支付方式列表 |
| 商戶訂單号 | out_trade_no | 是 | String | 20160806151343349 | |
| 異步通(tōng)知地(dì)址 | notify_url | 是 | String | http://www.pay.com/notify_url.p小舊hp | 服務器(qì)異步通(tōng)知地(dì)址 |
| 跳(tiào)轉通(tōng)知地(dì)址 | return_url | 是 | String | http://www.pay.com/return_url.php | 頁面跳(tiào)轉通(tōng)知地(dì)址 |
| 商品名稱 | name | 是 | String | VIP會員(yuán) | 如超過127個(gè)字節會自(zì)動截取 |
| 商品金(jīn)額 | money | 是 | String | 1.00 | 單位：元，最大2位小(xiǎo)數 |
| 業(yè)務擴展參數 | param | 否 | String | 沒有(yǒu)請留空 | 支付後原樣返回 |
| 簽名字符串 | sign | 是 | String | 202cb962ac59075b964b07152d234b70 | 簽名算(suàn)法點此查看(kàn) |
| 簽名類型 | sign_type | 是 | String | MD5 | 默認為(wèi)MD5 |
支付方式（type）不傳會跳(tiào)轉到收銀台支付
API接口支付
此接口可用于服務器(qì)後端發起支付請求，會返回支付二維碼鏈接或支付跳(ti玩件ào)轉url。
URL地(dì)址：http://epay.ococn.cn/mapi.php
請求方式：POST
請求參數說(shuō)明(míng)：
| 字段名 | 變量名 | 必填 | 類型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 商戶ID | pid | 是 | Int | 1001 | |
| 支付方式 | type | 是 | String | alipay | 支付方式列表 |
| 商戶訂單号 | out_trade_no | 是 | String | 20160806151343349 | |
| 異步通(tōng)知地(dì)址 | notify_url | 是 | String | http://www.pay.com/notify_url.php | 服務器(qì)異步通(tōng)知地(dì)址 |
| 跳(tiào)轉通(tōng)知地(dì)址 | return_url | 否 | String | http://www.pay.com/re上師turn_url.php | 頁面跳(tiào)轉通(tōng)知地(dì)址 |
| 商品名稱 | name | 是 | String | VIP會員(yuán) | 如超過127個(gè)字節會自(zì)動截取 |
| 商品金(jīn)額 | money | 是 | String | 1.00 | 單位：元，最大2位小(xiǎo)數 |
| 用戶IP地(dì)址 | clientip | 是 | String | 192.168.1.100 | 用戶發起支付的(de)IP地(dì)址 |
| 設備類型 | device | 否 | String | pc | 根據用戶浏覽器(qì)的(de)UA判斷， 傳入用戶所使用的(de)浏覽器(qì) 或設備類型，默認為(wèi)pc 設備類型列表 |
| 業(yè)務擴展參數 | param | 否 | String | 沒有(yǒu)請留空 | 支付後原樣返回 |
| 簽名字符串 | sign | 是 | String | 202cb962ac59075b964b07152電兵d234b70 | 簽名算(suàn)法點此查看(kàn) |
| 簽名類型 | sign_type | 是 | String | MD5 | 默認為(wèi)MD5 |
返回結果（json）：
| 字段名 | 變量名 | 類型 | 示例值 | 描述 |
|---|---|---|---|---|
| 返回狀态碼 | code | Int | 1 | 1為(wèi)成功，其它值為(wèi)失敗 |
| 返回信息 | msg | String | 失敗時(shí)返回原因 | |
| 訂單号 | trade_no | String | 20160806151343349 | 支付訂單号 |
| 支付跳(tiào)轉url | payurl | String | http://epay.ococn.cn/pa相兒y/wxpay/202010903/ | 如果返回該字段，則直接跳(tiào)轉到該url支付 |
| 二維碼鏈接 | qrcode | String | weixin://wxpay/bizpayu老通rl?pr=04IPMKM | 如果返回該字段，則根據該url生(shēng)成二維碼 |
| 小(xiǎo)程序跳(tiào)轉url | urlscheme | String | weixin://dl/business/?ticket=xxx國爸 | 如果返回該字段，則使用js跳(tiào)轉該url，可發起微(wēi)信小(老靜xiǎo)程序支付 |
注：payurl、qrcode、urlscheme 三個(gè)參數隻會返回其中一個(gè)
支付結果通(tōng)知
通(tōng)知類型：服務器(qì)異步通(tōng)知（notify_u長腦rl）、頁面跳(tiào)轉通(tōng)知（return_url）
請求方式：GET
請求參數說(shuō)明(míng)：
| 字段名 | 變量名 | 必填 | 類型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 商戶ID | pid | 是 | Int | 1001 | |
| 易支付訂單号 | trade_no | 是 | String | 20160806151343349021 | 雲上(shàng)付訂單号 |
| 商戶訂單号 | out_trade_no | 是 | String | 20160806151343349 | 商戶系統內(nèi)部的(de)訂單号 |
| 支付方式 | type | 是 | String | alipay | 支付方式列表 |
| 商品名稱 | name | 是 | String | VIP會員(yuán) | |
| 商品金(jīn)額 | money | 是 | String | 1.00 | |
| 支付狀态 | trade_status | 是 | String | TRADE_SUCCESS | 隻有(yǒu)TRADE_SUCCESS是成功 |
| 業(yè)務擴展參數 | param | 否 | String | ||
| 簽名字符串 | sign | 是 | String | 202cb962ac59075b964b0廠和7152d234b70 | 簽名算(suàn)法點此查看(kàn) |
| 簽名類型 | sign_type | 是 | String | MD5 | 默認為(wèi)MD5 |
收到異步通(tōng)知後，需返回success以表示服務器(qì)接收到了訂單通(t店玩ōng)知
MD5簽名算(suàn)法 物樂
1、将發送或接收到的(de)所有(yǒu)道輛參數按照(zhào)參數名ASCII碼從(cóng)小(上看xiǎo)到大排序（a-z），sign、鐵畫sign_type、和(hé)空值不參與簽名！
2、将排序後的(de)參數拼接成URL鍵值對(du日司ì)的(de)格式，例如 a=b&c=d&e=f，參數值不要進行url編碼。
3、再将拼接好(hǎo)的(de)字符串與商戶密鑰KEY進行MD5加密得從鄉出sign簽名參數，sign = md5 ( a=b&c=d&公科amp;e=f + KEY ) （注意：+ 為(wèi)各語言的(de)拼接符，不是字符！），md5結果為(wèi)小(兒秒xiǎo)寫。
4、具體(tǐ)簽名與發起支付的(de)示例代碼可下紅美(xià)載SDK查看(kàn)。
支付方式列表
| 調用值 | 描述 |
|---|---|
| alipay | 支付寶 |
| wxpay | 微(wēi)信支付 |
設備類型列表
| 調用值 | 描述 |
|---|---|
| pc | 電(diàn)腦浏覽器(qì) |
| mobile | 手機(jī)浏覽器(qì) |
| 手機(jī)QQ內(nèi)浏覽器(qì) | |
| 微(wēi)信內(nèi)浏覽器(qì) | |
| alipay | 支付寶客戶端 |
| jump | 僅返回支付跳(tiào)轉url |
[API]查詢商戶信息
URL地(dì)址：http://epay.ococn.cn/api.php有呢?act=query&pid={商戶ID}&key={商有少戶密鑰}
請求參數說(shuō)明(míng)：
| 字段名 | 變量名 | 必填 | 類型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 操作(zuò)類型 | act | 是 | String | query | 此API固定值 |
| 商戶ID | pid | 是 | Int | 1001 | |
| 商戶密鑰 | key | 是 | String | 89unJUB8HZ54Hj7x4nUj56HN4nUzUJ8i筆美 |
返回結果：
| 字段名 | 變量名 | 類型 | 示例值 | 描述 |
|---|---|---|---|---|
| 返回狀态碼 | code | Int | 1 | 1為(wèi)成功，其它值為(wèi)失敗 |
| 商戶ID | pid | Int | 1001 | 商戶ID |
| 商戶密鑰 | key | String(32) | 89unJUB8HZ54Hj7x4nUj56H放秒N4nUzUJ8i | 商戶密鑰 |
| 商戶狀态 | active | Int | 1 | 1為(wèi)正常，0為(wèi)封禁 |
| 商戶餘額 | money | String | 0.00 | 商戶所擁有(yǒu)的(de)餘額 |
| 結算(suàn)方式 | type | Int | 1 | 1:支付寶,2:微(wēi)信,3:QQ,4:區花銀行卡 |
| 結算(suàn)賬号 | account | String | admin@pay.com | 結算(suàn)的(de)支付寶賬号 |
| 結算(suàn)姓名 | username | String | 張三 | 結算(suàn)的(de)支付寶姓名 |
| 訂單總數 | orders | Int | 30 | 訂單總數統計(jì) |
| 今日(rì)訂單 | order_today | Int | 15 | 今日(rì)訂單數量 |
| 昨日(rì)訂單 | order_lastday | Int | 15 | 昨日(rì)訂單數量 |
[API]查詢結算(suàn)記錄 鄉醫
URL地(dì)址：http://epay.ococn.cn/api.php?act=settle&a算山mp;pid={商戶ID}&key={商戶密鑰}
請求參數說(shuō)明(míng)：
| 字段名 | 變量名 | 必填 | 類型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 操作(zuò)類型 | act | 是 | String | settle | 此API固定值 |
| 商戶ID | pid | 是 | Int | 1001 | |
| 商戶密鑰 | key | 是 | String | 89unJUB8HZ54Hj7x4nUj56HN4nUzUJ8i |
返回結果：
| 字段名 | 變量名 | 類型 | 示例值 | 描述 |
|---|---|---|---|---|
| 返回狀态碼 | code | Int | 1 | 1為(wèi)成功，其它值為(wèi)失對身敗 |
| 返回信息 | msg | String | 查詢結算(suàn)記錄成功！ | |
| 結算(suàn)記錄 | data | Array | 結算(suàn)記錄列表 |
[API]查詢單個(gè)訂單
URL地(dì)址：http://epay.ococn.cn/api.php?act=order務電&pid={商戶ID}&k雪鐵ey={商戶密鑰}&out_trade_no={商戶訂單号}
請求參數說(shuō)明(míng)：
| 字段名 | 變量名 | 必填 | 類型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 操作(zuò)類型 | act | 是 | String | order | 此API固定值 |
| 商戶ID | pid | 是 | Int | 1001 | |
| 商戶密鑰 | key | 是 | String | 89unJUB8HZ54Hj7x4nUj56HN4nUzUJ8i廠這 | |
| 系統訂單号 | trade_no | 選擇 | String | 20160806151343312 | |
| 商戶訂單号 | out_trade_no | 選擇 | String | 20160806151343349 |
提示：系統訂單号 和(hé) 商戶訂單号 二選一傳入即可，如果都(dōu)友媽傳入以系統訂單号為(wèi)準！
返回結果：
| 字段名 | 變量名 | 類型 | 示例值 | 描述 |
|---|---|---|---|---|
| 返回狀态碼 | code | Int | 1 | 1為(wèi)成功，其它值為(wèi)失敗 |
| 返回信息 | msg | String | 查詢訂單号成功！ | |
| 易支付訂單号 | trade_no | String | 2016080622555342651 | 雲上(shàng)付訂單号 |
| 商戶訂單号 | out_trade_no | String | 20160806151343349 | 商戶系統內(nèi)部的(de)訂單号 |
| 第三方訂單号 | api_trade_no | String | 20160806151343349 | 支付寶微(wēi)信等接口方訂單号 |
| 支付方式 | type | String | alipay | 支付方式列表 |
| 商戶ID | pid | Int | 1001 | 發起支付的(de)商戶ID |
| 創建訂單時(shí)間(jiān) | addtime | String | 2016-08-06 22:55:52 | |
| 完成交易時(shí)間(jiān) | endtime | String | 2016-08-06 22:55:52 | |
| 商品名稱 | name | String | VIP會員(yuán) | |
| 商品金(jīn)額 | money | String | 1.00 | |
| 支付狀态 | status | Int | 0 | 1為(wèi)支付成功，0為(wèi)未支付 |
| 業(yè)務擴展參數 | param | String | 默認留空 | |
| 支付者賬号 | buyer | String | 默認留空 |
[API]批量查詢訂單 離高
URL地(dì)址：http://epay.ococn.cn/api是鄉.php?act=orders&pid={商戶ID}&key={商戶密鑰}
請求參數說(shuō)明(míng)：
| 字段名 | 變量名 | 必填 | 類型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 操作(zuò)類型 | act | 是 | String | orders | 此API固定值 |
| 商戶ID | pid | 是 | Int | 1001 | |
| 商戶密鑰 | key | 是 | String | 89unJUB8HZ54Hj7x4nUj56HN4nU著子zUJ8i | |
| 查詢訂單數量 | limit | 否 | Int | 20 | 返回的(de)訂單數量，最大50 |
| 頁碼 | page | 否 | Int | 1 | 當前查詢的(de)頁碼 |
返回結果：
| 字段名 | 變量名 | 類型 | 示例值 | 描述 |
|---|---|---|---|---|
| 返回狀态碼 | code | Int | 1 | 1為(wèi)成功，其它值為(wèi)失敗 |
| 返回信息 | msg | String | 查詢結算(suàn)記錄成功！ | |
| 訂單列表 | data | Array | 訂單列表 |
[API]提交訂單退款
需要先在商戶後台開(kāi)啓訂單退款API接口開(kāi)關，才能調用該接口發起訂黑學單退款
URL地(dì)址：http://epay.ococn.cn/api.php?act=refund
請求方式：POST
請求參數說(shuō)明(míng)：
| 字段名 | 變量名 | 必填 | 類型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 商戶ID | pid | 是 | Int | 1001 | |
| 商戶密鑰 | key | 是 | String | 89unJUB8HZ54Hj7x4nUj56HN4nUzUJ8i | |
| 易支付訂單号 | trade_no | 特殊可選 | String | 20160806151343349021 | 易支付訂單号 |
| 商戶訂單号 | out_trade_no | 特殊可選 | String | 20160806151343349 | 訂單支付時(shí)傳入的(de)商戶訂單号，商家(jiā)自(zì)定義且保證商家森到(jiā)系統中唯一 |
| 退款金(jīn)額 | money | 是 | String | 1.50 | 少數通(tōng)道(dào)需要與原訂單金(jīn科藍)額一緻 |
注：trade_no、out_trade影內_no 不能同時(shí)為(wèi)空，如果都(dōu)傳通亮了以trade_no為(wèi)準
返回結果：
| 字段名 | 變量名 | 類型 | 示例值 | 描述 |
|---|---|---|---|---|
| 返回狀态碼 | code | Int | 1 | 1為(wèi)成功，其它值為(wèi)失敗理器 |
| 返回信息 | msg | String | 退款成功 |
SDK下(xià)載
img/017
SDK版本：V1.3