> ## Documentation Index
> Fetch the complete documentation index at: https://doc.haipay.net/llms.txt
> Use this file to discover all available pages before exploring further.

# 台湾地区支付接入

> 台湾地区支付接入文档，涵盖代收API、代收申请、代收查询、代付API、代付申请、代付查询、银行编码。

> [!WARNING]
>
> **阅读该接口文档前，务必先查看 [**接口说明**](https://doc.haipay.net/zh/history/V20260701/get-started/api-conventions.md)**

## **限额**

| 交易类型 | 限额 |
| :- | - |
| 代收 | 美元：0.99-499.99, 台币：100-20000 |
| 代付 | 台币：1000-30000 |

> **金额小数位：** TWD — 0位小数（仅整数） | USD — 2位小数

## **代收API**

### **代收申请**

**简要描述：**

* 创建代收订单

**URL：**

新台币: `/twd/collect/apply`
说明：appId需使用新台币对应的，用户支付成功后增加新台币余额

美元: `/usd/collect/apply`
说明：appId需使用美元对应的，用户支付成功后增加美元余额

**参数：**

| 参数名 | 必选 | 类型 | 说明 |
| :- | :- | :- | :- |
| appId | 是 | Long | 业务ID（后台获取，需要根据URL中的币种传递对应的业务ID） |
| orderId | 是 | String | 商户订单号(必须保证唯一性，长度不超过48) |
| name | 是 | String | 用户姓名，推荐使用真实姓名，格式：包含firstName和lastName，以空格分割的，示例：John Doe |
| phone | 是 | String | 真实手机号 |
| email | 是 | String | 真实电子邮件 |
| amount | 是 | String | 交易金额，台币下单不能包含小数 |
| payType | 是 | String | 交易类型 |
| inBankCode | 是 | String | [支付方式](#inBankCode) |
| callBackUrl | 是 | String | 用户支付成功后跳转地址 |
| callBackFailUrl | 是 | String | 用户支付失败后跳转地址 |
| cancelUrl | 否 | String | 如果传递，支付页面会展示返回按钮，用户点击跳转至该链接 |
| notifyUrl | 否 | String | 回调地址 |
| subject | 是 | String | 支付备注 |
| body | 否 | String | 备注详情 |
| country | 否 | String | 收银台模式需要传递，固定值：158 |
| currency | 否 | String | 币种(默认TWD 支持下单币种: USD,TWD) |
| partnerUserId | 是 | String | 用户唯一标识（如用户ID userId），用于风控系统，必须真实有效，否则会影响交易。 格式要求：数字、大小写字母或常用符号-\~!@#\$%&\*()\_。 |
| sign | 是 | String | 签名 |

返回data参数说明

| 参数名 | 类型 | 说明 |
| :- | :- | :- |
| orderId | String | 商户订单号(必须保证唯一性) |
| orderNo | String | 平台订单号 |
| payUrl | String | 支付链接 |
| sign | String | 签名 |

### **代收查询**

**简要描述：**

* 查询代收订单

**URL：**

台币: `/twd/collect/query`

美元: `/usd/collect/query`

**参数：**

| 参数名 | 必选 | 类型 | 说明 |
| :- | :- | :- | :- |
| appId | 是 | Long | 业务ID（后台获取，需要根据URL中的币种传递对应的业务ID） |
| orderId | 是 | String | 商户订单号 |
| orderNo | 否 | String | 平台订单号（响应快） |
| sign | 是 | String | 签名 |

返回data参数说明

| 参数名 | 类型 | 说明 |
| :- | :- | :- |
| orderId | String | 商户订单号(必须保证唯一性) |
| orderNo | String | 平台订单号 |
| amount | String | 交易金额 |
| actualAmount | String | 收到金额 |
| fee | String | 手续费 |
| status | Integer | 状态(0未开始，1支付中，2成功（终态），3失败（终态）,4部分收款（终态），5超额收款（终态）, -1异常待确认) |
| payTime | String | 支付成功时间（当status=2，4，5时有值）(本地时间), 格式: yyyy-MM-dd HH:mm:ss |
| errorMsg | String | 支付失败原因（当status=3时有值） |
| sign | String | 签名 |

### **支付方式**

| 币种 | 支付类型(payType) | 支付编码(inBankCode) | 限额 | 状态 | 说明 |
| :- | :- | :- | :- | :- | :- |
| TWD | QR | JKO\_PAY\_QR | 30-20000 | 可用 | JkoPay QR |
| TWD | EWALLET | JKO\_PAY\_TWD | 30-20000 | 可用 | JkoPay |
| TWD | BANK\_TRANSFER | ATM | 100-20000 | 可用 | ATM收银台 |
| TWD | BANK\_TRANSFER | STORE\_IBON | 100-20000 | 可用 | 7-11超商 |
| TWD | BANK\_TRANSFER | STORE\_HILIFEET | 100-20000 | 可用 | 萊爾富Life-ET |
| TWD | BANK\_TRANSFER | STORE\_OKGO | 100-20000 | 可用 | OK超商OK-go |
| TWD | BANK\_TRANSFER | STORE\_FAMI | 100-20000 | 可用 | 全家FAMIPORT |
| TWD | BANK\_TRANSFER | STORE\_MBC\_HILIFEET | 100-20000 | 可用 | 超商行動掃碼(萊爾富Life-ET) |
| TWD | BANK\_TRANSFER | EPOINT\_LINEPAY | 100-10000 | 可用 | LINEPAY |
| TWD | BANK\_TRANSFER | STORE\_MBC\_IBON | 100-20000 | 可用 | 7-11超商行動掃碼 |
| USD | EWALLET | JKO\_PAY | 0.99-499.99 | 可用 | JkoPay |
| USD | BANK\_TRANSFER | LINE\_PAY\_USD | 2.99-499.99 | 可用 | LinePay |
| USD | BANK\_TRANSFER | ATM\_USD | 32.99-499.99 | 可用 | ATM收银台 |
| USD | BANK\_TRANSFER | STORE\_IBON\_USD | 2.99-499.99 | 可用 | 7-11超商 |
| USD | BANK\_TRANSFER | STORE\_HILIFEET\_USD | 2.99-499.99 | 可用 | 萊爾富Life-ET |
| USD | BANK\_TRANSFER | STORE\_OKGO\_USD | 2.99-499.99 | 可用 | OK超商OK-go |
| USD | BANK\_TRANSFER | STORE\_FAMI\_USD | 2.99-499.99 | 可用 | 全家FAMIPORT |
| USD | BANK\_TRANSFER | STORE\_MBC\_HILIFEET\_USD | 2.99-499.99 | 可用 | 超商行動掃碼(萊爾富Life-ET) |
| USD | BANK\_TRANSFER | STORE\_MBC\_IBON\_USD | 2.99-499.99 | 可用 | 超商行動掃碼(7-11) |

## **代付API**

### **代付申请**

**简要描述：**

* 创建代付订单

**URL：`/twd/pay/apply`**

说明：appId 新台币， amount 新台币，实收结算新台币

**参数：**

| 参数名 | 必选 | 类型 | 说明 |
| :- | :- | :- | :- |
| appId | 是 | Long | 业务ID（后台获取，需要根据URL中的币种传递对应的业务ID） |
| orderId | 是 | String | 商户订单号(必须保证唯一性，长度不超过48) |
| amount | 是 | String | 交易金额（单位：NT\$，只允许为整数） |
| accountType | 是 | String | BANK\_ACCOUNT（银行账户） |
| bankCode | 是 | String | 银行代码具体值查看 [完整银行编码列表](#bank-codes) |
| accountNo | 是 | String | 用户银行账号 |
| name | 是 | String | 收款人姓名(格式：支持繁体中文或英文) |
| phone | 否 | String | 真实手机号（格式参考 [电话号码格式](https://doc.haipay.net/zh/history/V20260701/resources/faq.md#zh_faq_phone-number-format) ） |
| email | 否 | String | 真实电子邮件 |
| notifyUrl | 否 | String | 回调地址 |
| subject | 否 | String | 支付备注（交易标题，商品名称，支付原因） |
| body | 否 | String | 备注详情 |
| partnerUserId | 是 | String | 用户唯一标识（如用户ID userId），用于风控系统，必须真实有效，否则会影响交易。 格式要求：数字、大小写字母或常用符号-\~!@#\$%&\*()\_。 |
| branchCode | 否 | String | 非必填，部分情况下需要填写确保付款成功。 |
| branchName | 是 | String | 用于付款校验，为空会导致无法出款。 |
| sign | 是 | String | 签名 |

#####

request

```json theme={null}
{
    "appId": 1054,
    "orderId": "M100000450012",
    "amount": "55",
    "accountType": "BANK_ACCOUNT",
    "bankCode": "BANK_OF_TAIWAN",
    "accountNo": "99418029201a844099",
    "name": "Lin Chia-ling",
    "email": "lin.chialing@gmail.com",
    "subject": "Payment for services",
    "body": "Payment description",
    "partnerUserId": "USER_450921",
    "branchCode": "0037",
    "branchName": "館前分行",
    "sign": "I1PeK3eJEVsFFNowxVRqMXpeWa1lr/BcRpBi8SsW4wVo1+5AC1JsrFq/m/L3214NzKHvtDWi4zia3DL3dPut0yMyUyqL91LNCSaeISbGsQPlhEsQpyTOryS/RKOfsrn2Xo37SCF/phAvndOk2jwwGwqM5xLz1ms9Ukl85wv27QFNrXIMxK2p181e7MpMYrgf+xvEBE/VqCtKMtN9pO449wWwXzHWNPbZ76s4pAvKwRE9yXQDr7Iw14Dktcnl1FoLM4gWM/obkO+mz6SyAGDuXhVh/+OD/IGNiCyTCNq6ciQY28UnCFV6ZIP40gxsFhfBJKbK+Raw7y1Bh912ifYfug=="
}
```

response

```json theme={null}
{
    "status": "1",
    "error": "00000000",
    "msg": "",
    "data": {
        "orderId": "M1000245001F4",
        "orderNo": "3023022014149638",
        "sign": "LmhUnkw5j0pMiimsG6rKwdNNZGvX6GMpSmD1mdHZwq112wuK5BohmdEoqKB/jkMk28o3da4Cxh6Q+tW97+yTCemRrF+dMaHA73rpOeUuujKQl/UcFvJuMhfLBa2tp09L71NzoBqpPD6aXf37mYAz8E1HmERwFPpac5FVxIYanHG8cqmMLJYsVmHTSxWavgWU03ys9UczBePkBiR8sl2FSOhFABB0wAP28lswrV/ABS68IsLKtyd1fyI3GBfSbIK5nDEEnlE+EdElFdLs9taAxJImeVF1x4eT47+bkPJ2qS8z3K8QGzKLF3W+8SiRZGfSwDTsLKH+2Vycvy5auRl+ag=="
    }
}
```

返回data参数说明

| 参数名 | 类型 | 说明 |
| :- | :- | :- |
| orderId | String | 商户订单号(必须保证唯一性) |
| orderNo | String | 平台订单号 |
| sign | String | 签名 |

### **代付查询**

**简要描述：**

* 查询代付订单状态

**URL：`/twd/pay/query`**

**参数：**

| 参数名 | 必选 | 类型 | 说明 |
| :- | :- | :- | :- |
| appId | 是 | Long | 业务ID（后台获取，需要根据URL中的币种传递对应的业务ID） |
| orderId | 是 | String | 商户订单号 |
| orderNo | 否 | String | 平台订单号（响应快） |
| sign | 是 | String | 签名 |

request

```json theme={null}
{
    "appId": 1000,
    "orderId": "M1234567111",
    "orderNo": "3022111516571436",
    "sign": "ZxkVZL+GAyv0VhVWn4IvGYahTzxgQuthkuV2ONWiqIfIDb2avvHlFOUJVzqZi1q8CPHXZm1ltanRTRVTxfsuftLvGeDioUHglWt46/RU6c1OPznpLGsZ35Q3n5tW2y1EnOsxPynXBFLuDQy+aZ3l9u6AQ30T0zQexMGT+IxuFkmUp02g/6juaHa5ZgNMv7lN67ixIp162wrM7OJuaOif872QijSceRdZhzaMGImAwB0D4MosRV4WMBOKkwgPdmS7GuZN66YUidXk3wTGqX3MYRw6M0kj4eNegSUwPXvp4q4p0KO8Y3xUMld54GY2ApX3WN3CBtC/vpJqEszjGBbbGg=="
}
```

response — 订单失败

```json theme={null}
{
    "status": "1",
    "error": "00000000",
    "msg": "",
    "data": {
        "orderId": "M1234567111",
        "orderNo": "3022111516571436",
        "amount": "100000.00",
        "fee": "0.00",
        "status": 3,
        "errorMsg": "交易金額不合法",
        "sign": "KKuvCl0SuNANJs+l2ogAaJm8pmV+Hi+Xa7q27vJ6D1Ehs4aOp13kRbITfJAhczh3T81BE9qwHeJaYwf+r0EypKM9TL6pMwfG8Az4gRy1D57wiUaVjl2PWcvbEqrn1hL0b+btkjvAM9I+CcSv+wuOW3/uku17Ws3FhgJLj9sFsQUBAPjDO+758VnwBytCOLBmljLBXyKgNgpmFQ1/DNkqWl0UNzyLK45Zw3yf5NiwhEFbvW0jlOWlfu/ql4hluISUQG573jEoFCBEnQLb2tQoRZj1QYNRCXPf5lbej0vzqbEwvR9h+ZOf255t1MocJkdIe463DTV5U3KZdVT87HMagw=="
    }
}
```

response — 订单成功

```json theme={null}
{
    "status": "1",
    "error": "00000000",
    "msg": "",
    "data": {
        "orderId": "M1234567112",
        "orderNo": "3022111517401574",
        "amount": "100000.00",
        "fee": "1003.00",
        "status": 2,
        "payTime": "2024-03-01 23:59:59",
        "sign": "khPtOmGq+cpKX0HFAI/lbP0dx4oFyNAnL5oLsdmhDJdASlQm0yg5I3o+MhImYggEsL6c2bo5fP29t54OZFqSdQDfIuNDvGbAMAr4mRBxc0hoHLkBLyyagfVPBLyQA1JY8XV3ZL4ySzQ3ZQnMCfrh2K39ueUuz6HpZ03Hj0KYijVRCXAZaio/L5jfLBT12QXmvIfAHa8s/k9flhK05ENHPep3zjj/MZGOEaX7jkEJLfjK0duypDCa61BRQjM+oePOdVsgleIl1Yf98UAxMDZ/A3912KFHEb+/jvmdnulNbiJFyuT1fEe+j2teUgw3vFsZAtwNWAgxhC7UO+N0Q5z4EA=="
    }
}
```

返回data参数说明

| 参数名 | 类型 | 说明 |
| :- | :- | :- |
| orderId | String | 商户订单号(必须保证唯一性) |
| orderNo | String | 平台订单号 |
| amount | String | 交易金额 |
| fee | String | 手续费 |
| status | Integer | 订单状态(0未开始, 1放款中 2放款成功（终态） 3放款失败（终态） -1异常待确认) |
| payTime | String | 支付成功时间（当status=2时有值）(东八区时间), 格式: yyyy-MM-dd HH:mm:ss |
| errorMsg | String | 支付失败原因（当status=3时有值） |
| sign | String | 签名 |

### **银行编码**

| 币种 | 支付类型(accountType) | 支付编码(bankCode) | 限额 | 状态 | 说明 |
| :- | :- | :- | :- | :- | :- |
| TWD | BANK\_ACCOUNT | BANK\_OF\_TAIWAN | 1000-30000 | 可用 | 臺灣銀行 |
| TWD | BANK\_ACCOUNT | TAIPEI\_STAR\_BANK | 1000-30000 | 可用 | 瑞興商業銀行 |
| TWD | BANK\_ACCOUNT | HWATAI\_BANK | 1000-30000 | 可用 | 華泰商業銀行 |
| TWD | BANK\_ACCOUNT | SANXIN\_COMMERCIAL\_BANK | 1000-30000 | 可用 | 三信商業銀行 |
| TWD | BANK\_ACCOUNT | O\_BANK | 1000-30000 | 可用 | 王道商業銀行 |
| TWD | BANK\_ACCOUNT | ENTIE\_COMMERCIAL\_BANK | 1000-30000 | 可用 | 安泰商業銀行 |
| TWD | BANK\_ACCOUNT | KINGS\_TOWN\_BANK | 1000-30000 | 可用 | 京城商業銀行 |
| TWD | BANK\_ACCOUNT | TAICHUNG\_COMMERCIAL\_BANK | 1000-30000 | 可用 | 台中商業銀行 |
| TWD | BANK\_ACCOUNT | BANK\_OF\_PANHSIN | 1000-30000 | 可用 | 板信商業銀行 |
| TWD | BANK\_ACCOUNT | SUNNY\_BANK | 1000-30000 | 可用 | 陽信商業銀行 |
| TWD | BANK\_ACCOUNT | UNION\_BANK\_OF\_TAIWAN | 1000-30000 | 可用 | 聯邦商業銀行 |
| TWD | BANK\_ACCOUNT | KGI\_BANK | 1000-30000 | 可用 | 凱基商業銀行 |
| TWD | BANK\_ACCOUNT | FAR\_EASTERN\_INTERNATIONAL\_BANK | 1000-30000 | 可用 | 遠東國際商業銀行 |
| TWD | BANK\_ACCOUNT | THE\_SHANGHAI\_COMMERCIAL\_AND\_SAVINGS\_BANK | 1000-30000 | 可用 | 上海商業儲蓄銀行 |
| TWD | BANK\_ACCOUNT | YUANTA\_COMMERCIAL\_BANK | 1000-30000 | 可用 | 元大商業銀行 |
| TWD | BANK\_ACCOUNT | SHIN\_KONG\_COMMERCIAL\_BANK | 1000-30000 | 可用 | 臺灣新光商業銀行 |
| TWD | BANK\_ACCOUNT | TAISHIN\_INTERNATIONAL\_BANK | 1000-30000 | 可用 | 台新國際商業銀行 |
| TWD | BANK\_ACCOUNT | BANK\_SINOPAC | 1000-30000 | 可用 | 永豐商業銀行 |
| TWD | BANK\_ACCOUNT | E\_SUN\_COMMERCIAL\_BANK | 1000-30000 | 可用 | 玉山商業銀行 |
| TWD | BANK\_ACCOUNT | CTBC\_BANK | 1000-30000 | 可用 | 中國信託商業銀行 |
| TWD | BANK\_ACCOUNT | CATHAY\_UNITED\_BANK | 1000-30000 | 可用 | 國泰世華商業銀行 |
| TWD | BANK\_ACCOUNT | TAIPEI\_FUBON\_COMMERCIAL\_BANK | 1000-30000 | 可用 | 台北富邦商業銀行 |
| TWD | BANK\_ACCOUNT | BANK\_OF\_KAOHSIUNG | 1000-30000 | 可用 | 高雄銀行 |
| TWD | BANK\_ACCOUNT | TAIWAN\_BUSINESS\_BANK | 1000-30000 | 可用 | 臺灣中小企業銀行 |
| TWD | BANK\_ACCOUNT | CHUNGHWA\_POST\_CO\_LTD | 1000-30000 | 可用 | 中華郵政股份有限公司 |
| TWD | BANK\_ACCOUNT | MEGA\_INTERNATIONAL\_COMMERCIAL\_BANK | 1000-30000 | 可用 | 兆豐國際商業銀行 |
| TWD | BANK\_ACCOUNT | CHANG\_HWA\_BANK | 1000-30000 | 可用 | 彰化商業銀行 |
| TWD | BANK\_ACCOUNT | HUA\_NAN\_COMMERCIAL\_BANK | 1000-30000 | 可用 | 華南商業銀行 |
| TWD | BANK\_ACCOUNT | FIRST\_COMMERCIAL\_BANK | 1000-30000 | 可用 | 第一商業銀行 |
| TWD | BANK\_ACCOUNT | TAIWAN\_COOPERATIVE\_BANK | 1000-30000 | 可用 | 合作金庫商業銀行 |
| TWD | BANK\_ACCOUNT | LAND\_BANK\_OF\_TAIWAN | 1000-30000 | 可用 | 臺灣土地銀行 |

> [!WARNING]
>
> **重要说明：**
>
> * 在调用代付接口时，请使用对应的银行名称作为 `bankCode` 参数值

## 相关主题

* [公共接口](https://doc.haipay.net/zh/history/V20260701/api/version2/CommonApi.md)
* [HaiPay 接口说明与公共规则](https://doc.haipay.net/zh/history/V20260701/get-started/api-conventions.md)
* [日本支付接口](https://doc.haipay.net/zh/history/V20260701/payments/local/japan.md)
* [台湾 — 代收申请 (POST /twd/collect/apply)](https://doc.haipay.net/zh/history/V20260701/api-reference/twd/collect-apply.md)
* [台湾 — 代收查询 (POST /twd/collect/query)](https://doc.haipay.net/zh/history/V20260701/api-reference/twd/api/collectQuery.md)
* [台湾 — 代付申请 (POST /twd/pay/apply)](https://doc.haipay.net/zh/api-reference/twd/pay-apply.md)
* [台湾 — 代付查询 (POST /twd/pay/query)](https://doc.haipay.net/zh/api-reference/twd/pay-query.md)
* [处理异步通知并验证签名](https://doc.haipay.net/zh/operations/callback.md)
* [端到端测试：修改订单状态与发送通知](https://doc.haipay.net/zh/history/V20260701/testing/end-to-end.md)
* [查询代收支付类型与编码 (payType)](https://doc.haipay.net/zh/history/V20260701/resources/cashin-code-list.md)
* [查询代付账户类型与银行编码](https://doc.haipay.net/zh/history/V20260701/resources/cashout-code-list.md)
* [HaiPay 本地支付产品页](https://www.haipay.net/products/local-payment)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.