Release notes

2026-10-12 17:03

2026.9

New

Added paymentResultInfo.threeDSResult.paResStatus and paymentResultInfo.threeDSResult.liabilityShift parameters in the request of notifyPayment API and the response of inquiryPayment API.
Added retrievePaymentSession and submitPay APIs for Antom Payment Orchestration.
Added BCA and MACHBANK payment methods.
Added
BCABANK_VA
,
BETTR
and
MACHBANK
to Payment method enumeration values.
Added Kaspi support to the APO payment methods list.
Added Ethoca settings support on Antom Dashboard.
Added Mastercard monitoring program enforcement fees details.

Enhanced

Updated the maximum payment amount of PicPay.
Updated the user flow, buyer country/region, and processing currency of Pay by Bank.
Updated the user flow and refund period of Tamara.
Updated the minimum and maximum payment amount of WeChat Pay and WeChat Pay HK in the Omnichannel in-store payment devices list.
Updated the Antom Copilot product name to Antom Autopilot across all related documentation.

2026.8

New

Added extendInfo parameter in the response of consult (One-time Payments) API.
Added Model Context Protocol in Development tools.

Enhanced

Updated the content of Antom reconciliation expert Skill.

2026.7

New

Added installment.plans.supportedBank parameter in the response of consult (One-time Payments) API.
Added creditPayPlan.filteredInstallmentPeriods parameter in the request of createPaymentSession (One-time Payments) API.
Added paymentResultInfo.creditPayPlan.interestRate parameter in the request of notifyPayment API and the response of inquiryPayment API.
Added paymentMethodDetail.card.funding, paymentMethodDetail.card.issuerName and paymentMethodDetail.card.issuingCountryparameters in the request of notifyVaulting API and the response of inquireVaulting API.
Added vaultingResultCode and vaultingResultMessage parameters in the response of inquireVaulting API.
Added paymentMethod.paymentMethodMetaData.requestIncrementalAuthorization, paymentMethod.paymentMethodMetaData.requestExtendedAuthorization and paymentMethod.paymentMethodMetaData.paymentTypeparameters in the request of pay (One-time Payments) and createPaymentSession (One-time Payments) APIs.
Added paymentResultInfo.incrementalAuthorizationAvailable, paymentResultInfo.extendedAuthorizationAvailable and paymentResultInfo.refundOnAuthorizationAvailable parameters in the response of pay (One-time Payments) and inquiryPaymentAPIs and in the request of notifyPayment API.
Added authExpiryTime parameter in the response of pay (One-time Payments) API.
Added updateAmount API for API reference.
Added
UPDATE_AMOUNT_RESULT
enum for notifyType parameter in the request of notifyPayment API.
Added updateRequestId parameter in the request of notifyPayment API.
Added transactions.grossSettlementAmount and transactions.settlementQuote parameters in the response of inquiryPayment API
Added
REFUND_BY_TRANSACTION_TYPE_INCONSISTENT
error code in refund and notifyRefund APIs.
Added payment methods E.SUN Wallet, ShopBack, Trustly, and WERO to the Payment methods document.
Added the content of invoice date configuration for Invoice.

Enhanced

Updated the description of grossSettlementAmount parameter in inquiryRefund API.
Updated the description of authExpiryTime parameter in the request of notifyPayment API and the response of inquiryPayment API.
Updated the content of Overview for Antom Payment Orchestration.

2026.6

New

Added Antom reconciliation expert Skill for Reconciliation.
Added Flutter client integration for Payment Element integration of One-time Payments.
Added Accept payments with seQura for One-time Payments.

2026.5

New

Added inquireExchangeRate, inquireSubscriptionPayment, inquireSubscription and inquireSubscriptionList APIs for API reference.
Added Shopify plugin product overview and WooCommerce plugin product overview for Plugins.
Added Omnichannel for Payment products.
Added Query subscription information for Subscription Payment.

Enhanced

Updated the name of Guaranteed ACH and iDEAL | Wero.

2026.4

New

Added "Apple Pay configuration guide" for Antom Payment Orchestration.
Added payment methods Korean Virtual Account, au, and SoftBank to the Payment methods document.
Added Integration Skill for Development tools.
Added Video tutorials for merchant service operations.
Added prorationSettings and nextSubscriptionDate parameters in the request of update API.
Added authExpiryTime parameter in the request of notifyPayment API.
Added paymentResultInfo.userAuthorizationStatus parameter in the request of notifyPayment API and the response of inquiryPayment API.

2026.3

New

Added payment methods Direct Carrier Billing, seQura, and Samsung Pay to the Payment methods document.
Added the content of Visa, Mastercard, and Discover to Installment payments.
Added actualRefundAmount parameter in the request of the refund API.
We have restructured and expanded our Subscription Payment documentation. The new content includes:

Integration guides: Choose your integration path, enhanced subscription integration options—such as Payment Element recurring payments (supporting Apple Pay and Google Pay), Checkout Page hosted recurring payments, and API-only integrations for both APM recurring payments (also supporting Apple Pay and Google Pay) and card subscription payments integrations that offer both hosted and server-to-server modes.
Additional resources: Subscription trial and Subscription cancellation, along with a miscellaneous section providing Best practices to support smoother implementation.

Enhanced

Updated the name and content of Pay by Bank.

2026.2

New

Added the payment method PayMe to the Payment methods document.
Added the verifyAndCompletePayment API for Antom payment orchestration.
Added the order.buyer.buyerPhoneNoContryCode field in the pay API for Antom payment orchestration.

Enhanced

Updated the product name from "Auto Debit" to "Tokenized Payment".
Updated the description of paymentStatus and resultStatus in inquiryPayment API.
Updated the content of transaction details report, settlement details report, settlement summary report and report field summary.

2026.1

New

Added recurringType, env.deviceId, agreementInfo fields in the request of pay (Auto Debit) API.
Added applinkUrl, normalUrl and schemeUrl fields in the response of pay (Auto Debit) API.
Added the paymentExpiryTime field in the createPaymentSession (EasySafePay) API.
Added the evn field in the consult API.
Added Best practices for EasySafePay.
Add MB_WAY payment method in the pay (One-time Payments) API.
Added Accept payments with Indian APM, Accept payments with Indian cards, Accept payments with Apple Pay and Accept payments with Google Pay for One-time Payments.
Added Card payment features, 3D Secure 2, Antom 3DS-Retry, Merchant-Initiated Transaction (MIT), Installment payments, Antom Tokenization, Card-on-File (COF) transactions, Co-badged cards, Buy Now Pay Later integration requirements and Pre-front solutionfor Learn about payment methods.
Added the uploadInvoiceShippingFile API for API reference.
Added the payment method QRPH to the Payment methods document.
Added the Cardholder dispute resolution network (CDRN) for Dispute.
Added the Antom Dashboard version migration for Merchant service.
Added the Dispute resolution for Dispute.

Enhanced

Updated the sample code for Quick start of One-time Payments.

Deprecated

Removed the terminalType, osType and osVersion fields in the consult API.

2025.12

New

Added Overview, Find your use case, Accept payments with Apple Pay, Accept payments with Google Pay and Accept payments with South Korean issuer-authenticated cards for One-time Payments.
Added the Antom Copilot usage information on the Support page.
Added payment methods Hipay, Tinaba, and LinkAja to the Payment Methods document.
Added "Home", "Balance", "Sales to settlements", "Payment lifecycle", "Risk & dispute management", "Card monitoring programs", and "Reports" for Merchant service.
Added Accept payments with PayPay Smart Payment for One-time Payments.
Added the vaultPaymentMethod API for Antom Payment Orchestration.
Added the paymentMethodDetail.card.supportedBrands field in the inquireVaulting API and notifyVaulting API of Antom Payment Orchestration.
Added the paymentResultInfo.rrn field in the pay, notifyPayment and inquiryPayment API of Antom Payment Orchestration.
Added the rrn and arn fields in the notifyRefund and inquiryRefund API of Antom Payment Orchestration.

Enhanced

Updated the product name from "Checkout Payment" to "One-time Payments".
Updated the contents of Hosted mode and Server-to-server mode under API-only integration for One-time Payments.
Updated the description of the paymentMethodType in the createPaymentSession (One-time Payments).
Updated the description of the cpf in the pay (One-time Payments).
Updated the content of Card scheme's monitoring program.

Deprecated

Deprecated the Help Center documents.
Deprecated the in-store payment integration guides and product information.
Deprecated the in-store payment API documents from API reference.

2025.11

New

