直播主收款網址API技術文件

付款成功通知 / ReturnURL

應用場景

Server端方式(POST)(ReturnURL)
當消費者付款完成後，特店接受綠界的付款結果訊息，並回應接收訊息

  • Step1.綠界：以ServerPost方式傳送付款結果訊息至特店的Server網址(ReturnURL)
  • Step2.特店：收到綠界的付款結果訊息，回應1|OK

❗ 注意事項：

  • 僅通知付款成功的結果，付款失敗或待付款則不通知。
  • ATM、CVS、BARCODE可透過廠商管理後台的『模擬付款』，來確認ReturnURL是否正確接收付款結果通知。
  • 付款結果通知常見付款狀態未更新原因說明。
  • 1|OK僅是廠商回應綠界是否收到通知，並不會改變付款狀態。

HTTPS 傳輸協定

  • Accept ：text/html
  • Content Type：application/json
  • HTTP Method：POST

綠界Response參數說明 (Json格式)

MerchantID String(10)
特店編號 

RpHeader JSON
回傳資料 

Timestamp Number
回傳時間 

時間戳 Unix timestamp

TransCode Int
回傳代碼 

1 代表 API 傳輸資料 (MerchantID, RqHeader, Data) 接收成功，實際的API執行結果狀態請參考 RtnCode 參數

TransMsg String(200)
回傳訊息 

Data String
加密資料 

此為加密過的 JSON 格式資料，解密方式請參考參數解密方式說明

CheckMacValue String
檢查碼 

請參考附錄檢查碼機制進行計算

綠界Response參數範例 (Json格式)

{
    "MerchantID": "3002607",
    "RpHeader": {
        "Timestamp": 1234564848
    },
    "TransCode": 1,
    "TransMsg": "Success",
    "Data": "…",
    "CheckMacValue":"…"
}

Data參數說明(Json格式)

RtnCode Int
交易狀態

1 代表 API 執行成功。

RtnMsg String(200)
回應訊息

MerchantID String(10)
特店編號

DonateURL String(200)
贊助收款網址

於直播主收款功能產出的收款網址

SimulatePaid Int
是否為模擬付款

當交易為模擬付款時，才會回傳此欄位。回傳值為:

  • 0: 代表此交易非模擬付款
  • 1 : 代表此交易為模擬付款，並非是由消費者實際真的付款。所以綠界也不會撥款給特店，請勿對該筆交易做出貨等動作，以避免損失。

❗ 注意事項：

  • 特店可透過廠商後台來針對單筆訂單模擬綠界回傳付款通知，以方便介接API。
  • 此功能僅只是用於測試ReturnURL是否能成功接收，不會改變付款狀態。

OrderInfo JSON
訂單資訊 

MerchantTradeNo String(20)
特店交易編號 

TradeNo String(20)
綠界交易編號 

請保存綠界的交易編號與特店交易編號MerchantTradeNo的關聯。

TradeAmt Int
交易金額 

TradeDate String(20)
訂單成立時間 

格式為 yyyy/MM/dd HH:mm:ss

PaymentType String(20)
付款方式 

回傳內容請參考回覆付款方式一覽表。

PaymentDate String(20)
付款時間 

格式為 yyyy/MM/dd HH:mm:ss

❗ 注意事項：

  • 當付款方式為ATM、超商條碼、超商代碼時，付款時間會以銀行與超商告知綠界的銷帳時間為主。
  • 如直播主有即時接收當下付款成功通知的應用，請留意付款時間。

ChargeFee Number
手續費 

TradeStatus String(8)
交易狀態 

  • 0 :代表交易訂單成立未付款
  • 1 : 代表交易訂單成立已付款

PatronName String(100)
贊助者名稱 

PatronNote String(100)
贊助者留言 

LivestreamURL String(200)
直播頻道網址 

實況主收款設定時，如沒填寫此欄位則回傳空字串。

Data參數範例(Json格式)

{
    "RtnCode": 1,
    "RtnMsg": "Success",
    "MerchantID": "3002607",
    "DonateURL":"https://aa.aa.aa",
    "OrderInfo": {
        "MerchantTradeNo": "20180914001",
        "TradeNo": "1809261503338172",
        "TradeDate" :"2018/09/26 14:59:54",
        "TradeAmt":100,
        "PaymentType":"Credit_CreditCard",
        "PaymentDate":"2018/09/26 14:59:54",
        "TradeStatus":1,
        "ChargeFee":1.3
    },
    "PatronName":"王大明",
    "PatronNote":"贊助愛心捐款",
    "SimulatePaid":0,
    "LivestreamURL":"https://bb.bb.bb"
}
❗ 注意事項：
  1. 若未正確回應1|OK，系統會隔5~15分鐘後重發訊息給特店，當天重複發送四次。
  2. 若特店持續收到綠界回傳付款資訊，此時請檢查是否未正確回應1|OK給綠界，常見錯誤回傳值為(“1|OK”、1|ok、_OK 、1\OK、空白 )。
  3. 若遇消費者已付款，但未收到綠界回傳付款完成資訊，此時請檢查接收回傳參數的伺服器是否服務正常，導致無法接收。請參考：無法收到綠界回傳的付款結果通知
  4. 當模擬付款SimulatePaid的值為1時，表示此筆訂單資訊是由綠界廠商後台模擬付款按鈕所發送的回傳付款通知測試資訊，並非是由消費者實際真的付款，所以綠界也不會撥款給特店，請勿對該筆交易做出貨等動作，以避免損失。
  5. 特店務必判斷交易狀態RtnCode是否為1，若非1時請勿對該筆交易做出貨動作，並取得交易訊息RtnMsg記錄失敗原因。

Copyright © Green World FinTech Service Co., Ltd. All rights reserved.

綠界官方網站