PayTo API Webhook Notification - Developer Overview

The PayTo API Webhook Notification provides real-time updates on the status of PayTo mandates and payment initiation requests. It allows applications to respond instantly to changes in the state of a mandate or the outcome of a payment initiation, ensuring that systems remain up-to-date.

To simulate webhook notifications and test your integration, you can use the test API. Simply select the Testing tab above to trigger a test notification and verify your system’s handling of webhook events.

Webhook Security

To maintain data integrity and authenticity, all webhook payloads are signed using JWT (JSON Web Token) tokens. The receiving application must validate the JWT signature to confirm the authenticity of the event data before processing it.

Endpoints

The receiving application must meet the following requirements for webhook delivery:

  • HTTPS Endpoint: The endpoint exposed by the receiving application must be publicly accessible and capable of handling webhook notifications over HTTPS.
  • Retries: If the webhook delivery fails (e.g., due to server timeout or other issues), the system will attempt to resend the notification.
  • Event Handling: The endpoint should support deduplication and idempotency to avoid processing duplicate events.

Use Cases

  1. Real-Time Notifications
    Update internal systems instantly when a PayTo mandate is created, amended, or canceled.

  2. Payment Workflow Automation
    Automate workflows based on the success or failure of payment events, integrating notifications to trigger subsequent actions.

  3. Error Handling
    Proactively manage payment or mandate issues by responding to real-time failure notifications.

Handling Webhook Events

To ensure successful receipt of webhook events, your system must respond with a 2xx status code. If the endpoint does not respond within the specified timeframe or returns an error status, the webhook notification will be retried.

Example Workflow

  1. A PayTo mandate is created or a payment initiation is triggered.
  2. The PayTo API Webhook sends a notification to the receiving system with the event details.
  3. The system processes the event data, updates records accordingly, and initiates any necessary actions (e.g., notifying the customer or updating the status of a mandate).

Error Management

In the event of webhook delivery failures (e.g., network issues or server downtime), the system will retry sending the notification. Your endpoint should be designed to handle retries effectively and respond with a 2xx status code upon successful processing.

By integrating the PayTo API Webhook Notification, your application can stay updated with real-time information, enabling immediate responses to changes in mandate or payment statuses, and reducing the need for manual intervention.