clearbank-sdk 1.0.0

package/dist/esm/domains/payments/service.js

@@ -0,0 +1,251 @@
+/**
+ * GBP Payments service.
+ *
+ * Covers: FPS (single + bulk), Internal Transfers, CHAPS, Bacs returns,
+ * Cheque Deposits, Confirmation of Payee, Cross-Border (deprecated), SEPA SCT UK.
+ */
+export class PaymentsService {
+    constructor(http) {
+        this.http = http;
+    }
+    // ---------------------------------------------------------------------------
+    // Faster Payments (FPS)
+    // ---------------------------------------------------------------------------
+    /**
+     * 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).
+     */
+    async sendFPS(params, opts) {
+        const body = buildFpsBody(params.accountId, [params.payment]);
+        await this.http.post('/v3/Payments/FPS', body, opts);
+    }
+    /** Sends multiple Faster Payments in one request. */
+    async sendFPSBulk(params, opts) {
+        const body = buildFpsBody(params.accountId, params.payments);
+        await this.http.post('/v3/Payments/FPS', body, opts);
+    }
+    // ---------------------------------------------------------------------------
+    // Internal Transfers
+    // ---------------------------------------------------------------------------
+    /** Transfers funds between ClearBank-held accounts (same institution). */
+    async sendInternalTransfer(params, opts) {
+        const body = omitUndefined({
+            debtorAccountId: params.debtorAccountId,
+            creditorAccountId: params.creditorAccountId,
+            amount: params.amount,
+            currencyCode: params.currency ?? 'GBP',
+            reference: params.reference,
+            endToEndId: params.endToEndId,
+            debtorVirtualAccountId: params.debtorVirtualAccountId,
+            creditorVirtualAccountId: params.creditorVirtualAccountId,
+        });
+        await this.http.post('/v3/Payments/Transfer', body, opts);
+    }
+    /** Sends multiple internal transfers in one request. */
+    async sendBulkInternalTransfer(params, opts) {
+        const body = {
+            transfers: params.map((p) => omitUndefined({
+                debtorAccountId: p.debtorAccountId,
+                creditorAccountId: p.creditorAccountId,
+                amount: p.amount,
+                currencyCode: p.currency ?? 'GBP',
+                reference: p.reference,
+                endToEndId: p.endToEndId,
+                debtorVirtualAccountId: p.debtorVirtualAccountId,
+                creditorVirtualAccountId: p.creditorVirtualAccountId,
+            })),
+        };
+        await this.http.post('/v3/Payments/Transfer/Bulk', body, opts);
+    }
+    // ---------------------------------------------------------------------------
+    // CHAPS
+    // ---------------------------------------------------------------------------
+    /**
+     * 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.
+     */
+    async sendCHAPS(params, opts) {
+        const body = buildChapsBody(params);
+        await this.http.post('/payments/chaps/v5/customer-payments', body, opts);
+    }
+    /** Returns a received CHAPS payment. */
+    async returnCHAPS(params, opts) {
+        const body = {
+            originalInstructionId: params.originalInstructionId,
+            debtorAccountId: params.debtorAccountId,
+            returnReasonCode: params.returnReasonCode,
+            instructedAmount: { amount: params.amount, currency: params.currency ?? 'GBP' },
+        };
+        await this.http.post('/payments/chaps/v5/return-payments', body, opts);
+    }
+    // ---------------------------------------------------------------------------
+    // Bacs
+    // ---------------------------------------------------------------------------
+    /** Returns a Bacs payment received on a real account. */
+    async returnBacs(accountId, params, opts) {
+        const body = { transactionId: params.transactionId, reasonCode: params.reasonCode };
+        await this.http.post(`/v1/Accounts/${accountId}/Transactions/Returns`, body, opts);
+    }
+    /** Returns a Bacs payment received on a virtual account. */
+    async returnVirtualBacs(accountId, virtualAccountId, params, opts) {
+        const body = { transactionId: params.transactionId, reasonCode: params.reasonCode };
+        await this.http.post(`/v1/Accounts/${accountId}/Virtual/${virtualAccountId}/Transactions/Returns`, body, opts);
+    }
+    // ---------------------------------------------------------------------------
+    // Cheques (ICS)
+    // ---------------------------------------------------------------------------
+    /** Submits a cheque image deposit via the Image Clearing System (ICS). */
+    async submitChequeDeposit(params, opts) {
+        const body = omitUndefined({
+            accountId: params.accountId,
+            amount: params.amount,
+            currency: params.currency ?? 'GBP',
+            chequeImageFront: params.chequeImageFront,
+            chequeImageBack: params.chequeImageBack,
+            micrLine: params.micrLine,
+            payeeName: params.payeeName,
+            chequeNumber: params.chequeNumber,
+        });
+        await this.http.post('/payments/cheques/v1/submit-deposit', body, opts);
+    }
+    // ---------------------------------------------------------------------------
+    // Confirmation of Payee (CoP)
+    // ---------------------------------------------------------------------------
+    /**
+     * 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).
+     */
+    async checkCoP(params, opts) {
+        const body = omitUndefined({
+            accountName: params.accountName,
+            sortCode: params.sortCode,
+            accountNumber: params.accountNumber,
+            accountType: params.accountType ?? 'Personal',
+            secondaryReference: params.secondaryReference,
+        });
+        const res = await this.http.post('/v1/Cop/outbound/name-verification', body, opts);
+        return res.data;
+    }
+    /** Opts a real account out of inbound CoP name checks. */
+    async optOutAccountCoP(accountId, opts) {
+        await this.http.put(`/v1/Cop/opt/accounts/${accountId}`, { optOut: true }, opts);
+    }
+    /** Opts a virtual account out of inbound CoP name checks. */
+    async optOutVirtualAccountCoP(accountId, virtualAccountId, opts) {
+        await this.http.put(`/v1/Cop/opt/accounts/${accountId}/virtual/${virtualAccountId}`, { optOut: true }, opts);
+    }
+    // ---------------------------------------------------------------------------
+    // GBP Cross-Border (deprecated)
+    // ---------------------------------------------------------------------------
+    /**
+     * Sends a GBP cross-border payment.
+     * @deprecated EOL 13 November 2026. Use `MultiCurrencyService.sendPayment()` instead.
+     */
+    async sendCrossBorder(params, opts) {
+        const body = omitUndefined({
+            accountId: params.accountId,
+            amount: params.amount,
+            currency: params.currency ?? 'GBP',
+            creditor: { name: params.creditorName, iban: params.creditorIban, bic: params.creditorBic },
+            remittanceInformation: params.remittanceInformation,
+        });
+        await this.http.post('/payments/cross-border-sterling/v3/payments', body, opts);
+    }
+    // ---------------------------------------------------------------------------
+    // SEPA Credit Transfer UK
+    // ---------------------------------------------------------------------------
+    /** Sends a SEPA Credit Transfer UK euro payment. */
+    async sendSEPA(params, opts) {
+        const body = omitUndefined({
+            debtorAccountId: params.debtorAccountId,
+            instructedAmount: { amount: params.amount, currency: 'EUR' },
+            creditor: { name: params.creditorName, iban: params.creditorIban, bic: params.creditorBic },
+            remittanceInformation: params.remittanceInformation,
+            endToEndId: params.endToEndId,
+            instructionId: params.instructionId,
+        });
+        await this.http.post('/payments/sepa-credit-transfer/v2/customer-payments', body, opts);
+    }
+    /** Returns a received SEPA Credit Transfer UK payment. */
+    async returnSEPA(params, opts) {
+        const body = {
+            originalInstructionId: params.originalInstructionId,
+            debtorAccountId: params.debtorAccountId,
+            returnReasonCode: params.returnReasonCode,
+            instructedAmount: { amount: params.amount, currency: 'EUR' },
+        };
+        await this.http.post('/payments/sepa-credit-transfer/v2/return-payments', body, opts);
+    }
+}
+// ---------------------------------------------------------------------------
+// Helpers
+// ---------------------------------------------------------------------------
+function buildFpsBody(accountId, payments) {
+    return {
+        accountId,
+        payments: payments.map((p) => omitUndefined({
+            amount: p.amount,
+            currencyCode: p.currency ?? 'GBP',
+            destination: {
+                sortCode: p.destinationSortCode,
+                accountNumber: p.destinationAccountNumber,
+                name: p.destinationAccountName,
+            },
+            paymentType: p.paymentType ?? 'SIP',
+            enforceSendToScheme: p.enforceSendToScheme ?? false,
+            reference: p.reference,
+            endToEndId: p.endToEndId,
+        })),
+    };
+}
+function buildChapsBody(p) {
+    const body = {
+        debtorAccountId: p.debtorAccountId,
+        instructedAmount: { amount: p.amount, currency: p.currency ?? 'GBP' },
+        creditor: {
+            name: p.creditorName,
+            account: { sortCode: p.creditorSortCode, accountNumber: p.creditorAccountNumber },
+            address: buildAddress(p.creditorAddress),
+        },
+        remittanceInformation: p.remittanceInformation,
+    };
+    if (p.endToEndId)
+        body['endToEndId'] = p.endToEndId;
+    if (p.instructionId)
+        body['instructionId'] = p.instructionId;
+    if (p.debtorName !== undefined || p.debtorAddress !== undefined) {
+        body['debtor'] = omitUndefined({
+            name: p.debtorName,
+            address: p.debtorAddress ? buildAddress(p.debtorAddress) : undefined,
+        });
+    }
+    return body;
+}
+function buildAddress(addr) {
+    const result = {};
+    if (addr['streetName'])
+        result['streetName'] = addr['streetName'];
+    if (addr['buildingNumber'])
+        result['buildingNumber'] = addr['buildingNumber'];
+    if (addr['postCode'])
+        result['postCode'] = addr['postCode'];
+    if (addr['townName'])
+        result['townName'] = addr['townName'];
+    if (addr['country'])
+        result['country'] = addr['country'];
+    return result;
+}
+function omitUndefined(obj) {
+    return Object.fromEntries(Object.entries(obj).filter(([, v]) => v !== undefined));
+}
+//# sourceMappingURL=service.js.map

