Taiwan Payment API
About 720 wordsAbout 2 min
Warning
Before reading this API document, please make sure to check API Description Guide
Limits
| Transaction Type | Limit |
|---|---|
| Collection | TWD: 100-10000; USD: 0.99-1000 |
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: Donald John Trump |
| phone | Yes | String | Real phone number |
| 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 |
| callBackUrl | Yes | String | Redirect URL after successful payment |
| callBackFailUrl | Yes | String | Redirect URL after failed payment |
| 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
TWD Orders
Non-cashier
| payType | inBankCode | Description |
|---|---|---|
| BANK_TRANSFER | ATM | ATM cashier (payer can use mobile banking app to transfer funds to this bank’s account, account details differ for each transaction) |
| BANK_TRANSFER | STORE_HILIFEET | Hi-Life Life-ET (customer operates Life-ET machine in-store, selects required service via touchscreen, and completes payment) |
| BANK_TRANSFER | STORE_OKGO | OK Mart OK-go |
| BANK_TRANSFER | STORE_IBON | ibon Convenience Station |
| BANK_TRANSFER | STORE_FAMI | FamilyMart FamiPort |
| BANK_TRANSFER | STORE_MBC_HILIFEET | Convenience store mobile QR scan (Hi-Life Life-ET). Customer scans QR code provided in-store or online using a mobile phone, completes payment without machine operation |
| BANK_TRANSFER | STORE_MBC_IBON | 7-11 Convenience Store mobile QR scan |
| EWALLET | JKO_PAY_TWD | JKO Pay |
USD Orders
Non-cashier
| payType | inBankCode | Description |
|---|---|---|
| BANK_TRANSFER | LINE_PAY_USD | LinePay Wallet |
| BANK_TRANSFER | ATM_USD | ATM cashier (payer can use mobile banking app to transfer funds to this bank’s account, account details differ for each transaction) |
| BANK_TRANSFER | STORE_HILIFEET_USD | Hi-Life Life-ET (customer operates Life-ET machine in-store, selects required service via touchscreen, and completes payment) |
| BANK_TRANSFER | STORE_OKGO_USD | OK Mart OK-go |
| BANK_TRANSFER | STORE_IBON_USD | ibon Convenience Station |
| BANK_TRANSFER | STORE_FAMI_USD | FamilyMart FamiPort |
| BANK_TRANSFER | STORE_MBC_HILIFEET_USD | Convenience store mobile QR scan (Hi-Life Life-ET). Customer scans QR code provided in-store or online using a mobile phone, completes payment without machine operation |
| BANK_TRANSFER | STORE_MBC_IBON_USD | 7-11 Convenience Store mobile QR scan |
| EWALLET | JKO_PAY | JKO Pay |
| EWALLET | GOOGLE_PAY | Google Pay |
| EWALLET | APPLE_PAY | Apple Pay |