pay (Checkout Payment)

2024-12-19 05:42

POST /v1/payments/pay

Use this API to get the cashier page address. After getting the cashier page address, you can redirect the user to the cashier page to make a payment.

Structure

A message consists of a header and body. The following sections are focused on the body structure. For the header structure, see：

Note: Set the data type of each field (except array) as String. This means that you must use double quotation marks (" ") to enclose the field value. Examples:

If the data type of a field is Integer and its value is 20, set it as "20".
If the data type of a field is Boolean and its value is true, set it as "true".

Request parameters

merchantRegion String

The country or region where the merchant operates the business. The parameter is a 2-letter country or region code that follows ISO 3166 Country Codes standard.

Some possible values are US, SG, HK, PK, JP, CN, BR, AU, and MY.

Note: This parameter is required when you use the Global Acquirer Gateway (GAGW) product.

More information:

Maximum length: 2 characters

merchantAccountId String

The unique ID to identify a merchant account.

Note: Specify this parameter when you use a single client ID across multiple locations.

More information:

Maximum length: 32 characters

userRegion String

A 2-letter country or region code based on the standard of ISO 3166 Country Codes. This parameter is used to sort Alipay+ payment methods according to the user's region. For example, if ALIPAY_CN and KAKAOPAYare both on your payment method list and the user is from South Korea, KAKAOPAY will be listed first on the Alipay+ cashier page.

Note: This parameter is only for the merchant that has integrated the Alipay+ cashier page.

More information:

Maximum length: 2 characters

env Env REQUIRED

Information about the environment where the order is placed, such as the device information.

Show child parameters

order Order REQUIRED

The order information, such as buyer, merchant, goods, amount, shipping information, and purchase environment. This field is used for different purposes:

During the payment process, this field is mainly used by Antom for risk control or anti-money laundering.
After the payment is completed, this field is used for recording and reporting purposes such as purchase tracking and regulatory reporting.

Show child parameters

paymentRequestId String REQUIRED

The unique ID assigned by a merchant to identify a payment request. Antom uses this field for idempotence control.

More information:

This field is an API idempotency field.For payment requests that are initiated with the same value of paymentRequestId and reach a final status of S or F, the same result is to be returned for the request.
Maximum length: 64 characters

paymentAmount Amount REQUIRED

The payment amount that the merchant requests to receive in the order currency.

Show child parameters

settlementStrategy SettlementStrategy REQUIRED

The settlement strategy for the payment request.

Show child parameters

paymentMethod PaymentMethod REQUIRED

The payment method that is used to collect the payment by the merchant or acquirer.

Show child parameters

paymentFactor PaymentFactor

Factors that impact the payment. This field is used to indicate the payment scenario.

Note: Specify this parameter when the value of paymentMethodType is CARD.

Show child parameters

creditPayPlan CreditPayPlan

The credit payment plan information for this payment.

Note: Specify this field if you want to support installment payment and contact Antom technical support for details on how to offer installment payments.

Show child parameters

appId String

The unique ID that is assigned by Antom to identify the mini program.

Note: This field is required when terminalType is MINI_APP.

More information:

Maximum length: 32 characters

paymentExpiryTime Datetime

The payment expiration time is a specific time after which the payment will expire and the acquirer or merchant must terminate the order processing.

Notes:
For bank transfer payments, the default payment expiration time is 48 hours after the payment request is sent. For other payment categories, the default payment expiration time is usually 14 minutes after the payment request is sent. For example, if the request is sent on 2019-11-27T12:00:01+08:30, the payment expiration time is 2019-11-27T12:14:01+08:30.
Specify this field if you want to use a payment expiration time that differs from the default time. For bank transfer payments, the specified payment expiration time must be less than 48 hours after the payment request is sent. For other payment categories, the specified payment expiration time must be less than 10 minutes after the payment request is sent.

More information:

The value follows the ISO 8601 standard format. For example, "2019-11-27T12:01:01+08:00".

paymentNotifyUrl URL

The URL that is used to receive the payment result notification.

Note: Specify this parameter if you want to receive an asynchronous notification of the payment result. You can also set the URL to receive the result notification in Antom Dashboard. If the URL is specified in both the request and Antom Dashboard, the value specified in the request takes precedence.

More information:

Maximum length: 2048 characters

paymentRedirectUrl URL REQUIRED

The merchant page URL that the user is redirected to after the payment is completed.

More information:

Maximum length: 2048 characters

productCode String REQUIRED

Represents the payment product that is being used, which is stipulated in the contract. For Checkout Payment, the value is fixed as CASHIER_PAYMENT.

Response parameters

result Result REQUIRED

