Moneris API Webhook Failure Diagnostic Report - Solar Faults | terminalfaults.org

Technical Background:

Webhooks rely on a persistent connection between the Moneris API and the client's notification endpoint. A failure can stem from issues with TLS/SSL handshake, DNS resolution, API rate limiting, invalid SSL certificates, or a mismatch in the JSON payload structure expected by the client versus what's being sent by the Moneris API. Additionally, expired or invalid API tokens can prevent successful notification delivery. The client-side API might be experiencing downtime, blocking the Moneris server from sending any notification.

Symptoms:

Order update notifications via webhook are failing to be delivered from the Moneris API after checkout. The webhook appears to be non-functional.

Possible Causes:

Invalid or expired API token being used by the Moneris system to trigger the webhook.
Network connectivity issues between the Moneris API server and the client's webhook endpoint. DNS resolution failure.
TLS/SSL certificate issues on the client's webhook endpoint, causing the Moneris API to reject the connection.
API rate limiting being enforced by the client's webhook endpoint, causing the Moneris API to be throttled.
JSON payload mismatch: the data structure being sent by Moneris does not match what the client's webhook endpoint expects.
Client-side service hosting the webhook endpoint may be offline or experiencing downtime.

Solution:

1

Verify the API token used for webhook authentication is valid and has not expired. Regenerate a new token if necessary.
2

Use a DNS lookup tool (e.g., `nslookup`, `dig`) to confirm the client's webhook endpoint resolves to a valid IP address.
3

Check the TLS/SSL certificate on the client's webhook endpoint. Ensure it is valid, not expired, and issued by a trusted Certificate Authority. Confirm that the Moneris API trusts the certificate.
4

Review API rate limiting settings on both the Moneris API and the client's webhook endpoint. Increase limits if necessary, while implementing appropriate queuing mechanisms.
5

Validate the JSON payload structure being sent by the Moneris API against the expected format of the client's webhook endpoint. Use a JSON validator to check for errors.
6

Monitor the client-side service hosting the webhook endpoint to ensure it is online and responsive. Check server logs for errors.
7

Inspect the Moneris API logs for error messages related to the webhook delivery failure. Analyze response codes to identify the root cause.

Safety Warning:

The Moneris API and connected systems handle sensitive financial data. Ensure all troubleshooting steps are performed in a secure environment. Do not expose API keys or other sensitive information during the diagnostic process. Safe Handling: Unplug the card terminal from power and the network before performing any physical inspection or cleaning.

Prevention:

Implement robust error handling and logging on the client's webhook endpoint. Regularly monitor API token expiration dates and renew them proactively. Use a monitoring service to track the uptime and performance of the webhook endpoint. Implement proper JSON schema validation on the client side. Review the API contract between the Moneris and the client sides regularly.

Expert Tip:

The Moneris API may cache DNS records. If the client's webhook endpoint IP address changes, the Moneris API may continue to attempt delivery to the old address until the cache is refreshed. Force a cache refresh (if possible via the Moneris API) or wait for the TTL (Time To Live) to expire.

Frequently Asked Questions

•What is the specific error message or response code being returned when the webhook fails?

Examine API logs on both sides for specific error codes, e.g., 400, 401, 500.

•Has the client's webhook endpoint been recently updated or modified?

Rollback any changes to the previous state before the webhook failure started.

•Are there any network firewalls or security policies that might be blocking traffic between the Moneris API and the client's webhook endpoint?

Inspect firewall logs and rules to ensure that traffic to the webhook is permitted.

Technical Background:

Symptoms:

Possible Causes:

Solution:

Safety Warning:

Prevention:

Expert Tip:

Frequently Asked Questions

•What is the specific error message or response code being returned when the webhook fails?

•Has the client's webhook endpoint been recently updated or modified?

•Are there any network firewalls or security policies that might be blocking traffic between the Moneris API and the client's webhook endpoint?

Related questions

Technical Background:

Symptoms:

Possible Causes:

Solution:

Safety Warning:

Prevention:

Expert Tip: