PayTo API Webhook - Query Notification Developer Overview

The PayTo Query Webhook notifies your system when a query is raised related to a PayTo mandate or payment. This notification can be used to automatically handle queries that arise during the lifecycle of a mandate or payment transaction.

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

Webhook Security

All webhook notifications are secured using signed JWT (JSON Web Tokens) to ensure the integrity of the payload. Your system will need to verify the JWT signature and validate the token before processing the query event data.

Endpoints

Your application must expose a public HTTPS endpoint to receive Query Webhook events. This endpoint must be configured to handle retries and timeouts, as the webhook system will attempt redelivery in case of failures.

Use Cases

  1. Automated Query Management:
    When a PayTo query is raised, this webhook can notify your system to automatically process and respond to the query in real-time.

  2. Internal Process Integration:
    Use query notifications to trigger internal workflows, such as investigation or escalation to customer support teams.

  3. Customer Notification:
    Leverage the Query Webhook to inform customers immediately if a query arises, providing transparency and efficient resolution.

Handling Webhook Events

Ensure your system acknowledges the webhook events by responding with a 2xx HTTP status code. If your endpoint fails to respond within the required timeframe or returns an error, the webhook system will retry the delivery.

Example Workflow

  1. A query is raised for a PayTo mandate or payment (e.g., due to an incorrect payment detail or dispute).
  2. The PayTo Query Webhook sends a notification to your system.
  3. Your system processes the query and may trigger internal workflows, such as notifying customer support or requesting additional details from the customer.
  4. Your system resolves the query and provides a response back through the appropriate PayTo API call.

Error Management

In the event of webhook failures (e.g., invalid endpoint response), the webhook service will retry delivery until acknowledged. Ensure your system logs failed events and implements error handling to prevent data loss or missed notifications.

By integrating the PayTo Query Webhook, your system can automate the handling of queries raised during the PayTo payment lifecycle, enabling faster resolution, customer transparency, and internal process automation.