ClearBank.Webhook.Events.TransactionSettled (ClearBank v1.0.0)

Copy Markdown View Source

Fired when a payment settles on a GBP account (inbound or outbound).

Covers: FPS, CHAPS, Bacs Direct Credit, internal transfers.

Summary

Types

t()

@type t() :: %ClearBank.Webhook.Events.TransactionSettled{
  account_id: String.t(),
  amount: String.t(),
  counterpart_account: String.t() | nil,
  counterpart_account_number: String.t() | nil,
  counterpart_name: String.t() | nil,
  counterpart_sort_code: String.t() | nil,
  currency: String.t(),
  direction: :inbound | :outbound,
  end_to_end_id: String.t() | nil,
  reference: String.t() | nil,
  status: String.t(),
  timestamp: String.t(),
  transaction_id: String.t(),
  type: String.t(),
  virtual_account_id: String.t() | nil
}

Functions

from_payload(payload)

@spec from_payload(map()) :: t()