Bank events - hooksnode

A bank event is one transaction from one bank alert email. See Bank alerts to turn them on.

bank.credit.received: money came into the account.
bank.debit.posted: money left the account.

bank.credit.received

{
  "type": "bank.credit.received",
  "source_id": "2mJ8kQ4vXw9aB3cD5eF7gH1iK0L",
  "provider": "gmail",
  "mailbox": "finance@acme.ng",
  "bank": {
    "name": "GTBank",
    "sender": "gens@gtbank.com",
    "known": true
  },
  "transaction": {
    "direction": "credit",
    "amount_minor": 4500000,
    "currency": "NGN",
    "balance_minor": 128730050,
    "account_masked": "01******31",
    "account_last4": "0231",
    "narration": "TRF FROM ADA OKAFOR INV-9311",
    "reference": "000013260924101502123456789012",
    "counterparty": "ADA OKAFOR",
    "counterparty_bank": "Access Bank",
    "session_id": "000013260924101502123456789012",
    "occurred_at": "2026-09-24T10:15:02+01:00"
  },
  "confidence": "high",
  "parser": "rules",
  "email": {
    "id": "18f2c1a9b7d3e4f5",
    "thread_id": "18f2c1a9b7d3e4f5",
    "subject": "GeNS Transaction Alert [Credit: NGN 45,000.00]",
    "from": { "name": "GTBank", "email": "gens@gtbank.com" },
    "received_at": "2026-09-24T09:15:05Z"
  }
}

The example values are made up. The fields that the email does not have are left out.

Fields

string

required

bank.credit.received or bank.debit.posted.

string

required

The mail source that read the email.

string

required

gmail, outlook or imap.

string

required

The mailbox address.

object

required

Show bank fields

string

The bank’s name, when hooksnode knows the sender.

string

The sender address of the alert.

boolean

true when the sender is on the list of supported banks.

object

required

Hide transaction fields

string

required

credit or debit.

integer

required

The amount in minor units. 4500000 is 45,000.00.

string

required

An ISO 4217 code: NGN, USD, GBP or EUR. hooksnode uses NGN only when the sender is a known Nigerian bank and the email names no currency.

integer

The balance after the transaction, in minor units.

string

The account number as the email shows it.

string

The last digits of the account.

string

The narration or description.

string

The transaction reference.

string

The other party: the payer for a credit, the payee for a debit.

string

The other party’s bank, when the email names it.

string

The NIP session ID, when present.

string

The time of the transaction (RFC 3339). When the email has no time, this is when the email arrived.

string

The time as the email wrote it.

string

required

high or medium. See The parser never guesses.

string

required

rules or ai.

string

The model that read the email, when parser is ai.

object

required

The alert email. Use email.id to find the full email or to deduplicate.

Show email fields

string

The provider’s message ID.

string

The conversation ID.

string

The Message-ID header.

string

The subject.

object

{ "name", "email" }

string

When the email arrived (RFC 3339).

Handle bank events safely

Use email.id (or transaction.reference) as your idempotency key.
Post high credits at once. Send medium credits to a person to check.
Money moves only on the bank’s side. Treat these events as a notice, and confirm large amounts in your bank’s portal or statement.

​Fields

​Handle bank events safely

Fields

Handle bank events safely