A complete, production-grade Elixir client for the Starling Bank Public API.

StarlingBank is organized as one module per API domain, each implementing CRUD-style functions that mirror the underlying REST endpoints:

• StarlingBank.Accounts — accounts, identifiers, confirmation of funds
• StarlingBank.AccountHolders — identity, address, account holder type, customer
• StarlingBank.Balances — cleared/effective/available balances
• StarlingBank.Transactions — feed items, metadata, attachments, statements
• StarlingBank.Receipts — itemized receipts and receipt attachments
• StarlingBank.Merchants — merchant & merchant-location enrichment data
• StarlingBank.Payees — saved payees and their images
• StarlingBank.Payments — local & international payments, standing orders
• StarlingBank.DirectDebits — Direct Debit mandates
• StarlingBank.SavingsGoals — savings goals, top-ups, withdrawals
• StarlingBank.Cards — card controls (freeze, spending limits, channels)
• StarlingBank.Webhooks — webhook listing & signature verification
• StarlingBank.OAuth — authorization code exchange & token refresh
• StarlingBank.CustomerOnboarding — TPP customer onboarding (elevated access)

Configuration

config :starling_bank,
  access_token: {:system, "STARLING_ACCESS_TOKEN"},
  environment: :sandbox  # or :production

Or build an explicit client and pass it to any function:

client = StarlingBank.Client.new(access_token: "...", environment: :production)
{:ok, accounts} = StarlingBank.Accounts.list(client)

Every function returns {:ok, result} or {:error, %StarlingBank.Error{}}.

Telemetry

Every HTTP call emits [:starling_bank, :request, :start | :stop | :exception] telemetry events with %{method:, path:, environment:} metadata, suitable for attaching :telemetry_metrics or logging handlers.