notifyPayment
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. Valid values are:
PAYMENT_RESULT: Indicates that the notification is a payment result.OFFLINE_PAYMENT_CODE: Indicates that the notification is an offline payment code.
result Result
The payment result
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.
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
Information about the customer of the Alipay+ Mobile Payment Provider (Alipay+ payment methods).
Note: Alipay+ Mobile Payment Provider, is a Mobile Payment Partner participating in Alipay+ Core or other user- or issuer-facing payment service provider cooperating with a member of Ant Group to enable payments.
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.
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.
Response parameters
result Result REQUIRED
The request result contains information such as status and error codes.
Request
Response
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 isS, then the payment succeeds. - paymentTime:
This field is returned only when the value of result.resultStatus isS. - paymentActionForm:
In the in-store payment scenario, paymentCode is passed in through this field, and merchants can display the code to the customer.
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. |