| Id | Name | Description | Type | Additional Information |
|---|---|---|---|---|
| 1 | agent_uid | 經銷商商務代號 |
string | 必填 |
| 2 | service | 服務名稱 |
string |
必填
JSON格式,AES256加密資料 |
| 3 | encry_data | 『請求修改定期定額網址』欄位資料 | string | 必填『請求修改定期定額網址』欄位參考 JSON格式,AES256加密資料 |
| Id | Name | Description | Type | Additional Information |
|---|---|---|---|---|
| 1 | store_uid | 特約商店商務代號 |
string | 必填 |
| 2 | service | 服務名稱 |
string | 必填
JSON格式,AES256加密資料 |
| 3 | encry_data | 『請求修改定期定額網址』欄位資料 | string | 必填『請求修改定期定額網址』欄位參考 JSON格式,AES256加密資料 |
| Id | Name | Description | Type | Additional Information |
|---|---|---|---|---|
| 1 | store_uid | 特約商店代碼 | string | 必填 |
| 2 | order_id | 請求編號(請求編號最長為50bytes),不可重複 | string | 必填 |
| 3 | original_order_id | 原始單號 | string | 必填 |
| 4 | notify_before | 扣款前通知 | string | 『扣款通知』值參考 |
| 5 | notify_before_message | 通知內容 | string | |
| 6 | notify_after | 扣款後通知 | string | 『扣款通知』值參考 |
| 7 | notify_after_message | 通知內容 | string | |
| 8 | retry_enable | 扣款失敗後,是否啟用重扣機制(預設1) | int | 非必填 『扣款失敗後,重扣是否啟用』值參考 |
| 9 | fail_notify_delay | 扣款失敗,延遲幾日後重扣,單位:日 | string | |
| 10 | retry_time | 扣款失敗後,要重試幾次重扣 | string | |
| 11 | pay_mode_uid | 付款方式 | integer | 非必填 『卡片類型定義』值參考 |
| 12 | card_lock | 信用卡資料是否解鎖(預設0) | integer | 非必填 『更新頁面設定鎖』值參考 |
| 13 | member_lock | 會員資料鎖(預設0) | integer | 非必填 『更新頁面設定鎖』值參考 |
| 14 | name | 扣款人姓名 | string | 非必填 |
| 15 | debtor_type | 扣款人身份類型(預設) | integer | 非必填 『證號類型』值參考 |
| 16 | debtor_id | 扣款人證號 | string | 非必填 |
| 17 | phone_code | 扣款人手機國碼 | string | 非必填 |
| 18 | phone | 扣款人手機 | string | |
| 19 | 扣款人電子信箱 | string | ||
| 20 | store_member_id | 網站會員ID | string | |
| 21 | currency | 幣別(目前強制為TWD) | string | |
| 22 | cost | 每期應扣金額 | string | 非必填 |
| 23 | invoice_lock | 發票/收據 鎖(預設0) | int | 非必填 『更新頁面設定鎖』值參考 |
| 24 | invoice_type | 發票類型(預設0) | integer | 非必填 『單據類型』值參考 |
| 25 | cloud_type | 雲端載具類型(預設0) | int | 非必填 『雲端發票類型』值參考 |
| 26 | invoice_mobile_code | 當cloud_type為2時紀錄的手機條碼 | string | |
| 27 | invoice_natural_person | 當cloud_type為3時紀錄的自然人憑證條碼 | string | |
| 28 | invoice_love_code | 當input_type為2時紀錄的愛心碼 | string | |
| 29 | tong_bian | 發票統編 | string | 非必填 |
| 30 | donation_statistics_type | 捐款收據統計模式(預設0),當invoice_type為5時必填,且不能為0 | int | 依狀況必填 『捐款收據統計模式』值參考 |
| 31 | donation_identity_type | 捐款收據收件對象當invoice_type為5時必填,且不能為0 | int | 依狀況必填 『捐款單位』值參考 |
| 32 | donation_type_no | 捐款收據對象身分證或統編,當donation_identity_type為1時填身分證2填統編,當donation_identity_type為1時必填 | string | |
| 33 | donation_type_name | 捐款收據對象姓名或公司名稱,當donation_identity_type為1時填姓名2填公司名稱,當donation_identity_type為1時必填 | string | |
| 34 | invoice_receipt_zip_code | 捐款收據地址郵政區碼 | string | |
| 35 | invoice_receipt_city | 捐款收據地址縣市 | string | |
| 36 | invoice_receipt_district | 捐款收據地址鄉區 | string | |
| 37 | invoice_receipt_address | 捐款收據地址 | string | |
| 38 | edit_debit_lock | 扣款設定是否解鎖(預設0) | int | 非必填 『更新頁面設定鎖』值參考 |
| 39 | debit_setting_type | 扣款設定異動(預設0) | int | 非必填 『』值參考 |
| 40 | stop_date | 停扣日,格式:YYYY-MM-DD | string | 非必填 |
| 41 | delay_start_date | 延扣起始日 | string | |
| 42 | delay_end_date | 延扣結束日 | string | |
| 43 | stop_reason | 停扣、延扣原因 | string | |
| 44 | uniform_invoice_tax_name | 免用統一發票買受人 | string | |
| 45 | uniform_invoice_tax_id | 免用統一發票買受人統編 | string | |
| 46 | echo_lock | 自訂資料鎖(預設0) | int | 非必填 『更新頁面設定鎖』值參考 |
| 47 | echo_0 | 自訂回傳1 | string | 非必填 |
| 48 | echo_1 | 自訂回傳2 | string | 非必填 |
| 49 | echo_2 | 自訂回傳3 | string | 非必填 |
| 50 | echo_3 | 自訂回傳4 | string | 非必填 |
| 51 | echo_4 | 自訂回傳5 | string | 非必填 |
| 52 | success_returl | 修改成功後回傳網址 | string | |
| 53 | failure_returl | 修改失敗後回傳網址 | string |
| Id | Name | Description | Type | Additional Information |
|---|---|---|---|---|
| 1 | code | 回應代碼 | string | 『執行結果代碼』值參考 |
| 2 | msg | 回應說明 | string | |
| 3 | page_code | 頁面代碼 | string | |
| 4 | url | 頁面網址 | string |
| Value | Description | Type | Additional Information |
|---|---|---|---|
| 0 | 不通知 | ||
| 1 | |||
| 2 | 簡訊 |
| Value | Description | Type | Additional Information |
|---|---|---|---|
| 0 | 否 | ||
| 1 | 是 |
| Value | Description | Type | Additional Information |
|---|---|---|---|
| 1 | 信用卡 | ||
| 9 | 海外信用卡 | ||
| 29 | 美國運通 |
| Value | Description | Type | Additional Information |
|---|---|---|---|
| 0 | 不解除 | ||
| 1 | 解除 |
| Value | Description | Type | Additional Information |
|---|---|---|---|
| 1 | 身份證字號(預設) | integer | |
| 2 | 統一證號 | integer | |
| 3 | 護照號碼 | integer |
| Value | Description | Type | Additional Information |
|---|---|---|---|
| 0 | 不開 | ||
| 1 | 雲端發票 | ||
| 2 | 捐贈 | ||
| 4 | 免用統一發票收據 | ||
| 5 | 捐贈收據 |
| Value | Description | Type | Additional Information |
|---|---|---|---|
| 0 | 未使用雲端發票類型 | integer | |
| 2 | 手機條碼 | integer | |
| 3 | 自然人憑證條碼 | integer | |
| 4 | 以E-Mail寄送 | integer |
| Value | Description | Type | Additional Information |
|---|---|---|---|
| 0 | 無作用 | ||
| 1 | 單筆 | ||
| 2 | 年度 |
| Value | Description | Type | Additional Information |
|---|---|---|---|
| 0 | 無作用,預設 | ||
| 1 | 個人 | ||
| 2 | 公司 |
| Value | Description | Type | Additional Information |
|---|---|---|---|
| 0 | 不異動 | ||
| 1 | 停扣 | ||
| 2 | 延扣 |
| Value | Description | Type | Additional Information |
|---|---|---|---|
| 100 | 系統收到資料不正確。 | string | |
| 200 | 系統收到正確資料。 | string | |
| 400 | 系統錯誤 | string |
1、所有的API送出HTTPs請求之欄位中,service 和 encry_data 欄位皆進行 AES256+BASE64 加密處理。
2、AES加密,格式為CBC,長度為256bits,金鑰長度32,IV長度16,傳遞內文為加密後組合IV並經過Base64轉換後傳出。
方式:
使用自訂的AES256函式將JSON資料加密後,再將IV資料和此AES256加密後的JSON資料串聯後,使用base64再進行加密成ASCII字串即可完成加密。