APM payment integration
This document provides a consolidated overview of alternative payment method (APM) integration requirements, features, and key considerations across Antom products.
Supported APMs
Antom offers a wide ranges of alternative payment methods (APMs), such as digital wallets, bank transfers, online banking, buy now pay later, cash payments, real-time payments, direct debits, and carrier billing, allowing you to accept popular local APMs in various countries and regions. Refer to the payment methods overview to view the full list of supported APMs.
Integration options
Antom offers multiple integration paths, such as Payment Element, Checkout Page (CKP), and API integration. You can choose the one that best fits your business needs.
Payment Element
Drop-in UI components that embed directly into your application. Provides a native payment experience.
Checkout Page (CKP)
Redirect customers to a secure, Antom-hosted payment page. Fastest path to going live with minimal development effort required.
API-only
Build a fully customized payment experience by making API calls to obtain redirect URL to corresponding payment method pages. Complete control over UI and user flow at the cost of increased complexity.
Password-free payments
Build a secure and simple payment experience for your website or application. Buyers can enable one-click payment during the first transaction, and subsequent payments can be completed with a single click.
Integration key considerations
Below are key integration points and recommended approaches for different APMs.
| Payment method | Key points | Recommended solution |
| PayPay |
| paymentRedirectUrl should be no longer than 255 characters. |
| QRIS | Payment discrepancy may occur. | When payment discrepancies occur (such as the buyer makes a payment but you receive a notification of payment failure), once Antom receives a payment success message from the corresponding payment method, Antom will settle the funds to you. After you receive the funds, you can manually handle any subsequent refunds. The corresponding settlement details report will include this transaction. |
| Promptpay | Payment discrepancy may occur. | |
| Konbini, Konbini (7-Eleven), Pay-easy |
| |
| Maybank | Once the payment is completed, there may be a 5-minute delay in sending the asynchronous notification. | Display a prompt message, "Order is confirming" to buyers. |
| OVO, Pix, BANCOMAT Pay | The payment method app cannot be launched automatically. | The buyer must manually launch the payment method app to complete the payment. |
| Siam Commercial Bank |
| Prompt the buyer that a processing fee may be applied to payments made using the payment method. The fee amount is determined by the buyer's bank level. |
| Bank of Ayudhya |
| Prompt the buyer that a processing fee may be applied to payments made using the payment method. The fee amount is determined by the buyer's bank level. |
| GoPay, Bangkok Bank, KrungThai Bank | Not supported on PC. | None |
| NAVER Pay | The PC client requires additional integration. After the buyer logs in, payment is not completed directly on the original page, but is automatically redirected to a new tab. | Enable browser pop-up permissions and use a new browser object or window in the code to open the pop-up page to process the payment. |
| Express Bank Transfer | paymentRedirectUrl has restrictions on special characters. | Avoid using the "&" symbol in paymentRedirectUrl. |
| Mercado Pago (Brazil) | The buyerEmail parameter is consumed, resulting in a direct failure of the payment. | Specify the payerEmail parameter instead. |
Buy Now Pay Later integration requirements
Antom supports several Buy Now Pay Later (BNPL) payment methods. BNPL is a type of installment loan, which gives a buyer a certain credit line that is long-term effective and recyclable. The buyer can use this credit line for transactions. However, payment methods still need to apply real-time risk control to BNPL transactions to reduce risks on the buyer side and the payment method side, which requires merchants to provide specific information in the API request to Antom. The required information is categorized into basic ones and extended ones, and they have a heavy impact on the success of payments.
Certain parameters are required for the pay (One-time Payments) API requests. See the following sections for details.
Basic info parameters
Parameters in the following tables are strongly recommended to be passed in by merchants. The risk control of payment methods relies heavily on these parameters. The payment success rate is estimated to rise by 5%~10% if these parameters are provided.
Category | Parameter | Description |
order.buyer | referenceBuyerId | OPTIONAL String (64) The unique ID assigned by the merchant to identify a buyer. |
order.goods | goodsName | OPTIONAL String (256) Goods name. |
order.shipping | OPTIONAL Address Recipient shipping address. |
shippingAddress
Parameters | Description |
region | REQUIRED String (2) The two-character ISO 3166 country/region code. |
state | OPTIONAL String (8) The state, country, or province. |
city | OPTIONAL String (32) The city, district, suburb, town, or village. |
address1 | OPTIONAL String (256) Address line 1, such as street, PO Box, or company name. |
address2 | OPTIONAL String (256) Address line 2, such as the apartment, suite, unit, or building information. |
zipCode | OPTIONAL String (32) ZIP or postal code. |
Extended info parameters
Parameters in the following tables are recommended to be passed in by merchants. The payment success rate is estimated to rise by 5% if these parameters are provided.
Category | Parameters | Description |
order.goods | referenceGoodsId | REQUIRED String (64) The unique ID assigned by the merchant to identify the goods. |
goodsCategory | OPTIONAL String (64) A categorization of the goods type. | |
REQUIRED Amount Goods price. | ||
goodsQuantity | REQUIRED Integer Goods quantity. |
goodsUnitAmount
Parameters | Description |
currency | REQUIRED String (3) The three-character ISO-4217 currency code. |
value | REQUIRED Integer The amount to charge as a positive integer in the smallest currency unit. (That is, 100 cents to charge $1.00, or 100 to charge JPY 100, a 0-decimal currency). Value range: 1 - unlimited. |
pspName returned by APMs
When receiving asynchronous notifications through notifyPayment or when inquiring payment information through inquiryPayment, the pspName parameter may return values when the payment method can provide the payment method name. The following table lists the corresponding pspName values that will be returned for each payment method:
Payment method | value of pspName | Buyer country/region | Payment method type |
BillEase | Philippines | Buy now pay later | |
Kredivo | Indonesia | ||
BPI | Philippines | Online banking | |
AlipayCN | China | Digital wallet | |
AlipayHK | Hongkong, China | ||
Boost | Malaysia | ||
Dana | Indonesia | ||
Gcash | Philippines | ||
Grabpay | Singapore | ||
KaKaoPay | South Korea | ||
KPLUS | Thailand | ||
RabbitLinePay | Thailand | ||
NAVERPay | South Korea | ||
TossPay | South Korea | ||
TouchNGo | Malaysia | ||
TrueMoney | Thailand | ||
GoPay | Indonesia | ||
Grabpay | Malaysia, Philippines | ||
JKOPay | Taiwan, China | ||
Maya | Philippines | ||
MercadoPago | Brazil, Peru, Chile, Mexico | ||
OVO | Indonesia | ||
PayPay | Japan | ||
ShopeePay | Singapore, Indonesia, Philippines, Thailand | ||
ShopeePay | Malaysia | ||
ZaloPay | Vietnam |
Pre-front solutions
In standard integration experiences, buyers are required to redirect to a payment method page to complete certain actions, such as selecting a specific bank payment method, entering payment details, or scanning/copying payment passwords. The following best practices guide you in presenting bank lists, payment details, QR codes, or payment passwords on your page, reducing the need for page redirection during the payment process and improving the buyer experience.