package/dist/esm/domains/payments/service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"service.js","sourceRoot":"","sources":["../../../../src/domains/payments/service.ts"],"names":[],"mappings":"AAiBA;;;;;GAKG;AACH,MAAM,OAAO,eAAe;IAC1B,YAA6B,IAAgB;QAAhB,SAAI,GAAJ,IAAI,CAAY;IAAG,CAAC;IAEjD,8EAA8E;IAC9E,wBAAwB;IACxB,8EAA8E;IAE9E;;;;;;;OAOG;IACH,KAAK,CAAC,OAAO,CAAC,MAAqB,EAAE,IAAqB;QACxD,MAAM,IAAI,GAAG,YAAY,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;QAC9D,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAO,kBAAkB,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IAC7D,CAAC;IAED,qDAAqD;IACrD,KAAK,CAAC,WAAW,CAAC,MAAyB,EAAE,IAAqB;QAChE,MAAM,IAAI,GAAG,YAAY,CAAC,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC;QAC7D,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAO,kBAAkB,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IAC7D,CAAC;IAED,8EAA8E;IAC9E,qBAAqB;IACrB,8EAA8E;IAE9E,0EAA0E;IAC1E,KAAK,CAAC,oBAAoB,CAAC,MAA8B,EAAE,IAAqB;QAC9E,MAAM,IAAI,GAAG,aAAa,CAAC;YACzB,eAAe,EAAE,MAAM,CAAC,eAAe;YACvC,iBAAiB,EAAE,MAAM,CAAC,iBAAiB;YAC3C,MAAM,EAAE,MAAM,CAAC,MAAM;YACrB,YAAY,EAAE,MAAM,CAAC,QAAQ,IAAI,KAAK;YACtC,SAAS,EAAE,MAAM,CAAC,SAAS;YAC3B,UAAU,EAAE,MAAM,CAAC,UAAU;YAC7B,sBAAsB,EAAE,MAAM,CAAC,sBAAsB;YACrD,wBAAwB,EAAE,MAAM,CAAC,wBAAwB;SAC1D,CAAC,CAAC;QACH,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAO,uBAAuB,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IAClE,CAAC;IAED,wDAAwD;IACxD,KAAK,CAAC,wBAAwB,CAC5B,MAAgC,EAChC,IAAqB;QAErB,MAAM,IAAI,GAAG;YACX,SAAS,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAC1B,aAAa,CAAC;gBACZ,eAAe,EAAE,CAAC,CAAC,eAAe;gBAClC,iBAAiB,EAAE,CAAC,CAAC,iBAAiB;gBACtC,MAAM,EAAE,CAAC,CAAC,MAAM;gBAChB,YAAY,EAAE,CAAC,CAAC,QAAQ,IAAI,KAAK;gBACjC,SAAS,EAAE,CAAC,CAAC,SAAS;gBACtB,UAAU,EAAE,CAAC,CAAC,UAAU;gBACxB,sBAAsB,EAAE,CAAC,CAAC,sBAAsB;gBAChD,wBAAwB,EAAE,CAAC,CAAC,wBAAwB;aACrD,CAAC,CACH;SACF,CAAC;QACF,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAO,4BAA4B,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IACvE,CAAC;IAED,8EAA8E;IAC9E,QAAQ;IACR,8EAA8E;IAE9E;;;;;;OAMG;IACH,KAAK,CAAC,SAAS,CAAC,MAAuB,EAAE,IAAqB;QAC5D,MAAM,IAAI,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC;QACpC,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAO,sCAAsC,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IACjF,CAAC;IAED,wCAAwC;IACxC,KAAK,CAAC,WAAW,CAAC,MAAyB,EAAE,IAAqB;QAChE,MAAM,IAAI,GAAG;YACX,qBAAqB,EAAE,MAAM,CAAC,qBAAqB;YACnD,eAAe,EAAE,MAAM,CAAC,eAAe;YACvC,gBAAgB,EAAE,MAAM,CAAC,gBAAgB;YACzC,gBAAgB,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,EAAE,MAAM,CAAC,QAAQ,IAAI,KAAK,EAAE;SAChF,CAAC;QACF,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAO,oCAAoC,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IAC/E,CAAC;IAED,8EAA8E;IAC9E,OAAO;IACP,8EAA8E;IAE9E,yDAAyD;IACzD,KAAK,CAAC,UAAU,CACd,SAAiB,EACjB,MAA+B,EAC/B,IAAqB;QAErB,MAAM,IAAI,GAAG,EAAE,aAAa,EAAE,MAAM,CAAC,aAAa,EAAE,UAAU,EAAE,MAAM,CAAC,UAAU,EAAE,CAAC;QACpF,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAO,gBAAgB,SAAS,uBAAuB,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IAC3F,CAAC;IAED,4DAA4D;IAC5D,KAAK,CAAC,iBAAiB,CACrB,SAAiB,EACjB,gBAAwB,EACxB,MAA+B,EAC/B,IAAqB;QAErB,MAAM,IAAI,GAAG,EAAE,aAAa,EAAE,MAAM,CAAC,aAAa,EAAE,UAAU,EAAE,MAAM,CAAC,UAAU,EAAE,CAAC;QACpF,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAClB,gBAAgB,SAAS,YAAY,gBAAgB,uBAAuB,EAC5E,IAAI,EACJ,IAAI,CACL,CAAC;IACJ,CAAC;IAED,8EAA8E;IAC9E,gBAAgB;IAChB,8EAA8E;IAE9E,0EAA0E;IAC1E,KAAK,CAAC,mBAAmB,CACvB,MAAiC,EACjC,IAAqB;QAErB,MAAM,IAAI,GAAG,aAAa,CAAC;YACzB,SAAS,EAAE,MAAM,CAAC,SAAS;YAC3B,MAAM,EAAE,MAAM,CAAC,MAAM;YACrB,QAAQ,EAAE,MAAM,CAAC,QAAQ,IAAI,KAAK;YAClC,gBAAgB,EAAE,MAAM,CAAC,gBAAgB;YACzC,eAAe,EAAE,MAAM,CAAC,eAAe;YACvC,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,SAAS,EAAE,MAAM,CAAC,SAAS;YAC3B,YAAY,EAAE,MAAM,CAAC,YAAY;SAClC,CAAC,CAAC;QACH,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAO,qCAAqC,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IAChF,CAAC;IAED,8EAA8E;IAC9E,8BAA8B;IAC9B,8EAA8E;IAE9E;;;;;;OAMG;IACH,KAAK,CAAC,QAAQ,CAAC,MAAsB,EAAE,IAAqB;QAC1D,MAAM,IAAI,GAAG,aAAa,CAAC;YACzB,WAAW,EAAE,MAAM,CAAC,WAAW;YAC/B,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,aAAa,EAAE,MAAM,CAAC,aAAa;YACnC,WAAW,EAAE,MAAM,CAAC,WAAW,IAAI,UAAU;YAC7C,kBAAkB,EAAE,MAAM,CAAC,kBAAkB;SAC9C,CAAC,CAAC;QACH,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAc,oCAAoC,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;QAChG,OAAO,GAAG,CAAC,IAAI,CAAC;IAClB,CAAC;IAED,0DAA0D;IAC1D,KAAK,CAAC,gBAAgB,CAAC,SAAiB,EAAE,IAAqB;QAC7D,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAAO,wBAAwB,SAAS,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,IAAI,CAAC,CAAC;IACzF,CAAC;IAED,6DAA6D;IAC7D,KAAK,CAAC,uBAAuB,CAC3B,SAAiB,EACjB,gBAAwB,EACxB,IAAqB;QAErB,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CACjB,wBAAwB,SAAS,YAAY,gBAAgB,EAAE,EAC/D,EAAE,MAAM,EAAE,IAAI,EAAE,EAChB,IAAI,CACL,CAAC;IACJ,CAAC;IAED,8EAA8E;IAC9E,gCAAgC;IAChC,8EAA8E;IAE9E;;;OAGG;IACH,KAAK,CAAC,eAAe,CAAC,MAA6B,EAAE,IAAqB;QACxE,MAAM,IAAI,GAAG,aAAa,CAAC;YACzB,SAAS,EAAE,MAAM,CAAC,SAAS;YAC3B,MAAM,EAAE,MAAM,CAAC,MAAM;YACrB,QAAQ,EAAE,MAAM,CAAC,QAAQ,IAAI,KAAK;YAClC,QAAQ,EAAE,EAAE,IAAI,EAAE,MAAM,CAAC,YAAY,EAAE,IAAI,EAAE,MAAM,CAAC,YAAY,EAAE,GAAG,EAAE,MAAM,CAAC,WAAW,EAAE;YAC3F,qBAAqB,EAAE,MAAM,CAAC,qBAAqB;SACpD,CAAC,CAAC;QACH,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAO,6CAA6C,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IACxF,CAAC;IAED,8EAA8E;IAC9E,0BAA0B;IAC1B,8EAA8E;IAE9E,oDAAoD;IACpD,KAAK,CAAC,QAAQ,CAAC,MAAsB,EAAE,IAAqB;QAC1D,MAAM,IAAI,GAAG,aAAa,CAAC;YACzB,eAAe,EAAE,MAAM,CAAC,eAAe;YACvC,gBAAgB,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE;YAC5D,QAAQ,EAAE,EAAE,IAAI,EAAE,MAAM,CAAC,YAAY,EAAE,IAAI,EAAE,MAAM,CAAC,YAAY,EAAE,GAAG,EAAE,MAAM,CAAC,WAAW,EAAE;YAC3F,qBAAqB,EAAE,MAAM,CAAC,qBAAqB;YACnD,UAAU,EAAE,MAAM,CAAC,UAAU;YAC7B,aAAa,EAAE,MAAM,CAAC,aAAa;SACpC,CAAC,CAAC;QACH,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAO,qDAAqD,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IAChG,CAAC;IAED,0DAA0D;IAC1D,KAAK,CAAC,UAAU,CAAC,MAAwB,EAAE,IAAqB;QAC9D,MAAM,IAAI,GAAG;YACX,qBAAqB,EAAE,MAAM,CAAC,qBAAqB;YACnD,eAAe,EAAE,MAAM,CAAC,eAAe;YACvC,gBAAgB,EAAE,MAAM,CAAC,gBAAgB;YACzC,gBAAgB,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE;SAC7D,CAAC;QACF,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAO,mDAAmD,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IAC9F,CAAC;CACF;AAED,8EAA8E;AAC9E,UAAU;AACV,8EAA8E;AAE9E,SAAS,YAAY,CAAC,SAAiB,EAAE,QAAsB;IAC7D,OAAO;QACL,SAAS;QACT,QAAQ,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAC3B,aAAa,CAAC;YACZ,MAAM,EAAE,CAAC,CAAC,MAAM;YAChB,YAAY,EAAE,CAAC,CAAC,QAAQ,IAAI,KAAK;YACjC,WAAW,EAAE;gBACX,QAAQ,EAAE,CAAC,CAAC,mBAAmB;gBAC/B,aAAa,EAAE,CAAC,CAAC,wBAAwB;gBACzC,IAAI,EAAE,CAAC,CAAC,sBAAsB;aAC/B;YACD,WAAW,EAAE,CAAC,CAAC,WAAW,IAAI,KAAK;YACnC,mBAAmB,EAAE,CAAC,CAAC,mBAAmB,IAAI,KAAK;YACnD,SAAS,EAAE,CAAC,CAAC,SAAS;YACtB,UAAU,EAAE,CAAC,CAAC,UAAU;SACzB,CAAC,CACH;KACF,CAAC;AACJ,CAAC;AAED,SAAS,cAAc,CAAC,CAAkB;IACxC,MAAM,IAAI,GAA4B;QACpC,eAAe,EAAE,CAAC,CAAC,eAAe;QAClC,gBAAgB,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,IAAI,KAAK,EAAE;QACrE,QAAQ,EAAE;YACR,IAAI,EAAE,CAAC,CAAC,YAAY;YACpB,OAAO,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC,gBAAgB,EAAE,aAAa,EAAE,CAAC,CAAC,qBAAqB,EAAE;YACjF,OAAO,EAAE,YAAY,CAAC,CAAC,CAAC,eAAe,CAAC;SACzC;QACD,qBAAqB,EAAE,CAAC,CAAC,qBAAqB;KAC/C,CAAC;IACF,IAAI,CAAC,CAAC,UAAU;QAAE,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,UAAU,CAAC;IACpD,IAAI,CAAC,CAAC,aAAa;QAAE,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC,aAAa,CAAC;IAC7D,IAAI,CAAC,CAAC,UAAU,KAAK,SAAS,IAAI,CAAC,CAAC,aAAa,KAAK,SAAS,EAAE,CAAC;QAChE,IAAI,CAAC,QAAQ,CAAC,GAAG,aAAa,CAAC;YAC7B,IAAI,EAAE,CAAC,CAAC,UAAU;YAClB,OAAO,EAAE,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,SAAS;SACrE,CAAC,CAAC;IACL,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAS,YAAY,CAAC,IAMrB;IACC,MAAM,MAAM,GAA2B,EAAE,CAAC;IAC1C,IAAI,IAAI,CAAC,YAAY,CAAC;QAAE,MAAM,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC;IAClE,IAAI,IAAI,CAAC,gBAAgB,CAAC;QAAE,MAAM,CAAC,gBAAgB,CAAC,GAAG,IAAI,CAAC,gBAAgB,CAAC,CAAC;IAC9E,IAAI,IAAI,CAAC,UAAU,CAAC;QAAE,MAAM,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC;IAC5D,IAAI,IAAI,CAAC,UAAU,CAAC;QAAE,MAAM,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC;IAC5D,IAAI,IAAI,CAAC,SAAS,CAAC;QAAE,MAAM,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC;IACzD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,aAAa,CAAC,GAA4B;IACjD,OAAO,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC;AACpF,CAAC"}

