Simulate Reconciliation Webhook

Queue a reconciliation webhook against one of your own shipments, for testing your integration.

/reconciliation/mock/:shipment_id

POST https://api.terminal.africa/v1/reconciliation/mock/:shipment_id

This endpoint queues a real reconciliation.flagged, reconciliation.billed or reconciliation.corrected webhook, built from the reconciliation record that already exists on one of your own shipments. Use it to exercise your webhook handler without waiting for a discrepancy to be raised.

Staging only. This endpoint is not available in production and will return an error there. You must own the shipment, and the shipment must already have a reconciliation record — the endpoint replays that record's data rather than inventing one.

Path Parameters

Name	Type	Description
shipment_id*	String	Unique shipment_id of a shipment that already has a reconciliation record.

Headers

Name	Type	Description
Authorization*	String	Set value to Bearer SECRET_KEY
Content-Type	String	Set value to application/json

Request Body

Name	Type	Description
correction_type	String	reconciliation.corrected only. voided or replaced — which correction shape to send when the shipment has no real correction to replay. Optional; a shipment that really was corrected replays what actually happened, and anything else defaults to voided.
event*	String	The event to send. One of reconciliation.flagged, reconciliation.billed or reconciliation.corrected.

{
    "event": "reconciliation.flagged"
}

{
    "event": "reconciliation.corrected",
    "correction_type": "replaced"
}

200: OK Mock reconciliation webhook queued successfully.

{
    "status": true,
    "message": "Mock reconciliation webhook queued successfully",
    "data": {
        "event": "reconciliation.flagged",
        "shipment_id": "SH-40208776515",
        "reconcilliation_id": "RC-8TQK2M4XZP71VBDR"
    }
}

200: OK (reconciliation.corrected)

{
    "status": true,
    "message": "Mock reconciliation webhook queued successfully",
    "data": {
        "event": "reconciliation.corrected",
        "shipment_id": "SH-40208776515",
        "reconcilliation_id": "RC-8TQK2M4XZP71VBDR",
        "correction_type": "replaced"
    }
}

400 Only available in staging.

{
    "status": false,
    "message": "Only available in staging",
    "data": null
}

400 Invalid event.

{
    "status": false,
    "message": "Event must be one of reconciliation.flagged, reconciliation.billed, reconciliation.corrected",
    "data": null
}

400 Invalid correction_type.

{
    "status": false,
    "message": "correction_type must be one of voided, replaced",
    "data": null
}