Account and balance operations: listing accounts, fetching balances, and Account Holder Verification (AHV / Confirmation-of-Payee style checks across supported schemes).
Summary
Functions
Available and booked balance for an account — see the Webhooks reconciliation guide for how these can diverge intraday.
Lists accounts visible to the authenticated client, optionally filtered.
Lists bookings (both outflows and inflows) for an account — the
transaction-level ledger, as opposed to get_balance/2's point-in-time
summary. Match a booking to a payment via bookingReference
(= transactionReference in BankingCircle.Payments) or transactionId
(= the payment id).
Runs an Account Holder Verification check (name-to-IBAN match) against the relevant scheme for the given IBAN's country, before you initiate a payment to it.
Types
@type client() :: atom()
Functions
@spec get(String.t(), client()) :: {:ok, map()} | {:error, BankingCircle.Error.t()}
@spec get_balance(String.t(), client()) :: {:ok, map()} | {:error, BankingCircle.Error.t()}
Available and booked balance for an account — see the Webhooks reconciliation guide for how these can diverge intraday.
@spec list( keyword(), client() ) :: {:ok, map()} | {:error, BankingCircle.Error.t()}
Lists accounts visible to the authenticated client, optionally filtered.
@spec list_bookings(String.t(), keyword(), client()) :: {:ok, map()} | {:error, BankingCircle.Error.t()}
Lists bookings (both outflows and inflows) for an account — the
transaction-level ledger, as opposed to get_balance/2's point-in-time
summary. Match a booking to a payment via bookingReference
(= transactionReference in BankingCircle.Payments) or transactionId
(= the payment id).
@spec verify_account_holder(map(), client()) :: {:ok, map()} | {:error, BankingCircle.Error.t()}
Runs an Account Holder Verification check (name-to-IBAN match) against the relevant scheme for the given IBAN's country, before you initiate a payment to it.