Production-grade Elixir client for the TrueLayer open banking API.
Quick start
{:ok, client} = TruelayerClient.new(
environment: :sandbox,
client_id: System.fetch_env!("TRUELAYER_CLIENT_ID"),
client_secret: System.fetch_env!("TRUELAYER_CLIENT_SECRET"),
redirect_uri: "https://yourapp.com/callback",
signing_key_pem: File.read!("keys/signing_private.pem"),
signing_key_id: System.fetch_env!("TRUELAYER_KEY_ID"),
webhook_signing_secret: System.fetch_env!("TRUELAYER_WEBHOOK_SECRET")
)API modules
| Module | Responsibility |
|---|---|
TruelayerClient.Auth | OAuth2 tokens, auth links |
TruelayerClient.Payments | Pay-ins, auth flow, refunds, payment links |
TruelayerClient.Payouts | Merchant-account payouts |
TruelayerClient.Merchant | Merchant accounts, sweeping |
TruelayerClient.Mandates | VRP / sweeping mandates |
TruelayerClient.Data | Accounts, balances, transactions, cards |
TruelayerClient.Verification | Account holder name verification |
TruelayerClient.SignupPlus | Embedded user-data collection |
TruelayerClient.Tracking | Authorization-flow event tracking |
TruelayerClient.Webhooks | HMAC verification + typed dispatch |
Options
| Option | Type | Default | Notes |
|---|---|---|---|
:client_id | String.t() | required | |
:client_secret | String.t() | required | |
:environment | :sandbox | :live | :sandbox | |
:redirect_uri | String.t() | nil | Required for auth-code flows |
:signing_key_pem | binary() | nil | Required for Payments/Payouts/Mandates |
:signing_key_id | String.t() | nil | Key ID from TrueLayer Console |
:webhook_signing_secret | binary() | nil | HMAC-SHA256 webhook secret |
:webhook_replay_tolerance_sec | integer() | 300 | |
:request_timeout_ms | integer() | 30_000 | |
:max_retries | integer() | 3 | |
:base_retry_delay_ms | integer() | 300 | |
:token_store | module() | MemoryStore | Implement TokenStore behaviour |
:telemetry_prefix | [atom()] | [:truelayer_client] |
Summary
Functions
Returns the configured environment (:sandbox or :live).
Create a new TruelayerClient instance.
Create a new TruelayerClient instance, raising on failure.
Returns true when the client is configured for the Sandbox environment.
Types
@type t() :: %TruelayerClient{ config: TruelayerClient.Config.t(), http: Req.Request.t(), idem_table: TruelayerClient.Idempotency.table(), signer: TruelayerClient.Signing.signer() | nil, store_id: reference(), webhook_registry: TruelayerClient.Webhooks.registry() }
A fully initialised TruelayerClient instance.
Pass this struct to every domain module function, e.g.:
TruelayerClient.Payments.get_payment(client, payment_id)Functions
@spec environment(t()) :: TruelayerClient.Config.environment()
Returns the configured environment (:sandbox or :live).
@spec new(keyword()) :: {:ok, t()} | {:error, TruelayerClient.Error.t()}
Create a new TruelayerClient instance.
Returns {:ok, %TruelayerClient{}} or {:error, %TruelayerClient.Error{}}.
Example
{:ok, client} = TruelayerClient.new(
environment: :sandbox,
client_id: "your-client-id",
client_secret: "your-secret",
signing_key_pem: File.read!("signing_private.pem"),
signing_key_id: "your-key-id"
)Create a new TruelayerClient instance, raising on failure.
Example
client = TruelayerClient.new!(environment: :sandbox, client_id: "id", client_secret: "s")Returns true when the client is configured for the Sandbox environment.