For the complete documentation index, see llms.txt. This page is also available as Markdown.

Transaction

Sample payloads for transaction.success and transaction.failed.

The transaction events fire when a wallet charge is attempted — for a shipment, for insurance, or for any other billable action. The payload matches the shape Get Transaction returns.

flow is out for a debit and in for a credit. shipment is the shipment the charge relates to, or an empty string when the charge is not shipment-linked.

transaction.success

{
    "event": "transaction.success",
    "data": {
        "transaction_id": "TR-28598558366",
        "id": "Qm8zsXDrvkCEK5I8PtLaP3H29mkR11qu",
        "amount": 14000,
        "currency": "NGN",
        "description": "Billing charge for DHL Express shipment [SH-40208776515] to Augustus Obi.",
        "flow": "out",
        "platform": "terminal",
        "reference": "",
        "reversed": false,
        "shipment": "SH-40208776515",
        "wallet": "nGvZRE5lyb7H1ZuORKVjKlXfETsWff0J",
        "status": "success",
        "created_at": "2026-09-15T09:02:11.903Z",
        "updated_at": "2026-09-15T09:02:11.903Z"
    }
}

transaction.failed

Was this helpful?