付款 / 裕富無卡分期申請結果通知

應用場景

Server端方式 (POST) (PaymentInfoURL)
當消費使用BNPL付款方式申請完成後,特店接受申請結果訊息,並回應接收訊息

  • Step1.綠界:以ServerPost方式傳送申請結果訊息至特店的Server網址 [PaymentInfoURL]
  • Step2.特店:收到綠界的申請結果訊息,並判斷檢查碼是否相符
  • Step3.特店:檢查碼相符後,於網頁端回應1|OK

Client端方式 (POST) (ClientRedirectURL)
當消費者申請完成後,綠界一次性反饋申請結果通知,並將頁面導至特店自製頁面

  • Step1.綠界:傳送申請結果並將頁面導至特店的自製頁面網址 (ClientRedirectURL)
  • Step2.特店:收到綠界的申請結果訊息,並判斷檢查碼是否相符

❗ 注意事項:

  • PaymentInfoURL 為裕富已收到無卡分期申請通知,不代表已付款成功,付款結果請依 ReturnURL付款結果通知為主。

HTTPS 傳輸協定

  • Accept :text/html
  • Content Type :application/x-www-form-urlencoded
  • HTTP Method :POST

綠界回傳參數說明

MerchantID String(10)
特店編號

  • 測試環境特店編號
  • 正式環境金鑰取得

MerchantTradeNo String(20)
特店訂單編號

訂單產生時傳送給ECPAY的特店訂單編號

StoreID String(20)
特店旗下店舖代號

提供特店填入分店代號使用,僅可用英數字大小寫混合

RtnCode Int
交易訊息

  • BNPL 回傳值時為2時,交易狀態為申請中,其餘為失敗。

❗ 注意事項:當申請無卡分期時會回傳,不代表已申請成功或付款成功。  

RtnMsg String(200)
交易訊息

TradeNo String(20)
綠界的交易編號

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

TradeAmt Int
交易金額

PaymentType String(20)
特店選擇的付款方式

TradeDate String(20)
訂單成立時間

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

CustomField1 String(50)
自訂名稱欄位1

提供合作廠商使用記錄用客製化使用欄位

CustomField2 String(50)
自訂名稱欄位2

提供合作廠商使用記錄用客製化使用欄位

CustomField3 String(50)
自訂名稱欄位3

提供合作廠商使用記錄用客製化使用欄位

CustomField4 String(50)
自訂名稱欄位4

提供合作廠商使用記錄用客製化使用欄位

CheckMacValue String
檢查碼

特店必須檢查檢查碼[CheckMacValue]來驗證,請參考附錄檢查碼機制

當ChoosePayment參數為使用BNPL付款方式時:

BNPLTradeNo String(64)
無卡分期申請交易編號

BNPLInstallment String(2)  
無卡分期分期期數

❗ 注意事項:當成功申請無卡分期時會回傳,不代表已申請成功或付款成功。  

特店傳出參數說明

收到綠界回傳結果通知,請回傳1|OK,此訊息僅代表特店回應是否已收到綠界回傳通知,並不會影響訂單的狀態。

❗ 注意事項:

接收申請結果通知時,請系統開發人員確認下面事項,以利收到綠界發送的取號完成通知:
(1) 請確認訂單產生的回傳付款網址[PaymentInfoURL]參數中的程式是否已開發完成。
(2) 請確認回傳付款網址[PaymentInfoURL]中的網址,已經開放對外,從貴公司的網域之外也可以通知得到。

申請結果通知會以下表格式參數直接回傳,並以「參數=值」表示,參數與參數之間以&隔開,例:

				
					BNPLTrandeNo=12345678&BNPLInstallment=12&MerchantID=2000132&MerchantTradeNo=Test1513787899&PaymentNo=LLL17355880822&PaymentType=CVS_CVS&RtnCode=2&RtnMsg=apply succeeded&TradeAmt=2000&TradeDate=2017/12/21 00:39:03&TradeNo=17122100383415923452&StoreID=&CustomField1=&CustomField2=&CustomField3=&CustomField4=&CheckMacValue=C25373CE6379BB6116FAE8398F4A8E60B71B289D955F6B8A9D9F53FDCC97F571
				
			

YAML

提供的 YAML 文件用於定義 API 的配置、結構、操作和基礎設施管理等資訊,方便開發人員理解和使用 API。

				
					openapi: 3.1.0
info:
  title: ECPay Bankless Installment Application Result Notification API
  version: 1.0.0
servers:
  - url: PaymentInfoURL 
    description: Production Environment
  - url: PaymentInfoURL 
    description: Testing Environment
paths:
  /payment/number/notification:
    post:
      summary: Bankless Installment Application Result Notification
      description: Notify the merchant of the bankless installment application result.
      requestBody:
        required: true
        content:
          html/text:
            schema:
              type: object
              required:
                - MerchantID
                - MerchantTradeNo
                - RtnCode
              properties:
                    MerchantID:
                      type: string
                      maxLength: 10
                      description: Merchant ID
                    MerchantTradeNo:
                      type: string
                      description: Merchant's trade number
                    StoreID:
                      type: string
                      description: Store identifier
                    RtnCode:
                      type: integer
                      description: Return code
                    RtnMsg:
                      type: string
                      description: Return message
                    TradeNo:
                      type: string
                      description: ECPay trade number
                    TradeAmt:
                      type: integer
                      description: Trade amount
                    PaymentType:
                      type: string
                      description: Payment type
                    TradeDate:
                      type: string
                      format: date-time
                      description: Trade date
                    CustomField1:
                      type: string
                      description: Custom field 1
                    CustomField2:
                      type: string
                      description: Custom field 2
                    CustomField3:
                      type: string
                      description: Custom field 3
                    CustomField4:
                      type: string
                      description: Custom field 4
                    CheckMacValue:
                      type: string
                      description: Check MAC value
                    BNPLTradeNo:
                      type: string
                      description: Bankless installment application transaction number
                    BNPLInstallment:
                      type: string
                      description: Bankless installment installment period
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                type: string
                example: 1|OK
        '400':
          description: Invalid request
        '500':
          description: Server error

				
			

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

綠界官方網站