squarefi-bff-api-module 1.17.0 → 1.17.2

package/CHANGELOG.md

@@ -5,6 +5,18 @@ 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.2] - 2025-04-18
+
+### Changed
+
+- Renamed fiat account references to sub account in API documentation and types
+
+## [1.17.1] - 2025-04-18
+
+### Changed
+
+- Updated crypto addresses generation endpoints to support tenant-specific processing configuration
+
 ## [1.17.0] - 2025-04-18
 
 ### Changed

package/README.md

@@ -74,10 +74,6 @@ Access different API functionalities through the client:
 - `squarefi_bff_api_client.exchange` - Currency exchange operations
   - Get exchange rates by order type
   - Get rates by currency
-- `squarefi_bff_api_client.fiat_accounts` - Fiat account management
-  - List accounts with/without cards
-  - Create and manage fiat accounts
-  - Transaction history
 - `squarefi_bff_api_client.issuing` - Card issuing operations
   - Create and manage cards
   - Card limits and controls

package/dist/api/issuing.d.ts

@@ -3,12 +3,12 @@ export declare const issuing: {
     cards: {
         create: {
             standAloneCard: (data: API.Cards.Create.StandAloneRequest) => Promise<API.Cards.IssuingCardDetailItem>;
-            fiatAccountCard: (data: API.Cards.Create.FiatAccountRequest) => Promise<API.Cards.IssuingCardDetailItem>;
+            subAccountCard: (data: API.Cards.Create.SubAccountRequest) => Promise<API.Cards.IssuingCardDetailItem>;
         };
         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>;
-            getByFiatAccount: (params: API.Cards.CardsList.Request.ByFiatAccountAndWalletId) => Promise<API.Cards.CardsList.Response>;
+            getBySubAccount: (params: API.Cards.CardsList.Request.BySubAccountAndWalletId) => Promise<API.Cards.CardsList.Response>;
         };
         getById: (card_id: string) => Promise<API.Cards.IssuingCardDetailItem>;
         sensitiveData: {
@@ -31,10 +31,10 @@ export declare const issuing: {
     };
     transactions: {
         getByCardId: (card_id: string, limit?: number, offset?: number) => Promise<API.Cards.TransactionsList>;
-        getByFiatAccountId: (fiat_account_id: string, limit?: number, offset?: number) => Promise<API.Cards.TransactionsList>;
+        getBySubAccountId: (fiat_account_id: string, limit?: number, offset?: number) => Promise<API.Cards.TransactionsList>;
         csv: {
             getByCardId: (card_id: string) => Promise<string>;
-            getByFiatAccountId: (fiat_account_id: string) => Promise<string>;
+            getBySubAccountId: (fiat_account_id: string) => Promise<string>;
         };
     };
     sub_accounts: {

package/dist/api/issuing.js

@@ -17,20 +17,20 @@ exports.issuing = {
     cards: {
         create: {
             standAloneCard: (data) => apiClientFactory_1.apiClientV1.postRequest('/issuing/cards/create', { data }),
-            fiatAccountCard: (data) => apiClientFactory_1.apiClientV1.postRequest('/issuing/cards/balance', { data }),
+            subAccountCard: (data) => apiClientFactory_1.apiClientV1.postRequest('/issuing/cards/balance', { data }),
         },
         byWalletUuid: {
             getAll: (params) => apiClientFactory_1.apiClientV1.getRequest('/issuing/cards', { params }),
             getBySubaccountType: (params) => apiClientFactory_1.apiClientV1.getRequest('/issuing/cards', {
                 params,
             }),
-            getByFiatAccount: (params) => apiClientFactory_1.apiClientV1.getRequest('/issuing/cards', { params }),
+            getBySubAccount: (params) => apiClientFactory_1.apiClientV1.getRequest('/issuing/cards', { params }),
         },
         // 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 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 }) });
+            const subAccountData = yield exports.issuing.sub_accounts.getByUuid(card.fiat_account.id);
+            return Object.assign(Object.assign({}, card), { fiat_account: Object.assign(Object.assign({}, subAccountData), { type: card.fiat_account.type }) });
         }),
         sensitiveData: {
             // get: (card_id: string) => apiClientV1.getRequest<API.Cards.SensitiveData>(`/issuing/cards/${card_id}/sensitive`), deprecated from v1.13.1
@@ -71,14 +71,14 @@ exports.issuing = {
         getByCardId: (card_id, limit = constants_1.defaultPaginationParams.limit, offset = constants_1.defaultPaginationParams.offset) => apiClientFactory_1.apiClientV1.getRequest(`/issuing/transactions/`, {
             params: { limit, offset, card_id, new_scheme: true },
         }),
-        getByFiatAccountId: (fiat_account_id, limit = constants_1.defaultPaginationParams.limit, offset = constants_1.defaultPaginationParams.offset) => apiClientFactory_1.apiClientV1.getRequest(`/issuing/transactions/`, {
+        getBySubAccountId: (fiat_account_id, limit = constants_1.defaultPaginationParams.limit, offset = constants_1.defaultPaginationParams.offset) => apiClientFactory_1.apiClientV1.getRequest(`/issuing/transactions/`, {
             params: { limit, offset, fiat_account_id, new_scheme: true },
         }),
         csv: {
             getByCardId: (card_id) => apiClientFactory_1.apiClientV1.getRequest(`/issuing/transactions/csv`, {
                 params: { card_id },
             }),
-            getByFiatAccountId: (fiat_account_id) => apiClientFactory_1.apiClientV1.getRequest(`/issuing/transactions/csv`, {
+            getBySubAccountId: (fiat_account_id) => apiClientFactory_1.apiClientV1.getRequest(`/issuing/transactions/csv`, {
                 params: { fiat_account_id },
             }),
         },

package/dist/api/types.d.ts

@@ -209,7 +209,7 @@ export declare namespace API {
             issuing_programs: API.Cards.Config.Program;
             limits: API.Cards.Limits.Limits;
         }
-        interface FiatAccountCardListItem {
+        interface SubAccountCardListItem {
             type: string;
             brand: string;
             last4: string;
@@ -240,7 +240,7 @@ export declare namespace API {
                 interface BySubaccountAndWalletUuid extends ByWalletUuid {
                     filter?: Record<'fiat_account', Record<'type', SubAccountType>>;
                 }
-                type ByFiatAccountAndWalletId = ByWalletUuid & {
+                type BySubAccountAndWalletId = ByWalletUuid & {
                     fiat_account_id: string;
                 };
             }
@@ -311,11 +311,11 @@ export declare namespace API {
                 currency_id?: string;
             }
             type StandAloneRequest = CommonRequest;
-            interface FiatAccountRequest extends CommonRequest {
+            interface SubAccountRequest extends CommonRequest {
                 sub_account_id: string;
             }
             type StandAloneResponse = IssuingCardDetailItem;
-            type FiatAccountResponse = IssuingCardDetailItem;
+            type SubAccountResponse = IssuingCardDetailItem;
         }
     }
     namespace Chains {
@@ -623,8 +623,8 @@ export declare namespace API {
             onramp_enabled: boolean;
         }
     }
-    namespace FiatAccountsV2 {
-        type FiatAccountDetails = {
+    namespace SubAccountsV2 {
+        type SubAccountDetails = {
             iban: string;
             bank_name: string;
             swift_code: string;
@@ -634,7 +634,7 @@ export declare namespace API {
             reference_number: string;
             registration_number: string;
         };
-        interface FiatAccount {
+        interface SubAccount {
             balance: number;
             cards_count: number;
             created_at: string;
@@ -649,9 +649,9 @@ export declare namespace API {
             total_balance: number;
             wallet_id: string;
         }
-        namespace ExtendedFiatAccount {
-            interface ExtendedFiatAccount extends FiatAccount {
-                account_details?: FiatAccountDetails;
+        namespace ExtendedSubAccount {
+            interface ExtendedSubAccount extends SubAccount {
+                account_details?: SubAccountDetails;
                 payment_types: Array<{
                     order_type: OrderType;
                 }>;
@@ -668,18 +668,18 @@ export declare namespace API {
                 wallet_uuid: string;
                 fiat_account_id: string;
             }
-            type Response = ExtendedFiatAccount;
+            type Response = ExtendedSubAccount;
         }
-        interface FiatAccountWithCards extends FiatAccount {
+        interface SubAccountWithCards extends SubAccount {
             cards: API.Cards.IssuingCardListItem[];
         }
-        interface FiatAccountsList<T extends FiatAccount | FiatAccountWithCards> {
+        interface SubAccountsList<T extends SubAccount | SubAccountWithCards> {
             count: number;
             data: T[];
         }
-        type FiatAccountsListWithCards = FiatAccountsList<FiatAccountWithCards>;
-        type FiatAccountsListWithoutCards = FiatAccountsList<FiatAccount>;
-        namespace CreateFiatAccount {
+        type SubAccountsListWithCards = SubAccountsList<SubAccountWithCards>;
+        type SubAccountsListWithoutCards = SubAccountsList<SubAccount>;
+        namespace CreateSubAccount {
             interface Request {
                 wallet_id: string;
                 program_id: string;

package/dist/api/wallets.js

@@ -28,7 +28,7 @@ exports.wallets = {
     getAll: () => apiClientFactory_1.apiClientV2.getRequest('/wallets'),
     getByUuid: (uuid) => apiClientFactory_1.apiClientV2.getRequest(`/wallets/${uuid}`),
     addresses: {
-        create: ({ wallet_uuid, chain, label }) => apiClientFactory_1.apiClientV2.postRequest(`/wallets/${wallet_uuid}/addresses/${chain}`, {
+        create: ({ wallet_uuid, chain, label }) => apiClientFactory_1.apiClientV1.postRequest(`/wallets/${wallet_uuid}/addresses/${chain}`, {
             data: { label },
         }),
         get: {

package/dist/constants.d.ts

@@ -129,7 +129,7 @@ export declare enum IssuingProgramStatus {
     ACTIVE = "ACTIVE",
     ARCHIVED = "ARCHIVED"
 }
-export declare enum FiatAccountStatus {
+export declare enum SubAccountStatus {
     ACTIVE = "ACTIVE",
     BLOCKED = "BLOCKED",
     INACTIVE = "INACTIVE",

package/dist/constants.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CounterpartyDestinationType = exports.CounterpartyType = exports.SortingDirection = exports.APIKeyRole = exports.OrderType = exports.CurrencyType = exports.SubAccountType = exports.FiatAccountStatus = exports.IssuingProgramStatus = exports.CardStatus = exports.OrderStatuses = exports.KYCStatuses = exports.defaultPaginationParams = exports.walletType = exports.WalletTypeValues = exports.ResponseStatus = exports.RequestLoadingType = exports.RequestStatus = exports.WalletTransactionRecordType = exports.WalletTransactionStatus = exports.WalletTransactionMethod = exports.WalletTransactionType = exports.CardTransactionType = exports.CardType = exports.CardFormFactor = exports.AppEnviroment = exports.falsyValues = void 0;
+exports.CounterpartyDestinationType = exports.CounterpartyType = exports.SortingDirection = exports.APIKeyRole = exports.OrderType = exports.CurrencyType = exports.SubAccountType = exports.SubAccountStatus = exports.IssuingProgramStatus = exports.CardStatus = exports.OrderStatuses = exports.KYCStatuses = exports.defaultPaginationParams = exports.walletType = exports.WalletTypeValues = exports.ResponseStatus = exports.RequestLoadingType = exports.RequestStatus = exports.WalletTransactionRecordType = exports.WalletTransactionStatus = exports.WalletTransactionMethod = exports.WalletTransactionType = exports.CardTransactionType = exports.CardType = exports.CardFormFactor = exports.AppEnviroment = exports.falsyValues = void 0;
 exports.falsyValues = ['false', '0', '', 'FALSE', false, null, undefined, NaN, 0];
 var AppEnviroment;
 (function (AppEnviroment) {
@@ -149,13 +149,13 @@ var IssuingProgramStatus;
     IssuingProgramStatus["ACTIVE"] = "ACTIVE";
     IssuingProgramStatus["ARCHIVED"] = "ARCHIVED";
 })(IssuingProgramStatus || (exports.IssuingProgramStatus = IssuingProgramStatus = {}));
-var FiatAccountStatus;
-(function (FiatAccountStatus) {
-    FiatAccountStatus["ACTIVE"] = "ACTIVE";
-    FiatAccountStatus["BLOCKED"] = "BLOCKED";
-    FiatAccountStatus["INACTIVE"] = "INACTIVE";
-    FiatAccountStatus["CANCELED"] = "CANCELED";
-})(FiatAccountStatus || (exports.FiatAccountStatus = FiatAccountStatus = {}));
+var SubAccountStatus;
+(function (SubAccountStatus) {
+    SubAccountStatus["ACTIVE"] = "ACTIVE";
+    SubAccountStatus["BLOCKED"] = "BLOCKED";
+    SubAccountStatus["INACTIVE"] = "INACTIVE";
+    SubAccountStatus["CANCELED"] = "CANCELED";
+})(SubAccountStatus || (exports.SubAccountStatus = SubAccountStatus = {}));
 var SubAccountType;
 (function (SubAccountType) {
     SubAccountType["PREPAID"] = "prepaid";

package/package.json

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

package/src/api/issuing.ts

@@ -7,8 +7,8 @@ export const issuing = {
     create: {
       standAloneCard: (data: API.Cards.Create.StandAloneRequest) =>
         apiClientV1.postRequest<API.Cards.Create.StandAloneResponse>('/issuing/cards/create', { data }),
-      fiatAccountCard: (data: API.Cards.Create.FiatAccountRequest) =>
-        apiClientV1.postRequest<API.Cards.Create.FiatAccountResponse>('/issuing/cards/balance', { data }),
+      subAccountCard: (data: API.Cards.Create.SubAccountRequest) =>
+        apiClientV1.postRequest<API.Cards.Create.SubAccountResponse>('/issuing/cards/balance', { data }),
     },
     byWalletUuid: {
       getAll: (params: API.Cards.CardsList.Request.ByWalletUuid) =>
@@ -17,14 +17,14 @@ export const issuing = {
         apiClientV1.getRequest<API.Cards.CardsList.Response>('/issuing/cards', {
           params,
         }),
-      getByFiatAccount: (params: API.Cards.CardsList.Request.ByFiatAccountAndWalletId) =>
+      getBySubAccount: (params: API.Cards.CardsList.Request.BySubAccountAndWalletId) =>
         apiClientV1.getRequest<API.Cards.CardsList.Response>('/issuing/cards', { params }),
     },
     // 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 issuing.sub_accounts.getByUuid(card.fiat_account.id);
-      return { ...card, fiat_account: { ...fiatAccountData, type: card.fiat_account.type } };
+      const subAccountData = await issuing.sub_accounts.getByUuid(card.fiat_account.id);
+      return { ...card, fiat_account: { ...subAccountData, type: card.fiat_account.type } };
     },
     sensitiveData: {
       // get: (card_id: string) => apiClientV1.getRequest<API.Cards.SensitiveData>(`/issuing/cards/${card_id}/sensitive`), deprecated from v1.13.1
@@ -74,7 +74,7 @@ export const issuing = {
       apiClientV1.getRequest<API.Cards.TransactionsList>(`/issuing/transactions/`, {
         params: { limit, offset, card_id, new_scheme: true },
       }),
-    getByFiatAccountId: (
+    getBySubAccountId: (
       fiat_account_id: string,
       limit = defaultPaginationParams.limit,
       offset = defaultPaginationParams.offset
@@ -87,7 +87,7 @@ export const issuing = {
         apiClientV1.getRequest<string>(`/issuing/transactions/csv`, {
           params: { card_id },
         }),
-      getByFiatAccountId: (fiat_account_id: string) =>
+      getBySubAccountId: (fiat_account_id: string) =>
         apiClientV1.getRequest<string>(`/issuing/transactions/csv`, {
           params: { fiat_account_id },
         }),

package/src/api/types.ts

@@ -243,7 +243,7 @@ export namespace API {
       limits: API.Cards.Limits.Limits;
     }
 
-    export interface FiatAccountCardListItem {
+    export interface SubAccountCardListItem {
       type: string;
       brand: string;
       last4: string;
@@ -283,7 +283,7 @@ export namespace API {
           filter?: Record<'fiat_account', Record<'type', SubAccountType>>;
         }
 
-        export type ByFiatAccountAndWalletId = ByWalletUuid & {
+        export type BySubAccountAndWalletId = ByWalletUuid & {
           fiat_account_id: string;
         };
       }
@@ -363,12 +363,12 @@ export namespace API {
       }
       export type StandAloneRequest = CommonRequest;
 
-      export interface FiatAccountRequest extends CommonRequest {
+      export interface SubAccountRequest extends CommonRequest {
         sub_account_id: string;
       }
 
       export type StandAloneResponse = IssuingCardDetailItem;
-      export type FiatAccountResponse = IssuingCardDetailItem;
+      export type SubAccountResponse = IssuingCardDetailItem;
     }
   }
 
@@ -766,8 +766,8 @@ export namespace API {
     }
   }
 
-  export namespace FiatAccountsV2 {
-    export type FiatAccountDetails = {
+  export namespace SubAccountsV2 {
+    export type SubAccountDetails = {
       iban: string;
       bank_name: string;
       swift_code: string;
@@ -778,7 +778,7 @@ export namespace API {
       registration_number: string;
     };
 
-    export interface FiatAccount {
+    export interface SubAccount {
       balance: number;
       cards_count: number;
       created_at: string;
@@ -794,9 +794,9 @@ export namespace API {
       wallet_id: string;
     }
 
-    export namespace ExtendedFiatAccount {
-      export interface ExtendedFiatAccount extends FiatAccount {
-        account_details?: FiatAccountDetails;
+    export namespace ExtendedSubAccount {
+      export interface ExtendedSubAccount extends SubAccount {
+        account_details?: SubAccountDetails;
         payment_types: Array<{ order_type: OrderType }>;
         realtime_auth: [
           {
@@ -812,22 +812,22 @@ export namespace API {
         fiat_account_id: string;
       }
 
-      export type Response = ExtendedFiatAccount;
+      export type Response = ExtendedSubAccount;
     }
 
-    export interface FiatAccountWithCards extends FiatAccount {
+    export interface SubAccountWithCards extends SubAccount {
       cards: API.Cards.IssuingCardListItem[];
     }
 
-    export interface FiatAccountsList<T extends FiatAccount | FiatAccountWithCards> {
+    export interface SubAccountsList<T extends SubAccount | SubAccountWithCards> {
       count: number;
       data: T[];
     }
 
-    export type FiatAccountsListWithCards = FiatAccountsList<FiatAccountWithCards>;
-    export type FiatAccountsListWithoutCards = FiatAccountsList<FiatAccount>;
+    export type SubAccountsListWithCards = SubAccountsList<SubAccountWithCards>;
+    export type SubAccountsListWithoutCards = SubAccountsList<SubAccount>;
 
-    export namespace CreateFiatAccount {
+    export namespace CreateSubAccount {
       export interface Request {
         wallet_id: string;
         program_id: string;
@@ -1191,7 +1191,7 @@ export namespace API {
     //         }
     //       }
 
-    //       export namespace FiatAccount {
+    //       export namespace SubAccount {
     //         export type Request = {
     //           amount: number;
     //           fiat_uuid: string;

package/src/api/wallets.ts

@@ -10,7 +10,7 @@ export const wallets = {
   getByUuid: (uuid: string) => apiClientV2.getRequest<API.Wallets.Wallet>(`/wallets/${uuid}`),
   addresses: {
     create: ({ wallet_uuid, chain, label }: API.Wallets.WalletChain.Create.Request) =>
-      apiClientV2.postRequest<API.Wallets.WalletChain.Create.Response>(`/wallets/${wallet_uuid}/addresses/${chain}`, {
+      apiClientV1.postRequest<API.Wallets.WalletChain.Create.Response>(`/wallets/${wallet_uuid}/addresses/${chain}`, {
         data: { label },
       }),
     get: {

package/src/constants.ts

@@ -158,7 +158,7 @@ export enum IssuingProgramStatus {
   ARCHIVED = 'ARCHIVED',
 }
 
-export enum FiatAccountStatus {
+export enum SubAccountStatus {
   ACTIVE = 'ACTIVE',
   BLOCKED = 'BLOCKED',
   INACTIVE = 'INACTIVE',