Added a new release of SDK release notes.
Added the card.showBrandIcon parameter to control the visibility of card brand icons for Appearance customization.
Added "Antom Tokenization" and "Card-on-File (COF) transactions" for Card payment features on Checkout Payment.
Added "Get started", "Transaction", "Enable payment methods", "Acquirer management", "Orchestration" and "Accept payments using South Korean cards" for Antom Payment Orchestration.
Added "Accept payments with Google Pay" and "Accept payments with Apple Pay" for Checkout Payment.
Added the passengerCode field in the capture (Checkout Payment) API.
Added payment methods Paidy, Rakuten Pay, dBarai, Viettel Money, MB WAY, Swish, TWINT, Satispay, and ACH Direct Debit to the Payment Methods document.

Enhanced

Updated the description of the ticketNumber and flightNumber fields in the pay (Checkout Payment), createPaymentSession (Checkout Payment), and capture (Checkout Payment) APIs.
Updated APM payments for Antom Payment Orchestration.
Updated the sample code for Quick start of EasySafePay.
Updated the sample code for Quick start of Checkout Payment.
Updated the sample code for Quick start of Scan to Link.
Updated the sample code for Quick start of Subscription Payment.
Updated the sample code for Quick start of Auto Debit.
Updated "Batch refund" and "Dispute"for Merchant service.

2025.10

New

Added "Payment Element integration", "Appearance customization" and "Capture" for Checkout Payment.
Added the error codes
USER_NOT_SUBMITTED
,
USER_AUTHENTICATION_NOT_FINISHED
,
PICKUP_CARD
,
DOMESTIC_DEBIT_TRANSACTION_NOT_ALLOWED
,
BLOCKED_BY_CARDHOLDER
,
RESTRICTED_CARD
,
CARD_EXPIRED
,
ACCOUNT_CLOSED
,
INVALID_CVV
,
INSTALLMENT_NOT_SUPPORTED
,
PAYMENT_METHOD_SYSTEM_ERROR
, and
INVALID_INSTALLMENT_PLAN
to the pay (Checkout Payment), notifyPayment, and requiryPayment APIs.
Added the error code
USER_IDENTITY_FROZEN_BY_CHANNEL
to the notifyRefund API.
Added the declaration, declarationBizScene, and declarationBeneficiaryId fields in the pay (Checkout Payment) and createPaymentSession (Checkout Payment) APIs.
Added payment methods MPay to the Payment Methods document.

Enhanced

Updated the list of supported enumeration values for Auto Debit and Subscription Payment.
Updated the list of Antom Technical Support email addresses on the Support page.

2025.9

New

Added the networkToken and credentialType fields in the pay (Checkout Payment).
Added the CredentialTypeUsed field in the notifyPayment, and inquiryPayment APIs.
Added the exemptionRequested field in the pay (Checkout Payment), notifyPayment, and inquiryPayment APIs.
Added the exemptionType and challenged fields in the notifyPayment and inquiryPayment APIs.
Added the smartPaymentEnabled field in the pay (Checkout Payment) and createPaymentSession (Checkout Payment) APIs.
Added "Hosted mode", "Server-to-server mode" and "Best practices" for Antom Payment Orchestration.
Added payment methods Octopus to the List of payment methods.

Enhanced

Updated the content of "Cancel" for Antom Payment Orchestration.

Deprecated

Deprecated "Card payments" of Antom Payment Orchestration.

2025.8

New

Added payment methods Turkish cards, Indian cards, Net Banking, and UPI to the Payment Methods document.
Added the is3DSDataOnly and funding fields in the pay (Checkout Payment) API.
Added the refusalCodeRaw, refusalReasonRaw and merchantAdviceCode fields in the pay (Checkout Payment), notifyPayment, and requiryPayment APIs.
Added the threeDSOffered, threeDStransactionStatusReason, and challengeCancel fields in the notifyPayment andrequiryPayment APIs.
Added the agentCode, agentName, ticketNumber, ticketIssuerCode, restrictedTicketIndicator, carrierNo, fareBasis, couponNumber, flightNumber, passengerCode, and connectedTicketNumber fields in the pay (Checkout Payment) and createPaymentSession (Checkout Payment) APIs.
Added "Dispute", "Order number management", "Hosted mode" and "Embedded mode" for Antom Payment Orchestration.
Added the productScene, locale, goods.goodsBrand, goods.goodsSkuName, goods.goodsImageUrl, availablePaymentMethod.paymentMethodTypeList.paymentMethodType, availablePaymentMethod.paymentMethodTypeList.paymentMethodOrder,availablePaymentMethod.paymentMethodTypeList.expressCheckout, availablePaymentMethod.paymentMethodMetaData, paymentFactor.isAuthorization and normalUrl field in the createPaymentSession API for Antom Payment Orchestration.
Added the paymentResultInfo.threeDSResult.cavv, paymentResultInfo.threeDSResult.xid, paymentResultInfo.threeDSResult.eci, paymentResultInfo.threeDSResult.threeDSVersion and paymentTime field in the pay API for Antom Payment Orchestration.
Added the paymentResultInfo.issuerName, paymentResultInfo.threeDSResult.challengeCancel,paymentResultInfo.threeDSResult.threeDSOffered, paymentResultInfo.threeDSResult.threeDStransactionStatusReason,paymentResultInfo.lastFour, paymentResultInfo.expiryMonth, paymentResultInfo.expiryYear, transactions.acquirerInfo, authExpiryTime and paymentMethodType field in the inquiryPayment API for Antom Payment Orchestration.
Added the paymentResultInfo.lastFour, paymentResultInfo.issuerName, paymentResultInfo.expiryMonth andpaymentResultInfo.expiryYear field in the notifyPayment API for Antom Payment Orchestration.

Enhanced

Added the enumeration value
04
for the eci field in the notifyPayment and requiryPayment APIs.
Updated the description of the isAuthorization field in the pay (Checkout Payment) API.
Updated the length and description of the carrierNo field in the capture (Checkout Payment) API.
Updated the description of the cvv and cardHolderName fields in the pay (Checkout Payment) API.
Updated the content of "Capture", "Refund" and "Reconciliation" for Antom Payment Orchestration.

2025.7

Enhanced

Added the subscriptionInfo field in the pay (Checkout Payment) and createPaymentSession (Checkout Payment) APIs.
Added the storeName field in the pay (Checkout Payment) API.
Updated the content of APM payments for API-only integration.
Added the supported online payment integrations and plugins for the Payment Methods document.
Added "notifyDispute" for Antom Payment Orchestration.
Added the withholdingTaxAmountValue, withholdingTaxCurrency, iofFeeAmountValue, iofFeeCurrency fields in the settlement details report and settlement summary report.

2025.6

Enhanced

Added "Integration guide", "Revoke authorization", "Best practices" and "Best practices for configuring the authorization URL" for Auto Debit.
Updated the content of Cancel, Refund and URLs returned for some payment methods for Auto Debit.
Added the payment method Bizum to the Payment Methods document.
Updated the content of Transaction for Merchant service.

2025.5

Enhanced

Update the content of Hosted mode and Embedded mode for Checkout page integration.
Added payment methods PicPay and Tamara to the Payment Methods document.
Added Account management for Merchant service.
Updated the payment method types for Payment Methods.
Added the supported integrations and plugins for Payment Methods.
Added "EDC payment" for Antom Payment Orchestration.
Added "Compliance request" for Dispute Guidance for Ant International Merchants

2025.4

Enhanced

Added an “(Optional) Preload the SDK” step to Accept payments of EasySafePay.
Added "Collateral" and updated "Reserve" for Merchant service.
Added "Supported payment methods" for Payment Methods.
Added payment methods auPAY, FamiPay, and merpay to the Payment Methods document.
Added "Pop-up card binding experience" for Antom Payment Orchestration.
Updated the Pre-front solution for Checkout Payment.
Updated the sample code for Quick start of EasySafePay.
Updated the sample code for Quick start of Checkout Payment.
Updated the sample code for Quick start of Scan to Link.
Updated the sample code for Quick start of Subscription Payment.
Updated the sample code for Quick start of Auto Debit.
Updated the valid values of the locale parameter in Card payments of Checkout Payment.
Updated the SDK version to 1.34.0 for Web/WAP and Android clients.
Added the update APIs for Subscription Payment.

2025.3

Enhanced

Added a “Callback mode” integration guide for EDC Payment of Antom Payment Orchestration.
Added “WooCommerce plugin installation guide” for Plugins.
Added an “(Optional) Preload the SDK” step to APM payments and Card payments of SDK integration under Checkout Payment.
Update the South Korean Card issuers' interest-free installment information.
Updated the SDK version to 1.31.0 for Web/WAP and Android clients.
Updated the description of the userLoginId parameter in Accept payments of EasySafePay.
Updated the event codes of APM payments and Card payments of SDK integration under Checkout Payment.
Added Antom Shield section on the Home page.
Added “Rapid dispute resolution (RDR)” for Dispute.

