Void Transaction

DANGER

AI-powered intelligence and automation are only active in production. While staging can simulate API responses for testing, it won't trigger our automated workflows or send email replies.

API Reference

For the full endpoint specification (headers, request body, response schema, and examples), see Void Transaction API Reference.

The Void Transaction API enables you to integrate a feature within your application that allows end-users to ask for a specific transaction to be voided or cancelled. This functionality is subject to biller approval and is applicable only to certain types of transactions.

Applicability

This void transaction functionality is primarily intended for use with bill payment transactions.

It is explicitly not applicable for the following types of transactions where value is often instantly consumed or non-reversible once successfully processed:

• Prepaid mobile top-ups
• PIN-based products (e.g., game credits, digital gift cards, software licenses)
• Other instant fulfillment services

Please ensure that the UI option to request a transaction void is only presented to your users for eligible transaction types that support this process.

TIP

Use the is_refundable field from the Product Listing API to programmatically determine if a product is eligible for voiding.

Key Considerations

• Successful Transactions Only: The functionality to request a transaction void should strictly be available only for transactions with a Succesful status.

• Biller Approval Required: All void requests are forwarded to the respective biller and are subject to their review and approval policies. IIMMPACT facilitates this process, but the final decision to approve a void rests solely with the biller.

• Processing Time: The time it takes for a biller to review a void request and process it (if approved) can vary significantly, potentially ranging from near real-time to several business days.

• Email Notifications: The registered email address of the initiating API account is automatically CC'd on all email correspondence sent to the end-user regarding the void request.

• Webhook Notification: Upon successful confirmation of the transaction void from the biller and processing of the subsequent refund by IIMMPACT (including the crediting of funds back to your partner wallet), our system will send a webhook notification to your designated API endpoint.

Integration Flow

1. User Initiates Void — For an eligible and successful bill payment, the end-user clicks the "Void/Refund" button or a similar option within your application.

2. API Call to IIMMPACT — Your application makes a server-to-server API call to IIMMPACT's Void Transaction endpoint, providing the transaction reference ID, refund type, and the user's email address.

3. IIMMPACT Forwards to Biller — IIMMPACT securely transmits the void request to the concerned biller for their evaluation and decision.

4. Biller Review and Processing — The biller reviews the void request based on their internal policies. If approved, the biller processes the void and initiates the refund.

5. IIMMPACT System Update & Wallet Credit — Once IIMMPACT receives confirmation and the refunded amount from the biller, the transaction is recorded as voided and the amount is credited to your partner wallet.

6. Webhook Notification to Partner — IIMMPACT dispatches a webhook to your registered API endpoint with status_code: 53.

7. Partner Refunds End-User — Upon receiving the webhook, your system should process the refund back to the end-user (e.g., to their original payment method or e-wallet).