notifyPayment

2025-12-01 01:56

Antom uses this API to send the payment result to the merchant when the payment processing reaches a final state of success. Merchants promote merchant-side transactions based on the payment result.

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

notifyType String REQUIRED

Payment status notification type. The valid value is fixed as PAYMENT_RESULT, indicating that the notification is a payment result.

result Result REQUIRED

The payment result.

Show child parameters

paymentRequestId String REQUIRED

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

More information:

Maximum length: 64 characters

paymentId String REQUIRED

The unique ID that is assigned by Antom to identify a payment. A one-to-one correspondence between paymentId and paymentRequestId exists.

More information:

Maximum length: 64 characters

paymentAmount Amount REQUIRED

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

Show child parameters

paymentCreateTime Datetime

The date and time when the payment is created.

More information:

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

paymentTime Datetime

The date and time when the payment reaches a final state of success or failure.

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 digital wallets.

Note: This field is returned when the digital wallet can provide the related information.

Show child parameters

grossSettlementAmount Amount

The total settlement amount, which equals to the transaction amount multiplied by the value of settlementQuote.

Note: This field is empty when the settlement currency is the same as the transaction currency.

Show child parameters

settlementQuote Quote

The exchange rate between the settlement currency and transaction currency at the time of the transaction, which is provided only in the locked-in rate case.

Note: This field is empty when the settlement currency is the same as the transaction currency.

Show child parameters

receiptInfo ReceiptInfo

Receipt information.

Note: This parameter is returned when you use in-store card payments.

Show child parameters

acquirerInfo AcquirerInfo

The information of the acquirer that processes the payment.

Note: This parameter is returned when you use in-store card payments.

Show child parameters

acquirerReferenceNo String

The unique ID assigned by the non-Antom acquirer for the transaction.

Note: Specify this parameter when the transaction is settled by the non-Antom acquirer.

More information:

Maximum length: 64 characters

actualPaymentAmount Amount REQUIRED

Actual payment amount.

Show child parameters

cardInfo CardInfo

Card information.

Note: This parameter is returned when the value of paymentMethodType in the createPaymentSession API is CARD for specific merchants in specific regions.

Show child parameters

paymentResultInfo PaymentResultInfo

The information of payment results.

Note: This parameter is returned when the value of paymentMethodType in the createPaymentSession API is CARD for specific merchants in specific regions.

Show child parameters

Response parameters

result Result REQUIRED

A fixed value, which is sent to Antom to acknowledge that the notification is received.

Show child parameters

API Explorer

Request

Request Body

Response

Response Body

More information

This section provides additional information about key parameters. See the following parameters for details:

result (in the notification request sent by Antom):
Payment result. If the value of result.resultStatus is S, then the payment succeeds.
paymentTime:
This field is returned only when the value of result.resultStatus is S.

Result process logic

If the value of result.resultStatus is S, the payment result notification succeeds. Antom doesn't take any further action.

Result/Error codes

Code	Value	Message	Further action
SUCCESS	S	Success	The payment is successful, no further action is needed.
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.
USER_KYC_NOT_QUALIFIED	F	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).	Prompt the user to complete KYC.