package/dist/esm/domains/payments/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/esm/domains/payments/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/domains/payments/types.ts"],"names":[],"mappings":""}

package/dist/esm/domains/webhooks/index.js

@@ -0,0 +1,2 @@
+export { WebhooksService, buildAckBody } from './service.js';
+//# sourceMappingURL=index.js.map

package/dist/esm/domains/webhooks/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/domains/webhooks/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC"}

package/dist/esm/domains/webhooks/service.js

@@ -0,0 +1,168 @@
+import { verifySignature } from '../../core/crypto.js';
+import { ClearBankError } from '../../types/index.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 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.
+     */
+    async verifySignature(body, signature, publicKeyPem) {
+        return verifySignature(body, signature, publicKeyPem);
+    }
+    /**
+     * 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) {
+        let parsed;
+        if (typeof rawBody === 'string') {
+            try {
+                parsed = JSON.parse(rawBody);
+            }
+            catch {
+                throw new ClearBankError({
+                    message: 'Webhook body is not valid JSON',
+                    statusCode: null,
+                });
+            }
+        }
+        else {
+            parsed = rawBody;
+        }
+        if (!parsed || typeof parsed !== 'object') {
+            throw new ClearBankError({ message: 'Webhook body must be an object', statusCode: null });
+        }
+        const obj = parsed;
+        if (typeof obj['Type'] !== 'string' || !obj['Type']) {
+            throw new ClearBankError({
+                message: 'Webhook envelope missing Type field',
+                statusCode: null,
+            });
+        }
+        return {
+            Type: obj['Type'],
+            Version: typeof obj['Version'] === 'number' ? obj['Version'] : 0,
+            Nonce: typeof obj['Nonce'] === 'number' ? obj['Nonce'] : 0,
+            Payload: obj['Payload'] ?? {},
+        };
+    }
+    /**
+     * Parses the Payload of an envelope into a strongly-typed event object.
+     * Returns `null` for unknown event types (forward-compatible).
+     */
+    parseEvent(envelope, eventType) {
+        if (envelope.Type !== eventType)
+            return null;
+        return envelope.Payload;
+    }
+    /**
+     * 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.
+     */
+    async dispatch(envelope, handlers) {
+        const type = envelope.Type;
+        switch (type) {
+            case 'FITestEvent':
+                await handlers.FITestEvent?.(envelope.Payload, envelope);
+                break;
+            case 'TransactionSettled':
+                await handlers.TransactionSettled?.(envelope.Payload, envelope);
+                break;
+            case 'PaymentMessageAssessmentFailed':
+                await handlers.PaymentMessageAssessmentFailed?.(envelope.Payload, envelope);
+                break;
+            case 'PaymentMessageValidationFailed':
+                await handlers.PaymentMessageValidationFailed?.(envelope.Payload, envelope);
+                break;
+            case 'TransactionRejected':
+                await handlers.TransactionRejected?.(envelope.Payload, envelope);
+                break;
+            case 'FpsPaymentReturnCreated':
+                await handlers.FpsPaymentReturnCreated?.(envelope.Payload, envelope);
+                break;
+            case 'BacsPaymentCreated':
+                await handlers.BacsPaymentCreated?.(envelope.Payload, envelope);
+                break;
+            case 'BacsMandateCreated':
+                await handlers.BacsMandateCreated?.(envelope.Payload, envelope);
+                break;
+            case 'BacsMandateCancelled':
+                await handlers.BacsMandateCancelled?.(envelope.Payload, envelope);
+                break;
+            case 'BacsMandateMigrated':
+                await handlers.BacsMandateMigrated?.(envelope.Payload, envelope);
+                break;
+            case 'ChapsPaymentCreated':
+                await handlers.ChapsPaymentCreated?.(envelope.Payload, envelope);
+                break;
+            case 'ChapsReturnCreated':
+                await handlers.ChapsReturnCreated?.(envelope.Payload, envelope);
+                break;
+            case 'CopOutboundResponse':
+                await handlers.CopOutboundResponse?.(envelope.Payload, envelope);
+                break;
+            case 'MccyTransactionCreated':
+                await handlers.MccyTransactionCreated?.(envelope.Payload, envelope);
+                break;
+            case 'FxTradeCreated':
+                await handlers.FxTradeCreated?.(envelope.Payload, envelope);
+                break;
+            case 'FxTradeSettled':
+                await handlers.FxTradeSettled?.(envelope.Payload, envelope);
+                break;
+            case 'CustomerKycStatusChanged':
+                await handlers.CustomerKycStatusChanged?.(envelope.Payload, envelope);
+                break;
+            case 'EmbeddedAccountCreated':
+                await handlers.EmbeddedAccountCreated?.(envelope.Payload, envelope);
+                break;
+            case 'EmbeddedTransactionSettled':
+                await handlers.EmbeddedTransactionSettled?.(envelope.Payload, envelope);
+                break;
+            default:
+                await handlers.onUnknown?.(envelope);
+        }
+    }
+    /**
+     * Builds the JSON acknowledgement body to send in the webhook response.
+     * ClearBank uses the nonce to track delivered events.
+     */
+    buildAck(envelope) {
+        return { nonce: envelope.Nonce };
+    }
+}
+//# sourceMappingURL=service.js.map

package/dist/esm/domains/webhooks/service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"service.js","sourceRoot":"","sources":["../../../../src/domains/webhooks/service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAyBtD,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAE1C;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,OAAO,eAAe;IAC1B;;;;;;;OAOG;IACH,KAAK,CAAC,eAAe,CAAC,IAAY,EAAE,SAAiB,EAAE,YAAoB;QACzE,OAAO,eAAe,CAAC,IAAI,EAAE,SAAS,EAAE,YAAY,CAAC,CAAC;IACxD,CAAC;IAED;;;;OAIG;IACH,aAAa,CAAC,OAAgB;QAC5B,IAAI,MAAe,CAAC;QACpB,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;YAChC,IAAI,CAAC;gBACH,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAA4B,CAAC;YAC1D,CAAC;YAAC,MAAM,CAAC;gBACP,MAAM,IAAI,cAAc,CAAC;oBACvB,OAAO,EAAE,gCAAgC;oBACzC,UAAU,EAAE,IAAI;iBACjB,CAAC,CAAC;YACL,CAAC;QACH,CAAC;aAAM,CAAC;YACN,MAAM,GAAG,OAAO,CAAC;QACnB,CAAC;QAED,IAAI,CAAC,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;YAC1C,MAAM,IAAI,cAAc,CAAC,EAAE,OAAO,EAAE,gCAAgC,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC;QAC5F,CAAC;QAED,MAAM,GAAG,GAAG,MAAiC,CAAC;QAC9C,IAAI,OAAO,GAAG,CAAC,MAAM,CAAC,KAAK,QAAQ,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;YACpD,MAAM,IAAI,cAAc,CAAC;gBACvB,OAAO,EAAE,qCAAqC;gBAC9C,UAAU,EAAE,IAAI;aACjB,CAAC,CAAC;QACL,CAAC;QAED,OAAO;YACL,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC;YACjB,OAAO,EAAE,OAAO,GAAG,CAAC,SAAS,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;YAChE,KAAK,EAAE,OAAO,GAAG,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;YAC1D,OAAO,EAAG,GAAG,CAAC,SAAS,CAA6B,IAAI,EAAE;SAC3D,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,UAAU,CACR,QAAyB,EACzB,SAAY;QAEZ,IAAI,QAAQ,CAAC,IAAI,KAAK,SAAS;YAAE,OAAO,IAAI,CAAC;QAC7C,OAAO,QAAQ,CAAC,OAAwC,CAAC;IAC3D,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,QAAQ,CAAC,QAAyB,EAAE,QAAgC;QACxE,MAAM,IAAI,GAAG,QAAQ,CAAC,IAA6B,CAAC;QAEpD,QAAQ,IAAI,EAAE,CAAC;YACb,KAAK,aAAa;gBAChB,MAAM,QAAQ,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,OAAiC,EAAE,QAAQ,CAAC,CAAC;gBACnF,MAAM;YACR,KAAK,oBAAoB;gBACvB,MAAM,QAAQ,CAAC,kBAAkB,EAAE,CACjC,QAAQ,CAAC,OAAwC,EACjD,QAAQ,CACT,CAAC;gBACF,MAAM;YACR,KAAK,gCAAgC;gBACnC,MAAM,QAAQ,CAAC,8BAA8B,EAAE,CAC7C,QAAQ,CAAC,OAAoD,EAC7D,QAAQ,CACT,CAAC;gBACF,MAAM;YACR,KAAK,gCAAgC;gBACnC,MAAM,QAAQ,CAAC,8BAA8B,EAAE,CAC7C,QAAQ,CAAC,OAAoD,EAC7D,QAAQ,CACT,CAAC;gBACF,MAAM;YACR,KAAK,qBAAqB;gBACxB,MAAM,QAAQ,CAAC,mBAAmB,EAAE,CAClC,QAAQ,CAAC,OAAyC,EAClD,QAAQ,CACT,CAAC;gBACF,MAAM;YACR,KAAK,yBAAyB;gBAC5B,MAAM,QAAQ,CAAC,uBAAuB,EAAE,CACtC,QAAQ,CAAC,OAA6C,EACtD,QAAQ,CACT,CAAC;gBACF,MAAM;YACR,KAAK,oBAAoB;gBACvB,MAAM,QAAQ,CAAC,kBAAkB,EAAE,CACjC,QAAQ,CAAC,OAAwC,EACjD,QAAQ,CACT,CAAC;gBACF,MAAM;YACR,KAAK,oBAAoB;gBACvB,MAAM,QAAQ,CAAC,kBAAkB,EAAE,CACjC,QAAQ,CAAC,OAAwC,EACjD,QAAQ,CACT,CAAC;gBACF,MAAM;YACR,KAAK,sBAAsB;gBACzB,MAAM,QAAQ,CAAC,oBAAoB,EAAE,CACnC,QAAQ,CAAC,OAA0C,EACnD,QAAQ,CACT,CAAC;gBACF,MAAM;YACR,KAAK,qBAAqB;gBACxB,MAAM,QAAQ,CAAC,mBAAmB,EAAE,CAClC,QAAQ,CAAC,OAAyC,EAClD,QAAQ,CACT,CAAC;gBACF,MAAM;YACR,KAAK,qBAAqB;gBACxB,MAAM,QAAQ,CAAC,mBAAmB,EAAE,CAClC,QAAQ,CAAC,OAAyC,EAClD,QAAQ,CACT,CAAC;gBACF,MAAM;YACR,KAAK,oBAAoB;gBACvB,MAAM,QAAQ,CAAC,kBAAkB,EAAE,CACjC,QAAQ,CAAC,OAAwC,EACjD,QAAQ,CACT,CAAC;gBACF,MAAM;YACR,KAAK,qBAAqB;gBACxB,MAAM,QAAQ,CAAC,mBAAmB,EAAE,CAClC,QAAQ,CAAC,OAAyC,EAClD,QAAQ,CACT,CAAC;gBACF,MAAM;YACR,KAAK,wBAAwB;gBAC3B,MAAM,QAAQ,CAAC,sBAAsB,EAAE,CACrC,QAAQ,CAAC,OAA4C,EACrD,QAAQ,CACT,CAAC;gBACF,MAAM;YACR,KAAK,gBAAgB;gBACnB,MAAM,QAAQ,CAAC,cAAc,EAAE,CAAC,QAAQ,CAAC,OAAoC,EAAE,QAAQ,CAAC,CAAC;gBACzF,MAAM;YACR,KAAK,gBAAgB;gBACnB,MAAM,QAAQ,CAAC,cAAc,EAAE,CAAC,QAAQ,CAAC,OAAoC,EAAE,QAAQ,CAAC,CAAC;gBACzF,MAAM;YACR,KAAK,0BAA0B;gBAC7B,MAAM,QAAQ,CAAC,wBAAwB,EAAE,CACvC,QAAQ,CAAC,OAA8C,EACvD,QAAQ,CACT,CAAC;gBACF,MAAM;YACR,KAAK,wBAAwB;gBAC3B,MAAM,QAAQ,CAAC,sBAAsB,EAAE,CACrC,QAAQ,CAAC,OAA4C,EACrD,QAAQ,CACT,CAAC;gBACF,MAAM;YACR,KAAK,4BAA4B;gBAC/B,MAAM,QAAQ,CAAC,0BAA0B,EAAE,CACzC,QAAQ,CAAC,OAAgD,EACzD,QAAQ,CACT,CAAC;gBACF,MAAM;YACR;gBACE,MAAM,QAAQ,CAAC,SAAS,EAAE,CAAC,QAAQ,CAAC,CAAC;QACzC,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,QAAQ,CAAC,QAAyB;QAChC,OAAO,EAAE,KAAK,EAAE,QAAQ,CAAC,KAAK,EAAE,CAAC;IACnC,CAAC;CACF"}

