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

Embedded payment components

Drop-in UI components that embed directly into your application. Provides a native payment experience.

Key capabilities
No page redirects required
Pre-built, customizable UI
Requires client-side integration

Checkout Page (CKP)

Fastest setup
Hosted payment page

Redirect customers to a secure, Antom-hosted payment page. Fastest path to going live with minimal development effort required.

Key capabilities
Minimal code needed
Automatic payment method display
Requires page redirect

API-only

🔧Advanced
Custom payment page

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.

Key capabilities
Seamless user experience directing buyers to a specific payment method page
May require manual integration for each payment method

Password-free payments

Easy and safe authorized payment experience

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.

Key capabilities
Embedded payment process
Access token may require manual maintenance after expiry

Integration key considerations

Below are key integration points and recommended approaches for different APMs.

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.

shippingAddress

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.

goodsUnitAmount

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:

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.