> ## 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.

# Taiwan

<Warning>
  **Before reading this API document, please make sure to check [**API Description Guide**](/docs/en/guide/api_description_guide)**
</Warning>

## **Limits**

| Transaction Type | Limit                            |
| :--------------- | :------------------------------- |
| Collection       | USD: 0.99-499.99, TWD: 100-20000 |

> **Amount Decimal Places:** TWD — 0 decimal places (integer only) | USD — 2 decimal places

## **Collection API**

### **Collection Application**

**Brief Description:**

* Create a collection order

**URL:**

TWD: `/twd/collect/apply` Note: appId TWD, amount TWD, settlement TWD

USD: `/usd/collect/apply` Note: appId USD, amount USD, settlement USD

**Parameters:**

| Parameter Name  | Required | Type   | Description                                                                                                                                                                                                      |
| :-------------- | :------- | :----- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| appId           | Yes      | Long   | Business ID (obtained from the backend, needs to pass the corresponding business ID according to the currency in the URL)                                                                                        |
| orderId         | Yes      | String | Merchant order number (must be unique, max length 48)                                                                                                                                                            |
| name            | Yes      | String | User’s full name. Recommended to use real name. Format: firstName and lastName separated by a space. Example: John Doe                                                                                           |
| phone           | Yes      | String | Real phone number                                                                                                                                                                                                |
| email           | Yes      | String | Real email                                                                                                                                                                                                       |
| amount          | Yes      | String | Transaction amount. For TWD orders, decimals are not allowed                                                                                                                                                     |
| payType         | Yes      | String | Transaction type                                                                                                                                                                                                 |
| inBankCode      | Yes      | String | [Payment method](#inBankCode)                                                                                                                                                                                    |
| callBackUrl     | Yes      | String | Redirect URL after successful payment                                                                                                                                                                            |
| callBackFailUrl | Yes      | String | Redirect URL after failed payment                                                                                                                                                                                |
| cancelUrl       | No       | String | If provided, the payment page displays a Back button that redirects the user to this URL when clicked.                                                                                                           |
| notifyUrl       | No       | String | Callback URL                                                                                                                                                                                                     |
| subject         | Yes      | String | Payment note                                                                                                                                                                                                     |
| body            | No       | String | Additional details                                                                                                                                                                                               |
| country         | No       | String | Required for cashier mode, fixed value: 158                                                                                                                                                                      |
| currency        | No       | String | Currency (default TWD; supported currencies: USD, TWD)                                                                                                                                                           |
| partnerUserId   | Yes      | String | Unique user identifier (e.g., userId). Used for risk control. Must be valid, otherwise it will affect the transaction. Allowed format: numbers, uppercase/lowercase letters, or common symbols -\~!@#\$%&\*()\_. |
| sign            | Yes      | String | Signature                                                                                                                                                                                                        |

**Return data parameter description**

| Parameter Name | Type   | Description                            |
| :------------- | :----- | :------------------------------------- |
| orderId        | String | Merchant order number (must be unique) |
| orderNo        | String | Platform order number                  |
| payUrl         | String | Payment link                           |
| sign           | String | Signature                              |

### **Collection Query**

**Brief Description:**

* Query collection order

**URL:**

TWD: `/twd/collect/query`

USD: `/usd/collect/query`

**Parameters:**

| Parameter Name | Required | Type   | Description                                                                                                               |
| :------------- | :------- | :----- | :------------------------------------------------------------------------------------------------------------------------ |
| appId          | Yes      | Long   | Business ID (obtained from the backend, needs to pass the corresponding business ID according to the currency in the URL) |
| orderId        | Yes      | String | Merchant order number                                                                                                     |
| orderNo        | No       | String | Platform order number (faster response)                                                                                   |
| sign           | Yes      | String | Signature                                                                                                                 |

**Return data parameter description**

| Parameter Name | Type    | Description                                                                                                                                                              |
| :------------- | :------ | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| orderId        | String  | Merchant order number (must be unique)                                                                                                                                   |
| orderNo        | String  | Platform order number                                                                                                                                                    |
| amount         | String  | Transaction amount                                                                                                                                                       |
| actualAmount   | String  | Amount received                                                                                                                                                          |
| fee            | String  | Transaction fee                                                                                                                                                          |
| status         | Integer | Status (0: Not started, 1: Processing, 2: Success (final), 3: Failed (final), 4: Partial received (final), 5: Over-received (final), -1: Exception pending confirmation) |
| payTime        | String  | Payment success time (available when status=2,4,5). Local time format: yyyy-MM-dd HH:mm:ss                                                                               |
| errorMsg       | String  | Payment failure reason (available when status=3)                                                                                                                         |
| sign           | String  | Signature                                                                                                                                                                |

### **Payment Methods**<a id="inBankCode" />

| Currency | Payment Type (payType) | Payment Code (inBankCode) | Limit        | Status    | Description                                        |
| :------- | :--------------------- | :------------------------ | :----------- | :-------- | :------------------------------------------------- |
| TWD      | QR                     | JKO\_PAY\_QR              | 30-20000     | Available | JkoPay QR                                          |
| TWD      | EWALLET                | JKO\_PAY\_TWD             | 30-20000     | Available | JKO Pay                                            |
| TWD      | BANK\_TRANSFER         | ATM                       | 1000-20000   | Available | ATM Cashier                                        |
| TWD      | BANK\_TRANSFER         | STORE\_IBON               | 100-20000    | Available | 7-11 Convenience Store                             |
| TWD      | BANK\_TRANSFER         | STORE\_HILIFEET           | 100-20000    | Available | Hi-Life Life-ET                                    |
| TWD      | BANK\_TRANSFER         | STORE\_OKGO               | 100-20000    | Available | OK Mart OK-go                                      |
| TWD      | BANK\_TRANSFER         | STORE\_FAMI               | 100-20000    | Available | FamilyMart FamiPort                                |
| TWD      | BANK\_TRANSFER         | STORE\_MBC\_HILIFEET      | 100-20000    | Available | Convenience store mobile QR scan (Hi-Life Life-ET) |
| TWD      | BANK\_TRANSFER         | STORE\_MBC\_IBON          | 100-20000    | Available | 7-11 Convenience store mobile QR scan              |
| USD      | EWALLET                | JKO\_PAY                  | 0.99-499.99  | Available | JKO Pay                                            |
| USD      | BANK\_TRANSFER         | LINE\_PAY\_USD            | 2.99-499.99  | Available | Line Pay                                           |
| USD      | BANK\_TRANSFER         | ATM\_USD                  | 32.99-499.99 | Available | ATM Cashier                                        |
| USD      | BANK\_TRANSFER         | STORE\_IBON\_USD          | 2.99-499.99  | Available | 7-11 Convenience Store                             |
| USD      | BANK\_TRANSFER         | STORE\_HILIFEET\_USD      | 2.99-499.99  | Available | Hi-Life Life-ET                                    |
| USD      | BANK\_TRANSFER         | STORE\_OKGO\_USD          | 2.99-499.99  | Available | OK Mart OK-go                                      |
| USD      | BANK\_TRANSFER         | STORE\_FAMI\_USD          | 2.99-499.99  | Available | FamilyMart FamiPort                                |
| USD      | BANK\_TRANSFER         | STORE\_MBC\_HILIFEET\_USD | 2.99-499.99  | Available | Convenience store mobile QR scan (Hi-Life Life-ET) |
| USD      | BANK\_TRANSFER         | STORE\_MBC\_IBON\_USD     | 2.99-499.99  | Available | Convenience store mobile QR scan (7-Eleven)        |

## Related Topics

* [Common API](/docs/en/api/version2/CommonApi)
* [HaiPay API Description and Common Rules](/docs/en/guide/api_description_guide)
* [Japan Payment API](/docs/en/api/version2/Japan)