package/dist/esm/domains/webhooks/types.js

@@ -0,0 +1,5 @@
+/** Returns the JSON body to send as the webhook acknowledgement. */
+export function buildAckBody(envelope) {
+    return { nonce: envelope.Nonce };
+}
+//# sourceMappingURL=types.js.map

package/dist/esm/domains/webhooks/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/domains/webhooks/types.ts"],"names":[],"mappings":"AAuCA,oEAAoE;AACpE,MAAM,UAAU,YAAY,CAAC,QAAyB;IACpD,OAAO,EAAE,KAAK,EAAE,QAAQ,CAAC,KAAK,EAAE,CAAC;AACnC,CAAC"}

package/dist/esm/index.js

@@ -0,0 +1,56 @@
+/**
+ * clearbank-sdk — Production-grade TypeScript SDK for the ClearBank UK API.
+ *
+ * @packageDocumentation
+ */
+import { HttpClient } from './core/http.js';
+import { resolveConfig } from './core/config.js';
+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';
+export { ClearBankError } from './types/index.js';
+// Domain services
+export { AccountsService } from './domains/accounts/service.js';
+export { PaymentsService } from './domains/payments/service.js';
+export { MultiCurrencyService } from './domains/multicurrency/service.js';
+export { EmbeddedBankingService } from './domains/embedded/service.js';
+export { WebhooksService } from './domains/webhooks/service.js';
+export { buildAckBody } from './domains/webhooks/service.js';
+// Utilities
+export { generateUUID, isUUID, isValidSortCode, isValidAccountNumber, isValidIBAN, formatAmount, } from './utils/index.js';
+// ---------------------------------------------------------------------------
+// ClearBankClient
+// ---------------------------------------------------------------------------
+/**
+ * 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 class ClearBankClient {
+    constructor(config) {
+        const resolved = resolveConfig(config);
+        const http = new HttpClient(resolved);
+        this.accounts = new AccountsService(http);
+        this.payments = new PaymentsService(http);
+        this.multiCurrency = new MultiCurrencyService(http);
+        this.embedded = new EmbeddedBankingService(http);
+        this.webhooks = new WebhooksService();
+    }
+    static generateRequestId() {
+        return HttpClient.generateRequestId();
+    }
+}
+export default ClearBankClient;
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAChE,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAChE,OAAO,EAAE,oBAAoB,EAAE,MAAM,oCAAoC,CAAC;AAC1E,OAAO,EAAE,sBAAsB,EAAE,MAAM,+BAA+B,CAAC;AACvE,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAMhE,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAgBlD,kBAAkB;AAClB,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAkBhE,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAoBhE,OAAO,EAAE,oBAAoB,EAAE,MAAM,oCAAoC,CAAC;AAgB1E,OAAO,EAAE,sBAAsB,EAAE,MAAM,+BAA+B,CAAC;AA0BvE,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAChE,OAAO,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAC;AA6B7D,YAAY;AACZ,OAAO,EACL,YAAY,EACZ,MAAM,EACN,eAAe,EACf,oBAAoB,EACpB,WAAW,EACX,YAAY,GACb,MAAM,kBAAkB,CAAC;AAE1B,8EAA8E;AAC9E,kBAAkB;AAClB,8EAA8E;AAE9E;;;;;;;;;;;;;;GAcG;AACH,MAAM,OAAO,eAAe;IAO1B,YAAY,MAAuB;QACjC,MAAM,QAAQ,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC;QACvC,MAAM,IAAI,GAAG,IAAI,UAAU,CAAC,QAAQ,CAAC,CAAC;QAEtC,IAAI,CAAC,QAAQ,GAAG,IAAI,eAAe,CAAC,IAAI,CAAC,CAAC;QAC1C,IAAI,CAAC,QAAQ,GAAG,IAAI,eAAe,CAAC,IAAI,CAAC,CAAC;QAC1C,IAAI,CAAC,aAAa,GAAG,IAAI,oBAAoB,CAAC,IAAI,CAAC,CAAC;QACpD,IAAI,CAAC,QAAQ,GAAG,IAAI,sBAAsB,CAAC,IAAI,CAAC,CAAC;QACjD,IAAI,CAAC,QAAQ,GAAG,IAAI,eAAe,EAAE,CAAC;IACxC,CAAC;IAED,MAAM,CAAC,iBAAiB;QACtB,OAAO,UAAU,CAAC,iBAAiB,EAAE,CAAC;IACxC,CAAC;CACF;AAED,eAAe,eAAe,CAAC"}

package/dist/esm/types/index.js

@@ -0,0 +1,41 @@
+/**
+ * Core types shared across the ClearBank SDK.
+ */
+export class ClearBankError extends Error {
+    constructor(params) {
+        super(params.message);
+        this.name = 'ClearBankError';
+        this.statusCode = params.statusCode ?? null;
+        this.code = params.code ?? null;
+        this.correlationId = params.correlationId ?? null;
+        this.requestId = params.requestId ?? null;
+        this.details = params.details ?? null;
+        this.retryAfterSeconds = params.retryAfterSeconds ?? null;
+        // Maintain proper prototype chain
+        Object.setPrototypeOf(this, ClearBankError.prototype);
+    }
+    isNotFound() {
+        return this.statusCode === 404;
+    }
+    isConflict() {
+        return this.statusCode === 409;
+    }
+    isRateLimited() {
+        return this.statusCode === 429;
+    }
+    isUnprocessable() {
+        return this.statusCode === 422;
+    }
+    isRetryable() {
+        return this.statusCode === 429 || this.statusCode === 500 || this.statusCode === 503;
+    }
+    toString() {
+        let msg = `ClearBankError [${this.statusCode ?? 'network'}]: ${this.message}`;
+        if (this.correlationId)
+            msg += ` (X-Correlation-Id: ${this.correlationId})`;
+        if (this.retryAfterSeconds)
+            msg += ` (retry after ${this.retryAfterSeconds}s)`;
+        return msg;
+    }
+}
+//# sourceMappingURL=index.js.map

package/dist/esm/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAUH,MAAM,OAAO,cAAe,SAAQ,KAAK;IAQvC,YAAY,MAQX;QACC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACtB,IAAI,CAAC,IAAI,GAAG,gBAAgB,CAAC;QAC7B,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,UAAU,IAAI,IAAI,CAAC;QAC5C,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,IAAI,IAAI,CAAC;QAChC,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC,aAAa,IAAI,IAAI,CAAC;QAClD,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,SAAS,IAAI,IAAI,CAAC;QAC1C,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,IAAI,IAAI,CAAC;QACtC,IAAI,CAAC,iBAAiB,GAAG,MAAM,CAAC,iBAAiB,IAAI,IAAI,CAAC;QAC1D,kCAAkC;QAClC,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,cAAc,CAAC,SAAS,CAAC,CAAC;IACxD,CAAC;IAED,UAAU;QACR,OAAO,IAAI,CAAC,UAAU,KAAK,GAAG,CAAC;IACjC,CAAC;IACD,UAAU;QACR,OAAO,IAAI,CAAC,UAAU,KAAK,GAAG,CAAC;IACjC,CAAC;IACD,aAAa;QACX,OAAO,IAAI,CAAC,UAAU,KAAK,GAAG,CAAC;IACjC,CAAC;IACD,eAAe;QACb,OAAO,IAAI,CAAC,UAAU,KAAK,GAAG,CAAC;IACjC,CAAC;IACD,WAAW;QACT,OAAO,IAAI,CAAC,UAAU,KAAK,GAAG,IAAI,IAAI,CAAC,UAAU,KAAK,GAAG,IAAI,IAAI,CAAC,UAAU,KAAK,GAAG,CAAC;IACvF,CAAC;IAEQ,QAAQ;QACf,IAAI,GAAG,GAAG,mBAAmB,IAAI,CAAC,UAAU,IAAI,SAAS,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;QAC9E,IAAI,IAAI,CAAC,aAAa;YAAE,GAAG,IAAI,uBAAuB,IAAI,CAAC,aAAa,GAAG,CAAC;QAC5E,IAAI,IAAI,CAAC,iBAAiB;YAAE,GAAG,IAAI,iBAAiB,IAAI,CAAC,iBAAiB,IAAI,CAAC;QAC/E,OAAO,GAAG,CAAC;IACb,CAAC;CACF"}

