@spritz-finance/service-client 0.8.8 → 0.10.0

package/lib/features/types.d.ts

@@ -29,7 +29,6 @@ export declare enum FeatureFlag {
     BillPayments = "payments.accountType.bill",
     VirtualCardPayments = "payments.accountType.virtualCard",
     DebitCardPayments = "payments.accountType.debitCard",
-    PushToCardPayments = "payments.accountType.pushToCard",
     BankAccountPayments = "payments.accountType.bankAccount",
     RtpPayments = "payments.accountType.rtp",
     CadPayments = "payments.cad.enabled",

package/lib/features/types.js

@@ -26,7 +26,6 @@ var FeatureFlag;
     FeatureFlag["BillPayments"] = "payments.accountType.bill";
     FeatureFlag["VirtualCardPayments"] = "payments.accountType.virtualCard";
     FeatureFlag["DebitCardPayments"] = "payments.accountType.debitCard";
-    FeatureFlag["PushToCardPayments"] = "payments.accountType.pushToCard";
     FeatureFlag["BankAccountPayments"] = "payments.accountType.bankAccount";
     FeatureFlag["RtpPayments"] = "payments.accountType.rtp";
     FeatureFlag["CadPayments"] = "payments.cad.enabled";

package/lib/liabilities/liabilitiesServiceClient.d.ts

@@ -1,7 +1,7 @@
 export * as LiabilitiesClient from "./liabilitiesServiceClient";
 import { CheckbookUser } from "../lib/graphClient/generated";
 import { ExternalBillInput } from "../payableAccounts/types";
-import { CheckbookCardResponse, CheckbookDebitCardResponse, CheckbookDigitalAccountResponse, CheckbookUpdateCardResponse, CreateCheckbookUserParams, CreateDebitCardInput, CreateDigitalAccountInput, CreateEntityParams, DirectPaymentResponse, IssueRefundCreditInput, IssueRefundCreditResult, MethodFiEntity, RewardTransaction } from "./types";
+import { CheckbookCardResponse, CheckbookDebitCardResponse, CheckbookDigitalAccountResponse, CheckbookUpdateCardResponse, CreateCheckbookUserParams, CreateDebitCardInput, CreateDigitalAccountInput, CreateEntityParams, CreateTokenizedDebitCardInput, DirectPaymentResponse, IssueRefundCreditInput, IssueRefundCreditResult, MethodFiEntity, RewardTransaction, TokenizedDebitCardResponse } from "./types";
 export declare function getRewardTransaction(transactionId: string): Promise<RewardTransaction>;
 export declare function createMethodFiEntity(args: CreateEntityParams): Promise<MethodFiEntity>;
 export declare function getMethodFiEntity(userId: string): Promise<MethodFiEntity | null>;
@@ -10,6 +10,14 @@ export declare function upsertCheckbookUser(args: CreateCheckbookUserParams): Pr
 export declare function getCheckbookUser(userId: string): Promise<CheckbookUser | null>;
 export declare function createCheckbookVirtualCard(userId: string): Promise<CheckbookCardResponse>;
 export declare function createCheckbookDebitCard(input: CreateDebitCardInput): Promise<CheckbookDebitCardResponse>;
+/**
+ * Registers a debit card from a platform Evervault tokenization. Hits the same
+ * `/debit-card/create` route as {@link createCheckbookDebitCard}, but sends a
+ * `tokenizationId` instead of raw card data; liabilities relays it through the
+ * platform Evervault endpoint to Checkbook (gated by the `evervault.debitCards`
+ * flag). Throws on a non-2xx response.
+ */
+export declare function createTokenizedDebitCard(input: CreateTokenizedDebitCardInput): Promise<TokenizedDebitCardResponse>;
 export declare function createCheckbookDigitalAccount(input: CreateDigitalAccountInput): Promise<import("../types").ApiFailure | import("../types").ApiSuccess<CheckbookDigitalAccountResponse>>;
 export declare function createUSBillFromAccountNumber(userId: string, accountNumber: string, merchantId: string): Promise<import("../types").ApiFailure | import("../types").ApiSuccess<ExternalBillInput>>;
 export declare function getVirtualCardBalance(cardExternalId: string, userId: string): Promise<import("../types").ApiFailure | import("../types").ApiSuccess<number>>;

package/lib/liabilities/liabilitiesServiceClient.js

@@ -42,6 +42,7 @@ exports.upsertCheckbookUser = upsertCheckbookUser;
 exports.getCheckbookUser = getCheckbookUser;
 exports.createCheckbookVirtualCard = createCheckbookVirtualCard;
 exports.createCheckbookDebitCard = createCheckbookDebitCard;
+exports.createTokenizedDebitCard = createTokenizedDebitCard;
 exports.createCheckbookDigitalAccount = createCheckbookDigitalAccount;
 exports.createUSBillFromAccountNumber = createUSBillFromAccountNumber;
 exports.getVirtualCardBalance = getVirtualCardBalance;
@@ -95,6 +96,21 @@ async function createCheckbookDebitCard(input) {
         .post(`${LIABILITIES_ENDPOINT}/debit-card/create`, input)
         .then((res) => res.data);
 }
+/**
+ * Registers a debit card from a platform Evervault tokenization. Hits the same
+ * `/debit-card/create` route as {@link createCheckbookDebitCard}, but sends a
+ * `tokenizationId` instead of raw card data; liabilities relays it through the
+ * platform Evervault endpoint to Checkbook (gated by the `evervault.debitCards`
+ * flag). Throws on a non-2xx response.
+ */
+async function createTokenizedDebitCard(input) {
+    return serviceClient_1.baseClient
+        .post(`${LIABILITIES_ENDPOINT}/debit-card/create`, input)
+        .then((res) => ({
+        externalId: res.data.checkbookCardId,
+        cardLast4: res.data.cardLast4,
+    }));
+}
 async function createCheckbookDigitalAccount(input) {
     return serviceClient_1.baseClient
         .post(`${LIABILITIES_ENDPOINT}/digital-account/create`, input)

package/lib/liabilities/types.d.ts

@@ -186,6 +186,34 @@ export type CreateDigitalAccountInput = {
     identifier: string;
     type: DigitalAccountType;
 };
+/**
+ * Input for registering a debit card from a platform Evervault tokenization.
+ * The raw PAN never leaves the platform — liabilities looks the tokenization
+ * up and relays it through Evervault to Checkbook. `cardholderName`/`cardBin`
+ * are forwarded for the relay path and ignored by the legacy direct path.
+ */
+export type CreateTokenizedDebitCardInput = {
+    userId: string;
+    tokenizationId: string;
+    cardholderName: string;
+    cardBin: string;
+};
+/**
+ * Raw body returned by liabilities `POST /debit-card/create` on the relay path.
+ */
+export type RelayDebitCardResponse = {
+    userId: string;
+    checkbookCardId: string;
+    cardLast4: string;
+};
+/**
+ * Normalized result of {@link createTokenizedDebitCard}. `externalId` is the
+ * Checkbook card id (mapped from the relay path's `checkbookCardId`).
+ */
+export type TokenizedDebitCardResponse = {
+    externalId: string;
+    cardLast4: string;
+};
 export type CheckbookDebitCardResponse = {
     userId: string;
     externalId: string;

package/lib/platform/platformServiceClient.d.ts

@@ -1,5 +1,5 @@
 export * as PlatformClient from "./platformServiceClient";
-import { IssuePayoutData, IssuePayoutRequest, MTBalancesData, PlaidTreasuryBalancesData, SendPaymentData, SendPaymentRequest, TabapayBalancesResponse, TabapayFundingRequirementResponse, ValidateBillData, ValidateBillRequest } from "./types";
+import { IssuePayoutData, IssuePayoutRequest, MTBalancesData, PlaidTreasuryBalancesData, RelayCheckbookCardData, RelayCheckbookCardRequest, SendPaymentData, SendPaymentRequest, TabapayBalancesResponse, TabapayFundingRequirementResponse, ValidateBillData, ValidateBillRequest } from "./types";
 export declare function validateBill(request: ValidateBillRequest): Promise<import("../types").ApiFailure | import("../types").ApiSuccess<ValidateBillData>>;
 export declare function tabapayBalances(): Promise<import("../types").ApiFailure | import("../types").ApiSuccess<TabapayBalancesResponse>>;
 export declare function tabapayFundingRequirement(currency?: string): Promise<TabapayFundingRequirementResponse>;
@@ -11,3 +11,10 @@ export declare function modernTreasuryBalances(): Promise<import("../types").Api
  * from the platform's snapshot cache and refreshed at most every few hours.
  */
 export declare function plaidTreasuryBalances(): Promise<import("../types").ApiFailure | import("../types").ApiSuccess<PlaidTreasuryBalancesData>>;
+/**
+ * Registers a tokenized debit card with Checkbook via the platform's Evervault
+ * relay. Platform holds the Evervault credentials and the tokenized card data;
+ * the caller (liabilities) supplies the per-user Checkbook API credentials. The
+ * raw PAN is decrypted in-flight by the relay and never returned.
+ */
+export declare function relayCheckbookCard(request: RelayCheckbookCardRequest): Promise<import("../types").ApiFailure | import("../types").ApiSuccess<RelayCheckbookCardData>>;

package/lib/platform/platformServiceClient.js

@@ -44,6 +44,7 @@ exports.issuePayout = issuePayout;
 exports.sendPayment = sendPayment;
 exports.modernTreasuryBalances = modernTreasuryBalances;
 exports.plaidTreasuryBalances = plaidTreasuryBalances;
+exports.relayCheckbookCard = relayCheckbookCard;
 exports.PlatformClient = __importStar(require("./platformServiceClient"));
 const axios_1 = __importDefault(require("axios"));
 // @ts-expect-error no type declarations for axios-token-interceptor
@@ -104,3 +105,15 @@ async function plaidTreasuryBalances() {
         .get(`${PLAID_TREASURY_ENDPOINT}/balances`)
         .then((res) => res.data);
 }
+const EVERVAULT_RELAY_ENDPOINT = "/v1/evervault/relay/checkbook/cards";
+/**
+ * Registers a tokenized debit card with Checkbook via the platform's Evervault
+ * relay. Platform holds the Evervault credentials and the tokenized card data;
+ * the caller (liabilities) supplies the per-user Checkbook API credentials. The
+ * raw PAN is decrypted in-flight by the relay and never returned.
+ */
+async function relayCheckbookCard(request) {
+    return platformClient
+        .post(EVERVAULT_RELAY_ENDPOINT, request)
+        .then((res) => res.data);
+}

package/lib/platform/types.d.ts

@@ -68,10 +68,18 @@ export interface MTAccount {
     currency: string;
     balances: MTAccountBalance[];
     /**
-     * Outstanding liabilities-payout amount committed but not yet reflected in the
-     * available balance, as decimal dollars (e.g. "1234.56").
+     * Component 1 — payouts committed but not yet sent (still held by us),
+     * not yet reflected in the available balance, as decimal dollars (e.g.
+     * "1234.56").
      */
     liability: string;
+    /**
+     * Component 2 — payouts that bounced (returned/reversed/failed) and have not
+     * yet been refunded to the user: funds are back in the MT account but still
+     * owed out. Decimal dollars. Disjoint from `liability`; the two sum to the
+     * full MT payable.
+     */
+    terminalLiability: string;
 }
 export interface MTBalancesData {
     accounts: MTAccount[];
@@ -100,3 +108,14 @@ export interface PlaidTreasuryAccountBalance {
 export interface PlaidTreasuryBalancesData {
     accounts: PlaidTreasuryAccountBalance[];
 }
+export interface RelayCheckbookCardRequest {
+    tokenization_id: string;
+    user_id: string;
+    checkbook_user_id: string;
+    checkbook_api_key: string;
+    checkbook_api_secret: string;
+}
+export interface RelayCheckbookCardData {
+    checkbook_card_id: string;
+    card_last4: string;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spritz-finance/service-client",
-  "version": "0.8.8",
+  "version": "0.10.0",
   "gitHead": "06f8e96b7b38c34df26a38da329331940675e4f8",
   "description": "Service client",
   "license": "ISC",