PUT
/BizEvent/Cancel
When to Use
- Cancel pending deposit events before BizTransaction execution when investor withdraws funding commitment or payment fails clearing
- Reverse pending redemption events when investor changes withdrawal decision during notice period or market conditions improve
- Stop pending conversion events when regulatory approval delayed or investor opts to maintain current investment class allocation
- Terminate automated event workflows when system integration errors detected requiring manual intervention and reconciliation
- Prevent downstream BizTransaction processing by cancelling events in Pending status before workflow execution begins
Prerequisites
- Valid Bearer token with event modification permissions
- Event must be in Pending status - query via GET /BizEvent to verify status before cancellation attempt
- No dependent BizTransaction records created - events with completed transactions require reversal, not cancellation
- Valid BizEventID and product context (ProductID or ExternalProductId) to identify the specific event
Considerations
⚠️ Critical Event Cancellation Rules
- Status Restriction: Only events with status=Pending can be cancelled - Completed/Processing events are immutable and require reversal transactions
- Audit Trail Preservation: Cancelled events remain in database with updated status - audit trail maintains original event data plus cancellation timestamp
- Workflow Lock Release: Cancellation releases any workflow locks or holds on investor accounts allowing new events to be created
- Notification Triggers: Cancellation automatically triggers stakeholder notifications informing investors of cancelled event and reason
- Irreversibility: Once cancelled, event cannot be reactivated - investor must create new event to restart workflow
Description
Cancels a pending business event and sets its status to cancelled. This prevents the event from triggering further processing or investor notifications. Creates audit trail for compliance tracking and maintains data integrity.
Event Cancellation Rules
Events can only be cancelled if they are in pending status. Once an event has been processed (status changed to completed), it cannot be cancelled and requires a reversal transaction instead.
Required Headers - See Authentication
| Header | Value | Description |
|---|---|---|
| Authorization | {accessToken} | Bearer token for API access |
| Version | 2.0 | API version identifier |
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
ProductID |
integer | Native 7G identifier for the product containing the event to cancel. | |
ExternalProductId |
string | Your external identifier for the product (alternative to ProductID). | |
BizEventID |
integer | Native 7G identifier for the business event to cancel. |
ProductID
Native 7G identifier for the product containing the event to cancel.
ExternalProductId
Your external identifier for the product (alternative to ProductID).
BizEventID
Native 7G identifier for the business event to cancel.
Example Requests
json
# Cancel using ProductID and BizEventID
curl -X PUT "https://api.7g.com.au/BizEvent/Cancel?ProductID=100&BizEventID=12345" \
-H "Authorization: {accessToken}" \
-H "Version: 2.0"Response Examples
json
{
"result": true,
"message": "Event cancelled successfully",
"recordCount": 0,
"data": null
}