package/dist/esm/utils/index.js

@@ -0,0 +1,35 @@
+export { generateUUID } from '../core/crypto.js';
+export { HttpClient } from '../core/http.js';
+/** Returns true if a given string is a valid UUID v4 format. */
+export function isUUID(value) {
+    return /^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/i.test(value);
+}
+/** Returns true if a string looks like a UK sort code (6 digits). */
+export function isValidSortCode(value) {
+    return /^\d{6}$/.test(value);
+}
+/** Returns true if a string looks like a UK account number (8 digits). */
+export function isValidAccountNumber(value) {
+    return /^\d{8}$/.test(value);
+}
+/** Returns true if a string looks like a valid IBAN. */
+export function isValidIBAN(value) {
+    return /^[A-Z]{2}\d{2}[A-Z0-9]{1,30}$/.test(value);
+}
+/**
+ * Formats a decimal amount string for display.
+ *
+ * @example formatAmount('1234.5', 'GBP') // '£1,234.50'
+ */
+export function formatAmount(amount, currency, locale = 'en-GB') {
+    const num = parseFloat(amount);
+    if (isNaN(num))
+        return amount;
+    return new Intl.NumberFormat(locale, { style: 'currency', currency }).format(num);
+}
+/**
+ * Generates a pre-flight X-Request-Id for idempotent retries.
+ * Store this before sending — use the same ID when retrying on 5XX.
+ */
+export { HttpClient as _HttpClient } from '../core/http.js';
+//# sourceMappingURL=index.js.map