2025.2

Enhanced

Added the anticipationAmountValue, anticipationFeeCurrency, riskDesisionServiceFeeAmountValue, riskDesisionServiceCurrency, riskManagementFeeAmountValue, riskManagmentFeeCurrency and cardCategory fields in the settlement details report.
Added the anticipationAmountValue, anticipationFeeCurrency, riskDesisionServiceFeeAmountValue, riskDesisionServiceCurrency, riskManagementFeeAmountValue and riskManagmentFeeCurrency in the settlement summary report.
Added "Checkout page integration" for checkout payment.
Added the cardholderName, cardBin, lastFour, expiryMonth and expiryYear fields in the pay, inquiryPayment and notifyPayment API.

2025.1

Enhanced

Added “Quick start” for Scan to Link.
Added “Quick start” for Auto Debit.
Added “Quick start” for Subscription Payment.
Added the payment method MoMo to the Payment methods document.
Added the redirectUrl field in the createVaultingSession API for Antom Payment Orchestration.
Updated the description of the is3DSAuthentication field in the Card payment features document.
Updated the SDK version to 1.27.0 for Web, WAP, and Android clients of Checkout Payment, EasySafePay, and Auto Debit.
Added the availablePaymentMethod field in the createPaymentSession (Checkout Payment) API.

2024.12

Enhanced

Added payment methods and live settlement plan for Merchant service.
Added Apple Pay for Payment method.
Added “Quick start” for EasySafePay.
Added Android and iOS platforms for Quick start of Checkout payment.
Added the is3DSAuthentication field in createVaultingSession API and vaultPaymentMethod API.
Added the networkTransactionId field in notifyVaulting and inquireVaulting API.
Added the priceId, shipping and savedPaymentMethods field in the inquiryPayment API and notifyPayment API.
Added the rdrFeeAmountValue、rdrFeeCurrency field in the Settlement details report API, Settlement summary report API and Report field summary API.

2024.11

Enhanced

Updated the download link of the test wallet app for the Android system in the Test wallet document.
Updated the SDK version to 1.24.0 for Web, WAP, and Android clients of Checkout Payment, EasySafePay and Auto Debit.
Added the content of the token validity period and updated the payment token parameters in Auto Debit and Scan to Pay.
Updated the supported payment methods in Subscription Payment.
Updated the South Korean Card issuers' interest-free installment information.
Added GooglePay payment methods in API Explorer of the pay (Checkout Payment) API and createPaymentSession (Checkout Payment) API.
Added the disputeType field in the notifyDispute API.

2024.10

Enhanced

Deprecated the tokenize field and added the tokenizeMode field in the pay (Checkout Payment) and createPaymentSession (Checkout Payment) APIs.
Added an Integration guide for EDC payment in Korea under the Card Payments section of Antom Payment Orchestration.
Updated the code and download link for Quick start of Checkout Payment.
Updated the valid values for the locale parameter in EasySafePay (Web/WAP), EasySafePay (Android), and EasySafePay (iOS).
Added
SDK_PAYMENT_CANCEL
to the Event codes for EasySafePay (Web/WAP), EasySafePay (Android), and EasySafePay (iOS).
Updated the valid values of the locale parameter in Checkout Payment and Antom Payment Orchestration.
Add the FAQ section on the Home page.

2024.9

Enhanced

Updated the user experience of Konbini and Pay-easy.
Added the Merchant onboarding document to Merchant service.
Added the recurringPayment field in the consult API.
Added Apple Pay, PayPal, Afterpay, Klarna, Duitnow and Card payment methods for APO payment methods.
Added "Description of fields collected by the Antom SDK security module" article for EasySafePay.
Updated the description of the subscriptionNotificationUrl and paymentNotificationUrl field in the create API.

2024.8

Enhanced

Added the transaction type
PAYMENT_REVERSAL
in Transaction details report, Settlement details report, and Settlement summary report.
Updated the email address of Antom Merchant Service technical support.
Added a video guide for Test case under Antom Dashboard.
Added notifyVaulting, notifySubscription and notifyPayment (Subscription) URLs for Notification URL.
Added JKOPay, K PLUS and TrueMoney payment methods in API Explorer of the pay (Checkout Payment) API.

2024.7

Enhanced

Added the creditPayPlan field in the inquiryPayment and notifyPayment APIs.
Added the error codes
IDENTITY_VERIFY_FAILED
,
IDENTITY_AGE_NOT_ENOUGH
,
INVALID_IDENTITY_STATUS
and
INVALID_CPF
to the pay (Checkout Payment) API.
Added the enumeration value
DISPUTE_ACCEPTED
for the disputeNotificationType field in the notifyDispute API.
Added the disputeAcceptReason and disputeAcceptTime fields in the notifyDispute API.

2024.6

Enhanced

Added the paymentFactor field in the consult (Checkout Payment) API.
Added the arn field in the notifyDispute API.
Added "Use Antom libraries" section in Sign a request and verify the signature.

2024.5

Enhanced

Added the promotionResult field in the pay (Checkout Payment), inquiryPayment, and notifyPayment APIs.
Added the buyer and promotionInfos fields in the consult (Checkout Payment) API.
Added the merchantAccountId field in the pay (Checkout Payment), inquiryPayment, consult (Checkout Payment), cancel, and inquiryRefund APIs.
Updated the description of the buyerPhoneNo field in the pay (Checkout Payment) API.
Added the region field in Settlement details report and Report field summary.
Added the "Collect device and browser information in advance in 3D transactions" section in Card payment features.
Added "How to test card payments", "How to test Alipay+ payment methods", and "How to test other payment methods" articles for Sandbox.
Updated a series of documents for Checkout Payment, Auto Debit, EasySafePay, and Subscription Payment.
Rename the product from Easy Pay to EasySafePay.
Added Alipay, GCash, KakaoPay, Touch 'n Go, and TrueMoney payment methods for Scan to Link.

2024.3

Enhanced

Added the funding and cardCategory fields in the pay (Checkout Payment), inquiryPayment, and notifyPayment APIs.
Added the funding field in the consult (Checkout Payment) API.
Added the requireIssuerAuthentication field in the pay (Checkout Payment) API.
Updated the description of the selectedCardBrand field in the pay (Checkout Payment) API.
Added the transit, lodging, and gaming fields in the pay (Checkout Payment), createPaymentSession (Checkout Payment), and decide APIs.
Added the embeded Web/WEP integration guide for Card payments.

2024.2

Enhanced

Added the acceptDispute, supplyDefenseDocument, downloadDisputeEvidence, and notfiyDispute APIs for Dispute.
Added the enumeration value
DEFENSE_DUE_ALERT
for the disputeNotificationType field in the notifyDispute API.
Updated the description of the defenseDueTime field in the notifyDispute API.

2024.1

Enhanced

Added the payment method Yapily to the Payment methods document.
Added the paymentMethodId field in the create API.
Added the enumeration value
CARD
for the paymentMethodType field in the create API.
Updated the description of the subscriptionEndTime field in the create API.
Added the phaseNo field in the notifyPayment API.

2023.12

Enhanced

Added the sample codes for K PLUS in the consult API.
Added the authExpiryTime field in the response of inquiryPayment API.
Updated the download link of test wallet for the Android version in the Test wallet document.
Added the error code
INVALID_AMOUNT
to the following APIs: pay (Checkout Payment), notifyPayment, inquiryPayment .
Updated the description of enumeration value
TOKEN_CREATED
for the authorizationNotifyType field in the notifyAuthorization API.
Updated the component name
AMSEasyPay
in the Web/WEP, Android, and iOS Integration guide of Easy Pay.
Updated the component name
AMSCashierPayment
in the Card payments Web/WEP, Android, and iOS Integration guide of Checkout Payment.
Updated the component name
AMSCashierPayment
in the Bank related payments Web/WEP, Android, and iOS Integration guide of Checkout Payment.

2023.11

Enhanced

Added the error code
ORDER_IS_CANCELED
to the refund API.
Added the event code
SDK_PAYMENT_CANCEL
to the Android Integration guide of Easy Pay.
Added the payment methods Pagaleve and Bancomat Pay to the Payment methods document.
Added the scenario of Pagaleve to the field paymentMethod.paymentMethodMetaData of the pay (Checkout Payment) API.
Updated the description of the fields order.buyer and order.buyer.buyerPhoneNo of the pay (Checkout Payment) API.
Added the createVaultingSession, vaultPaymentMethod, notifyVaulting, and inquireVaulting APIs for Vault.
Added the Web/WEP, Android, and iOS Integration guides for Bank related payments.
Updated the code sample in the Web/WEP, Android, and iOS Integration guide of Easy Pay.

