PayTo API Webhook

PayTo Webhooks: Real-Time Notifications for Seamless Integration

PayTo Webhooks provide real-time notifications for key events related to PayTo agreements and payments. This allows your application to stay in sync with the latest changes without the need for polling.

How It Works:

  • Event-Driven Notifications: Webhooks notify your application whenever there are specific changes or actions related to mandates and payments. Key events include:

    • Mandate Creation Notification: Triggered when a new mandate is created.

    • Mandate authorisation Notification: Triggered when a mandate is authorised by the payer.

    • Mandate Amendment Notification: Triggered when an existing mandate is amended.

    • Payment Initiation Notification: Triggered when a payment is initiated under a mandate.

    • Mandate Status Change Notification: Triggered when the status of a mandate changes (e.g., activated, suspended, or cancelled).

  • Secure Delivery: Each notification is delivered as an HTTPS POST request to your configured webhook endpoint, including a JWT signature and JWT payload encrypting to ensure the integrity and authenticity of the payload.

Key Steps:

  1. Setup Your Webhook Endpoint: Configure an endpoint on your server to receive webhook notifications.

  2. Verify Incoming Notifications: Use the JWT signature included in each notification to verify its authenticity.

  3. Process the Notification: Update your application state based on the event details in the webhook payload.

PayTo Webhook Notification Flow

The diagram below illustrates how PayTo sends specific notifications to your webhook endpoint:

sequenceDiagram participant PayTo API participant Webhook Endpoint participant Application %% Webhook Notification Flow PayTo API->>Webhook Endpoint: POST Mandate Creation Notification (JWT Signature) Webhook Endpoint->>Application: Process Mandate Creation Notification Application-->>Webhook Endpoint: 200 OK (Acknowledgement) PayTo API->>Webhook Endpoint: POST Mandate authorisation Notification (JWT Signature) Webhook Endpoint->>Application: Process Mandate authorisation Notification Application-->>Webhook Endpoint: 200 OK (Acknowledgement) PayTo API->>Webhook Endpoint: POST Mandate Amendment Notification (JWT Signature) Webhook Endpoint->>Application: Process Mandate Amendment Notification Application-->>Webhook Endpoint: 200 OK (Acknowledgement) PayTo API->>Webhook Endpoint: POST Payment Initiation Notification (JWT Signature) Webhook Endpoint->>Application: Process Payment Initiation Notification Application-->>Webhook Endpoint: 200 OK (Acknowledgement) PayTo API->>Webhook Endpoint: POST Mandate Status Change Notification (JWT Signature) Webhook Endpoint->>Application: Process Mandate Status Change Notification Application-->>Webhook Endpoint: 200 OK (Acknowledgement)