Modules
Production-grade Elixir client for the Tink Open Banking API.
Account verification reports — verify ownership, IBAN, and balance.
Requires account-verification-reports:write and account-verification-reports:read.
Account data access. Requires accounts:read scope.
OAuth 2.0 authentication for the Tink API.
Utilities for inspecting and managing Tink.Client access token state.
Balance refresh — trigger and poll real-time balance pulls.
Requires balance-refresh and balance-refresh:readonly scopes.
Budget management — one-off and recurring budgets.
Requires budgets:read and budgets:write scopes.
Bulk payment initiation.
Requires bulk-payment:write and bulk-payment:read scopes.
Business account verification reports.
Requires business-account-verification-reports:read.
Cachex-backed response cache with per-resource TTLs, per-user isolation, opt-out support, and automatic invalidation on writes.
Cash flow analysis — income vs expenses over time.
Delegates to Tink.Statistics with sensible defaults.
Requires statistics:read scope.
Represents an authenticated Tink API client.
Runtime configuration for the Tink SDK.
Provider connectivity health checks.
Requires providers:read and credentials:read.
Connector API — manual account and transaction ingestion.
Full consent lifecycle management via the v2 connectivity API.
Cost-of-living analysis.
Requires cost-of-living:read and cost-of-living:write scopes.
Bank credential (connection) lifecycle management.
Umbrella for all Tink enrichment sub-modules.
Enrichment PFM categories. Cached 24 hours globally.
Requires enrichment.transactions:readonly or user:read.
Brand and merchant identification by ID.
Requires enrichment.merchant or enrichment.on-demand scope.
On-demand transaction enrichment — enrich transactions without aggregation.
Requires enrichment.on-demand scope.
Recurring transaction detection, grouping, and prediction.
Requires enrichment.transactions:readonly or transactions.recurring:read.
CO₂ sustainability insights for transactions and users.
Requires enrichment.sustainability scope.
Enriched transaction data with categories, merchant info, and CO₂.
Requires enrichment.transactions:readonly or transactions:read.
Structured error returned by all Tink API functions.
Expense verification reports.
Requires expense-checks:create, expense-checks:readonly, expense-checks:delete.
Financial calendar periods. Requires calendar:read scope.
Behaviour for HTTP adapters — swap Finch for test mocks.
Default Finch-backed HTTP adapter.
Mutual TLS (mTLS) HTTP adapter for Tink.
User identity data from the bank (verified name, address, date of birth).
Income verification reports.
Requires income-checks:create, income-checks:readonly, income-checks:delete.
AI-driven personalised financial insights.
Requires insights:read and insights:write scopes.
Investment account data. Requires investments:read or investment-accounts:readonly scope.
Tink Link URL builder for all end-user frontend flows.
Loan account data. Requires accounts:read or loan-accounts:readonly scope.
Mandate-based recurring payments (v1 and v2).
Requires mandate-payments and mandate-payments:readonly scopes.
Mandate management — get and revoke.
Requires mandates and mandates:readonly scopes.
Partner integration merchant management.
Requires merchants or merchants:readonly scope.
Stream-based cursor pagination helpers.
One-time payment initiation (PIS).
Provider-level consent management (legacy v1 consent API).
Requires provider-consents:read and provider-consents:write scopes.
Bank provider directory. Requires providers:read scope.
Client-side rate limiting using Hammer (token bucket / ETS backend).
Async report generation job status polling.
Requires reports-generation-jobs:readonly scope.
Risk insights reports for credit decisioning.
Requires risk-insights:create, risk-insights:readonly, risk-insights:delete.
Savings goals with allocations, deposits, withdrawals, and reallocation.
Requires savings-goals:read and savings-goals:write scopes.
Merchant settlement accounts — accounts, refunds, withdrawals, transactions.
Requires settlement-accounts or settlement-accounts:readonly scopes.
Aggregated spending statistics. Requires statistics:read scope.
Subscription detection and management.
Requires subscriptions:read and subscriptions:write scopes.
Telemetry integration. Attach handlers to these events in your application
Transaction report access (v2).
Requires transaction-reports:readonly scope.
Transaction data access. Requires transactions:read scope.
User management. Most operations require an application-level client (client credentials token) rather than a user token.
Internal utility helpers shared across all Tink API modules.
Event-driven webhook handler with a per-event-type handler registry.
Constant-time HMAC-SHA256 signature verification for incoming Tink webhooks.
Webhook endpoint registration and management.