In-store payments

Added the error code
ORDER_STATUS_INVALID
to the cancel API.
Added the error codes
ACCESS_DENIED
and
ORDER_IS_CANCELED
to the refund API.

Deprecated

Removed the domain used by GAGW: https://open-global.alipay.com.

2023.10

Enhanced

Added the scenarios of KONBINI, BANKTRANSFER_PAYEASY, and ONLINEBANKING_PAYEASY to the fields order.buyer.buyerEmail, order.buyer.buyerEmail.buyerPhoneNo, order.buyer.buyerEmail.buyerName.firstName, and order.buyer.buyerEmail.buyerName.lastName of the pay (Checkout Payment) API.
Added the error code
DO_NOT_HONOR
to the inquiryPayment, notifyPayment, and pay (Checkout Payment) APIs.
Added the auto-capture ability to card payment in the paymentFactor.captureMode field in the createPaymentSession (Checkout Payment) document.
Updated the integration solution of LINE Pay, Pay-easy, and Konbini in the Non-card payment document.
Added the Quickstart and Test resources documents to the Checkout Payment documentation.
Added the payment methods
DIRECT_DEBIT_SIAMCOMMERCIALBANK
and
DIRECT_DEBIT_KRUNGTHAIBANK
to the Payment methods document.
Added the payment methods DOKU, KPLUS, Pay-easy online banking, and Pay-easy bank transfer for Checkout Payment to the Payment methods document.
Added the payment methods KPLUS for Auto Debit and Subscription Payment to the Payment methods document.
Added the optional field agent-token to the request header to authorize ISVs for API calls.

Deprecated

Deleted the scenarios of Pay-easy and Konbini from the field paymentMethod.paymentMethodMetaData of the pay (Checkout Payment) API.
Deleted the error code INVALID_API from the pay (Checkout Payment) and pay (Auto Debit) APIs.
Deprecated the payment method of Pay-easy (with enumeration value
PAYEASY
).

2023.9

Enhanced

Added the field paymentFactor.captureMode to the pay (Checkout Payment) API.
Modified the description of the field paymentResultInfo in the inquiryPayment and notifyPayment APIs.
Added the fields WalletPaymentResultInfo.creditPayPlan, paymentResultInfo.funding, and WalletPaymentResultInfo.creditPayPlan.installmentNu to the inquiryPayment and notifyPayment APIs.
Modified the description of the fields order.shipping.shippingAddress.state, order.shipping.shippingAddress.zipCode, paymentMethod.paymentMethodMetaData.billingAddress.state, and paymentMethod.paymentMethodMetaData.billingAddress.zipCode in the pay (Checkout Payment) and createPaymentSession (Checkout Payment) APIs.
Added the field authCodeForm to the consult API.
Added the auto-capture ability to card payment in the Card payment, API integration, and Capture documents of the Checkout Payment documentation.
Added new payment methods JKOPay and LINE Pay for Checkout Payment to the Payment methods document.
Modified the maximum length of the field funding from 6 to 20 to the Transaction details report and Settlement details report documents in the Reconciliation documentation.
Added the enumeration values
COLLATERAL_WITHHOLDING
,
RESERVE_WITHHOLDING
,
RESERVE_RELEASE
to the field summaryType in the Settlement summary report document of the Reconciliation documentation.
Added the enumeration values
COLLATERAL_WITHHOLDING
,
RESERVE_WITHHOLDING
,
RESERVE_RELEASE
to the field transactionType in the Settlement details report document of the Reconciliation documentation.
Added the Best practices for configuring the payment continuation URL document to the Checkout Payment documentation.
Update the Settlement & Transactions documentation.

Deprecated

Deprecated the payment methods of Dolfin, BPI, bKash for Direct Debit and Periodic Subscriptions, and Easypaisa for Direct Debit and Periodic Subscriptions.

2023.8

Enhanced

Added the three video tutorials about merchant service operations: How to issue a refund, How to view transaction details, and How to manage invoices.
Added the documentation of the value-added services: Revenue Booster, Combined Payment, and Flexible Settlement.
Added the documentation of the payment products: Scan to Bind and Subscription Payment.
Added the Card payment documents in Checkout Payment documentation.
Added the enumeration values
AMEX
,
DISCOVER
,
DINERS
,
CUP
,
JCB
,
MAESTRO
, and
CARTES_BANCAIRES
for Card brands in Payment methods.
Added payment methods supported by Subscription Payment in Payment methods.
Added the document Risk management methods.
Added the accelerated domain name https://open-de-global.alipay.com for merchant servers based in Europe.
Added the create, notifySubscription, notifyPayment, change, and cancel APIs for Subscription Payment.
Added the error codes
CARD_NOT_SUPPORTED
,
USER_BALANCE_NOT_ENOUGH
,
INVALID_EXPIRATION_DATE
, and
INVALID_CARD_NUMBER
in the pay (Cashier Payment), notifyPayment, and inquiryPayment APIs.
Added the createPaymentSession (Cashier Payment) API for card payment.
Updated the Auto Debit documentation. The new version offers a restructured guide on integration and operations following the payment.
Updated the product name from Cashier Payment to Checkout Payment.
Updated the Reconciliation documentation. The new version provides comprehensive information on reconciliation, covering settlement rules and lifecycle.

2023.7

Enhanced

Added the createPaymentSession (Easy Pay) API for Easy Pay product.
Added both the English and Chinese version of the integration guide for Easy Pay product.
Added the enumeration value
TOKEN_CREATED
to the field authorizationNotifyType in the request parameters of the notifyAuthorization API.
Supported the acquirer AlipayBR for the Brazilian cards and PIX.

Deprecated

Deprecated the field customerId in the request parameters of the pay (Cashier Payment), pay (Auto Debit), pay (User-presented Mode Payment), pay (Order Code Payment), and pay (Entry Code Payment).

2023.6

Enhanced

Added the enumeration value
NAVERPAY
for Cashier Payment and Auto Debit, and
TOSS
for Cashier Payment in Payment methods.
Added the documentation for merchant service, which provides tutorials about merchant operations.
Added the contact information of Alipay Merchant Service risk operation support.

Document improvements

Modified the domain names for Cashier Payment and Auto Debit to which API requests are sent. For details, see Call an API.
Modified the format of
Request-Time
to a timestamp whose value is accurate to milliseconds. For details, see Construct the content to be signed.

2023.5

Enhanced

Added the enumeration value
ZALOPAY
for Cashier Payment and Auto Debit in Payment methods.
Expressed the transaction amount in major units. For more information, see the following documents:

Settle and reconcile for Cashier Payment
Transaction Items for Cashier Payment
Settlement Items for Cashier Payment
Settlement Summary for Cashier Payment
Settle and reconcile for Auto Debit
Transaction Items for Auto Debit
Settlement Items for Auto Debit
Settlement Summary for Auto Debit

Changed the length of the parameter customerBelongsTo from 16 to 64 in the request parameters of the consult and applyToken APIs.
Changed the length of the parameter paymentMethod.paymentMethodType from 32 to 64 in the request parameters of the pay (Auto Debit) API.

2023.4

Enhanced

Added the payment method type OTC in Payment methods.
Added the enumeration value
KREDIVO_ID
for Cashier Payment in Payment methods.
Changed the download address of the test wallet for Android in Test wallet.
Added the parameter cardInfo.threeDSResult in the response parameters of the inquiryPayment API.
Added the parameter cardInfo.threeDSResult in the request parameters of the inquiryPayment API.

Deprecated

Deprecated the parameter redirectActionForm in the response parameters of the pay (Cashier Payment) API.
Deprecated the parameter authUrl in the response parameters of the consult API.
Deprecated the parameter cardInfo.eci in the response parameters of the inquiryPayment API.
Deprecated the parameter cardInfo.eci in the request parameters of the notifyPayment API.

Document improvements

Added the description of Blik in the Collect or display extra information section of Pay with card-excluded payment methods.
Updated the description of the parameters order.env.clientIp and order.env.userAgent for the payment method Blik in the request parameters of the pay (Cashier Payment) API.

2023.3

Enhanced

Added Best practices for BNPL channels for Cashier Payment.
Added the enumeration values
KONBINI
,
FPX
, and
PAYEASY
for Cashier Payment;
PAYPAY
and
GrabPay
for Auto Debit in Payment methods.
Added the parameter payerEmail for the scenario Payeasy and Konbini to the parameter paymentMethod.paymentMethodMetaData in the request parameters of the pay (Cashier Payment) API.
Added the error code
AUTH_IN_PROCESS
in the applyToken API.
Added the sample codes for QRIS in the pay (Cashier Payment) API.
Added the enumeration value
OTC
to the field paymentOptions.paymentMethodCategory in the response parameters of the consult (Cashier Payment) API.

