squarefi-bff-api-module 1.35.2 → 1.36.0

package/dist/api/issuing.d.ts

@@ -9,9 +9,9 @@ export declare const issuing: {
             subAccountCard: (data: API.Cards.Create.SubAccountRequest) => Promise<API.Cards.Create.ExtendedSubAccountResponse>;
         };
         byWalletUuid: {
-            getAll: (params: API.Cards.CardsList.Request.ByWalletUuid) => Promise<API.Cards.CardsList.Response>;
-            getBySubaccountType: (params: API.Cards.CardsList.Request.BySubaccountAndWalletUuid) => Promise<API.Cards.CardsList.Response>;
-            getBySubAccount: (params: API.Cards.CardsList.Request.BySubAccountAndWalletId) => Promise<API.Cards.CardsList.Response>;
+            getAll: ({ limit, offset, ...rest }: API.Cards.CardsList.Request.ByWalletUuid) => Promise<API.Cards.CardsList.Response>;
+            getBySubaccountType: ({ limit, offset, ...rest }: API.Cards.CardsList.Request.BySubaccountAndWalletUuid) => Promise<API.Cards.CardsList.Response>;
+            getBySubAccount: ({ limit, offset, ...rest }: API.Cards.CardsList.Request.BySubAccountAndWalletId) => Promise<API.Cards.CardsList.Response>;
         };
         getById: (card_id: string) => Promise<API.Cards.IssuingCardDetailItem>;
         sensitiveData: {
@@ -33,8 +33,8 @@ export declare const issuing: {
         rename: (card_id: string, nick_name: string) => Promise<API.Cards.IssuingCardDetailItem>;
     };
     transactions: {
-        getByCardId: (card_id: string, limit?: number, offset?: number) => Promise<API.Cards.TransactionsList>;
-        getBySubAccountId: (fiat_account_id: string, limit?: number, offset?: number) => Promise<API.Cards.TransactionsList>;
+        getByCardId: ({ card_id, limit, offset, transaction_type, status, from, to, }: API.Cards.Transactions.List.ByCardIdRequest) => Promise<API.Cards.TransactionsList>;
+        getBySubAccountId: ({ fiat_account_id, limit, offset, transaction_type, status, from, to, }: API.Cards.Transactions.List.BySubAccountIdRequest) => Promise<API.Cards.TransactionsList>;
         csv: {
             getByCardId: (card_id: string) => Promise<string>;
             getBySubAccountId: (sub_account_id: string) => Promise<string>;

package/dist/api/issuing.js

@@ -31,14 +31,14 @@ export const issuing = {
             },
         },
         byWalletUuid: {
-            getAll: (params) => apiClientV1.getRequest('/issuing/cards', {
-                params,
+            getAll: ({ limit = defaultPaginationParams.limit, offset = defaultPaginationParams.offset, ...rest }) => apiClientV1.getRequest('/issuing/cards', {
+                params: { ...rest, limit, offset },
             }),
-            getBySubaccountType: (params) => apiClientV1.getRequest('/issuing/cards', {
-                params,
+            getBySubaccountType: ({ limit = defaultPaginationParams.limit, offset = defaultPaginationParams.offset, ...rest }) => apiClientV1.getRequest('/issuing/cards', {
+                params: { ...rest, limit, offset },
             }),
-            getBySubAccount: (params) => apiClientV1.getRequest('/issuing/cards', {
-                params,
+            getBySubAccount: ({ limit = defaultPaginationParams.limit, offset = defaultPaginationParams.offset, ...rest }) => apiClientV1.getRequest('/issuing/cards', {
+                params: { ...rest, limit, offset },
             }),
         },
         // getById: (card_id: string) => apiClientV1.getRequest<API.Cards.IssuingCardDetailItem>(`/issuing/cards/${card_id}`),
@@ -86,11 +86,11 @@ export const issuing = {
         }),
     },
     transactions: {
-        getByCardId: (card_id, limit = defaultPaginationParams.limit, offset = defaultPaginationParams.offset) => apiClientV1.getRequest(`/issuing/transactions/`, {
-            params: { limit, offset, card_id, new_scheme: true },
+        getByCardId: ({ card_id, limit = defaultPaginationParams.limit, offset = defaultPaginationParams.offset, transaction_type, status, from, to, }) => apiClientV1.getRequest(`/issuing/transactions/`, {
+            params: { limit, offset, card_id, new_scheme: true, transaction_type, status, from, to },
         }),
-        getBySubAccountId: (fiat_account_id, limit = defaultPaginationParams.limit, offset = defaultPaginationParams.offset) => apiClientV1.getRequest(`/issuing/transactions/`, {
-            params: { limit, offset, fiat_account_id, new_scheme: true },
+        getBySubAccountId: ({ fiat_account_id, limit = defaultPaginationParams.limit, offset = defaultPaginationParams.offset, transaction_type, status, from, to, }) => apiClientV1.getRequest(`/issuing/transactions/`, {
+            params: { limit, offset, fiat_account_id, new_scheme: true, transaction_type, status, from, to },
         }),
         csv: {
             getByCardId: (card_id) => apiClientV1.getRequest(`/issuing/transactions/csv`, {

package/dist/api/types/autogen/apiV1External.types.d.ts

@@ -2011,6 +2011,8 @@ export interface paths {
                     sub_account_type?: "prepaid" | "balance";
                     /** @description Filter cards by status */
                     status?: "ACTIVE" | "INACTIVE" | "SUSPENDED" | "CANCELED";
+                    /** @description Filter cards by exact last 4 digits of the card number */
+                    last4?: string;
                     /** @description Number of items to skip */
                     offset?: number;
                     /** @description Number of items to return */
@@ -3229,7 +3231,81 @@ export interface paths {
         delete?: never;
         options?: never;
         head?: never;
-        patch?: never;
+        /**
+         * Update sub-account
+         * @description Updates editable fields of a sub-account. Currently only the `nick_name` can be changed.
+         *
+         *     **Authentication**: x-api-key header required
+         *
+         *     **Access Control**: User must have access to the sub-account
+         *
+         */
+        patch: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    /** @description The ID of the sub-account to update */
+                    sub_account_id: string;
+                };
+                cookie?: never;
+            };
+            requestBody: {
+                content: {
+                    "application/json": {
+                        /**
+                         * @description New nickname for the sub-account
+                         * @example Travel budget
+                         */
+                        nick_name: string;
+                    };
+                };
+            };
+            responses: {
+                /** @description Sub-account updated successfully */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @example true */
+                            success?: boolean;
+                            data?: components["schemas"]["IssuingSubAccount"];
+                            /** @example Sub-account updated successfully */
+                            message?: string;
+                        };
+                    };
+                };
+                /** @description Bad Request - nick_name is required */
+                400: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ApiErrorResponse"];
+                    };
+                };
+                /** @description Access denied to this sub-account */
+                403: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ApiErrorResponse"];
+                    };
+                };
+                /** @description Sub-account not found */
+                404: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ApiErrorResponse"];
+                    };
+                };
+            };
+        };
         trace?: never;
     };
     "/api/issuing/sub-accounts/{sub_account_id}/transactions": {

package/dist/api/types/autogen/apiV1Frontend.types.d.ts

@@ -1736,6 +1736,8 @@ export interface paths {
                     sub_account_type?: "prepaid" | "balance";
                     /** @description Filter cards by status */
                     status?: "ACTIVE" | "INACTIVE" | "SUSPENDED" | "CANCELED";
+                    /** @description Filter cards by exact last 4 digits of the card number */
+                    last4?: string;
                     /** @description Number of items to skip */
                     offset?: number;
                     /** @description Number of items to return */
@@ -3008,7 +3010,76 @@ export interface paths {
         delete?: never;
         options?: never;
         head?: never;
-        patch?: never;
+        /**
+         * Update sub-account
+         * @description Updates editable fields of a sub-account. Currently only the `nick_name` can be changed.
+         *
+         *     **Authentication**: Bearer token with x-tenant-id header required
+         *
+         *     **Access Control**: User must have ADMIN role on the sub-account's wallet
+         *
+         */
+        patch: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    /** @description The ID of the sub-account to update */
+                    sub_account_id: string;
+                };
+                cookie?: never;
+            };
+            requestBody: {
+                content: {
+                    "application/json": {
+                        /**
+                         * @description New nickname for the sub-account
+                         * @example Travel budget
+                         */
+                        nick_name: string;
+                    };
+                };
+            };
+            responses: {
+                /** @description Sub-account updated successfully */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @example true */
+                            success?: boolean;
+                            /** @description Updated sub-account details */
+                            data?: Record<string, never>;
+                            /** @example Sub-account updated successfully */
+                            message?: string;
+                        };
+                    };
+                };
+                /** @description Bad Request - nick_name is required */
+                400: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+                /** @description Access denied to this sub-account */
+                403: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+                /** @description Sub-account not found */
+                404: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+            };
+        };
         trace?: never;
     };
     "/frontend/issuing/sub-accounts/{sub_account_id}/transactions": {
@@ -7143,7 +7214,7 @@ export interface paths {
                     /** @description Include shared wallets (via wallets_users table) */
                     include_shared?: boolean;
                     /** @description Field to sort the merged owned + shared wallet list by */
-                    sort_by?: "created_at" | "updated_at" | "name";
+                    sort_by?: "created_at" | "name";
                     /** @description Sort direction (case-insensitive) */
                     sort_order?: "ASC" | "DESC";
                 };
@@ -7165,8 +7236,6 @@ export interface paths {
                             data: {
                                 /** Format: uuid */
                                 uuid: string;
-                                /** @description Deprecated field */
-                                type?: string;
                                 /** @description Wallet display name (mirrors POST/PATCH responses) */
                                 name: string | null;
                                 /** @description Avatar URL for the wallet */
@@ -7272,8 +7341,6 @@ export interface paths {
                             data: {
                                 /** Format: uuid */
                                 uuid: string;
-                                /** @description Deprecated field */
-                                type?: string;
                                 /** @example Golden Vault 42 */
                                 name: string | null;
                                 logo_url: string | null;
@@ -7542,8 +7609,6 @@ export interface paths {
                             data: {
                                 /** Format: uuid */
                                 uuid: string;
-                                /** @description Deprecated field */
-                                type?: string;
                                 name: string | null;
                                 logo_url: string | null;
                                 /** Format: uuid */
@@ -7570,7 +7635,7 @@ export interface paths {
                                     decimal: number;
                                     amount: number;
                                     fiat_amount: number;
-                                    details: Record<string, never>[];
+                                    details: components["schemas"]["AggregatedBalanceDetails"][];
                                 }[];
                                 fiat_accounts: Record<string, never>[];
                                 /** @description User's base currency */
@@ -7778,8 +7843,6 @@ export interface paths {
                             data: {
                                 /** Format: uuid */
                                 uuid: string;
-                                /** @description Deprecated field */
-                                type?: string;
                                 /** Format: uuid */
                                 tenant_id: string;
                                 /** Format: date-time */
@@ -8205,29 +8268,9 @@ export interface paths {
                     content: {
                         "application/json": {
                             /** @example true */
-                            success?: boolean;
-                            data?: {
-                                id?: number;
-                                /** Format: date-time */
-                                created_at?: string;
-                                type?: string;
-                                status?: string;
-                                amount?: number;
-                                method?: string;
-                                record_type?: string;
-                                /** Format: uuid */
-                                wallet_id?: string;
-                                /** @description Currency information */
-                                currency?: Record<string, never>;
-                                /** @description Transaction metadata */
-                                meta?: Record<string, never>;
-                            }[];
-                            pagination?: {
-                                offset?: number;
-                                limit?: number;
-                                total?: number;
-                                has_more?: boolean;
-                            };
+                            success: boolean;
+                            data: components["schemas"]["Transaction"][];
+                            pagination: components["schemas"]["PaginationResponse"];
                         };
                     };
                 };
@@ -8385,23 +8428,8 @@ export interface paths {
                     content: {
                         "application/json": {
                             /** @example true */
-                            success?: boolean;
-                            data?: {
-                                id?: number;
-                                /** Format: date-time */
-                                created_at?: string;
-                                type?: string;
-                                status?: string;
-                                amount?: number;
-                                method?: string;
-                                record_type?: string;
-                                /** Format: uuid */
-                                wallet_id?: string;
-                                /** @description Currency information */
-                                currency?: Record<string, never>;
-                                /** @description Transaction metadata */
-                                meta?: Record<string, never>;
-                            };
+                            success: boolean;
+                            data: components["schemas"]["Transaction"];
                         };
                     };
                 };
@@ -9261,10 +9289,10 @@ export interface components {
          */
         OrderTypeId: "EXCHANGE_OMNI" | "EXCHANGE_OMNI_ONRAMP" | "EXCHANGE_OMNI_OFFRAMP" | "EXCHANGE_OMNI_CRYPTO" | "EXCHANGE_CRYPTO_INTERNAL" | "L2F_ACH_ONRAMP" | "L2F_ACH_OFFRAMP" | "L2F_SEPA_ONRAMP" | "L2F_SEPA_OFFRAMP" | "L2F_SWIFT_ONRAMP" | "L2F_SWIFT_OFFRAMP" | "L2F_WIRE_ONRAMP" | "L2F_WIRE_OFFRAMP" | "L2F_CHAPS_ONRAMP" | "L2F_CHAPS_OFFRAMP" | "L2F_FPS_ONRAMP" | "L2F_FPS_OFFRAMP" | "BRL_WIRE_ONRAMP" | "BRL_WIRE_OFFRAMP" | "BRL_ACH_ONRAMP" | "BRL_ACH_OFFRAMP" | "OMNIBUS_CRYPTO_TRANSFER" | "OMNIBUS_CRYPTO_WITHDRAWAL" | "OMNIBUS_INTERNAL_TRANSFER" | "SEGREGATED_CRYPTO_TRANSFER" | "TRANSFER_INTERNAL" | "TRANSFER_CARD_PREPAID" | "TRANSFER_CARD_SUBACCOUNT" | "TRANSFER_CARD_WHOLESALE" | "WITHDRAW_CARD_PREPAID" | "WITHDRAW_CARD_SUBACCOUNT" | "REFUND_CARD_PREPAID" | "REFUND_CARD_SUBACCOUNT" | "RN_CARDS_OFFRAMP" | "CARD_ISSUING_FEE";
         PaginationResponse: {
-            offset?: number;
-            limit?: number;
-            total?: number;
-            has_more?: boolean;
+            offset: number;
+            limit: number;
+            total: number;
+            has_more: boolean;
         };
         ErrorResponse: {
             /** @example false */
@@ -9551,6 +9579,79 @@ export interface components {
             /** Format: date-time */
             created_at: string;
         };
+        /** @description Unified currency record. `is_crypto: true` identifies a blockchain asset, `false` a fiat one. The joined `meta` JSONB blob carries currency-specific details (e.g. `chain_id`/contract for crypto, ISO code/country for fiat). */
+        Currency: {
+            id?: number;
+            /** Format: uuid */
+            uuid: string;
+            icon?: string | null;
+            name: string;
+            symbol: string;
+            is_crypto: boolean;
+            decimal: number;
+            /** @description Currency-specific metadata blob */
+            meta: {
+                [key: string]: unknown;
+            };
+        };
+        /** @description Transaction metadata. All fields are optional — presence depends on the transaction type/method (crypto transfer, card spend, fiat off-ramp, internal exchange, etc.). Unknown keys may also appear and should be ignored by clients. */
+        TransactionMeta: {
+            billing_amount?: number;
+            billing_amount_currency?: string;
+            transaction_amount?: number;
+            transaction_amount_currency?: string;
+            fee?: number;
+            fee_currency?: string;
+            network_fee?: number;
+            network_fee_currency?: string;
+            exchange_rate?: number;
+            from_address?: string;
+            to_address?: string;
+            /** Format: uuid */
+            from_user_data?: string;
+            /** Format: uuid */
+            to_user_data?: string;
+            to_card_id?: string;
+            to_card_last4?: string;
+            to_fiat_account_id?: string;
+            to_vendor_id?: string;
+            txid?: string;
+            /** Format: uuid */
+            order_id?: string;
+        } & {
+            [key: string]: unknown;
+        };
+        /** @description Wallet transaction record with embedded currency and metadata */
+        Transaction: {
+            id: number;
+            /** Format: date-time */
+            created_at: string;
+            type: string;
+            status: string;
+            amount: number;
+            method: string;
+            record_type: string;
+            /** Format: uuid */
+            wallet_id: string;
+            currency: components["schemas"]["Currency"];
+            meta: components["schemas"]["TransactionMeta"];
+        };
+        /** @description A single underlying balance row contributing to an aggregated `balance[]` entry. The aggregated entry merges all rows that share the same symbol; each `details[]` item exposes the per-row breakdown so clients can show per-chain / per-account amounts. */
+        AggregatedBalanceDetails: {
+            /** Format: uuid */
+            uuid: string;
+            amount: number;
+            fiat_amount: number;
+            currency: components["schemas"]["Currency"];
+            /** @description Snapshot of the underlying crypto record from this balance row */
+            crypto?: {
+                [key: string]: unknown;
+            };
+            /** Format: uuid */
+            crypto_id?: string | null;
+            /** Format: uuid */
+            wallet_id?: string;
+        };
     };
     responses: {
         /** @description Authentication credentials are missing or invalid */

package/dist/api/types/autogen/apiV1Legacy.types.d.ts

@@ -1260,13 +1260,18 @@ export interface paths {
                     sort_by?: "card_id" | "nick_name" | "name_on_card" | "last4" | "card_status" | "created_at";
                     /** @description Sort direction */
                     sort_order?: "ASC" | "DESC";
+                    /**
+                     * @description Filter cards by exact last 4 digits of the card number (equality match against `issuing_cards.last4`).
+                     * @example 1234
+                     */
+                    "filter[last4]"?: string;
                     /** @description Filter by specific card properties. Can be provided in three ways:
                      *     1. As JSON object: `filter={"last4":"1234"}`
                      *     2. As query params: `filter[last4]=1234`
                      *     3. For nested filtering: `filter[fiat_account][type]=prepaid`
                      *
                      *     Common filter fields:
-                     *     - `last4`: Filter by last 4 digits of card
+                     *     - `last4`: Filter by last 4 digits of card (exact match)
                      *     - `card_status`: Filter by status (ACTIVE, INACTIVE, CANCELED)
                      *     - `fiat_account.type`: Filter by account type (prepaid, balance)
                      *     - `from_created_at`: Filter cards created on or after this date (ISO 8601 format)
@@ -2284,10 +2289,12 @@ export interface paths {
                     new_scheme?: boolean;
                     /** @description Filter by transaction type */
                     transaction_type?: string;
-                    /** @description Filter by start date */
+                    /** @description Filter by start date (ISO 8601). Sent to external provider as `from_timestamp` and post-filtered against `cleared_at`/`created_at`. */
                     from?: string;
-                    /** @description Filter by end date */
+                    /** @description Filter by end date (ISO 8601). Sent to external provider as `to_timestamp` and post-filtered against `cleared_at`/`created_at`. */
                     to?: string;
+                    /** @description Filter by transaction status. Forwarded to external provider and applied as a post-filter on the combined result. */
+                    status?: "PENDING" | "APPROVED" | "DECLINED" | "CANCELED";
                 };
                 header?: never;
                 path?: never;

package/dist/api/types/autogen/apiV1Tenant.types.d.ts

@@ -6490,7 +6490,60 @@ export interface paths {
         delete?: never;
         options?: never;
         head?: never;
-        patch?: never;
+        /**
+         * Update sub-account
+         * @description Updates editable fields of a sub-account. Currently only the `nick_name` can be changed.
+         */
+        patch: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    sub_account_id: string;
+                };
+                cookie?: never;
+            };
+            requestBody: {
+                content: {
+                    "application/json": {
+                        nick_name: string;
+                    };
+                };
+            };
+            responses: {
+                /** @description Sub-account updated */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @example true */
+                            success?: boolean;
+                            data?: components["schemas"]["IssuingSubAccount"];
+                        };
+                    };
+                };
+                /** @description Bad Request — nick_name is required */
+                400: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ErrorResponse"];
+                    };
+                };
+                /** @description Sub-account not found */
+                404: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ErrorResponse"];
+                    };
+                };
+            };
+        };
         trace?: never;
     };
     "/admin/issuing/sub-accounts/{sub_account_id}/transactions": {

package/dist/api/types/types.d.ts

@@ -1,6 +1,7 @@
 import { APIKeyRole, CardFormFactor, CardTransactionType, CardType, CurrencyType, IssuingProgramStatus, OrderType, SortingDirection, SubAccountType } from '../../constants';
 import { components, operations, paths } from './autogen/apiV2.types';
 import { components as componentsV1Frontend, paths as pathsV1Frontend } from './autogen/apiV1Frontend.types';
+import { paths as pathsV1Legacy } from './autogen/apiV1Legacy.types';
 export declare namespace API {
     namespace Auth {
         namespace RefreshToken {
@@ -221,16 +222,11 @@ export declare namespace API {
         }
         namespace CardsList {
             namespace Request {
-                type CardsListSortingFields = Partial<Pick<IssuingCardListItem, 'created_at' | 'card_status' | 'last4' | 'nick_name' | 'name_on_card' | 'card_id'>>;
-                type CardsListFilteringFields = Partial<IssuingCardListItem>;
-                type CardsListRequestCommonParams = API.Common.Pagination.Request & API.Common.Sorting.Request<CardsListSortingFields> & API.Common.Filtering.Request<CardsListFilteringFields>;
-                interface ByWalletUuid extends CardsListRequestCommonParams {
-                    wallet_uuid: string;
-                }
-                interface BySubaccountAndWalletUuid extends ByWalletUuid {
+                type ByWalletUuid = NonNullable<pathsV1Legacy['/issuing/cards']['get']['parameters']['query']>;
+                type BySubaccountAndWalletUuid = ByWalletUuid & {
                     filter?: Record<'fiat_account', Record<'type', SubAccountType>>;
-                }
-                type BySubAccountAndWalletId = ByWalletUuid & {
+                };
+                type BySubAccountAndWalletId = Omit<ByWalletUuid, 'fiat_account_id'> & {
                     fiat_account_id: string;
                 };
             }
@@ -271,6 +267,19 @@ export declare namespace API {
             has_more: boolean;
             count: number;
         }
+        namespace Transactions {
+            namespace List {
+                type Query = NonNullable<pathsV1Legacy['/issuing/transactions']['get']['parameters']['query']>;
+                export type StatusFilter = NonNullable<Query['status']>;
+                export type ByCardIdRequest = Omit<Query, 'card_id'> & {
+                    card_id: string;
+                };
+                export type BySubAccountIdRequest = Omit<Query, 'fiat_account_id'> & {
+                    fiat_account_id: string;
+                };
+                export {};
+            }
+        }
         interface SensitiveData {
             card_number: string;
             cvv: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "squarefi-bff-api-module",
-  "version": "1.35.2",
+  "version": "1.36.0",
   "description": "Squarefi BFF API client module",
   "type": "module",
   "main": "./dist/index.js",