Reference
PayMethod
| Key | Icon | Supported Transaction Types | Supported Features | Description |
|---|---|---|---|---|
| WeChatPay |  | Consumption Cancellation Refund | CPM MPM Offline Mobile Web Payment Online Mobile Web Payment PC Web Payment APP Payment Mini Program Payment Customs Declaration | WeChat Pay in China, supports all payment scenarios except card payments |
| Alipay+ |  | Consumption Cancellation Refund | CPM MPM Offline Mobile Web Payment Online Mobile Web Payment PC Web Payment APP Payment Mini Program Payment Customs Declaration | Not just Alipay, but a suite of Alipay+ payment products, including Alipay, Gcash, AlipayHK, KakaoPay, TNG, etc.Learn about Alipay+ For the features supported by Alipay+ sub-wallets, please refer to the next table. Since the number of sub-wallets is continuously increasing and their supported features vary, it is recommended that you do not specify the sub-wallet ID sub_pay_method_id for online transactions. Instead, allow Alipay+ to dynamically select the appropriate sub-wallet, reducing your business complexity. |
| UnionPay |  | Consumption Cancellation Refund | CPM MPM Offline Mobile Web Payment Online Mobile Web Payment PC Web Payment | China UnionPay, includes offline QR code payments and online/offline web payments |
| RakutenPay |  | Consumption Refund | CPM MPM | A popular QR code payment product in Japan, available only for offline QR code payments |
| PayPay |  | Consumption Refund | CPM MPM | |
| DPay |  | Consumption Refund | CPM MPM | |
| MerPay |  | Consumption Refund | CPM | |
| AuPay |  | Consumption Refund | CPM MPM | |
| CreditLinkPay |  | Consumption Refund | Credit Card Payments Offline Mobile Web Payment Online Mobile Web Payment PC Web Payment | A general term for credit card payments. When making payment requests, do not include card brand IDs like Visa, MasterCard, JCB, etc., as the specific card used can only be determined after the payment. |
| Visa |  | Consumption Refund | Credit Card Payments | Do not include this ID in payment requests. For credit card payments, use CreditLinkPay |
| MasterCard |  | Consumption Refund | Credit Card Payments | |
| Amex |  | Consumption Refund | Credit Card Payments | |
| Discover |  | Consumption Refund | Credit Card Payments | |
| JCB |  | Consumption Refund | Credit Card Payments | |
| DinersClub |  | Consumption Refund | Credit Card Payments |
Sub PayMethods
| Key | Icon | Country/Region | Supported Features |
|---|---|---|---|
| Alipay |  | Mainland China | CPM MPM Offline Mobile Web Payment Online Mobile Web Payment PC Web Payment APP Payment Mini Program Payment |
| Gcash |  | Philippines | CPM MPM Offline Mobile Web Payment Online Mobile Web Payment PC Web Payment APP Payment Mini Program Payment |
| AlipayHK |  | Hong Kong, China | CPM MPM Offline Mobile Web Payment Online Mobile Web Payment PC Web Payment APP Payment Mini Program Payment |
| KakaoPay |  | South Korea | CPM MPM Offline Mobile Web Payment PC Web Payment APP Payment |
| TNG |  | Malaysia | CPM MPM Offline Mobile Web Payment Online Mobile Web Payment PC Web Payment APP Payment Mini Program Payment |
| EZLink |  | Singapore | CPM |
| DANA |  | Indonesia | Online Mobile Web Payment PC Web Payment APP Payment Mini Program Payment |
| NAVERPAY |  | South Korea | CPM MPM Offline Mobile Web Payment Online Mobile Web Payment PC Web Payment |
| HELLOMONEY_BY_AUB |  | Philippines | CPM MPM Offline Mobile Web Payment |
| PBENGAGEMY |  | Malaysia | CPM MPM Offline Mobile Web Payment |
| TINABA |  | Argentina | CPM MPM Offline Mobile Web Payment Online Mobile Web Payment PC Web Payment APP Payment |
| HIPAY |  | France | CPM MPM Offline Mobile Web Payment Online Mobile Web Payment PC Web Payment APP Payment Mini Program Payment |
| MPAY |  | Thailand | CPM MPM Offline Mobile Web Payment Online Mobile Web Payment PC Web Payment APP Payment |
| CHANGIPAY |  | South Korea | CPM MPM Offline Mobile Web Payment |
| TOSSPAY |  | South Korea | CPM MPM Offline Mobile Web Payment PC Web Payment APP Payment Mini Program Payment |
| OCBC |  | Singapore | CPM MPM Offline Mobile Web Payment |
| RABBIT_LINE_PAY |  | Thailand | PC Web Payment APP Payment |
| BPI |  | Philippines | Online Mobile Web Payment PC Web Payment |
TransType
| Key | Description |
|---|---|
| 1 | Consumption |
| 3 | Refund |
TransStatus
| Key | Description |
|---|---|
| 9 | Pre-order |
| 0 | In progress |
| 1 | Closed |
| 2 | Completed |
| 3 | Canceled |
TerminalType
| Key | Description |
|---|---|
| WEB | Desktop computers such as PCs |
| WAP | Mobile devices such as phones and tablets |
OsType
| Key | Description |
|---|---|
| ANDROID | Android operating system |
| IOS | IOS operating system |
PayScenario
| Key | Description |
|---|---|
| BSCANQR_PAY | QR code payment (User-presented mode CPM) |
| SCANQR_PAY | QR code payment (Merchant-presented mode MPM) |
| WAP_PAY | Online mobile web payment |
| WEB_PAY | PC web payment |
| ENTRYCODE_PAY | Offline mobile web payment |
| INAPP_PAY | APP payment |
| MINI_PROGRAM_PAY | Mini Program payment |
Language
| Key | Description |
|---|---|
| en-US | American English |
| zh-CN | Simplified Chinese |
| ja-JP | Japanese |
CardType
| Key | Description |
|---|---|
| 1 | Debit Card |
| 2 | Credit Card |
WeChatPay Customs
| Key | Description |
|---|---|
| GUANGZHOU_ZS | Guangzhou (General Administration Version) |
| HANGZHOU_ZS | Hangzhou (General Administration Version) |
| NINGBO | Ningbo |
| ZHENGZHOU_BS | Zhengzhou (Bonded Logistics Center) |
| CHONGQING | Chongqing |
| SHANGHAI_ZS | Shanghai (General Administration Version) |
| SHENZHEN | Shenzhen |
| ZHENGZHOU_ZH_ZS | Zhengzhou Comprehensive Bonded Zone (General Administration Version) |
| TIANJIN | Tianjin. When submitting orders to Tianjin customs, both Tianjin customs record and Tianjin CIQ record must be configured in the merchant management system. However, only one customs declaration request is needed. |
| SHANGHAI_JG | Shanghai Digital Clearance |
Alipay Customs
| Key | Description |
|---|---|
| ZONGSHU | General Administration Customs |
| ZHENGZHOU | Zhengzhou Customs |
| NINGBO | Ningbo Customs |
| SHANGHAI_CBT | Shanghai Customs |