Skip to main content
Before reading this API document, please make sure to check API Description Guide

Limits

Transaction TypeLimit
CollectionUSD: 0.99-499.99, TWD: 100-20000

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 NameRequiredTypeDescription
appIdYesLongBusiness ID (obtained from the backend, needs to pass the corresponding business ID according to the currency in the URL)
orderIdYesStringMerchant order number (must be unique, max length 48)
nameYesStringUser’s full name. Recommended to use real name. Format: firstName and lastName separated by a space. Example: Donald John Trump
phoneYesStringReal phone number
emailYesStringReal email
amountYesStringTransaction amount. For TWD orders, decimals are not allowed
payTypeYesStringTransaction type
inBankCodeYesStringPayment method
callBackUrlYesStringRedirect URL after successful payment
callBackFailUrlYesStringRedirect URL after failed payment
notifyUrlNoStringCallback URL
subjectYesStringPayment note
bodyNoStringAdditional details
countryNoStringRequired for cashier mode, fixed value: 158
currencyNoStringCurrency (default TWD; supported currencies: USD, TWD)
partnerUserIdYesStringUnique 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 -~!@#$%&*()_.
signYesStringSignature
Return data parameter description
Parameter NameTypeDescription
orderIdStringMerchant order number (must be unique)
orderNoStringPlatform order number
payUrlStringPayment link
signStringSignature

Collection Query

Brief Description:
  • Query collection order
URL: TWD: /twd/collect/query USD: /usd/collect/query Parameters:
Parameter NameRequiredTypeDescription
appIdYesLongBusiness ID (obtained from the backend, needs to pass the corresponding business ID according to the currency in the URL)
orderIdYesStringMerchant order number
orderNoNoStringPlatform order number (faster response)
signYesStringSignature
Return data parameter description
Parameter NameTypeDescription
orderIdStringMerchant order number (must be unique)
orderNoStringPlatform order number
amountStringTransaction amount
actualAmountStringAmount received
feeStringTransaction fee
statusIntegerStatus (0: Not started, 1: Processing, 2: Success (final), 3: Failed (final), 4: Partial received (final), 5: Over-received (final), -1: Exception pending confirmation)
payTimeStringPayment success time (available when status=2,4,5). Local time format: yyyy-MM-dd HH:mm:ss
errorMsgStringPayment failure reason (available when status=3)
signStringSignature

Payment Methods

CurrencyPayment Type (payType)Payment Code (inBankCode)LimitStatusDescription
TWDQRJKO_PAY_QR30-20000AvailableJkoPay QR
TWDEWALLETJKO_PAY_TWD30-20000AvailableJKO Pay
TWDBANK_TRANSFERATM1000-20000AvailableATM Cashier
TWDBANK_TRANSFERSTORE_IBON100-20000Available7-11 Convenience Store
TWDBANK_TRANSFERSTORE_HILIFEET100-20000AvailableHi-Life Life-ET
TWDBANK_TRANSFERSTORE_OKGO100-20000AvailableOK Mart OK-go
TWDBANK_TRANSFERSTORE_FAMI100-20000AvailableFamilyMart FamiPort
TWDBANK_TRANSFERSTORE_MBC_HILIFEET100-20000AvailableConvenience store mobile QR scan (Hi-Life Life-ET)
TWDBANK_TRANSFERSTORE_MBC_IBON100-20000Available7-11 Convenience store mobile QR scan
USDEWALLETJKO_PAY0.99-499.99AvailableJKO Pay
USDBANK_TRANSFERLINE_PAY_USD2.99-499.99AvailableLine Pay
USDBANK_TRANSFERATM_USD32.99-499.99AvailableATM Cashier
USDBANK_TRANSFERSTORE_IBON_USD2.99-499.99Available7-11 Convenience Store
USDBANK_TRANSFERSTORE_HILIFEET_USD2.99-499.99AvailableHi-Life Life-ET
USDBANK_TRANSFERSTORE_OKGO_USD2.99-499.99AvailableOK Mart OK-go
USDBANK_TRANSFERSTORE_FAMI_USD2.99-499.99AvailableFamilyMart FamiPort
USDBANK_TRANSFERSTORE_MBC_HILIFEET_USD2.99-499.99AvailableConvenience store mobile QR scan (Hi-Life Life-ET)
USDBANK_TRANSFERSTORE_MBC_IBON_USD2.99-499.99AvailableConvenience store mobile QR scan (7-Eleven)
Last modified on April 17, 2026