notifyDirectPayment
Antom sends direct payment result with this interface. The merchant can set up the URL for receiving payout notifications by specifying the notifyUrl field when calling createDirectPayment or setting the url in Antom Dashboard.
Request parameters
notifyType String REQUIRED
Type of the payment status notification. Valid values are:
PAYMENT_RESULT: Indicates that the notification is about the payment result.
More information:
- Maximum length: 32 characters
paymentId String
The unique ID that is assigned by Antom to identify a payment.
More information:
- Maximum length: 64 characters
paymentRequestId String
The unique ID assigned by a merchant to identify a payment request.
More information:
- Maximum length: 64 characters
paymentStatus String REQUIRED
Payment Status. Valid values are:
SUCCESS: The payment is successful.FAIL: The payment is unsuccessful.
More information:
- Maximum length: 32 characters
paymentResultMessage String
Payment result message that explains the payment result code.
Note: This parameter will only be returned when the value of paymentStatus is FAIL.
More information:
- Maximum length: 256 characters
paymentResultCode String
Payment result code .The Payment result code that might be returned are listed in the Payment result codes table on this page.
Note: This parameter will only be returned when the value of paymentStatus is FAIL.
More information:
- Maximum length: 64 characters
payFromAmount Object
The payment amount that the merchant requests to receive in the order currency.
payToMethod Object REQUIRED
payToAmount Object REQUIRED
The payment amount that the receiver received in.
paymentTime Datetime
The time when the payment is completed.
More information:
- The value follows the ISO 8601 standard format. For example, "2019-11-27T12:01:01+08:00".
Response parameters
result Result
A fixed value, which is sent to Antom to acknowledge that the notification is received.
Request
Response
Payment result codes
| Code | Value | Message | Further action |
|---|---|---|---|
| PROCESS_FAIL | F | Process fail | Process fail. Contact Antom Technical Support to resolve the issue. |
| USER_NOT_EXIST | F | User does not exist | Please try with the correct account information. |
| USER_ACCOUNT_ABNORMAL | F | User account abnormal | Please try with the proper credentials. |
| AMOUNT_EXCEED_LIMIT | F | Amount exceed limit | Amount exceed max limit, please retry with a lower limit. |
| RISK_REJECT | F | Risk reject | There are risk involved in this transaction, please contact Antom Technical Support for more information. |
| ORDER_IS_CLOSED | F | Order is closed | Order is closed. Use a new paymentRequestId to initiate the payment again. |
| BALANCE_NOT_ENOUGH | F | Balance not enough | Please top up your balance to make the payment. |
| UN_SUPPORT_BUSINESS | F | Unsupported business | Please contact Antom Technical Support for more information. |
| PARAM_ILLEGAL | F | illegal param received | Check and verify whether the request fields, including the header fields and body fields, are correct and valid. |
| CURRENCY_NOT_SUPPORT | F | The currency is not accepted. | Retry with the correct currency. |
| ACCESS_DENIED | F | Access is denied. | Retry with another user information. |