package/dist/esm/utils/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/utils/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAE7C,gEAAgE;AAChE,MAAM,UAAU,MAAM,CAAC,KAAa;IAClC,OAAO,wEAAwE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AAC9F,CAAC;AAED,qEAAqE;AACrE,MAAM,UAAU,eAAe,CAAC,KAAa;IAC3C,OAAO,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AAC/B,CAAC;AAED,0EAA0E;AAC1E,MAAM,UAAU,oBAAoB,CAAC,KAAa;IAChD,OAAO,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AAC/B,CAAC;AAED,wDAAwD;AACxD,MAAM,UAAU,WAAW,CAAC,KAAa;IACvC,OAAO,+BAA+B,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AACrD,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,YAAY,CAAC,MAAc,EAAE,QAAgB,EAAE,MAAM,GAAG,OAAO;IAC7E,MAAM,GAAG,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC;IAC/B,IAAI,KAAK,CAAC,GAAG,CAAC;QAAE,OAAO,MAAM,CAAC;IAC9B,OAAO,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,EAAE,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;AACpF,CAAC;AAED;;;GAGG;AACH,OAAO,EAAE,UAAU,IAAI,WAAW,EAAE,MAAM,iBAAiB,CAAC"}

package/dist/types/core/config.d.ts

@@ -0,0 +1,34 @@
+import type { TelemetryHook } from '../types/index.js';
+export type Environment = 'simulation' | 'production';
+export interface ClearBankConfig {
+    /** ClearBank API bearer token from the Portal. Required. */
+    readonly apiToken: string;
+    /** RSA private key as PEM string. Required for POST/PUT/PATCH requests. */
+    readonly privateKey?: string;
+    /** API environment. Defaults to 'simulation'. */
+    readonly environment?: Environment;
+    /** Override base URL — useful for testing. */
+    readonly baseUrl?: string;
+    /** HTTP timeout in ms. Defaults to 30000. */
+    readonly timeoutMs?: number;
+    /** Max retry attempts for retryable errors. Defaults to 3. */
+    readonly maxRetries?: number;
+    /** Base delay for exponential backoff in ms. Defaults to 1000. */
+    readonly retryBaseDelayMs?: number;
+    /** Max backoff delay cap in ms. Defaults to 30000. */
+    readonly retryMaxDelayMs?: number;
+    /** Observability hook called after every HTTP request. */
+    readonly telemetryHook?: TelemetryHook;
+}
+export interface ResolvedConfig {
+    readonly apiToken: string;
+    readonly privateKey: string | null;
+    readonly baseUrl: string;
+    readonly timeoutMs: number;
+    readonly maxRetries: number;
+    readonly retryBaseDelayMs: number;
+    readonly retryMaxDelayMs: number;
+    readonly telemetryHook: TelemetryHook | null;
+}
+export declare function resolveConfig(config: ClearBankConfig): ResolvedConfig;
+//# sourceMappingURL=config.d.ts.map