概覽
本文件僅供已簽約商戶使用，請勿公開轉載。
交易類型
ST Pay 提供兩種交易，都由您的伺服器呼叫 API 建立：
| 交易 | 資金方向 | 流程 |
|---|---|---|
| 代收 | 付款人 → ST Pay 收款帳戶 → 您的 ST Pay 餘額 | 您建立代收單，取得收款帳號與訂單金額，請付款人轉帳。ST Pay 確認入帳後，扣除手續費的結算金額加入您的餘額，並以 Callback 通知您。 |
| 代付 | 您的 ST Pay 餘額 → 收款人 | 您建立代付單並指定收款帳號。ST Pay 出款後，從您的餘額扣除代付金額加手續費，並以 Callback 通知您。 |
支援兩種通道：fps（轉數快）與 bank_transfer（銀行轉帳）。
API 一覽
| API | 用途 | 方法與路徑 |
|---|---|---|
| 代收建單 | 建立代收單，取得付款資訊 | POST /api/v1/collect/orders |
| 代付建單 | 建立代付單 | POST /api/v1/payout/orders |
| 代收查單 | 查詢代收單目前的狀態與金額 | POST /api/v1/collect/orders/query |
| 代付查單 | 查詢代付單目前的狀態與金額 | POST /api/v1/payout/orders/query |
| Callback | 訂單有結果時，ST Pay 主動通知您 | ST Pay POST 到您建單時帶的 callback_url |
對接流程
- 提供資料給 ST Pay
- 伺服器出口 IP：呼叫 API 的所有來源 IP，每個都須是單一 IPv4 或 IPv6 位址，不支援網段。
- 後台登入 IP：登入商戶後台的來源 IP，格式同上。與 API 的 IP 白名單分開設定。
- 取得 API 憑證與後台帳號：ST Pay 會交付
api_identity（API 身分）與 API 驗證金鑰。金鑰只在建立時顯示一次，之後 ST Pay 不再顯示，請立即妥善保存。ST Pay 也會建立商戶主管的後台帳號並交付初始密碼，第一次登入時必須更改。 - 在測試環境完成串接：依本文件完成四支 API 與 Callback，並以上線前檢查清單逐項確認。
- 上線正式環境：正式環境的網域、憑證、IP 白名單與測試環境完全獨立，需另外申請。
API 與後台登入的 IP 白名單、憑證都由 ST Pay 設定。需要變更時，請聯繫您的 ST Pay 對接窗口；IP 白名單變更後約 1 分鐘生效。
Callback 網址不需要提供給 ST Pay：請在每次建單時以 callback_url 帶入，規則見 Callback 網址。
環境
| 環境 | API 網域 | 商戶後台 | 說明 |
|---|---|---|---|
| 測試環境 | 由 ST Pay 對接窗口提供 | 由 ST Pay 對接窗口提供 | 不產生真實金流；使用測試環境專用的憑證 |
| 正式環境 | 測試環境完成串接後另行提供 | 測試環境完成串接後另行提供 | 真實金流；使用正式環境專用的憑證 |
完整網址為「網域 + 路徑」，例如 https://merchant.vincoterra.com/api/v1/collect/orders。商戶後台與 API 使用同一個網域（只是路徑不同），付款頁則在 pay.vincoterra.com。本文件範例一律使用正式環境的實際網域：merchant.vincoterra.com（API 與商戶後台）、pay.vincoterra.com（付款頁）；測試環境的網域由 ST Pay 對接窗口另行提供。