Document improvements

Updated the description of the two card collection modes in Pay with card payment methods.
Updated the description of the parameters order.shipping.shippingPhoneNo, order.buyer.buyerPhoneNo, order.buyer.buyerName.firstName, and order.shipping.shippingName.firstName in the request parameters of the pay (Cashier Payment) API.
Changed the length of the parameter clientIp from 32 to 64 in the request parameters of the pay (Cashier Payment), pay (Auto Debit), pay (User-presented Mode Payment), pay (Order Code Payment), and pay (Entry Code Payment).
Updated the description of the parameter result.resultStatus in the request parameters of the notifyPayment API.
Updated the card brands supported by Brazil, Peru, Mexico, and Chile in Payment methods.
Deleted the statement that the canceled transaction is not included in the settlement files in Cancel.
Added a note of the default order expiry time of Mercado Pago in the Obtain an asynchronous notification section of Pay with card-excluded payment methods.
Added the description of Mercado Pago in the Collect or display extra information section of Pay with card-excluded payment methods.
Added the description of codeValue in the Invoke the payment process section of Pay with card-excluded payment methods.
Updated the description of the notifyPayment notification in Notifications.
Renamed the "Payment method-incorporated solution" as the "Payment method-preposed solution".
Added the enumeration values
KONBINI
,
FPX
, and
PAYEASY
to the field paymentMethodType. For more information, see the following documents:

Transaction Items for Cashier Payment
Settlement Items for Cashier Payment

Added the enumeration values
PAYPAY
and
GrabPay
to the field paymentMethodType. For more information, see the following documents:

Transaction Items for Auto Debit
Settlement Items for Auto Debit

Updated the report sample in the Sample 5 section. For more information, see the following documents:

Settlement Items for Cashier Payment
Settlement Items for Auto Debit

Updated the description of the parameter originalTransactionId. For more information, see the following documents:

Settle and reconcile for Cashier Payment
Settle and reconcile for Auto Debit
Transaction Items for Cashier Payment
Transaction Items for Auto Debit
Settlement Items for Cashier Payment
Settlement Items for Auto Debit

2023.2

Enhanced

Added the Cashier Payment documentation in Chinese and English versions.
Added Payment methods for the use in the description of parameters.
Added the enumeration values
BILLEASE
,
QRIS
,
MERCADOPAGO_BR
,
MERCADOPAGO_MX
,
MERCADOPAGO_CL
, and
MERCADOPAGO_PE
to the field paymentOptions.paymentMethodType in the response parameters of the consult (Cashier Payment) API.
Added the enumeration values
BILLEASE
,
QRIS
,
MERCADOPAGO_BR
,
MERCADOPAGO_MX
,
MERCADOPAGO_CL
, and
MERCADOPAGO_PE
to the field paymentMethod.paymentMethodType in the request parameters of the pay (Cashier Payment) API.
Added the parameters cpf and payerEmail for the scenario Mercado Pago to the parameter paymentMethod.paymentMethodMetaData in the request parameters of the pay (Cashier Payment) API.
Added the enumeration values
BILLEASE
,
QRIS
,
MERCADOPAGO_BR
,
MERCADOPAGO_MX
,
MERCADOPAGO_CL
, and
MERCADOPAGO_PE
to the field paymentMethodType. For more information, see the following documents:

Transaction Items for Cashier Payment
Settlement Items for Cashier Payment

Added the enumeration value
REFUND_REVERSAL
to the parameter transactionType. For more information, see the following documents:

Settlement Items for Cashier Payment
Settlement Items for Auto Debit

Added the enumeration value
REFUND_REVERSAL
to the parameter summaryType. For more information, see the following documents:

Settlement Summary for Cashier Payment
Settlement Summary for Auto Debit

Document improvements

Updated the capitalization of the request headers in Overview.
Updated the code sample in the consult (Cashier Payment) and notifyPayment APIs.
Updated the description of the parameter paymentMethod.paymentMethodMetaData in the request parameters of the pay (Cashier Payment) API.

2023.1

Enhanced

Added the enumeration values
AKULAKU_PAYLATER_PH
and
GRABPAY_MY
to the field paymentOptions.paymentMethodType in the response parameters of the consult (Cashier Payment) API.
Added the enumeration values
AKULAKU_PAYLATER_PH
and
GRABPAY_MY
to the field paymentMethod.paymentMethodType in the request parameters of the pay (Cashier Payment) API.
Changed the parameter allowedPspRegions to allowedPaymentMethodRegions in the request parameters of the consult (Cashier Payment) API.
Added a list of enumeration values to the parameter PaymentOptions.paymentOptionDetail.supportCardBrands.cardBrand in the response parameters of the consult (Cashier Payment) API.
Added a list of enumeration values to the parameter PaymentOptions.paymentOptionDetail.supportCardBrands.logo.logoName in the response parameters of the consult (Cashier Payment) API.
Added the parameter PaymentOptions.paymentOptionDetail.funding in the response parameters of the consult (Cashier Payment) API.
Added the parameters paymentMethod.paymentMethodMetaData.dateOfBirth, paymentMethod.paymentMethodMetaData.businessNo, paymentMethod.paymentMethodMetaData.cardPasswordDigest, paymentMethod.paymentMethodMetaData.payerEmail, and paymentMethod.paymentMethodMetaData.payMentMethodRegion in the request parameters of the pay (Cashier Payment) API.
Added the parameters cardInfo.issuingCountry, cardInfo.funding, and cardInfo.paymentMethodRegion in the request parameters of the notifyPayment API.
Added the parameters cardInfo.issuingCountry, cardInfo.funding, and cardInfo.paymentMethodRegion in the response parameters of the inquiryPayment API.
Added the enumeration values
AKULAKU_PAYLATER_PH
and
GRABPAY_MY
to the parameter paymentMethodType. For more information, see the following documents:

Transaction Items for Cashier Payment
Settlement Items for Cashier Payment

Added the parameters issuingCountry, funding, and cardBrand. For more information, see the following documents:

Transaction Items for Cashier Payment
Settlement Items for Cashier Payment

Added the parameters interchangeFeeAmountValue, interchangeFeeCurrency, schemeFeeAmountValue, schemeFeeCurrency, AcquirerMarkupFeeAmountValue, and AcquirerMarkupFeeCurrency. For more information, see the following documents:

Settlement Items for Cashier Payment
Settlement Summary for Cashier Payment

Added the enumeration values
AUTHORIZATION
,
VOID
,
CAPTURE
, and
DISPUTE
to the parameter summaryType. For more information, see the following documents:

Settlement Summary for Cashier Payment

Document improvements

Modified the data type of the parameter PaymentOptions.installment in the response parameters of the consult (Cashier Payment) API to an object.
Updated the description of the parameter PaymentOptions.paymentMethodRegion in the response parameters of the consult (Cashier Payment) API.
Updated the description of the parameter feeAmountValue. For more information, see the following documents:

Settlement Items for Cashier Payment
Settlement Summary for Cashier Payment

2022.12

Enhanced

