Fileactive PayTo API Webhook - MPIR Outcome Developer Overview

The Fileactive PayTo API Webhook MPIR Outcome notifies your system of the result (outcome) of a PayTo Mandate Payment Initiation Request (MPIR). This webhook ensures that your application is informed of the status of a payment request in real-time, allowing for faster processing and system updates based on the payment’s outcome.

Webhook Security

To ensure data integrity and authenticity, all webhook notifications are secured using signed JWT (JSON Web Tokens). Your system must validate the JWT signature and authenticate the token before processing the outcome event.

Endpoints

Your application should expose a public HTTPS endpoint to receive MPIR Outcome webhook events. The endpoint must be capable of handling retries and timeouts, as the webhook system will attempt redelivery in case of failure or non-acknowledgment.

Use Cases

  1. Real-time Payment Status Updates:
    Receive instant notification of the payment result, whether it’s successful or failed, allowing your system to take appropriate action based on the outcome.

  2. Automated Workflows:
    Automatically trigger downstream processes such as updating customer records, sending confirmation emails, or adjusting balances based on the payment outcome.

  3. Error Handling:
    Automatically handle failed payment initiations, such as logging the failure, retrying the request, or notifying users of the issue.

Handling Webhook Events

When your system receives the webhook event, it should:

  1. Verify the authenticity of the JWT token.
  2. Process the payload to extract the MPIR outcome details.
  3. Respond with a 2xx HTTP status code to acknowledge the webhook.
  4. In case of an invalid response, the webhook service will retry the event delivery.

Example Workflow

  1. A PayTo payment initiation request (MPIR) is submitted.
  2. The PayTo system processes the payment and generates an outcome (success or failure).
  3. The Webhook sends the MPIR Outcome event to your application.
  4. Your system processes the outcome, updating internal records or triggering appropriate workflows (e.g., notifying customers of success or failure).
  5. The webhook service retries delivery if no acknowledgment (2xx HTTP status code) is received.

Error Management

In the event of an endpoint failure (e.g., unavailability or timeout), the webhook system will automatically retry the delivery multiple times until acknowledged. Ensure that your system logs and manages these failures to prevent data loss and ensure all notifications are processed.

Benefits of Integration

  • Real-time insight into payment statuses:
    You can adjust business processes immediately, minimizing delays between payment initiation and system updates.

  • Improved automation:
    Allows you to automate workflows triggered by successful or failed payments, reducing manual intervention and improving operational efficiency.

  • Better customer experience:
    Enables faster responses to customers, informing them of the status of their payments in real-time.

By integrating the MPIR Outcome Webhook, your system can stay up to date with the status of payment initiations, enabling real-time processing, automating actions based on payment results, and enhancing the overall efficiency of your payment workflows.