Modules
ClearBank UK API client for Elixir.
GBP Account management — real and virtual accounts.
Bacs-specific payment data retrieval.
Account reporting via camt.053 bank statements.
Transaction data retrieval for GBP real and virtual accounts.
Computes the DigitalSignature header value required by ClearBank for
all POST / PATCH / PUT requests.
Immutable client struct holding credentials and configuration.
Configuration management for clearbank.
Embedded Banking account management — hub, payment, and savings accounts for your embedded customers.
Embedded Banking customer management — onboard retail, sole trader, and legal entity customers onto your platform, backed by ClearBank.
Interest product configuration for embedded banking savings accounts.
Flexible Cash ISA management for embedded retail customers.
KYC (Know Your Customer) status management for embedded banking customers.
Represents a ClearBank API error.
Core HTTP request pipeline for the ClearBank API.
Exponential backoff retry logic for ClearBank API calls.
Multi-currency account management.
FX Spot Trade — execute real-time foreign exchange conversions between two ClearBank currency accounts at the live market rate.
FX Request for Quote (RFQ) — lock in a firm exchange rate before executing.
Multi-currency international payment sending.
SEPA Credit Transfer UK (SCT UK) — send and return euro payments via the SEPA Credit Transfer scheme from within the UK.
Bacs payment operations — primarily returning Bacs Direct Credits and Direct Debit payments.
Bacs Direct Debit Instructions (DDIs) — create, retrieve, and cancel Direct Debit mandates on real and virtual accounts.
CHAPS (Clearing House Automated Payment System) — high-value, same-day GBP payments settling via the Bank of England's RTGS system.
Cheque deposit via the Image Cheque Clearing System (ICS).
Confirmation of Payee (CoP) — pre-payment name checking service.
GBP Cross-Border Payments — sending GBP internationally via SWIFT/correspondent banking.
Faster Payments Service (FPS) — the UK's 24/7/365 real-time payment rail.
Internal Transfers — move funds between accounts held at ClearBank without going through an external payment scheme.
Minimal token-bucket rate limiter backed by a GenServer.
Typed response structs for ClearBank API responses.
Typed struct for a GBP real account.
Typed struct for an Embedded Banking customer.
Typed struct for a Bacs Direct Debit Instruction (DDI/mandate).
Typed struct for an Embedded Banking account.
Typed struct for an FX RFQ quote.
Typed struct for a multi-currency account.
Generic typed wrapper for paginated API responses.
Typed struct for a GBP account transaction.
Typed struct for a GBP virtual account.
Telemetry integration for clearbank.
ClearBank API test endpoints for validating authentication and digital signatures.
Shared type definitions and helper guards used across clearbank.
Webhook envelope struct and parsing.
Typed structs for all known ClearBank webhook event payloads.
Fired when a DDI is cancelled.
Fired when a Direct Debit Instruction (DDI) is created.
Fired when a DDI is migrated from another SUN.
Fired when a Bacs payment (Direct Credit or Direct Debit) is created.
Fired when a CHAPS payment is created and accepted.
Fired when a CHAPS return payment is created.
Fired when a CoP outbound name verification response is received.
Fired when an embedded customer's KYC status transitions.
Fired when a new embedded account is provisioned for a customer.
Fired when a payment settles on an embedded customer's account.
Test event fired by POST /v1/Test if subscribed.
Fired when an FPS return payment is created.
Fired when an FX trade is executed.
Fired when an FX trade settles (funds move between accounts).
Fired when a multi-currency transaction is created.
Fired when a payment is rejected during pre-settlement assessment.
Fired when a payment fails validation before submission.
Fired when a submitted payment is rejected post-processing.
Fired when a payment settles on a GBP account (inbound or outbound).
Behaviour for implementing typed ClearBank webhook handlers.
Verifies the DigitalSignature on inbound ClearBank webhooks.
Mix Tasks
Generates an RSA 2048-bit key pair suitable for ClearBank API authentication.