The result of the API call.

Show child parameters

paymentRequestId String

The unique ID that is assigned by a merchant to identify a payment request.

Note: This field is returned when resultCode is PAYMENT_IN_PROCESS.

More information:

Maximum length: 64 characters

paymentId String

The unique ID that is assigned by Antom to identify a payment.

Note: This field is returned when resultCode is PAYMENT_IN_PROCESS.

More information:

Maximum length: 64 characters

paymentAmount Amount

The payment amount that the merchant requests to receive in the order currency.

Note: This field is returned when resultCode is PAYMENT_IN_PROCESS.

Show child parameters

paymentData String

Used by the Antom client SDK to render the checkout page. This parameter is returned if the merchant app has integrated Antom client SDK. After receiving the parameter, you can call the showPaymentSheet API of the Antom client SDK.

More information:

Maximum length: 20000 characters

paymentCreateTime Datetime

The date and time when the payment is created.

Note: This field is returned when resultCode is PAYMENT_IN_PROCESS.

More information:

The value follows the ISO 8601 standard format. For example, "2019-11-27T12:01:01+08:00".

pspCustomerInfo PspCustomerInfo

The customer information of Alipay+ Mobile Payment Provider (Alipay+ payment methods).

Note: This field is returned when the Alipay+ payment methods can provide the related information.

Show child parameters

orderCodeForm OrderCodeForm

Information about the order code.

Note: This parameter is returned when the payment method supports providing the related information.

Show child parameters

grossSettlementAmount Amount

The value of this field equals to transaction amount multiplied by the value of settlementQuote. This field is returned when the currency exchange is predetermined and the exchange rate is locked at the time of transaction.

Show child parameters

settlementQuote Quote

The exchange rate between the settlement currency and transaction currency.

Note: This field is returned when grossSettlementAmount is returned.

Show child parameters

appIdentifier String

Android package name, which is used by Android apps to open a cashier page.

Note: This field is returned when resultCode is PAYMENT_IN_PROCESS and terminalType is APP or WAP.

More information:

Maximum length: 128 characters

applinkUrl URL

The URL that redirects users to open an app when the target app is installed, or to open a WAP page when the target app is not installed. For Android, the URL is a Native App Link. For iOS, the URL is a Universal Link.

Note: When the value of resultCode is PAYMENT_IN_PROCESS, at least one of schemeUrl, applinkUrl, and normalUrl is to be returned.

More information:

Maximum length: 2048 characters

normalUrl URL

The URL that redirects users to a WAP or WEB page in the default browser or the embedded WebView.

Note: When the value of resultCode is PAYMENT_IN_PROCESS, at least one of schemeUrl, applinkUrl, and normalUrl is to be returned.

More information:

Maximum length: 2048 characters

schemeUrl URL

The URL scheme that redirects users to open an app in an Android or iOS system when the target app is installed.

Note: When the value of resultCode is PAYMENT_IN_PROCESS, at least one of schemeUrl, applinkUrl, and normalUrl is to be returned.

More information:

Maximum length: 2048 characters

paymentResultInfo PaymentResultInfo

The payment result information.

Note: This parameter may be returned when the value of paymentMethodType is CARD.

Show child parameters

promotionResult Array <PromotionResult>

Promotion result.

Note: This parameter is generated when the buyer applies a promotion during the process of placing an order.

Show child parameters

API Explorer

Sample CodesRun in Sandbox

Request

URL

Payment method

AlipayCN

Terminal type

APP

Integration role

Acquirer-merchant Direct-merchant

Request Body

Response

Case

Successful/In-process transaction exists

Case description

If a transaction with paymentStatus of PROCESSING or SUCCESS exists, and you initiate a request with the same paymentRequestId as that of the existing transaction, the response will be the same as the response of the existing transaction. The following response is returned:

Response Body

More information

About the order field: Antom does not verify the consistency of the amount in the order field and the amount in the payment request. The order information is not applied in fund operations either. This field is mainly used for risk control, supervision, regulatory reporting, and consumption records display. Use the env field if the risk control capability provided by Antom is needed.

Sample for the order field

Result process logic

For different request results, different actions need to be taken. See the following list for details:

S: When this value is returned, the API call succeeds.
F: When this value is returned, the API call fails. Take actions according to the corresponding result message or call the API again with a new paymentRequestId value. If the issue persists, contact Antom Technical Support.
U: When this value is returned, check the result code:

Result code is not PAYMENT_IN_PROCESS: The API call fails. Call this API again with a new paymentRequestId value.
Result code is PAYMENT_IN_PROCESS: Check whether one or more of the three URLs (appLinkUrl, normalUrl, schemeUrl) are returned:

