Transaction data retrieval for GBP real and virtual accounts.
Transactions are created by inbound and outbound payments.
Use list_all/2 for institution-wide reporting, or account-scoped
functions for per-account transaction history.
Summary
Functions
Returns a specific transaction on a real account.
Returns all transactions for a specific real account.
Returns all transactions across the institution.
Returns all transactions for a virtual account.
Functions
@spec get(ClearBank.Client.t(), String.t(), String.t()) :: ClearBank.HTTP.result()
Returns a specific transaction on a real account.
Examples
{:ok, txn} = ClearBank.Accounts.Transactions.get(client, "acct-uuid", "txn-uuid")@spec list(ClearBank.Client.t(), String.t(), keyword()) :: ClearBank.HTTP.result()
Returns all transactions for a specific real account.
Options
:page_number,:page_size,:start_date,:end_date
Examples
{:ok, txns} = ClearBank.Accounts.Transactions.list(client, "acct-uuid")@spec list_all( ClearBank.Client.t(), keyword() ) :: ClearBank.HTTP.result()
Returns all transactions across the institution.
Options
:page_number- page (default: 1):page_size- results per page (default: 50):start_date- ISO 8601 datetime filter:end_date- ISO 8601 datetime filter
Examples
{:ok, txns} = ClearBank.Accounts.Transactions.list_all(client)@spec list_virtual(ClearBank.Client.t(), String.t(), String.t(), keyword()) :: ClearBank.HTTP.result()
Returns all transactions for a virtual account.
Options
:page_number,:page_size,:start_date,:end_date
Examples
{:ok, txns} = ClearBank.Accounts.Transactions.list_virtual(client, "acct-uuid", "virt-uuid")