Notification URL
Learn how to configure notification URLs and test notifications in Antom Dashboard.
Configure notification URLs
Configure your notification URLs in Antom Dashboard for the following notifications:
- notifyAuthorization
- notifyVaulting
- notifyPayment (Payment)
- notifyCapture (Checkout Payment)
- notifySubscription
- notifyPayment (Subscription)
- notifyDispute
- notifyRefund
Get started
To configure notification URLs:
- Log in to Antom Dashboard.
- Go to Developer > Notification URL, select the Configuration tab.
- Click Add under Action and enter your URL under Notification URL for a notification.
- Click Save. Your notification URL is successfully configured.
- (Optional) If you want to change the notification URL that you have already configured, click Modify under Action and enter your URL under Notification URL for the modified notification. The next step is the same as Step 4.
Notes:
- If you modify the notification URL, make sure you also update the URL in your live system to avoid any potential errors.
- If the notification URL is specified in both the API and Antom Dashboard, the URL specified in the API takes precedence.
Test notifications
You can simulate the process of receiving and handling asynchronous notifications in Antom Dashboard.
Before you begin
To test notifications, configure your API keys first. For more information about how to configure API keys, see API key configuration.
Get started
To test notifications, follow the steps:
- Log in to Antom Dashboard.
- Go to Developer > Notification URL, select the Test tab.
- Select the request type and configure the notification URL under Request > Configuration. The default notification URL is the URL that you specified under the Configuration tab.
- (Optional) Edit the notification message in the Request body field.
- Click Send.
- Antom then sends a simulated asynchronous notification to your notification URL.
- Response to Antom by following the notification response requirement. Refer to Return a receipt acknowledgment message about how to send a response.
- Antom validates whether your system handles the notification as expected. If your notification response is successfully received by Antom, the validation result is displayed in the Response area.
Return a receipt acknowledgment message
After verifying the signature and confirming that the notification is from Antom, you need to return a receipt acknowledgment message to Antom to inform Antom of a successful receipt of the notification. No digital signature is required for the process of returning a receipt acknowledgment message.
The example below shows the header of the message you send to Antom:
"Content-Type": "application/json", "response-time": "2019-07-12T12:08:56+05:30", "client-id": "T_111222333",
The example below shows the body of the message you send to Antom:
{ "result": { "resultCode":"SUCCESS", "resultStatus":"S", "resultMessage":"success" } }
If no such message is returned to Antom due to operation or network issues, Antom will automatically resend the asynchronous notification within 24 hours for up to eight times or until the correct response is received. The sending intervals are as follows: 0s, 2 min, 10 min, 10 min, 1 h, 2 h, 6 h, and 15 h.
Note: Record the processed notifications received from Antom for a payment request, and properly handle the idempotency to avoid processing a single request multiple times.