Added a drop-down box to filter the child parameters of the field paymentMethodMetaData in the request parameters of the pay (Cashier Payment) API.
Added a note indicating the rounding rule applied to IDR to the fields paymentAmount.value in the request parameters of the pay (Cashier Payment) API, paymentAmount.value in the request parameters of the consult (Cashier Payment) API, captureAmount.value in the request parameters of the capture (Cashier Payment) API, paymentAmount.value in the request parameters of the pay (Auto Debit) API, refundAmount.value in the request parameters of the refund API, and declarationAmount.value in the request parameters of the declare API.
Added the enumeration values
DOLFIN
,
GRABPAY_SG
,
LINKAJA
,
OVO
,
GOPAY_ID
,
OCTOCLICKS
,
ONLINEBANKING_BNI
,
ONLINEBANKING_MANDIRI
,
ONLINEBANKING_BRI
,
ONLINEBANKING_BCA
,
BANKTRANSFER_MAYBANK
,
BANKTRANSFER_BNI
,
BANKTRANSFER_PERMATA
,
CIMBNIAGA
,
BANKTRANSFER_MANDIRI
,
BANKTRANSFER_BSI
,
ATMTRANSFER_ID
, and
PAYNOW
to the field paymentOptions.paymentMethodType in the response parameters of the consult (Cashier Payment) API.
Added the enumeration values
DOLFIN
,
GRABPAY_SG
,
LINKAJA
,
OVO
,
GOPAY_ID
,
OCTOCLICKS
,
ONLINEBANKING_BNI
,
ONLINEBANKING_MANDIRI
,
ONLINEBANKING_BRI
,
ONLINEBANKING_BCA
,
BANKTRANSFER_MAYBANK
,
BANKTRANSFER_BNI
,
BANKTRANSFER_PERMATA
,
CIMBNIAGA
,
BANKTRANSFER_MANDIRI
,
BANKTRANSFER_BSI
,
ATMTRANSFER_ID
, and
PAYNOW
to the field paymentMethod.paymentMethodType in the request parameters of the pay (Cashier Payment) API.
Added the enumeration value
MAYA
to the field customerBelongsTo in the request parameters of the consult API.
Added the enumeration value
MAYA
to the field customerBelongsTo in the request parameters of the applyToken API.
Added the enumeration value
MAYA
to the field paymentMethod.paymentMethodType in the request parameters of the pay (Auto Debit) API.
Added the enumeration value
DOLFIN
,
GRABPAY_SG
,
LINKAJA
,
OVO
,
GOPAY_ID
,
OCTOCLICKS
,
ONLINEBANKING_BNI
,
ONLINEBANKING_MANDIRI
,
ONLINEBANKING_BRI
,
ONLINEBANKING_BCA
,
BANKTRANSFER_MAYBANK
,
BANKTRANSFER_BNI
,
BANKTRANSFER_PERMATA
,
CIMBNIAGA
,
BANKTRANSFER_MANDIRI
,
BANKTRANSFER_BSI
,
ATMTRANSFER_ID
, and
PAYNOW
to the field paymentMethodType. For more information, see the following documents:

Transaction Items for Cashier Payment
Settlement Items for Cashier Payment

Added the enumeration value
MAYA
to the field paymentMethodType. For more information, see the following documents:

Transaction Items for Auto Debit
Settlement Items for Auto Debit

2022.11

Enhanced

Added the error code FRAUD_REJECT in the pay (Cashier Payment), notifyPayment, and inquiryPayment APIs.
Added the error code SUSPECTED_RISK in the notifyPayment and inquiryPayment APIs.
Added the enumeration value
PROMPTPAY
to the field paymentOptions.paymentMethodType in the response parameters of the consult (Cashier Payment) API.
Added the enumeration value
PROMPTPAY
to the field paymentMethod.paymentMethodType in the request parameters of the pay (Cashier Payment) API.
Added the enumeration value
EASYPAISA
to the field customerBelongsTo in the request parameters of the consult and applyToken APIs.
Added the enumeration value
EASYPAISA
to the field paymentMethodType in the request parameters of the pay (Auto Debit) API.
Added the error code
NO_PAY_OPTIONS
in the consult and applyToken APIs.
Added the enumeration value
PROMPTPAY
to the field paymentMethodType. For more information, see the following documents:

Transaction Items for Cashier Payment
Settlement Items for Cashier Payment

Added the enumeration value
EASYPAISA
to the field paymentMethodType. For more information, see the following documents:

Transaction Items for Cashier Payment
Settlement Items for Cashier Payment
Transaction Items for Auto Debit
Settlement Items for Auto Debit

Deprecated

Deprecated the field cookieId in the request parameters of the pay (Cashier Payment) API.

Document improvements

Modified the description of the error code RISK_REJECT in the pay (Cashier Payment), notifyPayment, and inquiryPayment APIs.
Modified the description of the fields orderCodeForm, orderCodeForm.codeDetails. codeValue in the response parameters of the pay (Cashier Payment) API.
Modified the description of the fields order.env.deviceTokenId, shipToEmail, and goodsCategory in the request parameters of the pay (Cashier Payment) API.

2022.10

Enhanced

Added the paymentOptions.intallments field in the response parameters of the consult (Cashier Payment) API.
Added the paymentOptions.paymentOptionDetail.supportBanks field in the response parameters of the consult (Cashier Payment) API.
Added the enumeration value
PAYPAY
to the field paymentOptions.paymentMethodType in the response parameters of the consult (Cashier Payment) API.
Added the enumeration value
WALLET
to the field paymentOptions.paymentMethodCategory in the response parameters of the consult (Cashier Payment) API.
Added the error code CURRENCY_NOT_SUPPORT in the consult (Cashier Payment) API.
Added the fields blikCode and payerEmail as child parameters to the field paymentMethodMetaData.paymentMethodMetaData in the request parameters of pay (Cashier Payment) API.
Added the paymentMethod.paymentMethodMetaData.bankIdentifierCode field in the request parameters of pay (Cashier Payment) API.
Added the paymentMethod.paymentMethodMetaData.cpf field in the request parameters of pay (Cashier Payment) API.
Added the description of the fields order.buyer.buyerPhoneNo and order.buyer.buyerEmail in the request parameters of pay (Cashier Payment) API.
Added the description of the field paymentMethod.paymentMethodMetaData.billingAddress in the request parameters of pay (Cashier Payment) API.
Added the description of the field paymentMethod.paymentMethodMetaData.cpf in the request parameters of pay (Cashier Payment) API.
Added the value range to the field creditPayPlan.installmentNum in the request parameters of pay (Cashier Payment) API.
Added the enumeration value
PAYPAY
to the field paymentMethod.paymentMethodType in the request parameters of pay (Cashier Payment) API.
Added the error code MULTI_CAPTURE_NOT_SUPPORTED in the capture (Cashier Payment) and notifyCapture (Cashier Payment) APIs.
Added the field disputeJudgedTime in the request parameters of notifyDispute API.
Added the description of the field disputeJudgedResult in the request parameters of notifyDispute API.
Added the field installmentsNum. For more information, see the following documents:

Transaction Items for Cashier Payment
Settlement Items for Cashier Payment
Transaction Items for Auto Debit
Settlement Items for Auto Debit

Added the fields disputeHandlingFee, disputeHandlingFeeCurrency, disputeReverseFee, and disputeReverseFeeCurrency. For more information, see the following documents:

Settlement Items for Cashier Payment
Settlement Summary for Cashier Payment
Settlement Items for Auto Debit
Settlement Summary for Auto Debit

Added the enumeration value
PAYPAY
to the field paymentMethodType. For more information, see the following documents:

Transaction Items for Cashier Payment
Settlement Items for Cashier Payment
Transaction Items for Auto Debit
Settlement Items for Auto Debit

Updated the description of the fields settlementAmountValue, feeAmountValue, and taxFeeAmountValue. For more information, see the following documents:

Settlement Items for Cashier Payment
Settlement Summary for Cashier Payment
Settlement Items for Auto Debit
Settlement Summary for Auto Debit

Added the sample 4 applicable when the acquirer is Hundsun. For more information, see the following documents:

Settlement Items for Cashier Payment
Settlement Summary for Cashier Payment
Settlement Items for Auto Debit
Settlement Summary for Auto Debit

Deprecated

Deprecated the card child field of the paymentOptions.paymentOptionDetail field in the response parameters of the consult (Cashier Payment) API.
Deprecated the
ACCEPT_BY_ALIPAY
value of the disputeJudgedResult field in the request parameters of notifyDispute API.
Deprecated the error codes of the notifyDispute API.

Document improvements

Modified the enumeration value
MIXEDCARD
to
CARD
of the field paymentOptions.paymentMethodType in the response parameters of the consult (Cashier Payment) API.
Capitalized the enumeration values of the field paymentOptions.paymentMethodCategory in the response parameters of the consult (Cashier Payment) API.
Modified the description of the field paymentOptions.paymentOptionDetail in the response parameters of the consult (Cashier Payment) API.
Modified the paymentOptions.installments.interestRate to an optional field in the response parameters of the consult (Cashier Payment) API.
Modified the data type of the paymentMethod.paymentMethodMetaData field to an object and modified its description.
Modified the enumeration value
MIXEDCARD
to
CARD
of the field paymentMethod.paymentMethodType in the request parameters of the pay (Cashier Payment) API.
Modified the enumeration value
MIXEDCARD
to
CARD
of the field paymentMethodType. For more information, see the following documents:

Transaction Items for Cashier Payment
Settlement Items for Cashier Payment
Transaction Items for Auto Debit
Settlement Items for Auto Debit

2022.9

Enhanced

