API Reference truelayer_client v#1.0.0

Copy Markdown View Source

Modules

Production-grade Elixir client for the TrueLayer open banking API.

TrueLayer Authentication Server client.

Default in-memory token store backed by ETS, supervised by a GenServer.

Represents a TrueLayer OAuth2 access token with expiry tracking.

Behaviour for pluggable OAuth2 token storage backends.

Validated configuration struct for a TruelayerClient instance.

TrueLayer Data API v1.

Structured error type for all TruelayerClient operations.

Instrumented HTTP client wrapping Req.

Thread-safe idempotency key manager backed by ETS.

TrueLayer Mandates API — Variable Recurring Payments (VRP) and sweeping mandates.

TrueLayer Merchant Accounts API.

TrueLayer Payments API v3.

TrueLayer Payouts API — move funds from a merchant account to an external bank account.

Exponential backoff with cryptographically random full jitter.

ES512 JWS request signing for the TrueLayer Payments, Payouts, and Mandates APIs.

TrueLayer Signup+ API — collect verified user data embedded in a payment or auth flow.

TrueLayer Client Tracking API — retrieve events captured during an authorization flow.

TrueLayer Verification API — account holder name verification and KYC checks.

TrueLayer webhook signature verification, replay-attack protection, and typed dispatch.