squarefi-bff-api-module 1.16.0 → 1.17.0

package/CHANGELOG.md

@@ -5,6 +5,60 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.17.0] - 2025-04-18
+
+### Changed
+
+- Removed fiat_accounts API and integrated functionality into sub_accounts module
+
+## [1.16.1] - 2025-04-16
+
+### Changed
+
+- Updated changelog documentation
+
+## [1.16.0] - 2025-04-16
+
+### Added
+
+- Added support for fetching transactions by fiat account ID
+
+## [1.15.1] - 2025-04-16
+
+### Changed
+
+- Simplified logout logic in API client
+
+## [1.15.0] - 2025-04-14
+
+### Added
+
+- Added CSV export functionality for transactions
+
+## [1.14.0] - 2025-04-11
+
+### Added
+
+- Added delete functionality for counterparties destinations
+
+## [1.13.5] - 2025-04-11
+
+### Fixed
+
+- Added optional memo field to external crypto data type
+
+## [1.13.4] - 2025-04-11
+
+### Fixed
+
+- Added optional memo field to external crypto data type
+
+## [1.13.3] - 2025-04-10
+
+### Fixed
+
+- Moved search parameter to filter object in API types
+
 ## [1.13.2] - 2025-04-08
 
 ### Changed

package/dist/api/index.d.ts

@@ -2,7 +2,6 @@ import { auth } from './auth';
 import { counterparties } from './counterparties';
 import { developer } from './developer';
 import { exchange } from './exchange';
-import { fiat_accounts } from './fiat_accounts';
 import { issuing } from './issuing';
 import { kyc } from './kyc';
 import { list } from './list';