one or more of the URLs returned: The transaction is created successfully. Redirect your user to the address specified by the URL to complete the payment.
no URLs returned: The transaction creation fails. Call the pay (Checkout Payment) API again with a new paymentRequestId value. If the issue persists, contact Antom Technical Support.

Result/Error codes

Code	Value	Message	Further action
SUCCESS	S	Success	The payment is successful, no further action is needed.
ACCESS_DENIED	F	Access is denied.	Contact Antom Technical Support for detailed reasons.
AUTHENTICATION_REQUIRED	F	3D Secure authentication is required.	Reinitiate the payment and redirect the user to perform 3D Secure authentication.
CURRENCY_NOT_SUPPORT	F	The currency is not supported.	Contact Antom Technical Support for detailed reasons.
DO_NOT_HONOR	F	The payment is declined by the issuing bank.	Retry the payment using a different card or contact the issuing bank.
EXPIRED_CODE	F	The payment code is expired.	The user needs to refresh the payment code.
FRAUD_REJECT	F	The transaction cannot be further processed because of risk control. If the user has already paid for the transaction, the transaction will be refunded.	Contact Antom Technical Support when one of the following conditions is met: You want to make an appeal. The user does not receive the refund within two weeks.
IDENTITY_AGE_NOT_ENOUGH	F	The buyer's age does not meet the requirements.	Please confirm your identification details and try again.
IDENTITY_VERIFY_FAILED	F	Identity verification timed out or the result couldn't be retrieved.	Please confirm your identification details and try again.
INVALID_ACCESS_TOKEN	F	The access token is expired, revoked, or does not exist.	Check whether accessToken is correct. If not correct, pass in the correct value. If correct, contact Antom Technical Support for detailed reasons.
INVALID_AMOUNT	F	The transaction was declined by the issuing bank due to various reasons. For example, the specified amount is invalid or exceeds the maximum amount limit.	Contact Antom Technical Support for detailed reasons.
INVALID_CPF	F	Invalid CPF.	Please confirm your identification details and try again.
INVALID_CONTRACT	F	The parameter values in the contract do not match those in the current transaction.	Check whether the parameter values in the contract match those in the current transaction. If the values match, contact Antom Technical Support to troubleshoot the issue.
INVALID_IDENTITY_STATUS	F	Abnormal identity status.	Please confirm your identification details and try again.
INVALID_MERCHANT_STATUS	F	The merchant status is abnormal because restrictions exist.	Contact Antom Technical Support for detailed reasons.
INVALID_PAYMENT_CODE	F	The payment code cannot be accepted by Antom.	Choose other payment methods. Contact Antom Technical Support if the payment method is supported.
INVALID_PAYMENT_METHOD_META_DATA	F	The payment method metadata is invalid.	Check whether payment method metadata is correct. If correct, contact Antom Technical Support.
KEY_NOT_FOUND	F	The private key or public key of <span>Antom</span> or the merchant is not found.	Check whether the private key or public key exists. If not, upload the private key in Antom Developer Center.
MERCHANT_KYB_NOT_QUALIFIED	F	The payment failed because of the merchant's KYB status. The merchant is either not KYB compliant, or the KYB status is not qualified for this transaction.	Contact Antom Technical Support for detailed reasons.
MERCHANT_NOT_REGISTERED	F	The merchant is not registered.	Please register the merchant by using the registration interface. Contact Antom Technical Support if failed to call the registration interface.
NO_INTERFACE_DEF	F	API is not defined.	Check whether the URL is correct. Please refer to the endpoint in the API documentation.
NO_PAY_OPTIONS	F	No payment options are available.	Contact Antom Technical Support for detailed reasons.
ORDER_IS_CANCELED	F	The request you initiated has the same paymentRequestId as the previously paid transaction, which is canceled.	Use a new paymentRequestId to initiate the payment again.
ORDER_IS_CLOSED	F	The order associated with the paymentRequestId in your request is closed due to payment failure or payment timeout, etc.	Use a new paymentRequestId to initiate a payment.
PARAM_ILLEGAL	F	The required parameters are not passed, or illegal parameters exist. For example, a non-numeric input, an invalid date, or the length and type of the parameter are wrong.	Check and verify whether the required request fields (including the header fields and body fields) of the current API are correctly passed and valid.
PAYMENT_AMOUNT_EXCEED_LIMIT	F	The payment amount is greater than the maximum amount allowed by the contract or payment method.	Check whether the payment amount exceeds the limit or use a lower amount and try again. Contact Antom technical support to know the specific limitation.
PAYMENT_COUNT_EXCEED_LIMIT	F	The maximum number of payments exceeds the limit that is specified by the payment method.	Contact Antom Technical Support to know the specific limitation.
CARD_NOT_SUPPORTED	F	The card used for the transaction is not supported.	Use another card to pay the transaction.
PAYMENT_NOT_QUALIFIED	F	The merchant is not qualified to pay because the merchant is not registered, does not have a contract for Auto Debit payment, or is forbidden to make a payment.	Contact Antom Technical Support for detailed reasons.
PROCESS_FAIL	F	A general business failure occurred.	Do not retry. Human intervention is usually needed. It is recommended that you contact Antom Technical Support to troubleshoot the issue.
REPEAT_REQ_INCONSISTENT	F	The amount or currency is different from the previous request.	Ensure all the fields in the requests are the same or use a new paymentRequestId to initiate the payment again.
RISK_REJECT	F	The transaction cannot be further processed because of risk control. If the user has already paid for the transaction, the transaction will be refunded.	If the user does not receive the refund within two weeks, contact Antom Technical Support.
SETTLE_CONTRACT_NOT_MATCH	F	No matched settlement contract can be found.	Check the following for a solution: Specify one settlement currency from the multiple currencies that the merchant signed up for. Check if the settlement currency is specified in the settlement contracts. The merchant didn't sign a settlement contract. Contact Antom Technical Support.
SYSTEM_ERROR	F	A system error occurred.	Do not retry, and contact Antom Technical Support for more details.
USER_AMOUNT_EXCEED_LIMIT	F	The payment amount exceeds the user payment limit.	Create a new payment by using an amount less than or equal to the account's available balance, or contact Antom Technical Support.
USER_BALANCE_NOT_ENOUGH	F	The payment cannot be completed because the user balance in the corresponding payment method is not enough.	Please top up the account or choose other payment methods.
USER_KYC_NOT_QUALIFIED	F	The payment failed because of the user's KYC status. The user is either not KYC compliant, or the KYC status is not qualified for this transaction (for example, limitations on the payment amount or product information).	Complete the KYC verification first.
USER_NOT_EXIST	F	The user does not exist on the wallet side.	Contact Antom Technical Support for detailed reasons.
UNKNOWN_EXCEPTION	U	An API call has failed, which is caused by unknown reasons.	Call the interface again to resolve the issue. If not resolved, contact Antom Technical Support.
INVALID_CARD_NUMBER	F	The number of the card used for the transaction is invalid.	Check whether the value of paymentMethod.paymentMethodMetaData.cardno is correct: If not correct, pass in the correct value and try again. If correct, this card is not supported by the transaction, use another card to pay the transaction.
PAYMENT_IN_PROCESS	U	The payment is being processed.	Get any of the URLs (appLinkUrl, normalUrl, schemeUrl) and open the cashier page. If no URL is returned, call the pay API again with a new paymentRequestId value. If the issue persists, contact Antom Technical Support.
REQUEST_TRAFFIC_EXCEED_LIMIT	U	The request traffic exceeds the limit.	Call the interface again to resolve the issue. If not resolved, contact Antom Technical Support.
ORDER_NOT_EXIST	F	The order does not exist.	Check whether paymentId is correct.
ORDER_STATUS_INVALID	F	The transaction cannot be further processed because the order status is invalid.	Check the order status of the transaction or contact Antom Technical Support for detailed reasons.
USER_PAYMENT_VERIFICATION_FAILED	F	User fails to pass the payment verification in the methods like OTP, PIN, and so on.	Contact Antom Technical Support to know the specific reasons.
USER_STATUS_ABNORMAL	F	The user status is abnormal on the wallet side.	Contact Antom Technical Support to know the specific reasons.
VERIFY_TIMES_EXCEED_LIMIT	F	The current verification code failed to pass the payment verification too many times.	The user must get a new verification code.
VERIFY_UNMATCHED	F	The verification code is invalid.	The user must get a new verification code.
SELECTED_CARD_BRAND_NOT_AVAILABLE	F	The card brand that the user selected to pay is not available.	The card brand that the user selected to pay is not available.
PAYMENT_PROHIBITED	F	The payment cannot be processed because the goods are prohibited from sale in the country.	You are not allowed to appeal against this transaction.
INVALID_EXPIRATION_DATE	F	The value of paymentMethod.paymentMethodMetaData.expiryYear or paymentMethod.paymentMethodMetaData.expiryDate is invalid.	Check whether the value of paymentMethod.paymentMethodMetaData.expiryYear or paymentMethod.paymentMethodMetaData.expiryDate is correct: If not correct, pass in the correct value. If correct, contact Antom Technical Support for detailed reasons.