{"openapi":"3.0.1","info":{"title":"21PAY API","description":"21PAYPayment API","contact":{"email":"MayChen@twstar.app"},"license":{"name":"Apache 2.0","url":"http://www.apache.org/licenses/LICENSE-2.0.html"},"version":"1.1.0"},"servers":[{"description":"正式URL請跟客服人員詢問","url":"https://virtserver.swaggerhub.com/M8971/21PAY-API/1.1.0"}],"security":[{"apiKey":[]},{"appId":[]}],"tags":[{"name":"訂單 API / 订单接口","description":"充值、提現訂單輸入與查詢 / 充值、提现订单输入与查询"},{"name":"帳戶 API / 帐户接口","description":"列出所有帳戶餘額 / 列出所有帐户余额"}],"paths":{"/order":{"get":{"tags":["訂單 API / 订单接口"],"summary":"API 連線測試 / 接口连线测试","description":"供 API 連線測試用 / 供接口连线测试用","responses":{"200":{"description":"API 連線正常 / 接口连线正常","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"boolean","description":"狀態","example":true},"data":{"type":"object","properties":{}},"error":{"type":"string","description":"錯誤訊息","example":""}}}}}},"401":{"description":"API 拒絕連線","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"boolean","description":"狀態","example":false},"data":{"type":"object","properties":{},"example":{}},"error":{"type":"string","description":"錯誤訊息","example":"Permission Deny"}}}}}}}}},"/order/recharge":{"post":{"tags":["訂單 API / 订单接口"],"summary":"充值 / 儲值","description":"有3種串接模式 (Optional 的項目請依照客服告知的為準)\n* TransactionType = 1 (一般轉帳)\n  * 需要傳入 TransactionData / TransactionAmount 以建立儲值單資訊\n  * 返回資訊 (依通道情況欄位可能有些許差異, 請依照客服告知為準)\n  * BankNumber / BankBranchName / BankName / AccountNumber / AccountName \n* TransactionType = 3 (超商CVS)\n  * 需要傳入 TransactionAccountName / StoreId (Optional) / TransactionAmount 即可建立儲值單\n  * 返回資訊 IbonCode / ShortUrl / BillAmount(帳單金額包含手續費)\n* TransactionType = 4 (信用卡)\n  * 需要參數 TransactionAccountName / TransactionAmount / TransactionAccountNumber\n  * 返回資訊 PaymentUri(付款網址) / PaymentImg(付款二維碼) 兩個擇一使用\n* TransactionType = 5 (加密貨幣)\n  * 需要參數 TransactionAmount / TransactionMethod (Optional)\n  * 返回資訊 PaymentUri(付款網址)\n* TransactionType = 6 (二維碼)\n  * 需要參數 TransactionAccountName / TransactionAmount\n  * 返回資訊 PaymentUri(付款網址)\n* TransactionType = 7 (虛擬ATM)\n  * 需要參數 TransactionRemark (Optional 商品資訊) / TransactionAmount\n  * 返回資訊 BankNumber / AccountNumber / ExpireDate\n","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["TransactionType","TransactionData","TransactionAmount","TransactionCode","TransactionAccountName","TransactionAccountNumber","StoreId","Version"],"type":"object","properties":{"TransactionType":{"type":"string","description":"付款方式( 1 / 3 ~ 7 詳情請看上方說明)"},"AccountType":{"type":"string","description":"(目前未額外提供)"},"TransactionData":{"type":"string","description":"請傳入銀行代碼+帳戶名稱+銀行卡號的json資訊, 多筆帳戶請三個參數一組, 不要將多個AccountNumber放置在一起 [{\"BankNumber\":\"012\",\"AccountName\":\"王小明\",\"AccountNumber\":\"000123456789\"},{\"BankNumber\":\"013\",\"AccountName\":\"王小明\",\"AccountNumber\":\"000123412345\"},{\"BankNumber\":\"014\",\"AccountName\":\"王小明\",\"AccountNumber\":\"0001234100001\"}]","example":[{"BankNumber":"012","AccountName":"王小明","AccountNumber":"000123456789"},{"BankNumber":"013","AccountName":"王小明","AccountNumber":"000123412345"}]},"TransactionAccountName":{"type":"string","description":"交易方姓名"},"TransactionIdNumber":{"type":"string","description":"交易方身分證號"},"TransactionPhoneNumber":{"type":"string","description":"交易方電話號碼"},"StoreId":{"type":"string","description":"超商門市代碼, 多組請用半形逗號[,]分隔"},"TransactionAccountNumber":{"type":"string","description":"信用卡末四碼, 如果繳款後末四碼不符, 訂單會退回處理 (多組卡號可使用半形逗號分隔)"},"TransactionAmount":{"type":"number","description":"交易金額"},"TransactionCode":{"type":"string","description":"名稱代碼(自定義訂單編號或流水編碼, 預設會驗證是否有重複) 最大32字元"},"TransactionMethod":{"type":"number","description":"10001:信用卡, 501:Apple Pay, 701:Google Pay"},"Callback":{"type":"string","description":"回傳網址"},"Version":{"type":"string","description":"程式版本 1.1","default":"1.1"}}}}},"required":true},"responses":{"200":{"description":"API 收單成功","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"boolean","description":"狀態","example":true},"data":{"$ref":"#/components/schemas/ResponseData_type_recharge"},"error":{"$ref":"#/components/schemas/ErrorMessage200"}}}}}},"401":{"description":"API 拒絕連線","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"boolean","description":"狀態","example":false},"data":{"type":"object","properties":{},"example":{}},"error":{"type":"string","description":"錯誤訊息","example":"Permission Deny"}}}}}}}}},"/order/withdraw":{"post":{"tags":["訂單 API / 订单接口"],"summary":"提現 / 下发","description":"有2種串接模式\n* TransactionType = 1 (一般轉帳)\n  * 需要傳入 BankNumber / AccountName / AccountNumber / TransactionAmount \n  * BankBranchName & BankBranchNumber 依情況必填(請以客服告知為準)\n","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["TransactionType","BankNumber","BankBranchName","BankBranchNumber","AccountName","AccountNumber","TransactionAmount"],"type":"object","properties":{"TransactionType":{"type":"string","description":"付款方式 1"},"BankNumber":{"type":"string","description":"交易方銀行編號 (系統會依照編號對應銀行名稱)"},"BankBranchName":{"type":"string","description":"交易方銀行分行名稱"},"BankBranchNumber":{"type":"string","description":"交易方銀行分行代碼"},"AccountName":{"type":"string","description":"交易方名稱"},"AccountNumber":{"type":"string","description":"交易方銀行卡號"},"IdNumber":{"type":"string","description":"交易方身分證號"},"PhoneNumber":{"type":"string","description":"手機號碼"},"TransactionAmount":{"type":"number","description":"交易金額"},"TransactionCode":{"type":"string","description":"名稱代碼(自定義訂單編號或流水編碼, 預設會驗證是否有重複)"},"Remark":{"type":"string","description":"備註"},"Callback":{"type":"string","description":"回傳網址"},"Version":{"type":"string","description":"程式版本","default":"1.0"}}}}},"required":true},"responses":{"200":{"description":"API 收單成功","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"boolean","description":"狀態","example":true},"data":{"$ref":"#/components/schemas/ResponseData"},"error":{"$ref":"#/components/schemas/ErrorMessage200"}}}}}},"401":{"description":"API 拒絕連線","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"boolean","description":"狀態","example":false},"data":{"type":"object","properties":{},"example":{}},"error":{"type":"string","description":"錯誤訊息","example":"Permission Deny"}}}}}}}}},"/order/query":{"post":{"tags":["訂單 API / 订单接口"],"summary":"查詢單筆訂單 / 查询单笔订单","description":"供客戶以訂單編號查詢訂單資訊","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["OrderType"],"type":"object","properties":{"OrderType":{"type":"string","description":"訂單種類(recharge 或 withdraw)","enum":["recharge","withdraw"]},"SerialNumber":{"type":"string","description":"訂單編號 (我方的訂單編號, 跟TransactionCode兩個參數選擇一個帶入即可)"},"TransactionCode":{"type":"string","description":"名稱代碼(自定義訂單編號或流水編碼, 跟SerialNumber兩個參數選擇一個帶入即可)"}}}}},"required":true},"responses":{"200":{"description":"API 訂單資訊，定義請參照 Models > OrderData","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"boolean","description":"狀態","example":true},"data":{"$ref":"#/components/schemas/OrderData"},"error":{"$ref":"#/components/schemas/ErrorMessage200"}}}}}},"401":{"description":"API 拒絕連線","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"boolean","description":"狀態","example":false},"data":{"type":"object","properties":{},"example":{}},"error":{"type":"string","description":"錯誤訊息","example":"Permission Deny"}}}}}}}}},"/order/list":{"post":{"tags":["訂單 API / 订单接口"],"summary":"查詢多筆訂單 / 查询多筆订单","description":"供客戶以區間查詢訂單資訊","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["OrderType"],"type":"object","properties":{"OrderType":{"type":"string","description":"訂單種類","enum":["recharge","withdraw"]},"StartDate":{"type":"string","description":"起始日期"},"EndDate":{"type":"string","description":"結束日期"}}}}},"required":true},"responses":{"200":{"description":"API 訂單資訊，定義請參照 Models > OrderList","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"boolean","description":"狀態","example":true},"data":{"$ref":"#/components/schemas/OrderList"},"error":{"$ref":"#/components/schemas/ErrorMessage200"}}}}}},"401":{"description":"API 拒絕連線","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"boolean","description":"狀態","example":false},"data":{"type":"object","properties":{},"example":{}},"error":{"type":"string","description":"錯誤訊息","example":"Permission Deny"}}}}}}}}},"/account/list":{"get":{"tags":["帳戶 API / 帐户接口"],"summary":"查詢所有帳戶資訊 / 查询所有帐户资讯","description":"提供客戶查詢帳戶資訊 / 提供客户查询帐户资讯","responses":{"200":{"description":"API 帳戶資訊，定義請參照 Models > AccountList","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"boolean","description":"狀態","example":true},"data":{"$ref":"#/components/schemas/AccountList"},"error":{"type":"string","description":"錯誤訊息","example":""}}}}}},"400":{"description":"API 查詢失敗","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"boolean","description":"狀態","example":false},"data":{"type":"object","properties":{}},"error":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"401":{"description":"API 拒絕連線","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"boolean","description":"狀態","example":false},"data":{"type":"object","properties":{},"example":{}},"error":{"type":"string","description":"錯誤訊息","example":"Permission Deny"}}}}}}}}},"/account/balance":{"get":{"tags":["帳戶 API / 帐户接口"],"summary":"查詢帳戶餘額 / 查询帐户余额","description":"提供客戶查詢查詢帳戶餘額 / 提供客户查询帐户余额","responses":{"200":{"description":"API 餘額資訊","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"boolean","description":"狀態","example":true},"data":{"$ref":"#/components/schemas/BalanceData"},"error":{"type":"string","description":"錯誤訊息","example":""}}}}}},"400":{"description":"API 查詢失敗","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"boolean","description":"狀態","example":false},"data":{"type":"object","properties":{}},"error":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"401":{"description":"API 拒絕連線","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"boolean","description":"狀態","example":false},"data":{"type":"object","properties":{},"example":{}},"error":{"type":"string","description":"錯誤訊息","example":"Permission Deny"}}}}}}}}}},"components":{"schemas":{"ErrorMessage":{"type":"string","description":"錯誤訊息:\n  * Permission Deny - 驗證失敗 (SN/API Key有誤 或 IP位置不可連接)\n  * TransactionBankNumber::Required - 交易方銀行代碼為必要參數\n  * TransactionAccountNumber::Required - 交易方銀行卡號為必要參數\n  * TransactionAccountName::Required - 交易方名稱為必要參數\n  * TransactionPostCode::Required - 交易方郵遞區號為必要參數\n  * TransactionAddress::Required - 交易方地址為必要參數\n  * TransactionIdNumber::Required - 交易方身分證號為必要參數\n  * TransactionPhoneNumber::Required - 交易方電話為必要參數\n  * StoreId::Required - 超商門市代碼為必要參數\n  * TransactionData::Required - Version 1.1 時必填\n  * TransactionData::InvalidJSON - 字串解析失敗, 請檢查是否符合json格式\n  * TransactionData::Row {index} Missing `{key}` - json資料內, 某一筆(index)缺少需要欄位(key)資訊\n  * TransactionData::Row {index} Invalid `BankNumber` - json資料內, 某一筆(index)的BankNumber格式錯誤, 必須皆為數字字串\n  * TransactionData::Row {index} Invalid `AccountNumber` - json資料內, 某一筆(index)的AccountNumber格式錯誤, 必須皆為數字字串\n  * TransactionType::Required - 付款方式為必要參數\n  * TransactionType::Value = 1 or 3 - 付款方式錯誤, 只接受 1 or 3 的值\n  * TransactionType::3::SendCVS::Error - 超商取號失敗, 請聯繫技術人員\n  * AccountType::Required - 付款方式為3時必填\n  * AccountType::Value = (目前未額外提供)\n  * TransactionAmount::Required - 交易金額為必要參數\n  * TransactionAmount::NoAccountsAvailable - 拒絕交易, 沒有帳戶可提供或是訂單金額超過(低於)限制\n  * TransactionAmount::OutOfTodayLimit - 拒絕交易, 超過每日限額或筆數限制\n  * OrderType::Required - 訂單種類為必要參數\n  * OrderType::Unsupported - 訂單種類錯誤，僅允許 recharge 與 withdraw\n  * SerialNumber::Required - 訂單編號為必要參數\n  * SerialNumber::No21ound - 找不到此訂單\n  * TransactionCode::AlreadyHave - 名稱代碼已存在\n  * Order::RepeatPost - 重複送單(5分鐘內的訂單以下欄位全部相同,金額,銀行名稱,分行名稱,交易方名稱,交易方卡號)\n  * Version::Error - 版本錯誤, 目前只允許 1.0 跟 1.1\n","example":"Field::ErrorMessage"},"ErrorMessage200":{"type":"string","description":"錯誤訊息:\n  * Permission Deny - 驗證失敗 (SN/API Key有誤 或 IP位置不可連接)\n  * TransactionBankNumber::Required - 交易方銀行代碼為必要參數\n  * TransactionAccountNumber::Required - 交易方銀行卡號為必要參數\n  * TransactionAccountName::Required - 交易方名稱為必要參數\n  * TransactionPostCode::Required - 交易方郵遞區號為必要參數\n  * TransactionAddress::Required - 交易方地址為必要參數\n  * TransactionIdNumber::Required - 交易方身分證號為必要參數\n  * TransactionPhoneNumber::Required - 交易方電話為必要參數\n  * StoreId::Required - 超商門市代碼為必要參數\n  * TransactionData::Required - Version 1.1 時必填\n  * TransactionData::InvalidJSON - 字串解析失敗, 請檢查是否符合json格式\n  * TransactionData::Row {index} Missing `{key}` - json資料內, 某一筆(index)缺少需要欄位(key)資訊\n  * TransactionData::Row {index} Invalid `BankNumber` - json資料內, 某一筆(index)的BankNumber格式錯誤, 必須皆為數字字串\n  * TransactionData::Row {index} Invalid `AccountNumber` - json資料內, 某一筆(index)的AccountNumber格式錯誤, 必須皆為數字字串\n  * TransactionType::Required - 付款方式為必要參數\n  * TransactionType::Value = 1 or 3 - 付款方式錯誤, 只接受 1 or 3 的值\n  * TransactionType::3::SendCVS::Error - 超商取號失敗, 請聯繫技術人員\n  * AccountType::Required - 付款方式為3時必填\n  * AccountType::Value = (目前未額外提供)\n  * TransactionAmount::Required - 交易金額為必要參數\n  * TransactionAmount::NoAccountsAvailable - 拒絕交易, 沒有帳戶可提供或是訂單金額超過(低於)限制\n  * TransactionAmount::OutOfTodayLimit - 拒絕交易, 超過每日限額或筆數限制\n  * OrderType::Required - 訂單種類為必要參數\n  * OrderType::Unsupported - 訂單種類錯誤，僅允許 recharge 與 withdraw\n  * SerialNumber::Required - 訂單編號為必要參數\n  * SerialNumber::No21ound - 找不到此訂單\n  * TransactionCode::AlreadyHave - 名稱代碼已存在\n  * Order::RepeatPost - 重複送單(5分鐘內的訂單以下欄位全部相同,金額,銀行名稱,分行名稱,交易方名稱,交易方卡號)\n  * Version::Error - 版本錯誤, 目前只允許 1.0 跟 1.1\n"},"ResponseData":{"type":"object","properties":{"SerialNumber":{"type":"string","description":"訂單編號","example":"20180101A00001"}}},"ResponseData_type_recharge":{"type":"object","properties":{"SerialNumber":{"type":"string","description":"訂單編號","example":"20180101A00001"},"TransactionAmount":{"type":"string","description":"此次傳遞的儲值金額","example":100},"BankNumber":{"type":"string","description":"匯款資訊-銀行代碼","example":700},"BankName":{"type":"string","description":"匯款資訊-銀行名稱","example":"中華郵政股份有限公司"},"AccountName":{"type":"string","description":"匯款資訊-持卡人姓名","example":"王小明"},"AccountNumber":{"type":"string","description":"匯款資訊-銀行卡號","example":123456789},"IbonCode":{"type":"string","description":"匯款資訊-Ibon代碼","example":123456789},"ShortUrl":{"type":"string","description":"匯款資訊-繳費資訊短網址","example":"https://s.ccat.com.tw/Q/0cBtX1234"},"BillAmount":{"type":"string","description":"匯款資訊-帳單金額(含手續費)","example":130},"PaymentUri":{"type":"string","description":"付款連結","example":"https://domain.name/payment/url"},"PaymentImg":{"type":"string","description":"付款二維碼","example":"https://domain.name/payment/url/256"},"Img(暫時未提供)":{"type":"string","description":"繳款QRcode圖片[base64格式] 暫時未提供","example":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAABLAAAASwCAAAAADOSuwT...."}}},"OrderData":{"type":"object","properties":{"SerialNumber":{"type":"string","description":"訂單編號"},"OwnerAccount":{"type":"string","description":"終端銀行卡號"},"BankName":{"type":"string","description":"交易方銀行名稱"},"BankBranchName":{"type":"string","description":"交易方分行名稱"},"AccountName":{"type":"string","description":"交易方名稱"},"AccountNumber":{"type":"string","description":"交易方銀行卡號"},"TransactionData":{"type":"string","description":"交易方資料json字串"},"TransactionCode":{"type":"string","description":"名稱代碼"},"Remark":{"type":"string","description":"備註"},"TransactionAmount":{"type":"number","description":"交易金額"},"RealTransactionAmount":{"type":"number","description":"真實交易金額 (不一定會有這個欄位, 有特殊異動才有)"},"ApplicationTime":{"type":"string","description":"申請時間","format":"date-time"},"CompleteTime":{"type":"string","description":"完成時間","format":"date-time"},"Status":{"type":"string","description":"狀態:\n  * 1:處理中\n  * 2:交易進行中\n  * 3:交易成功\n  * 4:交易取消\n  * 5:提交完成\n  * 6:爭議訂單\n  * 7:延遲下發\n","format":"number"},"BalanceBefore":{"type":"string","description":"交易前帳戶餘額","format":"number"},"BalanceAfter":{"type":"string","description":"交易後帳戶餘額","format":"number"},"TransactionRemark":{"type":"string","description":"交易備註"},"Account5":{"type":"string","description":"匯款方的後五碼 (超商代號依照接收結果返回, 若代號為6碼則會回傳6碼)"}}},"OrderList":{"type":"array","items":{"$ref":"#/components/schemas/OrderData"}},"AccountData":{"type":"object","properties":{"BankName":{"type":"string","description":"銀行名稱"},"AccountName":{"type":"string","description":"帳戶名稱"},"AccountNumber":{"type":"string","description":"銀行卡號"},"Balance":{"type":"number","description":"帳戶餘額"}}},"BalanceData":{"type":"object","properties":{"Balance":{"type":"number","description":"帳戶餘額"},"Frozen":{"type":"number","description":"凍結金額"},"AvailableBalance":{"type":"number","description":"可用餘額"}}},"AccountList":{"type":"array","items":{"$ref":"#/components/schemas/AccountData"}}},"responses":{"OrderCreate":{"description":"API 收單成功","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"boolean","description":"狀態","example":true},"data":{"$ref":"#/components/schemas/ResponseData"},"error":{"$ref":"#/components/schemas/ErrorMessage200"}}}}}},"OrderCreateRecharge":{"description":"API 收單成功","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"boolean","description":"狀態","example":true},"data":{"$ref":"#/components/schemas/ResponseData_type_recharge"},"error":{"$ref":"#/components/schemas/ErrorMessage200"}}}}}},"AccountList":{"description":"API 帳戶資訊，定義請參照 Models > AccountList","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"boolean","description":"狀態","example":true},"data":{"$ref":"#/components/schemas/AccountList"},"error":{"type":"string","description":"錯誤訊息","example":""}}}}}},"QueryFail":{"description":"API 查詢失敗","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"boolean","description":"狀態","example":false},"data":{"type":"object","properties":{}},"error":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"OrderFail":{"description":"API 收單失敗 / 查詢失敗，定義請參照 Models > ErrorMessage","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"boolean","description":"狀態","example":false},"data":{"type":"object","properties":{}},"error":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"OrderInformation":{"description":"API 訂單資訊，定義請參照 Models > OrderData","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"boolean","description":"狀態","example":true},"data":{"$ref":"#/components/schemas/OrderData"},"error":{"$ref":"#/components/schemas/ErrorMessage200"}}}}}},"OrderList":{"description":"API 訂單資訊，定義請參照 Models > OrderList","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"boolean","description":"狀態","example":true},"data":{"$ref":"#/components/schemas/OrderList"},"error":{"$ref":"#/components/schemas/ErrorMessage200"}}}}}},"UnauthorizedError":{"description":"API 拒絕連線","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"boolean","description":"狀態","example":false},"data":{"type":"object","properties":{},"example":{}},"error":{"type":"string","description":"錯誤訊息","example":"Permission Deny"}}}}}}},"securitySchemes":{"appId":{"type":"apiKey","name":"sn","in":"query"},"apiKey":{"type":"apiKey","name":"Authorization","in":"header"}}},"x-original-swagger-version":"2.0"}