@@ -16,7 +15,6 @@ type Api = {
     counterparties: typeof counterparties;
     developer: typeof developer;
     exchange: typeof exchange;
-    fiat_accounts: typeof fiat_accounts;
     issuing: typeof issuing;
     kyc: typeof kyc;
     list: typeof list;

package/dist/api/index.js

@@ -5,7 +5,6 @@ const auth_1 = require("./auth");
 const counterparties_1 = require("./counterparties");
 const developer_1 = require("./developer");
 const exchange_1 = require("./exchange");
-const fiat_accounts_1 = require("./fiat_accounts");
 const issuing_1 = require("./issuing");
 const kyc_1 = require("./kyc");
 const list_1 = require("./list");
@@ -19,7 +18,6 @@ exports.squarefi_bff_api_client = {
     counterparties: counterparties_1.counterparties,
     developer: developer_1.developer,
     exchange: exchange_1.exchange,
-    fiat_accounts: fiat_accounts_1.fiat_accounts,
     issuing: issuing_1.issuing,
     kyc: kyc_1.kyc,
     list: list_1.list,

package/dist/api/issuing.d.ts

@@ -37,6 +37,22 @@ export declare const issuing: {
             getByFiatAccountId: (fiat_account_id: string) => Promise<string>;
         };
     };
+    sub_accounts: {
+        list: {
+            withCards: {
+                getSinglecards: (wallet_uuid: string, limit: number, offset: number) => Promise<API.Issuing.SubAccounts.SubAccountWithCards[]>;
+                getAll: (wallet_uuid: string, limit: number, offset: number) => Promise<API.Issuing.SubAccounts.SubAccountWithCards[]>;
+            };
+            withoutCards: {
+                getAll: (wallet_uuid: string, limit: number, offset: number) => Promise<API.Issuing.SubAccounts.SubAccount[]>;
+            };
+        };
+        getByUuid: (uuid: string) => Promise<API.Issuing.SubAccounts.SubAccount>;
+        create: (wallet_id: string, program_id: string) => Promise<API.Issuing.SubAccounts.SubAccount>;
+        transactions: {
+            get: (fiat_account_id: string, limit?: number, offset?: number) => Promise<API.Issuing.SubAccounts.TransactionList>;
+        };
+    };
     config: {
         programs: {
             getAll: () => Promise<API.Cards.Config.Program[]>;

package/dist/api/issuing.js

@@ -12,7 +12,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.issuing = void 0;
 const apiClientFactory_1 = require("../utils/apiClientFactory");
 const constants_1 = require("../constants");
-const fiat_accounts_1 = require("./fiat_accounts");
 const encrypt_1 = require("../utils/encrypt");
 exports.issuing = {
     cards: {
@@ -30,7 +29,7 @@ exports.issuing = {
         // getById: (card_id: string) => apiClientV1.getRequest<API.Cards.IssuingCardDetailItem>(`/issuing/cards/${card_id}`),
         getById: (card_id) => __awaiter(void 0, void 0, void 0, function* () {
             const card = yield apiClientFactory_1.apiClientV1.getRequest(`/issuing/cards/${card_id}`);
-            const fiatAccountData = yield fiat_accounts_1.fiat_accounts.getByUuid(card.fiat_account.id);
+            const fiatAccountData = yield exports.issuing.sub_accounts.getByUuid(card.fiat_account.id);
             return Object.assign(Object.assign({}, card), { fiat_account: Object.assign(Object.assign({}, fiatAccountData), { type: card.fiat_account.type }) });
         }),
         sensitiveData: {
@@ -84,6 +83,32 @@ exports.issuing = {
             }),
         },
     },
+    sub_accounts: {
+        list: {
+            withCards: {
+                getSinglecards: (wallet_uuid, limit, offset) => apiClientFactory_1.apiClientV1.getRequest(`/issuing/sub_account/list/${wallet_uuid}`, {
+                    params: { limit, offset, lt_cards_limit: 2, gt_cards_limit: 0, show_cards: true },
+                }),
+                getAll: (wallet_uuid, limit, offset) => apiClientFactory_1.apiClientV1.getRequest(`/issuing/sub_account/list/${wallet_uuid}`, {
+                    params: { limit, offset, show_cards: true },
+                }),
+            },
+            withoutCards: {
+                getAll: (wallet_uuid, limit, offset) => apiClientFactory_1.apiClientV1.getRequest(`/issuing/sub_account/list/${wallet_uuid}`, {
+                    params: { limit, offset },
+                }),
+            },
+        },
+        getByUuid: (uuid) => apiClientFactory_1.apiClientV1.getRequest(`/issuing/sub_account/${uuid}`),
+        create: (wallet_id, program_id) => apiClientFactory_1.apiClientV1.postRequest(`/issuing/sub_account`, {
+            data: { wallet_id, program_id },
+        }),
+        transactions: {
+            get: (fiat_account_id, limit, offset) => apiClientFactory_1.apiClientV1.getRequest(`/issuing/sub_account/${fiat_account_id}/transactions`, {
+                params: { limit, offset },
+            }),
+        },
+    },
     config: {
         programs: {
             getAll: () => apiClientFactory_1.apiClientV1.getRequest('/issuing/config/programs').then(({ data }) => data),

package/dist/api/types.d.ts

@@ -185,7 +185,7 @@ export declare namespace API {
             nick_name: string | null;
             wallet_id: string;
             program_id: string;
-            fiat_account: API.FiatAccounts.FiatAccount;
+            fiat_account: API.Issuing.SubAccounts.SubAccount;
             last4: string;
             request_id: string;
             name_on_card: string | null;
@@ -197,7 +197,7 @@ export declare namespace API {
             id: string;
             brand: string;
             card_id: string;
-            fiat_account: API.FiatAccounts.FiatAccount;
+            fiat_account: API.Issuing.SubAccounts.SubAccount;
             last4: string;
             card_status: string;
             form_factor: string;
@@ -623,55 +623,6 @@ export declare namespace API {
             onramp_enabled: boolean;
         }
     }
-    namespace FiatAccounts {
-        type Transaction = API.Cards.TransactionItem;
-        type FiatAccountDetails = {
-            iban: string;
-            bank_name: string;
-            swift_code: string;
-            bank_address: string;
-            receiver_name: string;
-            payment_details: string;
-            reference_number: string;
-            registration_number: string;
-        };
-        type TransactionList = {
-            count: number;
-            data: Transaction[];
-            has_more: boolean;
-        };
-        interface FiatAccount {
-            balance: number;
-            cards_count: number;
-            created_at: string;
-            currency: API.Currencies.FiatCurrency;
-            fiat_balance: number;
-            type: SubAccountType | string;
-            id: string;
-            issuing_program: API.Cards.Config.Program;
-            nick_name: string;
-            program_id: string;
-            payment_types: Array<{
-                order_type: OrderType;
-            }>;
-            realtime_auth: [
-                {
-                    crypto_token: string;
-                    fiat_account: string;
-                    id: string;
-                    priority: number;
-                }
-            ];
-            realtimeauth_balance: number;
-            status: string;
-            total_balance: number;
-            wallet_id: string;
-            account_details?: FiatAccountDetails;
-        }
-        interface FiatAccountWithCards extends FiatAccount {
-            cards: API.Cards.IssuingCardListItem[];
-        }
-    }
     namespace FiatAccountsV2 {
         type FiatAccountDetails = {
             iban: string;
@@ -809,6 +760,55 @@ export declare namespace API {
                 data: API.Cards.Config.Program[];
             };
         }
+        namespace SubAccounts {
+            type Transaction = API.Cards.TransactionItem;
+            type SubAccountDetails = {
+                iban: string;
+                bank_name: string;
+                swift_code: string;
+                bank_address: string;
+                receiver_name: string;
+                payment_details: string;
+                reference_number: string;
+                registration_number: string;
+            };
+            type TransactionList = {
+                count: number;
+                data: Transaction[];
+                has_more: boolean;
+            };
+            interface SubAccount {
+                balance: number;
+                cards_count: number;
+                created_at: string;
+                currency: API.Currencies.FiatCurrency;
+                fiat_balance: number;
+                type: SubAccountType | string;
+                id: string;
+                issuing_program: API.Cards.Config.Program;
+                nick_name: string;
+                program_id: string;
+                payment_types: Array<{
+                    order_type: OrderType;
+                }>;
+                realtime_auth: [
+                    {
+                        crypto_token: string;
+                        fiat_account: string;
+                        id: string;
+                        priority: number;
+                    }
+                ];
+                realtimeauth_balance: number;
+                status: string;
+                total_balance: number;
+                wallet_id: string;
+                account_details?: SubAccountDetails;
+            }
+            interface SubAccountWithCards extends SubAccount {
+                cards: API.Cards.IssuingCardListItem[];
+            }
+        }
     }
     namespace KYC {
         namespace Sumsub {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "squarefi-bff-api-module",
-  "version": "1.16.0",
+  "version": "1.17.0",
   "description": "Squarefi BFF API client module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/api/index.ts

@@ -2,7 +2,6 @@ import { auth } from './auth';
 import { counterparties } from './counterparties';
 import { developer } from './developer';
 import { exchange } from './exchange';
-import { fiat_accounts } from './fiat_accounts';
 import { issuing } from './issuing';
 import { kyc } from './kyc';
 import { list } from './list';
@@ -17,7 +16,6 @@ type Api = {
   counterparties: typeof counterparties;
   developer: typeof developer;
   exchange: typeof exchange;
-  fiat_accounts: typeof fiat_accounts;
   issuing: typeof issuing;
   kyc: typeof kyc;
   list: typeof list;
@@ -33,7 +31,6 @@ export const squarefi_bff_api_client: Api = {
   counterparties,
   developer,
   exchange,
-  fiat_accounts,
   issuing,
   kyc,
   list,

package/src/api/issuing.ts

@@ -1,7 +1,6 @@
 import { API } from './types';
 import { apiClientV1 } from '../utils/apiClientFactory';
 import { defaultPaginationParams } from '../constants';
-import { fiat_accounts } from './fiat_accounts';
 import { makeSecureRequest } from '../utils/encrypt';
 export const issuing = {
   cards: {
@@ -24,7 +23,7 @@ export const issuing = {
     // getById: (card_id: string) => apiClientV1.getRequest<API.Cards.IssuingCardDetailItem>(`/issuing/cards/${card_id}`),
     getById: async (card_id: string): Promise<API.Cards.IssuingCardDetailItem> => {
       const card = await apiClientV1.getRequest<API.Cards.IssuingCardDetailItem>(`/issuing/cards/${card_id}`);
-      const fiatAccountData = await fiat_accounts.getByUuid(card.fiat_account.id);
+      const fiatAccountData = await issuing.sub_accounts.getByUuid(card.fiat_account.id);
       return { ...card, fiat_account: { ...fiatAccountData, type: card.fiat_account.type } };
     },
     sensitiveData: {
@@ -94,6 +93,48 @@ export const issuing = {
         }),
     },
   },
+  sub_accounts: {
+    list: {
+      withCards: {
+        getSinglecards: (wallet_uuid: string, limit: number, offset: number) =>
+          apiClientV1.getRequest<API.Issuing.SubAccounts.SubAccountWithCards[]>(
+            `/issuing/sub_account/list/${wallet_uuid}`,
+            {
+              params: { limit, offset, lt_cards_limit: 2, gt_cards_limit: 0, show_cards: true },
+            }
+          ),
+        getAll: (wallet_uuid: string, limit: number, offset: number) =>
+          apiClientV1.getRequest<API.Issuing.SubAccounts.SubAccountWithCards[]>(
+            `/issuing/sub_account/list/${wallet_uuid}`,
+            {
+              params: { limit, offset, show_cards: true },
+            }
+          ),
+      },
+      withoutCards: {
+        getAll: (wallet_uuid: string, limit: number, offset: number) =>
+          apiClientV1.getRequest<API.Issuing.SubAccounts.SubAccount[]>(`/issuing/sub_account/list/${wallet_uuid}`, {
+            params: { limit, offset },
+          }),
+      },
+    },
+
+    getByUuid: (uuid: string) =>
+      apiClientV1.getRequest<API.Issuing.SubAccounts.SubAccount>(`/issuing/sub_account/${uuid}`),
+    create: (wallet_id: string, program_id: string) =>
+      apiClientV1.postRequest<API.Issuing.SubAccounts.SubAccount>(`/issuing/sub_account`, {
+        data: { wallet_id, program_id },
+      }),
+    transactions: {
+      get: (fiat_account_id: string, limit?: number, offset?: number) =>
+        apiClientV1.getRequest<API.Issuing.SubAccounts.TransactionList>(
+          `/issuing/sub_account/${fiat_account_id}/transactions`,
+          {
+            params: { limit, offset },
+          }
+        ),
+    },
+  },
   config: {
     programs: {
       getAll: () =>

package/src/api/types.ts

@@ -217,7 +217,7 @@ export namespace API {
       wallet_id: string;
       program_id: string;
 
-      fiat_account: API.FiatAccounts.FiatAccount;
+      fiat_account: API.Issuing.SubAccounts.SubAccount;
       last4: string;
       request_id: string;
       name_on_card: string | null;
@@ -230,7 +230,7 @@ export namespace API {
       id: string;
       brand: string;
       card_id: string;
-      fiat_account: API.FiatAccounts.FiatAccount;
+      fiat_account: API.Issuing.SubAccounts.SubAccount;
       last4: string;
       card_status: string;
       form_factor: string;
@@ -766,56 +766,6 @@ export namespace API {
     }
   }
 
-  export namespace FiatAccounts {
-    export type Transaction = API.Cards.TransactionItem;
-    export type FiatAccountDetails = {
-      iban: string;
-      bank_name: string;
-      swift_code: string;
-      bank_address: string;
-      receiver_name: string;
-      payment_details: string;
-      reference_number: string;
-      registration_number: string;
-    };
-
-    export type TransactionList = {
-      count: number;
-      data: Transaction[];
-      has_more: boolean;
-    };
-    export interface FiatAccount {
-      balance: number;
-      cards_count: number;
-      created_at: string;
-      currency: API.Currencies.FiatCurrency;
-      fiat_balance: number;
-      type: SubAccountType | string;
-      id: string;
-      issuing_program: API.Cards.Config.Program;
-      nick_name: string;
-      program_id: string;
-      payment_types: Array<{ order_type: OrderType }>;
-      realtime_auth: [
-        {
-          crypto_token: string;
-          fiat_account: string;
-          id: string;
-          priority: number;
-        }
-      ];
-      realtimeauth_balance: number;
-      status: string;
-      total_balance: number;
-      wallet_id: string;
-      account_details?: FiatAccountDetails;
-    }
-
-    export interface FiatAccountWithCards extends FiatAccount {
-      cards: API.Cards.IssuingCardListItem[];
-    }
-  }
-
   export namespace FiatAccountsV2 {
     export type FiatAccountDetails = {
       iban: string;
@@ -962,6 +912,56 @@ export namespace API {
         data: API.Cards.Config.Program[];
       };
     }
+
+    export namespace SubAccounts {
+      export type Transaction = API.Cards.TransactionItem;
+      export type SubAccountDetails = {
+        iban: string;
+        bank_name: string;
+        swift_code: string;
+        bank_address: string;
+        receiver_name: string;
+        payment_details: string;
+        reference_number: string;
+        registration_number: string;
+      };
+
+      export type TransactionList = {
+        count: number;
+        data: Transaction[];
+        has_more: boolean;
+      };
+      export interface SubAccount {
+        balance: number;
+        cards_count: number;
+        created_at: string;
+        currency: API.Currencies.FiatCurrency;
+        fiat_balance: number;
+        type: SubAccountType | string;
+        id: string;
+        issuing_program: API.Cards.Config.Program;
+        nick_name: string;
+        program_id: string;
+        payment_types: Array<{ order_type: OrderType }>;
+        realtime_auth: [
+          {
+            crypto_token: string;
+            fiat_account: string;
+            id: string;
+            priority: number;
+          }
+        ];
+        realtimeauth_balance: number;
+        status: string;
+        total_balance: number;
+        wallet_id: string;
+        account_details?: SubAccountDetails;
+      }
+
+      export interface SubAccountWithCards extends SubAccount {
+        cards: API.Cards.IssuingCardListItem[];
+      }
+    }
   }
 
   export namespace KYC {

package/src/api/fiat_accounts.ts

@@ -1,69 +0,0 @@
-import { API } from './types';
-
-import { apiClientV2, apiClientV1 } from '../utils/apiClientFactory';
-
-export const fiat_accounts_v2 = {
-  list: {
-    withCards: {
-      getAll: (wallet_uuid: string, limit: number, offset: number) =>
-        apiClientV2.getRequest<API.FiatAccountsV2.FiatAccountsListWithCards>(`/fiat-accounts/${wallet_uuid}`, {
-          params: { limit, offset, show_cards: true },
-        }),
-    },
-    withoutCards: {
-      getAll: (wallet_uuid: string, limit: number, offset: number) =>
-        apiClientV2.getRequest<API.FiatAccountsV2.FiatAccountsListWithoutCards>(`/fiat-accounts/${wallet_uuid}`, {
-          params: { limit, offset },
-        }),
-    },
-  },
-
-  getByUuid: ({ wallet_uuid, fiat_account_id }: API.FiatAccountsV2.ExtendedFiatAccount.Request) =>
-    apiClientV2.getRequest<API.FiatAccountsV2.ExtendedFiatAccount.Response>(
-      `/fiat-accounts/${wallet_uuid}/${fiat_account_id}`
-    ),
-  create: ({ wallet_id, program_id }: API.FiatAccountsV2.CreateFiatAccount.Request) =>
-    apiClientV2.postRequest<API.FiatAccountsV2.CreateFiatAccount.Response>(`/fiat-accounts/${wallet_id}`, {
-      data: { program_id },
-    }),
-  transactions: {
-    get: ({ fiat_account_id, wallet_uuid, limit, offset }: API.FiatAccountsV2.Transactions.TransactionList.Request) =>
-      apiClientV2.getRequest<API.FiatAccountsV2.Transactions.TransactionList.Response>(
-        `/fiat-accounts/${wallet_uuid}/${fiat_account_id}/transactions`,
-        {
-          params: { limit, offset },
-        }
-      ),
-  },
-};
-
-export const fiat_accounts = {
-  list: {
-    withCards: {
-      getSinglecards: (wallet_uuid: string, limit: number, offset: number) =>
-        apiClientV1.getRequest<API.FiatAccounts.FiatAccountWithCards[]>(`/fiat_accounts/list/${wallet_uuid}`, {
-          params: { limit, offset, lt_cards_limit: 2, gt_cards_limit: 0, show_cards: true },
-        }),
-      getAll: (wallet_uuid: string, limit: number, offset: number) =>
-        apiClientV1.getRequest<API.FiatAccounts.FiatAccountWithCards[]>(`/fiat_accounts/list/${wallet_uuid}`, {
-          params: { limit, offset, show_cards: true },
-        }),
-    },
-    withoutCards: {
-      getAll: (wallet_uuid: string, limit: number, offset: number) =>
-        apiClientV1.getRequest<API.FiatAccounts.FiatAccount[]>(`/fiat_accounts/list/${wallet_uuid}`, {
-          params: { limit, offset },
-        }),
-    },
-  },
-
-  getByUuid: (uuid: string) => apiClientV1.getRequest<API.FiatAccounts.FiatAccount>(`/fiat_accounts/${uuid}`),
-  create: (wallet_id: string, program_id: string) =>
-    apiClientV1.postRequest<API.FiatAccounts.FiatAccount>(`/fiat_accounts`, { data: { wallet_id, program_id } }),
-  transactions: {
-    get: (fiat_account_id: string, limit?: number, offset?: number) =>
-      apiClientV1.getRequest<API.FiatAccounts.TransactionList>(`/fiat_accounts/${fiat_account_id}/transactions`, {
-        params: { limit, offset },
-      }),
-  },
-};