squarefi-bff-api-module 1.36.56 → 1.36.58

package/README.md

@@ -1,6 +1,6 @@
 # Squarefi BFF API SDK
 
-A fully-typed TypeScript / JavaScript SDK for effortless interaction with the Squarefi **Back-For-Front** (BFF) API.
+A fully-typed TypeScript / JavaScript SDK for effortless interaction with the Squarefi **Back-For-Front** (BFF) API
 
 ---
 

package/dist/api/counterparties.d.ts

@@ -1,6 +1,7 @@
 import { API } from './types/types';
 export declare const counterparties: {
     getAll: ({ wallet_id, ...params }: API.Counterparties.List.Request) => Promise<API.Counterparties.List.Response>;
+    getAllWithDestinations: ({ wallet_id, ...params }: API.Counterparties.ListWithDestinations.Request) => Promise<API.Counterparties.ListWithDestinations.Response>;
     getById: ({ counterparty_account_id, }: API.Counterparties.GetById.Request) => Promise<API.Counterparties.GetById.Response>;
     create: ({ wallet_id, ...data }: API.Counterparties.Create.Request) => Promise<API.Counterparties.Create.Response>;
     update: ({ counterparty_account_id, wallet_id: _wallet_id, ...data }: API.Counterparties.Update.Request) => Promise<API.Counterparties.Update.Response>;

package/dist/api/counterparties.js

@@ -23,6 +23,22 @@ export const counterparties = {
         const res = await apiClientV1Frontend.getRequest(`/frontend/counterparty/accounts/wallet/${wallet_id}`, { params });
         return { total: res.pagination?.total ?? res.data.length, data: res.data };
     },
+    // Тот же роут, что getAll, но с include=destinations: бэкенд вкладывает активные реквизиты
+    // в строки листинга, и экран узнаёт состав реквизитов всех контрагентов одним запросом вместо
+    // одного запроса на контрагента. Флаг проставляется здесь и снаружи не принимается — иначе
+    // вызов с ним вернул бы реквизиты в рантайме, а тип листинга остался бы без них.
+    // destinations читаем строго, как в getById: подстановка [] на отсутствующий ключ выдала бы
+    // «реквизитов нет» для всех контрагентов сразу и скрыла бы бэкенд, не поддержавший флаг.
+    getAllWithDestinations: async ({ wallet_id, ...params }) => {
+        const res = await apiClientV1Frontend.getRequest(`/frontend/counterparty/accounts/wallet/${wallet_id}`, { params: { ...params, include: 'destinations' } });
+        return {
+            total: res.pagination?.total ?? res.data.length,
+            data: res.data.map(({ destinations, ...account }) => ({
+                ...account,
+                destinations: destinations.map(mapDestination),
+            })),
+        };
+    },
     getById: async ({ counterparty_account_id, }) => {
         const res = await apiClientV1Frontend.getRequest(`/frontend/counterparty/accounts/${counterparty_account_id}`);
         const { destinations, ...account } = res.data.account;

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

@@ -6525,6 +6525,15 @@ export interface paths {
                         "application/json": components["schemas"]["ApiErrorResponse"];
                     };
                 };
+                /** @description KYC rail gate failed (KYC-enabled tenants) — `RAIL_NOT_CONFIGURED`, `RAIL_NOT_ENABLED`, `DEPOSITS_DISABLED`, `WALLET_RAIL_NOT_ONBOARDED` or `WALLET_RAIL_NOT_APPROVED`: the program's rail must be enabled and the wallet APPROVED on it */
+                422: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ApiErrorResponse"];
+                    };
+                };
                 /** @description Server error */
                 500: {
                     headers: {
@@ -7659,8 +7668,6 @@ export interface components {
         };
         /** @description Bank/beneficiary postal address */
         BankingAddress: {
-            /** Format: uuid */
-            id?: string;
             /** @description Country ID reference */
             country_id?: number | null;
             city?: string | null;
@@ -7671,8 +7678,6 @@ export interface components {
         } | null;
         /** @description Banking destination details (for SWIFT, SEPA, ACH, Wire, etc.) */
         BankingData: {
-            /** Format: uuid */
-            id?: string;
             /** @description Bank account number */
             account_number?: string | null;
             /** @description Routing/sort code */
@@ -7705,8 +7710,6 @@ export interface components {
         };
         /** @description Crypto destination details (for CRYPTO_EXTERNAL, CRYPTO_INTERNAL) */
         CryptoData: {
-            /** Format: uuid */
-            id?: string;
             /** @description Blockchain address */
             address: string;
             /**
@@ -7764,7 +7767,21 @@ export interface components {
             banking_data?: components["schemas"]["BankingData"];
             crypto_data?: components["schemas"]["CryptoData"];
             internal_data?: components["schemas"]["CounterpartyInternalData"];
+            counterparty_account?: components["schemas"]["CounterpartyAccountRef"];
         };
+        /** @description Owning counterparty account, embedded on destination reads; absent on create/update. */
+        CounterpartyAccountRef: {
+            /** Format: uuid */
+            id: string;
+            name: string;
+            /** @enum {string} */
+            type: "BUSINESS" | "INDIVIDUAL";
+            /** Format: uuid */
+            wallet_id?: string | null;
+            nickname?: string | null;
+            email?: string | null;
+            phone?: string | null;
+        } | null;
         ApiSuccessResponse: {
             /** @example true */
             success: boolean;

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

@@ -1064,6 +1064,8 @@ export interface paths {
                     sort_by?: "created_at" | "type" | "name" | "nickname" | "email" | "phone";
                     /** @description Sort direction (defaults to ASC). Ignored without `sort_by`. */
                     sort_order?: "ASC" | "DESC";
+                    /** @description Embed each account's active destinations in the list rows. Omit it and the response is unchanged. With `destinations` every row carries a `destinations` array — empty when the account has none, so "no payment details" is distinguishable from "not loaded". Pagination keeps counting accounts, and the embed combines with `search` / `type` / `sort_by` / `sort_order`. */
+                    include?: "destinations";
                 };
                 header?: never;
                 path: {
@@ -1073,7 +1075,7 @@ export interface paths {
             };
             requestBody?: never;
             responses: {
-                /** @description Accounts list */
+                /** @description Accounts list. Rows carry their destinations only when `include=destinations` was requested. */
                 200: {
                     headers: {
                         [name: string]: unknown;
@@ -1082,7 +1084,7 @@ export interface paths {
                         "application/json": {
                             /** @example true */
                             success: boolean;
-                            data: components["schemas"]["CounterpartyAccount"][];
+                            data: (components["schemas"]["CounterpartyAccount"] | components["schemas"]["CounterpartyAccountWithDestinations"])[];
                             pagination?: components["schemas"]["PaginationResponse"];
                         };
                     };
@@ -6536,6 +6538,15 @@ export interface paths {
                         "application/json": components["schemas"]["ErrorResponse"];
                     };
                 };
+                /** @description A recipient is not in the wallet's address book (DESTINATION_NOT_FOUND, details.destination_ids) */
+                404: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ErrorResponse"];
+                    };
+                };
             };
         };
         delete?: never;
@@ -6630,7 +6641,7 @@ export interface paths {
                         };
                     };
                 };
-                /** @description Template not found */
+                /** @description Template not found, or a recipient is not in the wallet's address book (DESTINATION_NOT_FOUND, details.destination_ids) */
                 404: {
                     headers: {
                         [name: string]: unknown;
@@ -6770,7 +6781,14 @@ export interface paths {
             requestBody: {
                 content: {
                     "application/json": {
-                        /** Format: uuid */
+                        /**
+                         * Format: uuid
+                         * @description Batch source currency. Crypto recipients are paid with it
+                         *     on-chain, so it must be an on-chain asset; a fiat source
+                         *     currency cannot fund crypto recipients. Preview reports such
+                         *     a row as a problem and submit/approve refuse the batch.
+                         *
+                         */
                         currency_id: string;
                         /** Format: uuid */
                         virtual_account_id?: string;
@@ -6816,6 +6834,15 @@ export interface paths {
                         "application/json": components["schemas"]["ErrorResponse"];
                     };
                 };
+                /** @description A recipient is not in the wallet's address book (DESTINATION_NOT_FOUND, details.destination_ids) */
+                404: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ErrorResponse"];
+                    };
+                };
                 /** @description Rate limit exceeded */
                 429: {
                     headers: {
@@ -6854,7 +6881,7 @@ export interface paths {
             };
             requestBody?: never;
             responses: {
-                /** @description Batch details with progress counters and totals */
+                /** @description Batch details with progress counters and totals, plus the in-flight count and the per-destination-type breakdown (whole batch, independent of the item list paging) */
                 200: {
                     headers: {
                         [name: string]: unknown;
@@ -6863,7 +6890,7 @@ export interface paths {
                         "application/json": {
                             /** @example true */
                             success?: boolean;
-                            data?: components["schemas"]["MassPayout"];
+                            data?: components["schemas"]["MassPayoutDetail"];
                         };
                     };
                 };
@@ -6919,6 +6946,15 @@ export interface paths {
                         };
                     };
                 };
+                /** @description Mass payout not found, or a recipient is not in the wallet's address book (DESTINATION_NOT_FOUND, details.destination_ids) */
+                404: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ErrorResponse"];
+                    };
+                };
                 /** @description Batch is not editable anymore (already submitted) */
                 409: {
                     headers: {
@@ -6946,7 +6982,7 @@ export interface paths {
         };
         /**
          * List items of a mass payout
-         * @description Items in upload order, paginated with limit/offset like the batch list. The optional status filter narrows the tracker view (e.g. failed rows only).
+         * @description Items in upload order, paginated with limit/offset like the batch list. The optional status filter narrows the tracker view (e.g. failed rows only). Every row carries the address-book destination it pays (with its owning account), joined in the same query — a batch page needs no address-book lookups.
          */
         get: {
             parameters: {
@@ -10308,7 +10344,7 @@ export interface paths {
                         "application/json": components["schemas"]["ErrorResponse"];
                     };
                 };
-                /** @description Rail pre-check failed — `VENDOR_NOT_CONFIGURED`, `RAIL_NOT_CONFIGURED`, `DEPOSITS_DISABLED`, `WALLET_RAIL_NOT_ONBOARDED` or `WALLET_RAIL_NOT_APPROVED` */
+                /** @description KYC rail gate failed (KYC-enabled tenants, demo programs included) — `VENDOR_NOT_CONFIGURED`, `RAIL_NOT_CONFIGURED`, `RAIL_NOT_ENABLED`, `DEPOSITS_DISABLED`, `WALLET_RAIL_NOT_ONBOARDED`, `WALLET_RAIL_NOT_APPROVED` or `RAIL_GATE_CHECK_FAILED` */
                 422: {
                     headers: {
                         [name: string]: unknown;
@@ -12535,6 +12571,10 @@ export interface paths {
                                      * @enum {string}
                                      */
                                     identity_verification_status?: "APPROVED" | "DECLINED" | "PENDING" | "PROCESSING" | "HOLD" | "NEEDS_ATTENTION" | "DOUBLE" | "SOFT_REJECT" | "REJECT" | "UNVERIFIED" | "WAITING_ON_UBOS" | "WAITING_ON_REVIEW";
+                                    /** @description The member deleted their account. They keep their row and role in the
+                                     *     team, but have no access and receive no notifications.
+                                     *      */
+                                    is_deleted?: boolean;
                                 };
                             }[];
                             pagination?: components["schemas"]["PaginationResponse"];
@@ -13441,6 +13481,11 @@ export interface components {
         CounterpartyAccount: {
             /** Format: uuid */
             id: string;
+            /**
+             * Format: uuid
+             * @description Wallet the counterparty belongs to
+             */
+            wallet_id?: string | null;
             /** @description Account holder name */
             name: string;
             /** @enum {string} */
@@ -13460,9 +13505,26 @@ export interface components {
              * @default false
              */
             has_internal_destination: boolean;
+            /** @description Number of active destinations. Present on the list response only. */
+            destinations_count?: number;
             /** Format: date-time */
             created_at: string;
+            /** Format: date-time */
+            updated_at?: string;
         };
+        /** @description Owning counterparty account, embedded on destination reads. */
+        CounterpartyAccountRef: {
+            /** Format: uuid */
+            id: string;
+            name: string;
+            /** @enum {string} */
+            type: "BUSINESS" | "INDIVIDUAL";
+            /** Format: uuid */
+            wallet_id?: string | null;
+            nickname?: string | null;
+            email?: string | null;
+            phone?: string | null;
+        } | null;
         /** @description A counterparty account with its embedded active destinations (returned by GET account by id). */
         CounterpartyAccountWithDestinations: components["schemas"]["CounterpartyAccount"] & {
             /** @description Active destinations belonging to this account. */
@@ -13541,6 +13603,11 @@ export interface components {
         CounterpartyDestination: {
             /** Format: uuid */
             id: string;
+            /**
+             * Format: uuid
+             * @description Owning counterparty account
+             */
+            counterparty_account_id: string;
             /**
              * @description Destination / payment rail type
              * @enum {string}
@@ -13550,9 +13617,13 @@ export interface components {
             nickname?: string | null;
             /** Format: date-time */
             created_at: string;
+            /** Format: date-time */
+            updated_at?: string;
             banking_data?: components["schemas"]["CounterpartyBankingData"] | null;
             crypto_data?: components["schemas"]["CounterpartyCryptoData"] | null;
             internal_data?: components["schemas"]["CounterpartyInternalData"] | null;
+            /** @description Embedded on the list and get-by-id reads; absent on create/update. */
+            counterparty_account?: components["schemas"]["CounterpartyAccountRef"] | null;
         };
         /** @description Whether an instant internal transfer is available for a counterparty destination. Two states: available (available=true, target_wallet_id set) and not available (available=false, target_wallet_id=null). Any recipient that cannot receive an instant internal transfer is uniformly reported as not available — the check does not disclose the reason. */
         InternalTransferAvailability: {
@@ -14234,6 +14305,73 @@ export interface components {
             }[];
             kyc_rails?: components["schemas"]["KycRail"] | null;
         };
+        /** @description Bank requisites of a virtual account, grouped per rail. Derived from `deposit_instructions` — a rail key is present only when the account carries an instruction for it, and an account with no instructions serializes as `{}`. */
+        VirtualAccountAccountDetails: {
+            ach?: {
+                accountNumber?: string;
+                routingNumber?: string;
+            } | null;
+            wire?: {
+                accountNumber?: string;
+                routingNumber?: string;
+            } | null;
+            swift?: {
+                swiftCode?: string;
+                accountNumber?: string;
+            } | null;
+            sepa?: {
+                iban?: string;
+                swiftCode?: string;
+            } | null;
+            ukPayments?: {
+                accountNumber?: string;
+                sortCode?: string;
+            } | null;
+            swiftCode?: string | null;
+            bankName?: string | null;
+            bankAddress?: string | null;
+            beneficiary?: {
+                name?: string;
+                address?: string | null;
+            } | null;
+        };
+        /** @description Postal address carried by a deposit instruction. Note `country_code` — the originator address block spells the same idea `country`. */
+        DepositInstructionAddress: {
+            address_line1?: string | null;
+            address_line2?: string | null;
+            city?: string | null;
+            state?: string | null;
+            postal_code?: string | null;
+            /** @description ISO country code */
+            country_code?: string | null;
+        };
+        /** @description One way to fund a virtual account: the requisites of a single payment rail. An account issues one instruction per rail its program enables, so the same bank details may appear twice under different `instruction_type` values. Only `instruction_type` is guaranteed — which identifiers a rail carries differs (an IBAN rail has no routing number, a US rail has no IBAN). An element may carry further keys that are provider bookkeeping rather than payment requisites — they are not part of this contract. */
+        DepositInstruction: {
+            /**
+             * @description Rail discriminator. Uppercase; a new provider rail is added to this list when it ships.
+             * @enum {string}
+             */
+            instruction_type: "ACH" | "FEDWIRE" | "SWIFT" | "SEPA_CT" | "CHAPS" | "FPS";
+            /** @description Domestic account number (some IBAN-only rails repeat the IBAN here) */
+            account_number?: string | null;
+            /** @description ABA / sort-code style routing number */
+            account_routing_number?: string | null;
+            iban?: string | null;
+            swift_bic?: string | null;
+            sort_code?: string | null;
+            /** @description Receiving bank */
+            institution_name?: string | null;
+            institution_address?: components["schemas"]["DepositInstructionAddress"] | null;
+            intermediary_institution_name?: string | null;
+            intermediary_institution_swift_bic?: string | null;
+            /** @description Beneficiary the payment must be addressed to */
+            account_holder_name?: string | null;
+            account_holder_address?: components["schemas"]["DepositInstructionAddress"] | null;
+            /** @description Reference the payer must quote, when the rail requires one */
+            memo?: string | null;
+        } & {
+            [key: string]: unknown;
+        };
         /** @description Fields shared by every virtual-account read shape. */
         VirtualAccountBase: {
             /** Format: uuid */
@@ -14257,40 +14395,13 @@ export interface components {
             /** @description Customer name the account is held under */
             customer_name?: string | null;
             /** @description Bank requisites summary derived from deposit_instructions. Empty object when the account has no instructions; null when deposits are disabled on the program's KYC rail. */
-            account_details?: {
-                ach?: {
-                    accountNumber?: string;
-                    routingNumber?: string;
-                } | null;
-                wire?: {
-                    accountNumber?: string;
-                    routingNumber?: string;
-                } | null;
-                swift?: {
-                    swiftCode?: string;
-                    accountNumber?: string;
-                } | null;
-                sepa?: {
-                    iban?: string;
-                    swiftCode?: string;
-                } | null;
-                ukPayments?: {
-                    accountNumber?: string;
-                    sortCode?: string;
-                } | null;
-                swiftCode?: string | null;
-                bankName?: string | null;
-                bankAddress?: string | null;
-                beneficiary?: {
-                    name?: string;
-                    address?: string | null;
-                } | null;
-            } | null;
+            account_details?: components["schemas"]["VirtualAccountAccountDetails"] | null;
             /** @description Deposit requisites (source of truth). Emptied to [] (never null) when deposits are disabled on the program's KYC rail. */
-            deposit_instructions?: {
+            deposit_instructions?: components["schemas"]["DepositInstruction"][] | null;
+            /** @description Provider bookkeeping for the account. Deliberately left opaque — the keys are per-vendor internals, not a contract to code against. */
+            meta?: {
                 [key: string]: unknown;
-            }[] | null;
-            meta?: Record<string, never> | null;
+            } | null;
         };
         /** @description Virtual bank account as returned by the list read. Currencies come embedded as full objects; the raw uuids are exposed as `account_currency_id` / `destination_currency_id`. Only ACTIVE accounts are listed. */
         VirtualAccount: components["schemas"]["VirtualAccountBase"] & {
@@ -14383,10 +14494,13 @@ export interface components {
             /** @description Customer name the account is held under */
             customer_name?: string | null;
             /** @description Bank account details for deposits, derived from deposit_instructions. Returned null when deposits are disabled on the program's KYC rail. */
-            account_details?: Record<string, never> | null;
+            account_details?: components["schemas"]["VirtualAccountAccountDetails"] | null;
             /** @description Deposit requisites (source of truth). Emptied to [] (never null) when deposits are disabled on the program's KYC rail. */
-            deposit_instructions?: Record<string, never>[];
-            meta?: Record<string, never> | null;
+            deposit_instructions?: components["schemas"]["DepositInstruction"][];
+            /** @description Provider bookkeeping for the account. Deliberately left opaque — the keys are per-vendor internals, not a contract to code against. */
+            meta?: {
+                [key: string]: unknown;
+            } | null;
             /** @description Account currency details */
             account_currency_details?: components["schemas"]["CurrencyDetails"] | null;
             /** @description Destination currency details */
@@ -14412,6 +14526,61 @@ export interface components {
             /** @description Number of minor-unit decimals */
             decimal: number;
         };
+        /** @description Postal address of the sender, as the rail reported it. */
+        OrderOriginatorAddress: {
+            address_line1?: string | null;
+            address_line2?: string | null;
+            city?: string | null;
+            state?: string | null;
+            postal_code?: string | null;
+            /** @description ISO country code */
+            country?: string | null;
+        };
+        /** @description Who sent the money. `name` is the only key every rail supplies. */
+        OrderOriginatorProfile: {
+            /** @description Sender name as reported by the rail (rails may truncate it) */
+            name: string;
+            /**
+             * @description Kind of sender. Present on internal transfers, where it comes from the sending wallet's KYC entity — `unknown` when the wallet has none. Bank rails do not report it.
+             * @enum {string}
+             */
+            type?: "individual" | "business" | "universal" | "unknown";
+            address?: components["schemas"]["OrderOriginatorAddress"] | null;
+        };
+        /** @description Bank identifiers of the sending account. Normalized on read: rails disagree about which slot an IBAN or a BIC belongs in, so a value is filed by its shape rather than by the slot it was stored in. The block is all-or-nothing — when it is present every key below is present too, with an empty string standing for "not supplied" (so `swift_bic: ''` means unknown, not "no BIC exists"). */
+        OrderOriginatorAccountInformation: {
+            /** @description Domestic account number. Empty when the stored value turned out to be an IBAN — read `iban` then. */
+            account_number: string;
+            /** @description ABA-style routing number. Empty when the stored value turned out to be a BIC — read `swift_bic` then. */
+            routing_number: string;
+            iban: string;
+            swift_bic: string;
+            sort_code: string;
+            currency_code: string;
+            /** @description Sending bank. Empty when the rail merely echoed the sender name here. */
+            institution_name: string;
+            intermediary_institution_name: string;
+        };
+        /** @description Crypto counterpart of `account_information`: present on internal (on-platform) transfers, where the sender is a wallet rather than a bank account. */
+        OrderOriginatorWalletInformation: {
+            /**
+             * Format: uuid
+             * @description Sending wallet
+             */
+            wallet_uuid: string;
+            wallet_name?: string | null;
+            crypto_address?: string | null;
+        };
+        /** @description Sender of an inbound order, normalized to one shape across every rail (bank deposits, on-ramps, internal transfers). Rendered from an allowlist, so no key beyond the five below is ever returned; which of them appear depends on the rail — a bank deposit carries `profile` + `account_information`, an internal transfer carries `profile` + `wallet_information`. Surfaced in the transaction panel (Sender, Account number, SWIFT / BIC, Bank name, Routing number) and in the PDF statement. */
+        OrderOriginator: {
+            profile?: components["schemas"]["OrderOriginatorProfile"];
+            account_information?: components["schemas"]["OrderOriginatorAccountInformation"];
+            wallet_information?: components["schemas"]["OrderOriginatorWalletInformation"];
+            /** @description Payment reference quoted by the sender */
+            reference?: string | null;
+            /** @description Free-text memo carried by the rail */
+            memo?: string | null;
+        };
         /** @description Public order metadata. List and single-read responses reduce the stored `meta` JSONB to a fixed allowlist of public keys; create/approve/cancel responses return the stored meta minus scheduler-internal keys. Every field is optional: presence depends on the order type (crypto transfer, fiat off-ramp, exchange, internal transfer, card top-up, deposit). */
         OrderMeta: {
             /** @description Legacy idempotency key — null on orders created by the current flow */
@@ -14483,10 +14652,8 @@ export interface components {
              * @description Card sub-account (card top-up orders)
              */
             sub_account_id?: string | null;
-            /** @description Sender details on inbound (deposit) orders, normalized to one canonical shape across rails. Keys: `profile` (sender identity), `account_information` (bank identifiers: account_number, routing_number, iban, swift_bic, sort_code, currency_code, institution_name, intermediary_institution_name), `wallet_information` (crypto counterpart on internal transfers), `reference`, `memo`. */
-            originator?: {
-                [key: string]: unknown;
-            } | null;
+            /** @description Sender details on inbound (deposit) and internal-transfer orders. */
+            originator?: components["schemas"]["OrderOriginator"] | null;
             /** @description Card authorizations: card id */
             card_id?: string | null;
             /** @description Card authorizations: merchant name */
@@ -14508,25 +14675,28 @@ export interface components {
             /** Format: date-time */
             completed_at?: string | null;
         };
-        /** @description Order record */
+        /** @description Order record. The `required` list below is what every order response carries, on every route that returns an order. `required` is about presence, not about value: a field marked both required and nullable is always in the payload and may be `null`. Everything outside that list is genuinely conditional — `is_threshold_amount` comes with the list read, `mass_payout` with the list and single reads, and the fee / compliance fields are absent from the create, approve, cancel and comment responses. */
         Order: {
             /** Format: uuid */
-            id?: string;
+            id: string;
             /** Format: uuid */
-            order_uuid?: string;
+            order_uuid: string;
             /** Format: uuid */
             request_id?: string | null;
             /** Format: uuid */
-            wallet_uuid?: string;
+            wallet_uuid: string;
             /** Format: uuid */
-            from_uuid?: string;
+            from_uuid: string;
             /** Format: uuid */
-            to_uuid?: string;
-            amount_from?: number;
-            amount_to?: number | null;
-            order_type?: string;
-            /** @enum {string} */
-            status?: "NEW" | "PENDING" | "EXPECTED" | "PROCESSING" | "COMPLETE" | "FAILED" | "CANCELED" | "REFUNDED";
+            to_uuid: string;
+            amount_from: number;
+            amount_to: number | null;
+            order_type: string;
+            /**
+             * @description Complete set for these routes — a failure is always `FAILED`, there is no second failure status. `EXPECTED` is a scheduled payment waiting for its `scheduled_at`; `REFUNDED` is a failed order whose funds were paid back, as opposed to `CANCELED`, where nothing ever moved.
+             * @enum {string}
+             */
+            status: "NEW" | "PENDING" | "EXPECTED" | "PROCESSING" | "COMPLETE" | "FAILED" | "CANCELED" | "REFUNDED";
             /**
              * @description Compliance (transaction monitoring) state. Orthogonal to `status`: a `held` order is still PENDING and nothing has been credited — it resolves to COMPLETE or FAILED once the review finishes. `null` means the order was never subject to a compliance hold.
              * @enum {string|null}
@@ -14577,7 +14747,8 @@ export interface components {
             sig_key_version?: string | null;
             /** @description Computed dust flag — amount below the render threshold for either currency. Returned by the list endpoint (GET /frontend/orders/wallet/{wallet_uuid}); absent from single-order reads. */
             is_threshold_amount?: boolean;
-            meta?: components["schemas"]["OrderMeta"];
+            /** @description Always present; `null` for an order that carries no metadata at all. */
+            meta: components["schemas"]["OrderMeta"] | null;
             /** @description Batch this order was created by, when it was sent as part of a mass payout; null for a standalone order. Filter the list by it with `filters=[{"mass_payout_id":"<uuid>"}]`. */
             mass_payout?: {
                 /** Format: uuid */
@@ -14591,9 +14762,9 @@ export interface components {
              */
             scheduled_at?: string | null;
             /** Format: date-time */
-            created_at?: string;
+            created_at: string;
             /** Format: date-time */
-            updated_at?: string | null;
+            updated_at: string | null;
         };
         /** @description Single-order read shape (GET /orders/id/{order_id} and GET /orders/uuid/{order_uuid}) — the base Order plus context objects hydrated from its `meta` references. */
         OrderDetail: components["schemas"]["Order"] & {
@@ -14880,6 +15051,8 @@ export interface components {
             record_type: string;
             /** Format: uuid */
             wallet_id: string;
+            /** @description Computed dust flag — amount below the render threshold for the currency. Hidden from the list unless `show_low_balance=true`. */
+            is_threshold_amount?: boolean;
             currency: components["schemas"]["Currency"];
             meta: components["schemas"]["TransactionMeta"];
         };
@@ -14999,7 +15172,10 @@ export interface components {
             wallet_id?: string;
             /**
              * Format: uuid
-             * @description Source currency the batch is funded in
+             * @description Source currency the batch is funded in. Crypto recipients are
+             *     paid with it on-chain, so it must be an on-chain asset; a fiat
+             *     source currency cannot fund crypto recipients.
+             *
              */
             currency_id?: string;
             /**
@@ -15084,11 +15260,32 @@ export interface components {
             created_at?: string;
             /** Format: date-time */
             processed_at?: string | null;
+            /** @description The address-book destination this row pays, with its owning account under counterparty_account — the same shape the counterparty endpoints return, raw data (no formatting). Always present; a destination deleted from the address book after the batch was made is still returned. Null only if the destination row no longer exists at all. */
+            destination?: components["schemas"]["CounterpartyDestination"] | null;
+        };
+        /** @description Progress of the batch for one destination type. total minus completed, failed and cancelled is what is still in flight for that type. */
+        MassPayoutMethodBreakdown: {
+            /**
+             * @description Type of the destinations the rows pay (CounterpartyDestination.type)
+             * @enum {string}
+             */
+            destination_type: "ACH" | "RTP" | "SWIFT" | "SEPA" | "CRYPTO_EXTERNAL" | "CRYPTO_INTERNAL" | "CHAPS" | "FPS" | "FEDWIRE" | "INTERNAL";
+            total: number;
+            completed: number;
+            failed: number;
+            cancelled: number;
+        };
+        /** @description The batch as returned by the single-batch read: the MassPayout fields plus the progress cuts a tracker page draws from. Both are computed over the whole batch and never depend on how the item list is paged or filtered. */
+        MassPayoutDetail: components["schemas"]["MassPayout"] & {
+            /** @description Payments not yet finished: total_items minus completed_count, failed_count and cancelled_count */
+            processing_count: number;
+            /** @description Progress per destination type: one entry per type present in the batch (a type without rows is not listed), in order of first appearance; the totals add up to total_items */
+            method_breakdown: components["schemas"]["MassPayoutMethodBreakdown"][];
         };
         MassPayoutItemInput: {
             /**
              * Format: uuid
-             * @description Existing counterparty destination of the source wallet
+             * @description Counterparty destination from the source wallet's own address book. A destination of another wallet, or an unknown id, is refused with 404 DESTINATION_NOT_FOUND (details.destination_ids lists the offending ids); the two cases are deliberately not distinguished.
              */
             destination_id: string;
             /** @description The amount the recipient receives, in the payout currency of this row */
@@ -15114,7 +15311,10 @@ export interface components {
          *     documents to the rows of a batch instead.
          *      */
         MassPayoutTemplateItemInput: {
-            /** Format: uuid */
+            /**
+             * Format: uuid
+             * @description Counterparty destination from the wallet's own address book; a destination of another wallet, or an unknown id, is refused with 404 DESTINATION_NOT_FOUND
+             */
             destination_id: string;
             /** @description Optional in a template: omit it (or send null) to save a recipient
              *     list whose amounts are filled in later. When present it must be

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

@@ -1639,224 +1639,6 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
-    "/issuing/cards/prepaid": {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        get?: never;
-        put?: never;
-        /**
-         * Create a new prepaid card
-         * @deprecated
-         * @description **Deprecated.** Use `POST /frontend/issuing/cards` (unified, routes by the program's
-         *     `sub_account_type`) instead — it carries the same fee/top-up handling.
-         *
-         *     Creates a new prepaid card for the user. Initial topup amount is determined by user group settings.
-         *
-         *     **Cardholder is required**: Every card must be associated with a cardholder.
-         *     Create a cardholder first, then pass the `cardholder_id` here.
-         *
-         */
-        post: {
-            parameters: {
-                query?: never;
-                header?: never;
-                path?: never;
-                cookie?: never;
-            };
-            requestBody: {
-                content: {
-                    "application/json": {
-                        /** @description Card nickname */
-                        nick_name: string;
-                        /**
-                         * Format: uuid
-                         * @description Issuing program ID
-                         */
-                        program_id: string;
-                        /**
-                         * Format: uuid
-                         * @description Wallet ID
-                         */
-                        wallet_id: string;
-                        /**
-                         * Format: uuid
-                         * @description ID of the cardholder to associate with this card. **Required.**
-                         *
-                         */
-                        cardholder_id: string;
-                        /**
-                         * Format: uuid
-                         * @description Currency ID for card fees (required if program has issuing fee or initial topup)
-                         */
-                        currency_id?: string;
-                        /**
-                         * @deprecated
-                         * @description **Deprecated.** Use `cardholder_id` instead.
-                         */
-                        email?: string;
-                        /**
-                         * @deprecated
-                         * @description **Deprecated.** Use `cardholder_id` instead.
-                         */
-                        vendor_user_id?: string;
-                        /** @description User data ID (optional) */
-                        user_data_id?: string;
-                    };
-                };
-            };
-            responses: {
-                /** @description Prepaid card created successfully */
-                200: {
-                    headers: {
-                        [name: string]: unknown;
-                    };
-                    content: {
-                        "application/json": {
-                            card_id?: string;
-                            /** @enum {string} */
-                            status?: "ACTIVE";
-                        };
-                    };
-                };
-                /** @description Bad Request - missing required fields or validation error */
-                400: {
-                    headers: {
-                        [name: string]: unknown;
-                    };
-                    content: {
-                        "application/json": components["schemas"]["Error"];
-                    };
-                };
-                /** @description Server Error */
-                500: {
-                    headers: {
-                        [name: string]: unknown;
-                    };
-                    content: {
-                        "application/json": components["schemas"]["Error"];
-                    };
-                };
-            };
-        };
-        delete?: never;
-        options?: never;
-        head?: never;
-        patch?: never;
-        trace?: never;
-    };
-    "/issuing/cards/balance": {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        get?: never;
-        put?: never;
-        /**
-         * Create a new balance card
-         * @deprecated
-         * @description **Deprecated.** Use `POST /frontend/issuing/cards` (unified, routes by the program's
-         *     `sub_account_type`) instead — it carries the same fee/top-up handling.
-         *
-         *     Creates a new card linked to an existing balance account for the user. Card fees and initial topup are determined by user group settings.
-         *
-         *     **Cardholder is required**: Every card must be associated with a cardholder.
-         *     Create a cardholder first, then pass the `cardholder_id` here.
-         *
-         */
-        post: {
-            parameters: {
-                query?: never;
-                header?: never;
-                path?: never;
-                cookie?: never;
-            };
-            requestBody: {
-                content: {
-                    "application/json": {
-                        /** @description Card nickname */
-                        nick_name: string;
-                        /**
-                         * Format: uuid
-                         * @description Issuing program ID
-                         */
-                        program_id: string;
-                        /**
-                         * Format: uuid
-                         * @description Wallet ID
-                         */
-                        wallet_id: string;
-                        /**
-                         * Format: uuid
-                         * @description Fiat account (sub-account) ID to link the card to
-                         */
-                        fiat_account_id: string;
-                        /**
-                         * Format: uuid
-                         * @description ID of the cardholder to associate with this card. **Required.**
-                         *
-                         */
-                        cardholder_id: string;
-                        /**
-                         * Format: uuid
-                         * @description Currency ID for card fees (required if program has issuing fee)
-                         */
-                        currency_id?: string;
-                        /**
-                         * @deprecated
-                         * @description **Deprecated.** Use `cardholder_id` instead.
-                         */
-                        vendor_user_id?: string;
-                        /** @description User data ID (optional) */
-                        user_data_id?: string;
-                    };
-                };
-            };
-            responses: {
-                /** @description Balance card created successfully */
-                200: {
-                    headers: {
-                        [name: string]: unknown;
-                    };
-                    content: {
-                        "application/json": {
-                            card_id?: string;
-                            /** @enum {string} */
-                            status?: "ACTIVE";
-                        };
-                    };
-                };
-                /** @description Bad Request - missing required fields, validation error, or cards limit reached */
-                400: {
-                    headers: {
-                        [name: string]: unknown;
-                    };
-                    content: {
-                        "application/json": components["schemas"]["Error"];
-                    };
-                };
-                /** @description Server Error */
-                500: {
-                    headers: {
-                        [name: string]: unknown;
-                    };
-                    content: {
-                        "application/json": components["schemas"]["Error"];
-                    };
-                };
-            };
-        };
-        delete?: never;
-        options?: never;
-        head?: never;
-        patch?: never;
-        trace?: never;
-    };
     "/issuing/cards/{card_id}/freeze": {
         parameters: {
             query?: never;
@@ -2547,7 +2329,7 @@ export interface paths {
                         "application/json": components["schemas"]["ErrorResponse"];
                     };
                 };
-                /** @description Forbidden - KYC not approved for this wallet */
+                /** @description Forbidden - KYC not approved for this wallet, or (KYC-enabled tenants) the wallet is not APPROVED on the program's KYC rail / the rail is disabled — `code` carries WALLET_RAIL_NOT_ONBOARDED, WALLET_RAIL_NOT_APPROVED, RAIL_NOT_ENABLED or RAIL_NOT_CONFIGURED */
                 403: {
                     headers: {
                         [name: string]: unknown;
@@ -3943,6 +3725,12 @@ export interface paths {
                          * @example 123e4567-e89b-12d3-a456-426614174000
                          */
                         card_id?: string;
+                        /**
+                         * Format: uuid
+                         * @description Optional client-generated UUID for idempotency. Retrying with the same reference_id returns the original order instead of debiting the wallet again.
+                         * @example 3f0b8f61-52a4-4f0e-9f0d-2f6f4f1b9a11
+                         */
+                        reference_id?: string;
                     };
                 };
             };
@@ -4013,119 +3801,6 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
-    "/orders/TRANSFER_CARD_PREPAID": {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        get?: never;
-        put?: never;
-        /**
-         * Create a wholesale card deposit order
-         * @description Transfer funds from crypto to a wholesale card vendor
-         */
-        post: {
-            parameters: {
-                query?: never;
-                header?: never;
-                path?: never;
-                cookie?: never;
-            };
-            requestBody: {
-                content: {
-                    "application/json": {
-                        /**
-                         * @description Amount to transfer
-                         * @example 100
-                         */
-                        amount: number;
-                        /**
-                         * @description Source wallet UUID
-                         * @example 8205c701-cd41-4929-910f-fccbb949729a
-                         */
-                        wallet_uuid: string;
-                        /**
-                         * @description UUID of cryptocurrency from currency table to withdraw from
-                         * @example c6d0c728-2624-403d-8e42-0c3f8b1e5e41
-                         */
-                        from_uuid: string;
-                        /**
-                         * @description Card ID
-                         * @example 509eca03-bc0d-4a38-b7dc-d136d2bdaa43
-                         */
-                        card_id: string;
-                    };
-                };
-            };
-            responses: {
-                /** @description Order successfully created */
-                200: {
-                    headers: {
-                        [name: string]: unknown;
-                    };
-                    content: {
-                        "application/json": {
-                            /** Format: date-time */
-                            created_at?: string;
-                            order_uuid?: string;
-                            wallet_uuid?: string;
-                            from_uuid?: string;
-                            to_uuid?: string;
-                            amount_from?: number;
-                            /** @example TRANSFER_CARD_PREPAID */
-                            order_type?: string;
-                            /** @enum {string} */
-                            status?: "PENDING" | "COMPLETE" | "FAILED";
-                            amount_to?: number;
-                            info?: string;
-                            meta?: {
-                                fee?: number;
-                                order_uuid?: string;
-                                fee_currency?: string;
-                                exchange_rate?: number;
-                                billing_amount?: number;
-                                vendor_id?: string;
-                                transaction_amount?: number;
-                                billing_currency?: string;
-                                transaction_currency?: string;
-                                network_fee?: number;
-                            };
-                            id?: string;
-                        };
-                    };
-                };
-                /** @description Bad request - validation error */
-                400: {
-                    headers: {
-                        [name: string]: unknown;
-                    };
-                    content: {
-                        "application/json": {
-                            error?: string;
-                        };
-                    };
-                };
-                /** @description Server error */
-                500: {
-                    headers: {
-                        [name: string]: unknown;
-                    };
-                    content: {
-                        "application/json": {
-                            error?: string;
-                        };
-                    };
-                };
-            };
-        };
-        delete?: never;
-        options?: never;
-        head?: never;
-        patch?: never;
-        trace?: never;
-    };
     "/orders/EXCHANGE_CRYPTO_INTERNAL": {
         parameters: {
             query?: never;
@@ -7101,6 +6776,23 @@ export interface paths {
                         };
                     };
                 };
+                /** @description KYC rail gate (KYC-enabled tenants) — the program's rail is disabled, deposits are disabled, or the wallet is not APPROVED on that rail */
+                422: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @example This wallet is not onboarded on this rail yet. */
+                            error?: string;
+                            /**
+                             * @example WALLET_RAIL_NOT_ONBOARDED
+                             * @enum {string}
+                             */
+                            code?: "RAIL_NOT_CONFIGURED" | "RAIL_NOT_ENABLED" | "DEPOSITS_DISABLED" | "WALLET_RAIL_NOT_ONBOARDED" | "WALLET_RAIL_NOT_APPROVED" | "RAIL_GATE_CHECK_FAILED";
+                        };
+                    };
+                };
                 /** @description Server error */
                 500: {
                     headers: {

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

@@ -4982,6 +4982,11 @@ export interface paths {
         /**
          * Create virtual account
          * @description Create a virtual account for a specific wallet. Tenant API can create VA for any user. Supports force_create to bypass existing VA check.
+         *
+         *     On KYC-enabled tenants the program's KYC rail gate applies exactly as on the client API — the rail must be enabled
+         *     (`kyc_rails.is_active`, `is_deposit_enabled`) and the wallet must be APPROVED on it (`wallet_kyc_rails`); otherwise 422 with
+         *     `RAIL_NOT_ENABLED`, `DEPOSITS_DISABLED`, `WALLET_RAIL_NOT_ONBOARDED` or `WALLET_RAIL_NOT_APPROVED`. `force_create` never bypasses it.
+         *
          */
         post: {
             parameters: {
@@ -5055,6 +5060,13 @@ export interface paths {
                     };
                     content?: never;
                 };
+                /** @description KYC rail gate — rail disabled, deposits disabled, or wallet not APPROVED on the program's rail */
+                422: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
                 /** @description Internal server error */
                 500: {
                     headers: {
@@ -8438,8 +8450,6 @@ export interface components {
             destinations_count?: number;
         };
         BankingData: {
-            /** Format: uuid */
-            id?: string;
             account_number?: string | null;
             routing_number?: string | null;
             bank_name: string | null;
@@ -8449,8 +8459,6 @@ export interface components {
             sort_code?: string | null;
             note?: string | null;
             address?: {
-                /** Format: uuid */
-                id?: string;
                 country_id?: number | null;
                 city?: string | null;
                 postcode?: string | null;
@@ -8462,8 +8470,6 @@ export interface components {
             created_at: string;
         } | null;
         CryptoData: {
-            /** Format: uuid */
-            id?: string;
             address: string;
             /** Format: uuid */
             currency_id?: string;
@@ -8505,7 +8511,21 @@ export interface components {
             banking_data?: components["schemas"]["BankingData"];
             crypto_data?: components["schemas"]["CryptoData"];
             internal_data?: components["schemas"]["CounterpartyInternalData"];
+            counterparty_account?: components["schemas"]["CounterpartyAccountRef"];
         };
+        /** @description Owning counterparty account, embedded on destination reads; absent on create/update. */
+        CounterpartyAccountRef: {
+            /** Format: uuid */
+            id: string;
+            name: string;
+            /** @enum {string} */
+            type: "BUSINESS" | "INDIVIDUAL";
+            /** Format: uuid */
+            wallet_id?: string | null;
+            nickname?: string | null;
+            email?: string | null;
+            phone?: string | null;
+        } | null;
         AdminApiKey: {
             /** Format: uuid */
             id?: string;

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

@@ -260,6 +260,23 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/user/account": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post?: never;
+        /** Delete own account */
+        delete: operations["UserController_deleteOwnAccount"];
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/user/email": {
         parameters: {
             query?: never;
@@ -2667,6 +2684,30 @@ export interface operations {
             };
         };
     };
+    UserController_deleteOwnAccount: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Unauthorized */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
     AuthenticatedUserController_changeEmailConfirm: {
         parameters: {
             query?: never;

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

@@ -564,12 +564,19 @@ export declare namespace API {
             type Response = CounterpartyWithDestinations;
         }
         namespace List {
-            type Request = pathsV1Frontend['/frontend/counterparty/accounts/wallet/{wallet_id}']['get']['parameters']['path'] & NonNullable<pathsV1Frontend['/frontend/counterparty/accounts/wallet/{wallet_id}']['get']['parameters']['query']>;
+            type Request = Omit<pathsV1Frontend['/frontend/counterparty/accounts/wallet/{wallet_id}']['get']['parameters']['path'] & NonNullable<pathsV1Frontend['/frontend/counterparty/accounts/wallet/{wallet_id}']['get']['parameters']['query']>, 'include'>;
             type Response = {
                 total: number;
                 data: Counterparty[];
             };
         }
+        namespace ListWithDestinations {
+            type Request = List.Request;
+            type Response = {
+                total: number;
+                data: CounterpartyWithDestinations[];
+            };
+        }
         namespace Create {
             type Request = pathsV1Frontend['/frontend/counterparty/accounts/wallet/{wallet_id}']['post']['parameters']['path'] & pathsV1Frontend['/frontend/counterparty/accounts/wallet/{wallet_id}']['post']['requestBody']['content']['application/json'];
             type Response = Counterparty;
@@ -1427,6 +1434,16 @@ export declare namespace API {
         type TemplateRoot = pathsV1Frontend['/frontend/mass-payouts/{wallet_id}/templates/{template_id}'];
         /** The batch itself: progress counters, totals and the approval/schedule state. */
         export type MassPayout = componentsV1Frontend['schemas']['MassPayout'];
+        /**
+         * The batch as the single read returns it (`getById`) — the base `MassPayout` plus the two
+         * progress cuts a tracker page draws from. Both are computed over the whole batch and ignore
+         * how the item list is paged or filtered. The list read and every mutation still answer with
+         * the plain `MassPayout`, so a page that needs the breakdown after `approve` / `cancel` must
+         * re-read the batch.
+         */
+        export type MassPayoutDetail = componentsV1Frontend['schemas']['MassPayoutDetail'];
+        /** Progress of the batch for one destination type; `total` minus the three counters is in flight. */
+        export type MassPayoutMethodBreakdown = componentsV1Frontend['schemas']['MassPayoutMethodBreakdown'];
         /** A stored recipient row, with its own status and the order created for it at execution. */
         export type MassPayoutItem = componentsV1Frontend['schemas']['MassPayoutItem'];
         /** A recipient row as written on create/update. */

package/package.json

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