API介接说明文件.DOC

Rapid Get Paid 網路金流 API 說明 一、建立帳單 HTTPS API 存取請使用POST方式傳遞，輸入及輸出的參數及組成說明如下表： 請留意帳單編碼資料及驗證碼產生方式 Web Method URL /api_gateway.php? api_key={平台設定的API KEY} order_data={帳單資料編碼} check_sum={資料驗證碼} 輸入 參數型態 欄位名稱 欄位長度 敘述 String api_key 20 平台設定的API KEY String order_data 200 帳單建立的資料編碼字串 先建立一個陣列資料，陣列的欄位名稱須相同如下: $order_data[cus_name]=客戶名稱，必填; $order_data[cus_email]=客戶EMAIL，必填; $order_data[cus_phone]=客戶連絡電話，必填; $order_data[item_amount]=交易金額，必填; $order_data[item_name]=商品名稱，必填; $order_data[item_desc]=商品描述，必填; $order_data[payment_type]=付款方式參數1~7任一，必填”; 1 信用卡, 2 銀聯卡, 3 ATM, 4 7-11 ibon, 5 fami port, 6 支付寶, 7 Paypal $order_data[tradeno]=客戶在貴站的交易編號，必填，不可重複; $order_data[return_url]=客戶完成付款後瀏覽器返回網址; $order_data[cancel_url]=客戶取消付款後瀏覽器返回網址; $order_data[notify_url]=客戶完成付款後平台背景通知貴站已完成交易的網址; notify_url如未填寫，將以平台內API設定的即時交易通知URL為預設。 若平台內也未設，則不做及時通知。 將建立的陣列轉成JSON格式 $encode_data = json_encode($order_data); 將JSON資料進行BASE64編碼 $base64_data = base64_encode($encode_data); String check_sum 30 資料驗證碼 將交易資料BASE64編碼後的字串接上您的API SECRET，並將該字串進行md5編碼 $check_sum = md5($base64_data.$api_secret); 輸出 (json資料型態) Bool stats True/False 建立成功或失敗 String error_code 3 訊息代碼 000 成功 101 平台API KEY不正確 102 平台API SECRET或資料參數錯誤 201 帳單資料不全 202 帳單資料錯誤 203 金額超過上限 204 金額未達下限 205 自訂交易序號錯誤 301 付款方式錯誤 302 付款方式停用 303 未驗證用戶選擇信用卡付款方式 String error_msg 20 成功或錯誤說明 Array data Array 帳單建立成功時提供 $data[‘rgp_trade_id’]=Rapid Gat Paid的交易編號 $data[‘payment_url’]=付款頁面網址，請將使用者瀏覽器導向該網址，ATM或ibon及fami port無須導向 如為ATM或ibon及fami port方式會額外提供的詳細資料: ATM $data[‘payment_url’]=付款頁面網址，請將使用者瀏覽器導向該網址 $data[‘bank_code’] =繳費銀行代碼 $data[‘bank_account’] =繳費銀行帳號 $data[‘expired’]=繳費期限 ibon及fami port $data[‘pay_code’]=繳費代碼 $data[‘expired’]=繳費期限 二、接收交易成功通知 請先至平台API設定頁面設定即時交易通知URL 如果您是建立帳單時有填寫notify_url，則以建立帳單時為接收網址 我們將會在帳單完成付款時發出首次通知，如未正常回應，將每三分鐘傳送一次，最多傳送八次。我們將以POST方式傳送，您接收的URL僅需要回應ok字串即可 Web Method URL http://yourcallbackurl/receive.php? api_key={平台設定的API KEY} order_data={帳單資料編碼} check_sum={資料驗證碼} simulation={是否為模擬觸發} 輸入 參數型態 欄位名稱 欄位長度 敘述 String api_ke