Updated the sign a request and verify the signature documentation.
Updated the Support documentation.
Added the merchantRegion field in the request parameters of the consult (Cashier Payment) API.
Added enumeration values to the field paymentOptions.paymentMethodType in the response parameters of the consult (Cashier Payment) API.
Added the paymentOptions.paymentMethodCategory field in the response parameters of the consult (Cashier Payment) API.
Added the field paymentOptions.paymentOptionDetail in the response parameters of the consult (Cashier Payment) API.
Added the fields paymentFactor, paymentMethod.paymentMethodId in the request parameters of the pay (Cashier Payment) API.
Added enumeration values to the field paymentMethod.paymentMethodType in the request parameters of the pay (Cashier Payment) API.
Added the field card as a child parameter to the field paymentMethodMetaData in the request parameters of pay (Cashier Payment) API.
Added the merchantRegion field in the request parameters of the pay (Cashier Payment) API.
Added the capture (Cashier Payment) API.
Added the fields cardInfo and acquirerReferenceNo in the request parameters of the notifyPayment API.
Added the notifyCapture (Cashier Payment) API.
Added the fields cardInfo and acquirerReferenceNo in the response parameters of the inquiryPayment API.
Added the field acquirerReferenceNo in the response parameters of the refund API.
Added the error code ORDER_STATUS_INVALID in the cancel API.

Deprecated

Deprecated the field paymentMethod.card in the request parameters of the pay (Cashier Payment) API.

Document improvements

Modified the description of the paymentOptions.paymentMethodRegion field in the response parameters of the consult (Cashier Payment) API.
Modified the minimum length of the paymentOptions.logo.logoName field in the response parameters of the consult (Cashier Payment) API.
Modified the description of the result.resultStatus field in the response parameters of the pay (Cashier Payment) API.
Modified the name of the error code
PAYMENT_METHOD_NOT_SUPPORTED
in the refund API.
Updated the result process logic of the pay (Cashier Payment) API.
Modified the description of the transactions field in the response parameters of the inquiryPayment API.
Updated the payment result codes of the inquiryPayment API.
Modified the description of the file path naming rule and the field seq. For more information, see the following documents:

Transaction Items for Cashier Payment
Settlement Items for Cashier Payment
Settlement Summary for Cashier Payment
Transaction Items for Auto Debit
Settlement Items for Auto Debit
Settlement Summary for Auto Debit

Modified the description of the field customerId. For more information, see the following documents:

Transaction Items for Cashier Payment
Settlement Items for Cashier Payment
Settlement Summary for Cashier Payment
Transaction Items for Auto Debit
Settlement Items for Auto Debit
Settlement Summary for Auto Debit

Added the field acquirer. For more information, see the following documents:

Transaction Items for Cashier Payment
Settlement Items for Cashier Payment
Settlement Summary for Cashier Payment
Transaction Items for Auto Debit
Settlement Items for Auto Debit
Settlement Summary for Auto Debit

Added the field acquirerReferenceNo. For more information, see the following documents:

Transaction Items for Cashier Payment
Settlement Items for Cashier Payment
Transaction Items for Auto Debit
Settlement Items for Auto Debit

Modified the description of the fields transactionId, originalTransactionId, transactionRequestId, referenceTransactionId, paymentMethodType, and transactionType. For more information, see the following documents:

Transaction Items for Cashier Payment
Settlement Items for Cashier Payment
Transaction Items for Auto Debit
Settlement Items for Auto Debit

Modified the description of the field settlementBatchId. For more information, see the following documents:

Settlement Items for Cashier Payment
Settlement Summary for Cashier Payment
Settlement Items for Auto Debit
Settlement Summary for Auto Debit

Added the fields taxFeeAmountValue and taxFeeCurrency. For more information, see the following documents:

Settlement Items for Cashier Payment
Settlement Summary for Cashier Payment
Settlement Items for Auto Debit
Settlement Summary for Auto Debit

2022.8

Enhanced

Deprecated the Data dictionary for APIs.
Deprecated the APIs about registration for online payments: registration, notifyRegistrationStatus, inquiryRegistrationStatus, inquiryRegistrationInfo.

Document improvements

Modified the description of the referenceTransactionId field. For more information, see the following documents:

Transaction Items for Cashier Payment
Settlement Items for Cashier Payment
Transaction Items for Auto Debit
Settlement Items for Auto Debit

Added the fields processingFeeAmountValue and processingFeeCurrency to the Settle and reconcile documents. For more information, see the following documents:

Settle and reconcile for Cashier Payment
Settle and reconcile for Auto Debit

Modified the description of the feeAmountValue field. For more information, see the following documents:

Settle and reconcile for Cashier Payment
Settlement Items for Cashier Payment
Settlement Summary for Cashier Payment
Settle and reconcile for Auto Debit
Settlement Items for Auto Debit
Settlement Summary for Auto Debit

Modified the description of the paymentMethodMetaData field in the pay (Cashier Payment) API.

2022.7

Enhanced

Added the userRegion field in the request parameters and the paymentData field in the response parameters of the pay (Cashier Payment) API.
Added two error codes
REFUND_NOT_SUPPORTED
and
PARTIAL_REFUND_NOT_SUPPORTED
in the refund API.
Added Best practices for BNPL channels for Cashier Payment.
Added the goodsCategory field to pay (Cashier Payment) and pay (Auto Debit) APIs.
Added Akulaku PayLater payment method to Cashier Payment, and Boost eWallet to Cashier Payment and Auto Debit. For more information, see the following documents:

Document improvements

Updated the result process logic in the pay (Cashier Payment) API.
Updated the error codes in the interfaces: consult, applyToken, revoke, pay (Cashier Payment), pay (Auto Debit), notifyPayment, inquiryPayment, cancel, refund, inquiryRefund, notifyRefund, declare, inquiryDeclarationRequests, pay (User-presented Mode Payment), pay (Order Code Payment), pay (Entry Code Payment).

2022.5

Added the consult (Cashier Payment) and notifyRefund interfaces.

Updated the pay (Cashier Payment) document:

Added the paymentMethod.paymentMethodMetaData field in Request parameters.
Added some new enumeration values in the paymentMethod.paymentMethodType field.
Modfied the field description of settlementStrategy.settlementCurrency.
Added the following error codes:

INVALID_PAYMENT_METHOD_META_DATA
INCORRECT_BLIKCODE
SETTLE_CONTRACT_NOT_MATCH

Updated the notifyPayment document:

Added the new enumeration value of
PAYMENT_PENDING
in the notifyType field.

Updated the inquiryPayment document:

Added the new enumeration value of
PENDING
in the paymentStatus field.

Updated the refund document:

Added the refundNotifyUrl field in Request parameters.
Added the error code: REFUND_IN_PROCESS

Updated the Transaction Items, Settlement Items, and Settlement Summary documents under Cashier Payment:

Added the following new enumeration values in the paymentMethodType field in Transaction Items and Settlement Items:

IDEAL
GIROPAY
SOFORT
PAYU
P24
BLIK
EPS
BANCONTACT
PIX

Added the following fields in Settlement Items and Settlement Summary:

processingFeeAmountValue
processingFeeCurrency

Modified the Report path and name parts in Settlement Items and Settlement Summary.

2022.4

Added the merchantRegion field in the request parameters of the following interfaces:

pay (Cashier Payment)
consult
applyToken
pay (User-presented Mode Payment)
pay (Order Code Payment)
pay (Entry Code Payment)

Modified Customs codes in the sample codes of the following interfaces:

declare: modified ZHENGZHOU to ZONGSHU
inquiryDeclarationRequests: modified shenzhen to ZONGSHU

The Business Registration Country/Region field is moved from the Welcome page to the Create New Application page.

2022.3

Added the Sandbox documentation.
Added a new version of the Cashier Payment documentation.
Added a new version of the Auto Debit documentation.
Added the redirectActionForm field in the response parameters of the inquiryPayment interface.

2022.2

Deleted the initAuthentication and verifyAuthentication interfaces.
Added the USER_NOT_EXIST error code in the pay (Auto Debit).

2022.1

Added the grossSettlementAmount and settlementQuote fields in the following interfaces:

notifyPayment
inquiryPayment
refund
inquiryRefund

Updated the pay (Cashier Payment) document:

Added the following error codes:

INVALID_MERCHANT_STATUS
MERCHANT_KYB_NOT_QUALIFIED
NO_PAY_OPTIONS

Deleted the following error codes:

SUCCESS
ORDER_NOT_EXIST

Updated the pay (Auto Debit) document:

Deleted the following fields:

Request parameters:

merchant.store
order.env.storeTerminalId
order.env.storeTerminalRequestTime
payToMethod
paymentMethod.paymentMethodMetaData
isAuthorization
paymentVerificationData
paymentFactor

Response parameters:

authExpiryTime
challengeActionForm
redirectActionForm
orderCodeForm

Modified the following fields from Optional to Required:

Request parameters:

paymentMethod.paymentMethodId
env
env.terminalType
settlementStrategy.settlementCurrency

Response parameters:

result.resultMessage

