5 小額支付接口
5.1 小額支付接口
5.1.1 業務功能
收銀員使用掃碼設備讀取微信用戶刷卡授權碼信息，并傳送至商戶收銀臺，由商戶收銀臺或者商戶後臺調 用該接口發起支付對用戶進行收款
5.1.2 交互模式
請求：後臺請求交互模式
返回結果：後臺請求交互模式
5.1.3 請求參數列表
請求url：https://gateway.wepayez.com/pay/gateway
POST XML 內容體進行請求
| 字段名 | 變數名 | 必填 | 類型 | 說明 |
|---|---|---|---|---|
| 接口類型 | service | 是 | String(32) | 接口類型：unified.trade.micropay |
| 版本號 | version | 否 | String(8) | 版本號，version默認值是 2.0 |
| 字元集 | charset | 否 | tring(8) | 字元集，取值： UTF-8 |
| 簽名方式 | sign_type | 否 | String(8) | 簽名類型，取值：MD5 |
| 商戶號 | mch_id | 是 | String(32) | 商戶唯一标识码，由平臺分配 |
| 商戶訂單號 | out_trade_no | 是 | String(32) | 商戶系統內部的訂單號 ,5 到 32 個字元、只能包含字母數字或者下劃線，區分大小寫，確保在商戶系統唯一 |
| 設備號 | device_info | 否 | String(32)終端設備號，商戶自定義。 | |
| 商品描述 | body | 是 | String(127) | 商品描述 |
| 附加資訊 | attach | 否 | String(127) | 商戶附加資訊，可做擴展參數 |
| 總金額 | total_fee | 是 | Int | 金额，以支付货币为准，以分为单位。如支付货币为港币，1000 表示 HKD10.00。测试商户号最大限额 100 分/筆（即 1 元/筆）。 |
| 終端IP | mch_create_ip | 是 | String(16) | 訂單生成的機器 IP |
| 授權碼 | auth_code | 是 | String(128) | 掃碼支付授權碼，設備讀取用戶展示的條碼或者二維碼資訊 |
| 訂單生成時間 | time_start | 否 | String(14) | 訂單生成時間，格式為 yyyymmddhhmmss，如 2009年12月25日9點10分10碼錶示為20091225091010。時區為 GMT+8 beijing。 |
| 訂單超時時間 | time_expire | 否 | String(14) | 訂單失效時間，格式為 yyyymmddhhmmss，如2009年12月27日 9點10分10碼錶示為20091227091010。時區為 GMT+8 beijing。 |
| 操作員 | op_user_id | 否 | String(32) | 操作員帳號,默認為商戶號 |
| 門店編號 | op_shop_id | 否 | String(32) | |
| 設備編號 | op_device_id | 否 | String(32) | |
| 商品標記 | goods_tag | 否 | String(32) | 商品標記 |
| 隨機字串 | nonce_str | 是 | String(32) | 隨機字串，不長於 32位 |
| 簽名 | sign | 是 | String(32) | MD5 簽名結果，詳見“第 4 章 MD5 簽名規則” |
5.1.4 返回結果
POST XML 內容體進行請求
| 字段名 | 變數名 | 必填 | 類型 | 說明 |
|---|---|---|---|---|
| 版本號 | version | 是 | String(8) | 版本號，version 默認值是 2.0。 |
| 字元集 | charset | 是 | String(8) | 字元集，取值： UTF-8 |
| 簽名方式 | sign_type | 否 | String(8) | 簽名類型，取值：MD5 |
| 返回狀態碼 | status | 是 | String(16) | 0 表示成功非 0 表示失敗。此字段是通信標識，非交易標識，交易是否成功需要查看 result_code 來判斷 |
| 返回資訊 | message | 否 | String(128) | 返回資訊，如非空，為錯誤原因簽名失敗參數格式校驗錯誤 |
以下字段在 status 為 0 的時候有返回
| 字段名 | 變數名 | 必填 | 類型 | 說明 |
|---|---|---|---|---|
| 業務結果 | result_code | 是 | String(16) | 0 表示成功非 0 表示失敗 |
| 商戶號 | mch_id | 是 | String(32) | 商戶唯一标识码，由平臺分配 |
| 設備號 | device_info | 否 | String(32) 終端設備號 | |
| 隨機字串 | nonce_str | 是 | String(32) | 隨機字串，不長於 32 位 |
| 錯誤代碼 | err_code | 否 | String(32) | 具體錯誤碼請看文檔最後錯誤碼列表 |
| 錯誤代碼描述 | err_msg | 否 | String(128) | 結果資訊描述 |
| 簽名 | sign | 是 | String(32) | MD5 簽名結果，詳見“第 4 章 MD5 簽名規則” |
| 查詢判斷 | need_query | 否 | String(1) | 用來判斷是否需要調用查詢接口，值為 Y 時需要，值為 N 時不需要 |
以下字段在 status 和 result_code 都為 0 的時候有返回
| 字段名 | 變數名 | 必填 | 類型 | 說明 |
|---|---|---|---|---|
| 用戶標識 | openid | 否 | String(128) | 用戶在服务商 appid 下的唯一標識 |
| 用戶標識 | sub_openid | 否 | String(128) | 用戶在服务商子商戶 appid 下的唯一標識 |
| 交易類型 | trade_type | 是 | String(32) | pay.alipay.micropay.intl——支付寶 |
| 是否關注公眾帳號 | is_subscribe | 否 | String(1) | 用戶是否關注公眾帳號， Y-關注， N-未關注，僅在公眾帳號類型支付有效 支付結果 |
| 支付結果資訊 | pay_info | 否 | String(64) | 支付結果資訊，支付成功時為空 |
| 平臺訂單號 | transaction_id | 是 | String(32) | 平臺交易號 |
| 第三方訂單號 | out_transaction_id | 是 | String(32) | 第三方（Alipay）訂單號 |
| 子商戶是否關注 | sub_is_subscribe | 否 | Int | 用戶是否關注子公眾帳號，0-關注，1-未關注，僅在公眾帳號類型支付有效 |
| 子商戶appid | sub_appid | 否 | String | 子商戶 appid |
| 商戶訂單號 | out_trade_no | 是 | String(32) | 商戶系統內部的訂單號 ,5 到 32 個字元、只能包含字母數字或者下劃線，區分大小寫，確保在商戶系統唯一 |
| 總金額 | total_fee | 是 | Int | 總金額，以分為單位，不允許包含任何字、符號 |
| 現金券金額 | coupon_fee | 否 | Int | 現金券支付金額<=訂單總金額，訂單總金額-現金券金額=現金支付金額 |
| 貨幣種類 | fee_type | 否 | String(8) | 貨幣類型，符合 ISO 4217 標準的三位字母代码 |
| 附加資訊 | attach | 否 | String(127) | 商家數據包，原樣返回 |
| 付款銀行 | bank_type | 否 | String(16) | 銀行類型 |
| 銀行訂單號 | bank_billno | 否 | String(32) | 銀行訂單號，若為支付寶支付則為空 |
| 支付完成時間 | time_end | 是 | String(14) | 支付完成時間，格式為 yyyyMMddhhmmss，如2009 年 12 月 27 日 9 點 10 分 10碼錶示為20091227091010。時區為 GMT+8 beijing。 |
| 現金支付金額 | cash_fee | 是 | Int | 訂單現金支付金額. |
| 現金支付貨幣類型 | cash_fee_type | 否 | String(16) | 貨幣類型，符合 ISO 4217 標準的三位字母代碼。 |
| 匯率 | rate | 是 | String(16) | 用戶支付幣種與商戶結算幣種的兌換比例關係。 |
數據按 XML 的格式即時返回
關於調用支付接口後相關情況的處理方案：
1、 支付請求後：status 和 result code 字段返回都為 0 時，判定訂單支付成功；
2、 支付請求後：status 返回為 0，而 result code 返回不為 0 時，並且返回的參數 need_query 為 N 時，才不 用調查詢接口，其他情況（包括沒有返回 need_query 參數，返回了 need_query 參數但值為 Y）則必須調用訂 單查詢接口進行確認；
3、調用查詢接口建議 ：查詢 6 次每隔 5 秒查詢一次 （具體的查詢次數和時間也可自定義，建議查詢時間不低 於 30 秒）6 次查詢走完， 接口仍未返回成功標識(即查詢接口返回的 trade_state 不是 SUCCESS)則調用撤銷接口進行撤銷；
5.2 撤銷訂單接口
5.2.1 業務功能
當支付返回失敗，或收銀系統超時需要取消交易，可以調用該接口。接口邏輯 ：支付失敗的關單，支付成 功的撤銷支付。
注意：5 分鐘的訂單才可以撤銷，其他正常支付的單如需實現相同功能請調用退款接口。
調用支付接口後請勿立即調用撤銷訂單接口，建議支付後至少 15s 後再調用撤銷訂單接口。
5.2.2 交互模式
請求：後臺請求交互模式
返回結果：後臺請求交互模式
5.2.3 請求參數列表
請求 url：https://gateway.wepayez.com/pay/gateway
POST XML 內容體進行請求
| 字段名 | 變數名 | 必填 | 類型 | 說明 |
|---|---|---|---|---|
| 接口類型 | service | 是 | String(32) | 接口類型：unified.micropay.reverse |
| 版本號 | version | 是 | String(8) | 版本號，version 默認值是 2.0。 |
| 字元集 | charset | 是 | String(8) | 字元集，取值： UTF-8 |
| 簽名方式 | sign_type | 否 | String(8) | 簽名類型，取值：MD5 |
| 商戶號 | mch_id | 是 | String(32) | 商戶唯一标识码，由平臺分配 |
| 商戶訂單號 | out_trade_no | 是 | String(32) | 商戶系統內部的訂單號,5到32個字元、只能包含字母數字或者下劃線，區分大小寫，確保在商戶系統唯一 |
| 隨機字串 | nonce_str | 是 | String(32) | 隨機字串，不長於 32 位 |
| 簽名 | sign | 是 | String(32) | MD5 簽名結果，詳見“第 4 章 MD5 簽名規則” |
5.2.4 返回結果
數據按 XML 的格式即時返回
| 字段名 | 變數名 | 必填 | 類型 | 說明 |
|---|---|---|---|---|
| 版本號 | version | 是 | String(8) | 版本號，version 默認值是 2.0。 |
| 字元集 | charset | 是 | String(8) | 取值： UTF-8。 |
| 簽名方式 | sign_type | 否 | String(8) | 簽名類型，取值：MD5 |
| 返回狀態碼 | status | 是 | String(16) | 0 表示成功非 0 表示失敗。此字段是通信標識，非交易標識，交易是否成功需要查看 result_code來判斷 |
| 返回資訊 | message | 否 | String(128) | 返回資訊，如非空，為錯誤原因簽名失敗參數格式校驗錯誤 |
以下字段在 status 為 0 的時候有返回
| 字段名 | 變數名 | 必填 | 類型 | 說明 |
|---|---|---|---|---|
| 業務結果 | result_code | 是 | String(16) | 0 表示成功非 0 表示失敗 |
| 商戶號 | mch_id | 是 | String(32) | 商戶唯一标识码，由平臺分配 |
| 隨機字串 | nonce_str | 是 | String(32) | 隨機字串，不長於 32 位 |
| 錯誤代碼 | err_code | 否 | String(32) | 具體錯誤碼請看文檔最後錯誤碼列表 |
| 錯誤代碼描述 | err_msg | 否 | String(128) | 結果資訊描述 |
| 簽名 | sign | 是 | String(32) | MD5 簽名結果，詳見“第 4 章 MD5 簽名規則” |
5.3 訂單查詢接口
5.3.1 業務功能
根據商戶訂單號或者平臺訂單號查詢平臺的具體訂單資訊。
5.3.2 交互模式
後臺系統調用交互模式
5.3.3 請求參數列表
請求 url：https://gateway.wepayez.com/pay/gateway
通過 get 或 POST XML 內容體進行請求
| 字段名 | 變數名 | 必填 | 類型 | 說明 |
|---|---|---|---|---|
| 接口類型 | service | 是 | String(32) | 接口類型：unified.trade.micropay |
| 版本號 | version | 否 | String(8) | 版本號，version默認值是 2.0 |
| 字元集 | charset | 否 | tring(8) | 字元集，取值： UTF-8 |
| 簽名方式 | sign_type | 否 | String(8) | 簽名類型，取值：MD5 |
| 商戶號 | mch_id | 是 | String(32) | 商戶唯一标识码，由平臺分配 |
| 商戶訂單號 | out_trade_no | 否 | String(32) | 商戶系統內部的訂單號, out_trade_no和transaction_id 至少一個必填，同時存在 時 transaction_id優先 |
| 平臺訂單號 | transaction_id | 否 | String(32) | 平 臺 交 易 號 , out_trade_no 和 transaction_id 至少一個必填，同時存在 時 transaction_id 優先。 |
| 隨機字串 | nonce_str | 是 | String(32) | 隨機字串，不長於 32 位 |
| 簽名 | sign | 是 | String(32) | MD5簽名結果，詳見“第4章MD5簽名規則” |
5.3.4 返回結果
數據按 XML 的格式即時返回
| 字段名 | 變數名 | 必填 | 類型 | 說明 |
|---|---|---|---|---|
| 版本號 | version | 是 | String(8) | 版本號，version 默認值是 2.0。 |
| 字元集 | charset | 是 | String(8) | 字元集，取值： UTF-8 |
| 簽名方式 | sign_type | 否 | String(8) | 簽名類型，取值：MD5 |
| 返回狀態碼 | status | 是 | String(16) | 0 表示成功非 0 表示失敗。此字段是通信標識，非交易標識，交易是否成功需要查看 result_code 來判斷 |
| 返回資訊 | message | 否 | String(128) | 返回資訊，如非空，為錯誤原因簽名失敗參數格式校驗錯誤 |
以下字段在 status 為 0 的時候有返回
| 字段名 | 變數名 | 必填 | 類型 | 說明 |
|---|---|---|---|---|
| 業務結果 | result_code | 是 | String(16) | 0 表示成功非 0 表示失敗 |
| 商戶號 | mch_id | 是 | String(32) | 商戶唯一标识码，由平臺分配 |
| 設備號 | device_info | 否 | String(32) 終端設備號 | |
| 隨機字串 | nonce_str | 是 | String(32) | 隨機字串，不長於 32 位 |
| 錯誤代碼 | err_code | 否 | String(32) | 具體錯誤碼請看文檔最後錯誤碼列表 |
| 錯誤代碼描述 | err_msg | 否 | String(128) | 結果資訊描述 |
| 簽名 | sign | 是 | String(32) | MD5 簽名結果，詳見“第 4 章 MD5 簽名規則” |
以下字段在 status 和 result_code 都為 0 的時候有返回
| 字段名 | 變數名 | 必填 | 類型 | 說明 |
|---|---|---|---|---|
| 交易狀態 | trade_state | 是 | String(32) | SUCCESS—支付成功REFUND—轉入退款NOTPAY—未支付CLOSED—已關閉REVOKED—已撤銷USERPAYING—用戶支付中PAYERROR—支付失敗(其他原因，如銀行返回失敗) |
以下字段在 trade_state 為 SUCCESS 的時候有返回
| 字段名 | 變數名 | 必填 | 類型 | 說明 |
|---|---|---|---|---|
| 交易類型 | trade_type | 是 | String(32) | pay.alipay.micropay.intl——支付寶 |
| 商戶 appid | appid | 否 | String | 服务商 appid |
| 子商戶 appid | sub_appid | 否 | String | 服务商子商戶 appid |
| 用戶標識 | openid | 否 | String(128) | 用戶在服务商 appid 下的唯一標識 |
| 用戶標識 | sub_openid | 否 | String(128) | 用戶在服务商子商戶 appid 下的唯一標識 |
| 是否關注公眾帳號 | is_subscribe | 否 | String(1) | 用戶是否關注公眾帳號， Y-關注， N-未關注，僅在公眾帳號類型支付有效 |
| 是否關注公眾帳號 | sub_is_subscribe | 否 | String(1) | 用戶是否關注公眾帳號， Y-關注， N-未關注，僅在公眾帳號類型支付有效（子商戶公眾帳號） |
| 平臺訂單號 | transaction_id | 是 | String(32) | 平臺交易號 |
| 第三方交易號 | out_transaction_id | 是 | String(32) | 第三方（Alipay）交易號 |
| 商戶訂單號 | out_trade_no | 是 | String(32) | 商戶系統內部的訂單號 ,5到32個字元、只能包含字母數字或者下劃線，區分大小寫，確保在商戶系統唯一 總金額 |
| 現金券金額 | coupon_fee | 否 | Int | 現金券支付金額<=訂單總金額， 訂單總金額-現金券金額=現金支付金額 |
| 貨幣種類 | fee_type | 否 | String(8) | 貨幣類型，符合 ISO 4217 標準的三位字母代碼。 |
| 附加資訊 | attach | 否 | String(127) | 商家數據包，原樣返回 |
| 付款銀行 | bank_type | 否 | String(16) | 銀行類型 |
| 銀行訂單號 | bank_billno | 否 | String(32) | 銀行訂單號，若為支付宝支付則為空 |
| 支付完成時間 | time_end | 是 | String(14) | 支付完成時間，格式為 yyyyMMddhhmmss，如2009 年 12 月 27 日 9 點 10 分 10 碼錶示為20091227091010。時區為 GMT+8 beijing。該時間取自平臺伺服器 |
| 現金支付金額 | cash_fee | 是 | Int | 現金支付金額訂單現金支付金額，100現金支付 |
| 貨幣類型 | cash_fee_type | 否 | String(16) | 貨幣類型，符合 ISO 4217 標準的三位字母代碼。 |
| 匯率 | rate | 是 | String(16) | 用戶支付幣種與商戶結算幣種的兌換比例關係。 |