Report Issue

DANGER

Note: 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.

The Report Issue API provides a direct way to integrate an issue-reporting mechanism within your application. This function is intended for end-users to raise concerns or disputes specifically for transactions that have already been successfully completed.

Functionality

This feature enables your customers to report problems they encounter after a transaction has been marked as successful. Common scenarios where this would be used include:

• Voucher/PIN Issues: The end-user experiences problems redeeming a purchased voucher (e.g., the voucher code appears invalid or has already been used), or a provided PIN/serial number is unusable.

• Non-Updated Bill Payments: A bill payment was successfully processed and confirmed by IIMMPACT, but the end-user's account with the biller does not reflect the payment after a reasonable waiting period.

• Service Discrepancies: Other issues where the service or product received does not match what was expected, despite a successful transaction confirmation.

Key Considerations

• Successful Transactions Only: The UI element (e.g., a Report Issue button) that triggers this API call should only be displayed and made available to the end-user for transactions that have a 'SUCCESFUL' status. This function is not intended for failed or pending transactions.

• Outcome and Case Management: Successfully reporting an issue via this API creates a unique support case ID within the IIMMPACT system. This case is then managed through our "AI-Powered Support Process" (detailed previously), which may involve AI-driven resolution or escalation to human support.

API-Driven Issue Reporting Flow

The typical flow when an end-user reports an issue via this API is as follows:

1. User Initiates Report: The end-user triggers the issue report for a successful transaction via the Report Issue UI element in your application.

2. API Call to IIMMPACT: Your application makes a server-to-server API call to IIMMPACT's "Report Issue" endpoint, providing necessary transaction identifiers and the user's description of the issue.

3. Case Creation & Confirmation: IIMMPACT validates the API request. Upon successful validation, a support case is created, and a unique case identifier may be returned in the API response for your reference.

Default Email Notification: The registered email address of the initiating API account is always CC'd on all email correspondence sent to the end-user.

API Endpoint

POST https://api.iimmpact.com/v2/transactions/check

Request Headers

Header	Description	Required
Authorization	ID Token	No

Request Body

Parameter	Type	Required	Description
refid	string	No
user_email	array	No	Array of emails to include. Ensure that you pass user's email address and any other email address that you want to cc
user_email[]	string	No

Response 200

Field	Type	Description
data	object
data.refid	string
data.status	string
data.message	string

Example Response:

{
  "data": {
    "refid": "123456",
    "status": "Success",
    "message": "We've received your request for a status update and are in the midst of checking with the relevant service provider. We'll keep you updated on the status of your request via email."
  }
}

Response 400

Field	Type	Description
message	string
errors	object
errors.trxid	array

Example Response:

{
  "message": "The given data was invalid.",
  "errors": {
    "trxid": []
  }
}