Added the following error codes:

INVALID_MERCHANT_STATUS
MERCHANT_KYB_NOT_QUALIFIED
USER_PAYMENT_VERIFICATION_FAILED

Deleted the following error codes:

USER_NOT_EXIST
ORDER_NOT_EXIST

Updated the notifyPayment document:

Deleted the following fields:

Request parameters:

notifyType: OFFLINE_PAYMENT_CODE
result.resultStatus: U

Modified the following fields from Optional to Required:

Request parameters:

paymentCreateTime
paymentId
result.resultMessage

Added the error codes of pay (Cashier Payment) and pay (Auto Debit).

Updated the inquiryPayment document:

Deleted the following fields:

Response parameters:

authExpiryTime
redirectActionForm
transaction.transactionType: PAYMENT, CANCEL, AUTHORIZATION, CAPTURE, VOID
transactionTime

Modified the following fields from Optional to Required:

Response parameters:

result
result.resultMessage
transactions.transactionId

Added the following two result codes tables:

Payment result codes
Transaction result codes

Deleted the following error codes:

RISK_REJECT
USER_KYC_NOT_QUALIFIED

Updated the cancel document:

Modified the following field from Optional to Required:

Response parameters:

result.resultMessage

Updated the refund document:

Modified the following field from Optional to Required:

Response parameters:

result.resultMessage

Added the following error codes:

INVALID_MERCHANT_STATUS
ORDER_IS_CLOSED

Updated the inquiryRefund document:

Added the following field:

Response parameters:

refundStatus: FAIL

Deleted the following error codes:

RISK_REJECT
MERCHANT_NOT_REGISTERED
INVALID_CONTRACT

Added a Refund result codes table.

Updated the consult document:

Modified the following field from Optional to Required:

Response parameters:

result.resultMessage

Added the following error codes:

INVALID_CLIENT_STATUS
OAUTH_FAILED
UNKNOWN_CLIENT

Updated the applyToken document:

Modified the following field from Optional to Required:

Response parameters:

result.resultMessage

Added the following error codes:

INVALID_CLIENT_STATUS
OAUTH_FAILED
UNKNOWN_CLIENT
USER_NOT_EXIST
USER_STATUS_ABNORMAL

Updated the revoke document:

Modified the following field from Optional to Required:

Response parameters:

result.resultMessage

Added the following error codes:

CLIENT_FORBIDDEN_ACCESS_API
INVALID_CLIENT_STATUS
OAUTH_FAILED
UNKNOWN_CLIENT

Added the grossSettlementAmount and settlementQuote fields in the inquiryRefund interface.

Updated the pay (User-presented Mode Payment) document:

Deleted the following fields:

Request parameters:

isAuthorization
paymentFactor.isPaymentEvaluation
paymentMethod.paymentMethodMetaData
paymentRedirectUrl
paymentVerificationData
payToMethod

Response parameters:

authExpiryTime
challengeActionForm.challengeRenderValue
orderCodeForm

Added the settlementStrategy field.
Modified the paymentMethod.paymentMethodId field from Optional to Required.

Updated the pay (Order Code Payment) document:

Deleted the following fields:

Request parameters:

isAuthorization
paymentFactor.isPaymentEvaluation
paymentMethod.paymentMethodMetaData
paymentVerificationData
payToMethod

Response parameters:

authExpiryTime
challengeActionForm.challengeRenderValue

Added the settlementStrategy field.
Modified the orderCodeForm field from Optional to Required.

Updated the pay (Entry Code Payment) document:

Deleted the following fields:

Request parameters:

isAuthorization
paymentFactor.isPaymentEvaluation
paymentMethod.paymentMethodMetaData
paymentVerificationData
payToMethod

Response parameters:

authExpiryTime
challengeActionForm.challengeRenderValue
orderCodeForm

Added the settlementStrategy field.
Modified the order.env and the order.env.userAgent fields from Optional to Required.

2021.12

Auto Debit added the authorization result notification functionality. Therefore, the following documentation are reorganized:

For Online payment and In-store payment:

Added the refund inquiry functionality in the following products:

Cashier Payment
Auto Debit
User-presented Mode Payment
Order Code Payment
Entry Code Payment

Therefore, the following documentation are reorganized:

Post-payment service
Best practice
API list

Updated the pay (Cashier Payment) document:

Request parameters

Deleted the following fields:

merchant.store
order.env.storeTerminalId
order.env.storeTerminalRequestTime
payToMethod
paymentMethod.paymentMethodId
paymentMethod.paymentMethodMetaData
isAuthorization
paymentVerificationData
paymentFactor

Modified the following fields from Optional to Required:

order.env
settlementStrategy.settlementCurrency

Response parameters

Deleted the following fields:

result.resultStatus: S
paymentTime
authExpiryTime
challegeActionForm
redirectActionForm.method: SCAN
orderCodeForm.paymentMethodType
settlementQuote
grossSettlementAmount

Modified the following fields from Optional to Required:

orderCodeForm.expireTime
orderCodeForm.codeDetails
result.resultMessage

Added the userLoginId field in the applyToken interface.
Added the following fields in the pay (Cashier Payment) and pay (Auto Debit) interfaces:

schemeUrl
applinkUrl
normalUrl
appIdentifier

Added the new enumeration values of
BPI
and
RABBIT_LINE_PAY
in the following APIs:

pay (Cashier Payment): paymentMethod.paymentMethodType

Added the new enumeration value of
RABBIT_LINE_PAY
in the following APIs:

pay (Auto Debit): paymentMethod.paymentMethodType
consult: customerBelongsTo
applyToken: customerBelongsTo

2021.11

Auto Debit: Updated the Client side integration with wallet document.

2021.10

Cashier Payment: Updated the Client side integration with wallet document.
Auto Debit added the payment result notification functionality. Therefore, the following documentation are reorganized:

Added the following new APIs in online payments:

Added the following new API in in-store payments:

inquiryRefund

2021.9

The following terms are renamed:


Obsolete term	Current term	Comments
PMP	Alipay+ MPP	The meaning of the current term is the same as the obsolete term.
Connect Wallet	Alipay+ MPP
H5	WAP
mobile website	WAP

New introduction videos of online payment and in-store payment scenarios are added. You can go to Online payment and In-store payment to view details.

2021.8

Added MULTIPLE_REFUNDS_NOT_SUPPORTED of error code in the following APIs:

Removed the inquiryUserInfo interface is removed.
Added the paymentNotifyUrl field in the pay (Auto Debit) interface.

2021.7

Added the error code of USER_KYC_NOT_QUALIFIED in the following APIs:

Modified the orderCodeForm.codeDetails field from Required to Optional for the following interfaces:

Deleted the orderCodeForm.codeDetails.codeValueType field in the following APIs:

2021.5

Antom Docs redesigned with improved user experience and new information architecture. New docs to assist new users:

Reorganized the structure of API-related instruction documentation.

Added the following documentation:

Message encoding

Renamed the following documentation titles:

API fundamentals -> Overview
Digital signature -> Sign a request and validate the signature
Encryption -> Encrypt and decrypt a message

Removed the following documentation to the corresponding product documentation:

Settlement Items
Settlement Summary
Transaction Items

For example, you can go to Cashier Payment > Reports and reconciliation > Settlement Items (https://global.alipay.com/docs/ac/cashierpayment/settlementitems_online) to view details.

Terminology renaming. The following term is renamed:

Consumer-presented Mode Payment -> User-presented Mode Payment

2021.4

Added a new field and enum (appId and MINI_APP) to the following APIs:

2021.3

Added new settlement modes to the following products:

Removed the following fields from the Settlement Summary file for each product:

transactionAmountValue
transactionCurrency

Deleted INVALID_CODE of error code in the following APIs:

Added INVALID_PAYMENT_CODE of error code in the following API:

pay (User-presented Mode Payment)

2020.12

Renamed the following term:


Obsolete term	Current term	Comments
PSP	PMP	The obsolete term might be still displayed in codes, for example, API specifications, Java code specifications, or other places where technical elements exist. The meaning of the obsolete term is not changed.

New versions of Product APIs for online payment and in-store payment products are released in December. The API documentation format has been updated to a new version for better user experience. You can now access subfields in the same documentation. Previously, subfields were only available in data dictionary. You can go to API Reference > Product APIs > Online payments (https://global.alipay.com/docs/ac/ams/payment_cashier) to explore the new version.

2020.5

A new version of Antom Docs is released in May. Technical documentation on original portal (https://global.alipay.com/open/doc.htm) is merged to this new site for a better user experience. You can go to Documentation > Legacy Documentation (https://global.alipay.com/docs/ac/legacy/legacydoc) to view details.