clearbank-sdk 1.0.0

package/dist/types/domains/multicurrency/types.d.ts

@@ -0,0 +1,84 @@
+import type { Amount, CurrencyCode, IBAN, ISODateTime, UUID } from '../../types/index.js';
+export type MCCYAccountType = 'YourFunds' | 'SafeguardedPooled' | 'SafeguardedDesignated' | 'ClientMoneyPooled' | 'ClientMoneyDesignated' | 'SegregatedPooled' | 'SegregatedDesignated';
+export interface MCCYAccount {
+    readonly id: UUID;
+    readonly name: string;
+    readonly type: MCCYAccountType | null;
+    readonly currency: CurrencyCode;
+    readonly iban: IBAN | null;
+    readonly status: string | null;
+    readonly balance: Amount | null;
+    readonly createdAt: ISODateTime | null;
+}
+export interface MCCYVirtualAccount {
+    readonly id: UUID;
+    readonly name: string;
+    readonly iban: IBAN | null;
+    readonly status: string | null;
+    readonly owner: string | null;
+    readonly createdAt: ISODateTime | null;
+}
+export interface CreateMCCYAccountParams {
+    readonly accountName: string;
+    readonly accountType: MCCYAccountType;
+    readonly currency: CurrencyCode;
+    readonly owner?: string;
+    readonly minimumBalance?: string;
+}
+export interface UpdateMCCYAccountParams {
+    readonly accountName?: string;
+    readonly copEnabled?: boolean;
+}
+export interface CreateMCCYVirtualAccountParams {
+    readonly accountName: string;
+    readonly owner?: string;
+}
+export interface CreditorAddress {
+    readonly streetName?: string;
+    readonly townName?: string;
+    readonly postCode?: string;
+    readonly country?: string;
+}
+export interface InternationalPayment {
+    readonly accountId: UUID;
+    readonly amount: Amount;
+    readonly currency: CurrencyCode;
+    readonly creditorName: string;
+    readonly creditorIban?: IBAN;
+    readonly creditorBic?: string;
+    readonly creditorAddress?: CreditorAddress;
+    readonly remittanceInformation?: string;
+    readonly endToEndId?: string;
+}
+export interface FXTradeParams {
+    readonly sellAccountId: UUID;
+    readonly buyAccountId: UUID;
+    readonly sellCurrency: CurrencyCode;
+    readonly buyCurrency: CurrencyCode;
+    readonly sellAmount?: Amount;
+    readonly buyAmount?: Amount;
+    readonly endToEndId?: string;
+}
+export interface FXTradeResult {
+    readonly tradeId: string;
+    readonly rate: string;
+    readonly sellAmount: Amount;
+    readonly buyAmount: Amount;
+}
+export interface FXQuoteParams {
+    readonly sellAccountId: UUID;
+    readonly buyAccountId: UUID;
+    readonly sellCurrency: CurrencyCode;
+    readonly buyCurrency: CurrencyCode;
+    readonly sellAmount?: Amount;
+    readonly buyAmount?: Amount;
+}
+export interface FXQuote {
+    readonly quoteId: string;
+    readonly rate: string;
+    readonly sellAmount: Amount;
+    readonly buyAmount: Amount;
+    readonly expiresAt: ISODateTime;
+    isExpired(): boolean;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types/domains/multicurrency/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/domains/multicurrency/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAC;AAE1F,MAAM,MAAM,eAAe,GACvB,WAAW,GACX,mBAAmB,GACnB,uBAAuB,GACvB,mBAAmB,GACnB,uBAAuB,GACvB,kBAAkB,GAClB,sBAAsB,CAAC;AAE3B,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,EAAE,EAAE,IAAI,CAAC;IAClB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,IAAI,EAAE,eAAe,GAAG,IAAI,CAAC;IACtC,QAAQ,CAAC,QAAQ,EAAE,YAAY,CAAC;IAChC,QAAQ,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI,CAAC;IAC3B,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,QAAQ,CAAC,SAAS,EAAE,WAAW,GAAG,IAAI,CAAC;CACxC;AAED,MAAM,WAAW,kBAAkB;IACjC,QAAQ,CAAC,EAAE,EAAE,IAAI,CAAC;IAClB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI,CAAC;IAC3B,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,QAAQ,CAAC,SAAS,EAAE,WAAW,GAAG,IAAI,CAAC;CACxC;AAED,MAAM,WAAW,uBAAuB;IACtC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,WAAW,EAAE,eAAe,CAAC;IACtC,QAAQ,CAAC,QAAQ,EAAE,YAAY,CAAC;IAChC,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;CAClC;AAED,MAAM,WAAW,uBAAuB;IACtC,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,CAAC;CAC/B;AAED,MAAM,WAAW,8BAA8B;IAC7C,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,SAAS,EAAE,IAAI,CAAC;IACzB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,QAAQ,EAAE,YAAY,CAAC;IAChC,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,YAAY,CAAC,EAAE,IAAI,CAAC;IAC7B,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,eAAe,CAAC,EAAE,eAAe,CAAC;IAC3C,QAAQ,CAAC,qBAAqB,CAAC,EAAE,MAAM,CAAC;IACxC,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;CAC9B;AAED,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,aAAa,EAAE,IAAI,CAAC;IAC7B,QAAQ,CAAC,YAAY,EAAE,IAAI,CAAC;IAC5B,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC;IACpC,QAAQ,CAAC,WAAW,EAAE,YAAY,CAAC;IACnC,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;CAC9B;AAED,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,aAAa,EAAE,IAAI,CAAC;IAC7B,QAAQ,CAAC,YAAY,EAAE,IAAI,CAAC;IAC5B,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC;IACpC,QAAQ,CAAC,WAAW,EAAE,YAAY,CAAC;IACnC,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,OAAO;IACtB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,SAAS,EAAE,WAAW,CAAC;IAChC,SAAS,IAAI,OAAO,CAAC;CACtB"}

package/dist/types/domains/payments/index.d.ts

@@ -0,0 +1,3 @@
+export { PaymentsService } from './service.js';
+export type { FpsPayment, FpsPaymentType, SendFpsParams, SendFpsBulkParams, InternalTransferParams, SendChapsParams, ReturnChapsParams, ReturnBacsPaymentParams, SubmitChequeDepositParams, CheckCoPParams, CoPResponse, CoPMatchResult, SendCrossBorderParams, SendSepaParams, ReturnSepaParams, } from './types.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/domains/payments/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/domains/payments/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAC/C,YAAY,EACV,UAAU,EACV,cAAc,EACd,aAAa,EACb,iBAAiB,EACjB,sBAAsB,EACtB,eAAe,EACf,iBAAiB,EACjB,uBAAuB,EACvB,yBAAyB,EACzB,cAAc,EACd,WAAW,EACX,cAAc,EACd,qBAAqB,EACrB,cAAc,EACd,gBAAgB,GACjB,MAAM,YAAY,CAAC"}

package/dist/types/domains/payments/service.d.ts

@@ -0,0 +1,65 @@
+import type { HttpClient, RequestOptions } from '../../core/http.js';
+import type { SendFpsParams, SendFpsBulkParams, InternalTransferParams, SendChapsParams, ReturnChapsParams, ReturnBacsPaymentParams, SubmitChequeDepositParams, CheckCoPParams, CoPResponse, SendCrossBorderParams, SendSepaParams, ReturnSepaParams } from './types.js';
+/**
+ * GBP Payments service.
+ *
+ * Covers: FPS (single + bulk), Internal Transfers, CHAPS, Bacs returns,
+ * Cheque Deposits, Confirmation of Payee, Cross-Border (deprecated), SEPA SCT UK.
+ */
+export declare class PaymentsService {
+    private readonly http;
+    constructor(http: HttpClient);
+    /**
+     * Sends a single Faster Payment.
+     *
+     * @remarks
+     * Limit: £1,000,000 per payment. Confirmation via `TransactionSettled` webhook.
+     * Set `enforceSendToScheme: true` to always route via FPS scheme (subject to
+     * Pay.UK APP scam reimbursement liability).
+     */
+    sendFPS(params: SendFpsParams, opts?: RequestOptions): Promise<void>;
+    /** Sends multiple Faster Payments in one request. */
+    sendFPSBulk(params: SendFpsBulkParams, opts?: RequestOptions): Promise<void>;
+    /** Transfers funds between ClearBank-held accounts (same institution). */
+    sendInternalTransfer(params: InternalTransferParams, opts?: RequestOptions): Promise<void>;
+    /** Sends multiple internal transfers in one request. */
+    sendBulkInternalTransfer(params: InternalTransferParams[], opts?: RequestOptions): Promise<void>;
+    /**
+     * Sends a CHAPS customer credit transfer (pacs.008).
+     *
+     * @remarks
+     * No upper limit. Same-day settlement during Bank of England RTGS hours.
+     * Requires structured ISO 20022 creditor address.
+     */
+    sendCHAPS(params: SendChapsParams, opts?: RequestOptions): Promise<void>;
+    /** Returns a received CHAPS payment. */
+    returnCHAPS(params: ReturnChapsParams, opts?: RequestOptions): Promise<void>;
+    /** Returns a Bacs payment received on a real account. */
+    returnBacs(accountId: string, params: ReturnBacsPaymentParams, opts?: RequestOptions): Promise<void>;
+    /** Returns a Bacs payment received on a virtual account. */
+    returnVirtualBacs(accountId: string, virtualAccountId: string, params: ReturnBacsPaymentParams, opts?: RequestOptions): Promise<void>;
+    /** Submits a cheque image deposit via the Image Clearing System (ICS). */
+    submitChequeDeposit(params: SubmitChequeDepositParams, opts?: RequestOptions): Promise<void>;
+    /**
+     * Sends an outbound CoP name verification request.
+     *
+     * @remarks
+     * Match results: MATC (full match), CLOSE (close match), NOMATCH, INAM (wrong account type),
+     * PANM (partial name match).
+     */
+    checkCoP(params: CheckCoPParams, opts?: RequestOptions): Promise<CoPResponse>;
+    /** Opts a real account out of inbound CoP name checks. */
+    optOutAccountCoP(accountId: string, opts?: RequestOptions): Promise<void>;
+    /** Opts a virtual account out of inbound CoP name checks. */
+    optOutVirtualAccountCoP(accountId: string, virtualAccountId: string, opts?: RequestOptions): Promise<void>;
+    /**
+     * Sends a GBP cross-border payment.
+     * @deprecated EOL 13 November 2026. Use `MultiCurrencyService.sendPayment()` instead.
+     */
+    sendCrossBorder(params: SendCrossBorderParams, opts?: RequestOptions): Promise<void>;
+    /** Sends a SEPA Credit Transfer UK euro payment. */
+    sendSEPA(params: SendSepaParams, opts?: RequestOptions): Promise<void>;
+    /** Returns a received SEPA Credit Transfer UK payment. */
+    returnSEPA(params: ReturnSepaParams, opts?: RequestOptions): Promise<void>;
+}
+//# sourceMappingURL=service.d.ts.map

package/dist/types/domains/payments/service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../../../../src/domains/payments/service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACrE,OAAO,KAAK,EACV,aAAa,EACb,iBAAiB,EAEjB,sBAAsB,EACtB,eAAe,EACf,iBAAiB,EACjB,uBAAuB,EACvB,yBAAyB,EACzB,cAAc,EACd,WAAW,EACX,qBAAqB,EACrB,cAAc,EACd,gBAAgB,EACjB,MAAM,YAAY,CAAC;AAEpB;;;;;GAKG;AACH,qBAAa,eAAe;IACd,OAAO,CAAC,QAAQ,CAAC,IAAI;gBAAJ,IAAI,EAAE,UAAU;IAM7C;;;;;;;OAOG;IACG,OAAO,CAAC,MAAM,EAAE,aAAa,EAAE,IAAI,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAK1E,qDAAqD;IAC/C,WAAW,CAAC,MAAM,EAAE,iBAAiB,EAAE,IAAI,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IASlF,0EAA0E;IACpE,oBAAoB,CAAC,MAAM,EAAE,sBAAsB,EAAE,IAAI,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAchG,wDAAwD;IAClD,wBAAwB,CAC5B,MAAM,EAAE,sBAAsB,EAAE,EAChC,IAAI,CAAC,EAAE,cAAc,GACpB,OAAO,CAAC,IAAI,CAAC;IAsBhB;;;;;;OAMG;IACG,SAAS,CAAC,MAAM,EAAE,eAAe,EAAE,IAAI,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAK9E,wCAAwC;IAClC,WAAW,CAAC,MAAM,EAAE,iBAAiB,EAAE,IAAI,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAclF,yDAAyD;IACnD,UAAU,CACd,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,uBAAuB,EAC/B,IAAI,CAAC,EAAE,cAAc,GACpB,OAAO,CAAC,IAAI,CAAC;IAKhB,4DAA4D;IACtD,iBAAiB,CACrB,SAAS,EAAE,MAAM,EACjB,gBAAgB,EAAE,MAAM,EACxB,MAAM,EAAE,uBAAuB,EAC/B,IAAI,CAAC,EAAE,cAAc,GACpB,OAAO,CAAC,IAAI,CAAC;IAahB,0EAA0E;IACpE,mBAAmB,CACvB,MAAM,EAAE,yBAAyB,EACjC,IAAI,CAAC,EAAE,cAAc,GACpB,OAAO,CAAC,IAAI,CAAC;IAkBhB;;;;;;OAMG;IACG,QAAQ,CAAC,MAAM,EAAE,cAAc,EAAE,IAAI,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,WAAW,CAAC;IAYnF,0DAA0D;IACpD,gBAAgB,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAI/E,6DAA6D;IACvD,uBAAuB,CAC3B,SAAS,EAAE,MAAM,EACjB,gBAAgB,EAAE,MAAM,EACxB,IAAI,CAAC,EAAE,cAAc,GACpB,OAAO,CAAC,IAAI,CAAC;IAYhB;;;OAGG;IACG,eAAe,CAAC,MAAM,EAAE,qBAAqB,EAAE,IAAI,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAe1F,oDAAoD;IAC9C,QAAQ,CAAC,MAAM,EAAE,cAAc,EAAE,IAAI,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAY5E,0DAA0D;IACpD,UAAU,CAAC,MAAM,EAAE,gBAAgB,EAAE,IAAI,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;CASjF"}

package/dist/types/domains/payments/types.d.ts

@@ -0,0 +1,107 @@
+import type { Amount, CurrencyCode, UUID, StructuredAddress } from '../../types/index.js';
+export type FpsPaymentType = 'SIP' | 'SOP' | 'FDP';
+export interface FpsPayment {
+    readonly amount: Amount;
+    readonly currency?: CurrencyCode;
+    readonly destinationSortCode: string;
+    readonly destinationAccountNumber: string;
+    readonly destinationAccountName: string;
+    readonly reference?: string;
+    readonly paymentType?: FpsPaymentType;
+    readonly enforceSendToScheme?: boolean;
+    readonly endToEndId?: string;
+}
+export interface SendFpsParams {
+    readonly accountId: UUID;
+    readonly payment: FpsPayment;
+    readonly payments?: never;
+}
+export interface SendFpsBulkParams {
+    readonly accountId: UUID;
+    readonly payments: FpsPayment[];
+    readonly payment?: never;
+}
+export interface InternalTransferParams {
+    readonly debtorAccountId: UUID;
+    readonly creditorAccountId: UUID;
+    readonly amount: Amount;
+    readonly currency?: CurrencyCode;
+    readonly reference?: string;
+    readonly endToEndId?: string;
+    readonly debtorVirtualAccountId?: UUID;
+    readonly creditorVirtualAccountId?: UUID;
+}
+export interface SendChapsParams {
+    readonly debtorAccountId: UUID;
+    readonly amount: Amount;
+    readonly currency?: CurrencyCode;
+    readonly creditorName: string;
+    readonly creditorSortCode: string;
+    readonly creditorAccountNumber: string;
+    readonly creditorAddress: StructuredAddress;
+    readonly remittanceInformation: string;
+    readonly endToEndId?: string;
+    readonly instructionId?: string;
+    readonly debtorName?: string;
+    readonly debtorAddress?: StructuredAddress;
+}
+export interface ReturnChapsParams {
+    readonly originalInstructionId: string;
+    readonly debtorAccountId: UUID;
+    readonly returnReasonCode: string;
+    readonly amount: Amount;
+    readonly currency?: CurrencyCode;
+}
+export interface ReturnBacsPaymentParams {
+    readonly transactionId: UUID;
+    readonly reasonCode: string;
+}
+export interface SubmitChequeDepositParams {
+    readonly accountId: UUID;
+    readonly amount: Amount;
+    readonly currency?: CurrencyCode;
+    readonly chequeImageFront: string;
+    readonly chequeImageBack: string;
+    readonly micrLine: string;
+    readonly payeeName?: string;
+    readonly chequeNumber?: string;
+}
+export type CoPMatchResult = 'MATC' | 'CLOSE' | 'NOMATCH' | 'INAM' | 'PANM';
+export interface CheckCoPParams {
+    readonly accountName: string;
+    readonly sortCode: string;
+    readonly accountNumber: string;
+    readonly accountType?: 'Personal' | 'Business';
+    readonly secondaryReference?: string;
+}
+export interface CoPResponse {
+    readonly matchResult: CoPMatchResult;
+    readonly accountName?: string;
+}
+/** @deprecated EOL 13 November 2026. Use multicurrency payments instead. */
+export interface SendCrossBorderParams {
+    readonly accountId: UUID;
+    readonly amount: Amount;
+    readonly currency?: CurrencyCode;
+    readonly creditorName: string;
+    readonly creditorIban: string;
+    readonly creditorBic: string;
+    readonly remittanceInformation?: string;
+}
+export interface SendSepaParams {
+    readonly debtorAccountId: UUID;
+    readonly amount: Amount;
+    readonly creditorName: string;
+    readonly creditorIban: string;
+    readonly creditorBic: string;
+    readonly remittanceInformation?: string;
+    readonly endToEndId?: string;
+    readonly instructionId?: string;
+}
+export interface ReturnSepaParams {
+    readonly originalInstructionId: string;
+    readonly debtorAccountId: UUID;
+    readonly returnReasonCode: string;
+    readonly amount: Amount;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types/domains/payments/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/domains/payments/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE,IAAI,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AAM1F,MAAM,MAAM,cAAc,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC;AAEnD,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,QAAQ,CAAC,EAAE,YAAY,CAAC;IACjC,QAAQ,CAAC,mBAAmB,EAAE,MAAM,CAAC;IACrC,QAAQ,CAAC,wBAAwB,EAAE,MAAM,CAAC;IAC1C,QAAQ,CAAC,sBAAsB,EAAE,MAAM,CAAC;IACxC,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,WAAW,CAAC,EAAE,cAAc,CAAC;IACtC,QAAQ,CAAC,mBAAmB,CAAC,EAAE,OAAO,CAAC;IACvC,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;CAC9B;AAED,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,SAAS,EAAE,IAAI,CAAC;IACzB,QAAQ,CAAC,OAAO,EAAE,UAAU,CAAC;IAC7B,QAAQ,CAAC,QAAQ,CAAC,EAAE,KAAK,CAAC;CAC3B;AAED,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,SAAS,EAAE,IAAI,CAAC;IACzB,QAAQ,CAAC,QAAQ,EAAE,UAAU,EAAE,CAAC;IAChC,QAAQ,CAAC,OAAO,CAAC,EAAE,KAAK,CAAC;CAC1B;AAMD,MAAM,WAAW,sBAAsB;IACrC,QAAQ,CAAC,eAAe,EAAE,IAAI,CAAC;IAC/B,QAAQ,CAAC,iBAAiB,EAAE,IAAI,CAAC;IACjC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,QAAQ,CAAC,EAAE,YAAY,CAAC;IACjC,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,sBAAsB,CAAC,EAAE,IAAI,CAAC;IACvC,QAAQ,CAAC,wBAAwB,CAAC,EAAE,IAAI,CAAC;CAC1C;AAMD,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,eAAe,EAAE,IAAI,CAAC;IAC/B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,QAAQ,CAAC,EAAE,YAAY,CAAC;IACjC,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAC;IAClC,QAAQ,CAAC,qBAAqB,EAAE,MAAM,CAAC;IACvC,QAAQ,CAAC,eAAe,EAAE,iBAAiB,CAAC;IAC5C,QAAQ,CAAC,qBAAqB,EAAE,MAAM,CAAC;IACvC,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;IAChC,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,aAAa,CAAC,EAAE,iBAAiB,CAAC;CAC5C;AAED,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,qBAAqB,EAAE,MAAM,CAAC;IACvC,QAAQ,CAAC,eAAe,EAAE,IAAI,CAAC;IAC/B,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAC;IAClC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,QAAQ,CAAC,EAAE,YAAY,CAAC;CAClC;AAMD,MAAM,WAAW,uBAAuB;IACtC,QAAQ,CAAC,aAAa,EAAE,IAAI,CAAC;IAC7B,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;CAC7B;AAMD,MAAM,WAAW,yBAAyB;IACxC,QAAQ,CAAC,SAAS,EAAE,IAAI,CAAC;IACzB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,QAAQ,CAAC,EAAE,YAAY,CAAC;IACjC,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAC;IAClC,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;IACjC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;CAChC;AAMD,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,GAAG,MAAM,CAAC;AAE5E,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAC/B,QAAQ,CAAC,WAAW,CAAC,EAAE,UAAU,GAAG,UAAU,CAAC;IAC/C,QAAQ,CAAC,kBAAkB,CAAC,EAAE,MAAM,CAAC;CACtC;AAED,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,WAAW,EAAE,cAAc,CAAC;IACrC,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;CAC/B;AAMD,4EAA4E;AAC5E,MAAM,WAAW,qBAAqB;IACpC,QAAQ,CAAC,SAAS,EAAE,IAAI,CAAC;IACzB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,QAAQ,CAAC,EAAE,YAAY,CAAC;IACjC,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,qBAAqB,CAAC,EAAE,MAAM,CAAC;CACzC;AAMD,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,eAAe,EAAE,IAAI,CAAC;IAC/B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,qBAAqB,CAAC,EAAE,MAAM,CAAC;IACxC,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;CACjC;AAED,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,qBAAqB,EAAE,MAAM,CAAC;IACvC,QAAQ,CAAC,eAAe,EAAE,IAAI,CAAC;IAC/B,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAC;IAClC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;CACzB"}

package/dist/types/domains/webhooks/index.d.ts

@@ -0,0 +1,3 @@
+export { WebhooksService, buildAckBody } from './service.js';
+export type { WebhookEnvelope, WebhookEventType, WebhookEventMap, PartialWebhookHandlers, WebhookHandlerFn, FITestEvent, TransactionSettled, PaymentMessageAssessmentFailed, PaymentMessageValidationFailed, TransactionRejected, FpsPaymentReturnCreated, BacsPaymentCreated, BacsMandateCreated, BacsMandateCancelled, BacsMandateMigrated, ChapsPaymentCreated, ChapsReturnCreated, CopOutboundResponse, CoPMatchResult, MccyTransactionCreated, FxTradeCreated, FxTradeSettled, CustomerKycStatusChanged, EmbeddedAccountCreated, EmbeddedTransactionSettled, } from './types.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/domains/webhooks/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/domains/webhooks/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAC7D,YAAY,EACV,eAAe,EACf,gBAAgB,EAChB,eAAe,EACf,sBAAsB,EACtB,gBAAgB,EAChB,WAAW,EACX,kBAAkB,EAClB,8BAA8B,EAC9B,8BAA8B,EAC9B,mBAAmB,EACnB,uBAAuB,EACvB,kBAAkB,EAClB,kBAAkB,EAClB,oBAAoB,EACpB,mBAAmB,EACnB,mBAAmB,EACnB,kBAAkB,EAClB,mBAAmB,EACnB,cAAc,EACd,sBAAsB,EACtB,cAAc,EACd,cAAc,EACd,wBAAwB,EACxB,sBAAsB,EACtB,0BAA0B,GAC3B,MAAM,YAAY,CAAC"}

package/dist/types/domains/webhooks/service.d.ts

@@ -0,0 +1,66 @@
+import type { WebhookEnvelope, WebhookEventMap, PartialWebhookHandlers } from './types.js';
+export { buildAckBody } from './types.js';
+/**
+ * Webhook signature verification and typed event dispatch.
+ *
+ * @example
+ * ```ts
+ * const webhooks = client.webhooks;
+ *
+ * app.post('/webhooks', async (req, res) => {
+ *   const body = JSON.stringify(req.body);
+ *   const isValid = await webhooks.verifySignature(body, req.headers['digitalsignature'], publicKeyPem);
+ *   if (!isValid) return res.status(401).send('Invalid signature');
+ *
+ *   await webhooks.dispatch(req.body, {
+ *     TransactionSettled: async (event) => {
+ *       await processPayment(event);
+ *     },
+ *     onUnknown: (envelope) => console.log('Unknown event:', envelope.Type),
+ *   });
+ *
+ *   res.json(webhooks.buildAck(req.body));
+ * });
+ * ```
+ */
+export declare class WebhooksService {
+    /**
+     * Verifies a ClearBank `DigitalSignature` header using ClearBank's public key.
+     * Download the public key from Portal → Webhook Management.
+     *
+     * @param body       Raw request body as a string (before JSON.parse).
+     * @param signature  Value of the `DigitalSignature` header.
+     * @param publicKeyPem ClearBank RSA public key in PEM format.
+     */
+    verifySignature(body: string, signature: string, publicKeyPem: string): Promise<boolean>;
+    /**
+     * Parses and validates a raw webhook body into a typed envelope.
+     *
+     * @throws {ClearBankError} if the body is not valid JSON or is missing the Type field.
+     */
+    parseEnvelope(rawBody: unknown): WebhookEnvelope;
+    /**
+     * Parses the Payload of an envelope into a strongly-typed event object.
+     * Returns `null` for unknown event types (forward-compatible).
+     */
+    parseEvent<K extends keyof WebhookEventMap>(envelope: WebhookEnvelope, eventType: K): WebhookEventMap[K] | null;
+    /**
+     * Dispatches a webhook envelope to the appropriate handler.
+     *
+     * Only the handlers you provide are called — unhandled event types are silently
+     * ignored unless you provide `onUnknown`. This makes it easy to add handlers
+     * incrementally as you subscribe to more webhook event types.
+     *
+     * @param envelope   Parsed webhook envelope (from `parseEnvelope`).
+     * @param handlers   Object mapping event type names to handler functions.
+     */
+    dispatch(envelope: WebhookEnvelope, handlers: PartialWebhookHandlers): Promise<void>;
+    /**
+     * Builds the JSON acknowledgement body to send in the webhook response.
+     * ClearBank uses the nonce to track delivered events.
+     */
+    buildAck(envelope: WebhookEnvelope): {
+        nonce: number;
+    };
+}
+//# sourceMappingURL=service.d.ts.map

package/dist/types/domains/webhooks/service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../../../../src/domains/webhooks/service.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EACV,eAAe,EACf,eAAe,EACf,sBAAsB,EAoBvB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAE1C;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,qBAAa,eAAe;IAC1B;;;;;;;OAOG;IACG,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAI9F;;;;OAIG;IACH,aAAa,CAAC,OAAO,EAAE,OAAO,GAAG,eAAe;IAmChD;;;OAGG;IACH,UAAU,CAAC,CAAC,SAAS,MAAM,eAAe,EACxC,QAAQ,EAAE,eAAe,EACzB,SAAS,EAAE,CAAC,GACX,eAAe,CAAC,CAAC,CAAC,GAAG,IAAI;IAK5B;;;;;;;;;OASG;IACG,QAAQ,CAAC,QAAQ,EAAE,eAAe,EAAE,QAAQ,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC;IAkH1F;;;OAGG;IACH,QAAQ,CAAC,QAAQ,EAAE,eAAe,GAAG;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE;CAGvD"}

package/dist/types/domains/webhooks/types.d.ts

@@ -0,0 +1,215 @@
+import type { Amount, CurrencyCode, ISODateTime, UUID } from '../../types/index.js';
+/**
+ * Known ClearBank webhook event types.
+ * The dispatch switch handles a `default` branch for forward-compatibility
+ * with event types introduced after this SDK version.
+ */
+export type WebhookEventType = 'FITestEvent' | 'TransactionSettled' | 'PaymentMessageAssessmentFailed' | 'PaymentMessageValidationFailed' | 'TransactionRejected' | 'FpsPaymentReturnCreated' | 'BacsPaymentCreated' | 'BacsMandateCreated' | 'BacsMandateCancelled' | 'BacsMandateMigrated' | 'ChapsPaymentCreated' | 'ChapsReturnCreated' | 'CopOutboundResponse' | 'MccyTransactionCreated' | 'FxTradeCreated' | 'FxTradeSettled' | 'CustomerKycStatusChanged' | 'EmbeddedAccountCreated' | 'EmbeddedTransactionSettled';
+export interface WebhookEnvelope {
+    readonly Type: string;
+    readonly Version: number;
+    readonly Nonce: number;
+    readonly Payload: Record<string, unknown>;
+}
+/** Returns the JSON body to send as the webhook acknowledgement. */
+export declare function buildAckBody(envelope: WebhookEnvelope): {
+    nonce: number;
+};
+export interface FITestEvent {
+    readonly firedAt: string;
+}
+export interface TransactionSettled {
+    readonly accountId: UUID;
+    readonly virtualAccountId: UUID | null;
+    readonly transactionId: UUID;
+    readonly amount: Amount;
+    readonly currencyCode: CurrencyCode;
+    readonly direction: 'Inbound' | 'Outbound';
+    readonly type: string;
+    readonly status: string;
+    readonly reference: string | null;
+    readonly counterpartName: string | null;
+    readonly counterpartSortCode: string | null;
+    readonly counterpartAccountNumber: string | null;
+    readonly endToEndId: string | null;
+    readonly timestamp: ISODateTime;
+}
+export interface PaymentMessageAssessmentFailed {
+    readonly paymentId: UUID;
+    readonly accountId: UUID;
+    readonly reasonCode: string;
+    readonly reasonDescription: string;
+    readonly timestamp: ISODateTime;
+}
+export interface PaymentMessageValidationFailed {
+    readonly paymentId: UUID;
+    readonly accountId: UUID;
+    readonly errors: Record<string, unknown>;
+    readonly timestamp: ISODateTime;
+}
+export interface TransactionRejected {
+    readonly transactionId: UUID;
+    readonly accountId: UUID;
+    readonly amount: Amount;
+    readonly currencyCode: CurrencyCode;
+    readonly reasonCode: string;
+    readonly reasonDescription: string;
+    readonly timestamp: ISODateTime;
+}
+export interface FpsPaymentReturnCreated {
+    readonly returnId: UUID;
+    readonly originalTransactionId: UUID;
+    readonly accountId: UUID;
+    readonly amount: Amount;
+    readonly currencyCode: CurrencyCode;
+    readonly reasonCode: string;
+    readonly timestamp: ISODateTime;
+}
+export interface BacsPaymentCreated {
+    readonly paymentId: UUID;
+    readonly accountId: UUID;
+    readonly virtualAccountId: UUID | null;
+    readonly amount: Amount;
+    readonly currencyCode: CurrencyCode;
+    readonly type: string;
+    readonly serviceUserNumber: string;
+    readonly reference: string;
+    readonly processingDate: string;
+    readonly timestamp: ISODateTime;
+}
+export interface BacsMandateCreated {
+    readonly mandateId: UUID;
+    readonly accountId: UUID;
+    readonly serviceUserNumber: string;
+    readonly reference: string;
+    readonly payerName: string;
+    readonly status: string;
+    readonly timestamp: ISODateTime;
+}
+export interface BacsMandateCancelled {
+    readonly mandateId: UUID;
+    readonly accountId: UUID;
+    readonly reason: string;
+    readonly timestamp: ISODateTime;
+}
+export interface BacsMandateMigrated {
+    readonly mandateId: UUID;
+    readonly accountId: UUID;
+    readonly oldServiceUserNumber: string;
+    readonly newServiceUserNumber: string;
+    readonly timestamp: ISODateTime;
+}
+export interface ChapsPaymentCreated {
+    readonly instructionId: UUID;
+    readonly accountId: UUID;
+    readonly amount: Amount;
+    readonly currencyCode: CurrencyCode;
+    readonly creditorName: string;
+    readonly remittanceInformation: string;
+    readonly timestamp: ISODateTime;
+}
+export interface ChapsReturnCreated {
+    readonly returnId: UUID;
+    readonly originalInstructionId: UUID;
+    readonly accountId: UUID;
+    readonly amount: Amount;
+    readonly reasonCode: string;
+    readonly timestamp: ISODateTime;
+}
+export type CoPMatchResult = 'MATC' | 'CLOSE' | 'NOMATCH' | 'INAM' | 'PANM';
+export interface CopOutboundResponse {
+    readonly requestId: UUID;
+    readonly matchResult: CoPMatchResult;
+    readonly accountName: string;
+    readonly accountType: string;
+    readonly sortCode: string;
+    readonly accountNumber: string;
+    readonly timestamp: ISODateTime;
+}
+export interface MccyTransactionCreated {
+    readonly transactionId: UUID;
+    readonly accountId: UUID;
+    readonly virtualAccountId: UUID | null;
+    readonly amount: Amount;
+    readonly currencyCode: CurrencyCode;
+    readonly direction: string;
+    readonly type: string;
+    readonly reference: string | null;
+    readonly timestamp: ISODateTime;
+}
+export interface FxTradeCreated {
+    readonly tradeId: UUID;
+    readonly sellAccountId: UUID;
+    readonly buyAccountId: UUID;
+    readonly sellCurrency: CurrencyCode;
+    readonly buyCurrency: CurrencyCode;
+    readonly sellAmount: Amount;
+    readonly buyAmount: Amount;
+    readonly rate: string;
+    readonly timestamp: ISODateTime;
+}
+export interface FxTradeSettled {
+    readonly tradeId: UUID;
+    readonly sellAccountId: UUID;
+    readonly buyAccountId: UUID;
+    readonly sellAmount: Amount;
+    readonly buyAmount: Amount;
+    readonly timestamp: ISODateTime;
+}
+export interface CustomerKycStatusChanged {
+    readonly customerId: UUID;
+    readonly previousStatus: string;
+    readonly newStatus: string;
+    readonly reason: string;
+    readonly timestamp: ISODateTime;
+}
+export interface EmbeddedAccountCreated {
+    readonly accountId: UUID;
+    readonly customerId: UUID;
+    readonly accountType: string;
+    readonly accountName: string;
+    readonly iban: string | null;
+    readonly sortCode: string | null;
+    readonly accountNumber: string | null;
+    readonly timestamp: ISODateTime;
+}
+export interface EmbeddedTransactionSettled {
+    readonly transactionId: UUID;
+    readonly accountId: UUID;
+    readonly customerId: UUID;
+    readonly amount: Amount;
+    readonly currencyCode: CurrencyCode;
+    readonly direction: string;
+    readonly type: string;
+    readonly reference: string | null;
+    readonly counterpartName: string | null;
+    readonly timestamp: ISODateTime;
+}
+export interface WebhookEventMap {
+    FITestEvent: FITestEvent;
+    TransactionSettled: TransactionSettled;
+    PaymentMessageAssessmentFailed: PaymentMessageAssessmentFailed;
+    PaymentMessageValidationFailed: PaymentMessageValidationFailed;
+    TransactionRejected: TransactionRejected;
+    FpsPaymentReturnCreated: FpsPaymentReturnCreated;
+    BacsPaymentCreated: BacsPaymentCreated;
+    BacsMandateCreated: BacsMandateCreated;
+    BacsMandateCancelled: BacsMandateCancelled;
+    BacsMandateMigrated: BacsMandateMigrated;
+    ChapsPaymentCreated: ChapsPaymentCreated;
+    ChapsReturnCreated: ChapsReturnCreated;
+    CopOutboundResponse: CopOutboundResponse;
+    MccyTransactionCreated: MccyTransactionCreated;
+    FxTradeCreated: FxTradeCreated;
+    FxTradeSettled: FxTradeSettled;
+    CustomerKycStatusChanged: CustomerKycStatusChanged;
+    EmbeddedAccountCreated: EmbeddedAccountCreated;
+    EmbeddedTransactionSettled: EmbeddedTransactionSettled;
+}
+export type WebhookHandlerFn<T> = (payload: T, envelope: WebhookEnvelope) => void | Promise<void>;
+export type PartialWebhookHandlers = {
+    [K in keyof WebhookEventMap]?: WebhookHandlerFn<WebhookEventMap[K]>;
+} & {
+    onUnknown?: (envelope: WebhookEnvelope) => void | Promise<void>;
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/types/domains/webhooks/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/domains/webhooks/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAC;AAMpF;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GACxB,aAAa,GACb,oBAAoB,GACpB,gCAAgC,GAChC,gCAAgC,GAChC,qBAAqB,GACrB,yBAAyB,GACzB,oBAAoB,GACpB,oBAAoB,GACpB,sBAAsB,GACtB,qBAAqB,GACrB,qBAAqB,GACrB,oBAAoB,GACpB,qBAAqB,GACrB,wBAAwB,GACxB,gBAAgB,GAChB,gBAAgB,GAChB,0BAA0B,GAC1B,wBAAwB,GACxB,4BAA4B,CAAC;AAEjC,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC3C;AAED,oEAAoE;AACpE,wBAAgB,YAAY,CAAC,QAAQ,EAAE,eAAe,GAAG;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,CAEzE;AAMD,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,kBAAkB;IACjC,QAAQ,CAAC,SAAS,EAAE,IAAI,CAAC;IACzB,QAAQ,CAAC,gBAAgB,EAAE,IAAI,GAAG,IAAI,CAAC;IACvC,QAAQ,CAAC,aAAa,EAAE,IAAI,CAAC;IAC7B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC;IACpC,QAAQ,CAAC,SAAS,EAAE,SAAS,GAAG,UAAU,CAAC;IAC3C,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,QAAQ,CAAC,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IACxC,QAAQ,CAAC,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5C,QAAQ,CAAC,wBAAwB,EAAE,MAAM,GAAG,IAAI,CAAC;IACjD,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,QAAQ,CAAC,SAAS,EAAE,WAAW,CAAC;CACjC;AAED,MAAM,WAAW,8BAA8B;IAC7C,QAAQ,CAAC,SAAS,EAAE,IAAI,CAAC;IACzB,QAAQ,CAAC,SAAS,EAAE,IAAI,CAAC;IACzB,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,iBAAiB,EAAE,MAAM,CAAC;IACnC,QAAQ,CAAC,SAAS,EAAE,WAAW,CAAC;CACjC;AAED,MAAM,WAAW,8BAA8B;IAC7C,QAAQ,CAAC,SAAS,EAAE,IAAI,CAAC;IACzB,QAAQ,CAAC,SAAS,EAAE,IAAI,CAAC;IACzB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACzC,QAAQ,CAAC,SAAS,EAAE,WAAW,CAAC;CACjC;AAED,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,aAAa,EAAE,IAAI,CAAC;IAC7B,QAAQ,CAAC,SAAS,EAAE,IAAI,CAAC;IACzB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC;IACpC,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,iBAAiB,EAAE,MAAM,CAAC;IACnC,QAAQ,CAAC,SAAS,EAAE,WAAW,CAAC;CACjC;AAED,MAAM,WAAW,uBAAuB;IACtC,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC;IACxB,QAAQ,CAAC,qBAAqB,EAAE,IAAI,CAAC;IACrC,QAAQ,CAAC,SAAS,EAAE,IAAI,CAAC;IACzB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC;IACpC,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,SAAS,EAAE,WAAW,CAAC;CACjC;AAED,MAAM,WAAW,kBAAkB;IACjC,QAAQ,CAAC,SAAS,EAAE,IAAI,CAAC;IACzB,QAAQ,CAAC,SAAS,EAAE,IAAI,CAAC;IACzB,QAAQ,CAAC,gBAAgB,EAAE,IAAI,GAAG,IAAI,CAAC;IACvC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC;IACpC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,iBAAiB,EAAE,MAAM,CAAC;IACnC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;IAChC,QAAQ,CAAC,SAAS,EAAE,WAAW,CAAC;CACjC;AAED,MAAM,WAAW,kBAAkB;IACjC,QAAQ,CAAC,SAAS,EAAE,IAAI,CAAC;IACzB,QAAQ,CAAC,SAAS,EAAE,IAAI,CAAC;IACzB,QAAQ,CAAC,iBAAiB,EAAE,MAAM,CAAC;IACnC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,SAAS,EAAE,WAAW,CAAC;CACjC;AAED,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,SAAS,EAAE,IAAI,CAAC;IACzB,QAAQ,CAAC,SAAS,EAAE,IAAI,CAAC;IACzB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,SAAS,EAAE,WAAW,CAAC;CACjC;AAED,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,SAAS,EAAE,IAAI,CAAC;IACzB,QAAQ,CAAC,SAAS,EAAE,IAAI,CAAC;IACzB,QAAQ,CAAC,oBAAoB,EAAE,MAAM,CAAC;IACtC,QAAQ,CAAC,oBAAoB,EAAE,MAAM,CAAC;IACtC,QAAQ,CAAC,SAAS,EAAE,WAAW,CAAC;CACjC;AAED,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,aAAa,EAAE,IAAI,CAAC;IAC7B,QAAQ,CAAC,SAAS,EAAE,IAAI,CAAC;IACzB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC;IACpC,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,qBAAqB,EAAE,MAAM,CAAC;IACvC,QAAQ,CAAC,SAAS,EAAE,WAAW,CAAC;CACjC;AAED,MAAM,WAAW,kBAAkB;IACjC,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC;IACxB,QAAQ,CAAC,qBAAqB,EAAE,IAAI,CAAC;IACrC,QAAQ,CAAC,SAAS,EAAE,IAAI,CAAC;IACzB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,SAAS,EAAE,WAAW,CAAC;CACjC;AAED,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,GAAG,MAAM,CAAC;AAE5E,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,SAAS,EAAE,IAAI,CAAC;IACzB,QAAQ,CAAC,WAAW,EAAE,cAAc,CAAC;IACrC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAC/B,QAAQ,CAAC,SAAS,EAAE,WAAW,CAAC;CACjC;AAED,MAAM,WAAW,sBAAsB;IACrC,QAAQ,CAAC,aAAa,EAAE,IAAI,CAAC;IAC7B,QAAQ,CAAC,SAAS,EAAE,IAAI,CAAC;IACzB,QAAQ,CAAC,gBAAgB,EAAE,IAAI,GAAG,IAAI,CAAC;IACvC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC;IACpC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,QAAQ,CAAC,SAAS,EAAE,WAAW,CAAC;CACjC;AAED,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,OAAO,EAAE,IAAI,CAAC;IACvB,QAAQ,CAAC,aAAa,EAAE,IAAI,CAAC;IAC7B,QAAQ,CAAC,YAAY,EAAE,IAAI,CAAC;IAC5B,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC;IACpC,QAAQ,CAAC,WAAW,EAAE,YAAY,CAAC;IACnC,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,SAAS,EAAE,WAAW,CAAC;CACjC;AAED,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,OAAO,EAAE,IAAI,CAAC;IACvB,QAAQ,CAAC,aAAa,EAAE,IAAI,CAAC;IAC7B,QAAQ,CAAC,YAAY,EAAE,IAAI,CAAC;IAC5B,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,SAAS,EAAE,WAAW,CAAC;CACjC;AAED,MAAM,WAAW,wBAAwB;IACvC,QAAQ,CAAC,UAAU,EAAE,IAAI,CAAC;IAC1B,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;IAChC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,SAAS,EAAE,WAAW,CAAC;CACjC;AAED,MAAM,WAAW,sBAAsB;IACrC,QAAQ,CAAC,SAAS,EAAE,IAAI,CAAC;IACzB,QAAQ,CAAC,UAAU,EAAE,IAAI,CAAC;IAC1B,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,QAAQ,CAAC,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IACtC,QAAQ,CAAC,SAAS,EAAE,WAAW,CAAC;CACjC;AAED,MAAM,WAAW,0BAA0B;IACzC,QAAQ,CAAC,aAAa,EAAE,IAAI,CAAC;IAC7B,QAAQ,CAAC,SAAS,EAAE,IAAI,CAAC;IACzB,QAAQ,CAAC,UAAU,EAAE,IAAI,CAAC;IAC1B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC;IACpC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,QAAQ,CAAC,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IACxC,QAAQ,CAAC,SAAS,EAAE,WAAW,CAAC;CACjC;AAMD,MAAM,WAAW,eAAe;IAC9B,WAAW,EAAE,WAAW,CAAC;IACzB,kBAAkB,EAAE,kBAAkB,CAAC;IACvC,8BAA8B,EAAE,8BAA8B,CAAC;IAC/D,8BAA8B,EAAE,8BAA8B,CAAC;IAC/D,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,uBAAuB,EAAE,uBAAuB,CAAC;IACjD,kBAAkB,EAAE,kBAAkB,CAAC;IACvC,kBAAkB,EAAE,kBAAkB,CAAC;IACvC,oBAAoB,EAAE,oBAAoB,CAAC;IAC3C,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,kBAAkB,EAAE,kBAAkB,CAAC;IACvC,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,sBAAsB,EAAE,sBAAsB,CAAC;IAC/C,cAAc,EAAE,cAAc,CAAC;IAC/B,cAAc,EAAE,cAAc,CAAC;IAC/B,wBAAwB,EAAE,wBAAwB,CAAC;IACnD,sBAAsB,EAAE,sBAAsB,CAAC;IAC/C,0BAA0B,EAAE,0BAA0B,CAAC;CACxD;AAMD,MAAM,MAAM,gBAAgB,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,EAAE,QAAQ,EAAE,eAAe,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;AAElG,MAAM,MAAM,sBAAsB,GAAG;KAClC,CAAC,IAAI,MAAM,eAAe,CAAC,CAAC,EAAE,gBAAgB,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;CACpE,GAAG;IACF,SAAS,CAAC,EAAE,CAAC,QAAQ,EAAE,eAAe,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACjE,CAAC"}

package/dist/types/index.d.ts

@@ -0,0 +1,54 @@
+/**
+ * clearbank-sdk — Production-grade TypeScript SDK for the ClearBank UK API.
+ *
+ * @packageDocumentation
+ */
+import { AccountsService } from './domains/accounts/service.js';
+import { PaymentsService } from './domains/payments/service.js';
+import { MultiCurrencyService } from './domains/multicurrency/service.js';
+import { EmbeddedBankingService } from './domains/embedded/service.js';
+import { WebhooksService } from './domains/webhooks/service.js';
+import type { ClearBankConfig } from './core/config.js';
+export type { ClearBankConfig, Environment } from './core/config.js';
+export type { RequestOptions, ApiResponse } from './core/http.js';
+export { ClearBankError } from './types/index.js';
+export type { TelemetryEvent, TelemetryHook, PaginationParams, PaginatedResponse, DateRangeParams, StructuredAddress, CurrencyCode, Amount, UUID, ISODateTime, SortCode, IBAN, } from './types/index.js';
+export { AccountsService } from './domains/accounts/service.js';
+export type { Account, AccountType, AccountStatus, VirtualAccount, Transaction, TransactionDirection, TransactionStatus, DirectDebitInstruction, CreateAccountParams, UpdateAccountParams, CreateVirtualAccountParams, UpdateVirtualAccountParams, CreateDDIParams, StatementRequestParams, } from './domains/accounts/types.js';
+export { PaymentsService } from './domains/payments/service.js';
+export type { FpsPayment, FpsPaymentType, SendFpsParams, SendFpsBulkParams, InternalTransferParams, SendChapsParams, ReturnChapsParams, ReturnBacsPaymentParams, SubmitChequeDepositParams, CheckCoPParams, CoPResponse, SendCrossBorderParams, SendSepaParams, ReturnSepaParams, } from './domains/payments/types.js';
+export type { CoPMatchResult as PaymentCoPMatchResult } from './domains/payments/types.js';
+export { MultiCurrencyService } from './domains/multicurrency/service.js';
+export type { MCCYAccount, MCCYAccountType, MCCYVirtualAccount, CreateMCCYAccountParams, UpdateMCCYAccountParams, CreateMCCYVirtualAccountParams, InternationalPayment, CreditorAddress, FXTradeParams, FXTradeResult, FXQuoteParams, FXQuote, } from './domains/multicurrency/types.js';
+export { EmbeddedBankingService } from './domains/embedded/service.js';
+export type { Customer, CustomerType, KYCStatus, CustomerAddress, CreateRetailCustomerParams, CreateSoleTraderCustomerParams, CreateLegalEntityCustomerParams, UpdateCustomerParams, BeneficialOwner, EmbeddedAccount, EmbeddedAccountType, CreateHubAccountParams, CreatePaymentAccountParams, CreateSavingsAccountParams, UpdateEmbeddedAccountParams, EmbeddedFPSParams, CreateISAParams, ISATransferInParams, InterestProduct, ConfigureInterestParams, KYCStatusResponse, SubmitKYCParams, } from './domains/embedded/types.js';
+export { WebhooksService } from './domains/webhooks/service.js';
+export { buildAckBody } from './domains/webhooks/service.js';
+export type { WebhookEnvelope, WebhookEventType, WebhookEventMap, PartialWebhookHandlers, WebhookHandlerFn, FITestEvent, TransactionSettled, PaymentMessageAssessmentFailed, PaymentMessageValidationFailed, TransactionRejected, FpsPaymentReturnCreated, BacsPaymentCreated, BacsMandateCreated, BacsMandateCancelled, BacsMandateMigrated, ChapsPaymentCreated, ChapsReturnCreated, CopOutboundResponse, CoPMatchResult, MccyTransactionCreated, FxTradeCreated, FxTradeSettled, CustomerKycStatusChanged, EmbeddedAccountCreated, EmbeddedTransactionSettled, } from './domains/webhooks/types.js';
+export { generateUUID, isUUID, isValidSortCode, isValidAccountNumber, isValidIBAN, formatAmount, } from './utils/index.js';
+/**
+ * The top-level ClearBank API client.
+ *
+ * @example
+ * ```ts
+ * const client = new ClearBankClient({
+ *   apiToken: process.env.CLEARBANK_API_TOKEN!,
+ *   privateKey: process.env.CLEARBANK_PRIVATE_KEY!,
+ *   environment: 'simulation',
+ * });
+ *
+ * const accounts = await client.accounts.list();
+ * await client.payments.sendFPS({ accountId, payment: { ... } });
+ * ```
+ */
+export declare class ClearBankClient {
+    readonly accounts: AccountsService;
+    readonly payments: PaymentsService;
+    readonly multiCurrency: MultiCurrencyService;
+    readonly embedded: EmbeddedBankingService;
+    readonly webhooks: WebhooksService;
+    constructor(config: ClearBankConfig);
+    static generateRequestId(): string;
+}
+export default ClearBankClient;
+//# sourceMappingURL=index.d.ts.map