squarefi-bff-api-module 1.36.64 → 1.36.66

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

@@ -2538,6 +2538,10 @@ export interface paths {
                     sub_account_type?: "prepaid" | "balance";
                     /** @description Filter cards by status.
                      *     Accepts a single value or a comma-separated list, e.g. `status=ACTIVE,CANCELED`.
+                     *
+                     *     Cards whose creation was refused — FAILED with no card behind them — are left
+                     *     out of the listing: they carry no number, no balance and nothing to act on.
+                     *     Pass `status=FAILED` to get them back.
                      *      */
                     status?: ("ACTIVE" | "INACTIVE" | "SUSPENDED" | "CANCELED")[];
                     /** @description Filter cards by last 4 digits of the card number (partial, case-insensitive match) */

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

@@ -2696,6 +2696,10 @@ export interface paths {
                     sub_account_type?: "prepaid" | "balance";
                     /** @description Filter cards by status (matches issuing_cards.card_status).
                      *     Accepts a single value or a comma-separated list, e.g. `status=ACTIVE,FROZEN`.
+                     *
+                     *     Cards whose creation the vendor refused — FAILED with no card behind them —
+                     *     are left out of the listing: they carry no number, no balance and nothing the
+                     *     client can act on. Pass `status=FAILED` to get them back.
                      *      */
                     status?: ("ACTIVE" | "INACTIVE" | "FROZEN" | "CANCELED" | "CLOSED" | "BLOCKED" | "FAILED" | "PENDING")[];
                     /** @description Filter cards by last 4 digits of the card number (partial, case-insensitive match) */
@@ -11253,7 +11257,7 @@ export interface paths {
          *     Each wallet includes `access_role` (owner/admin/user/auditor) and `is_owner` boolean.
          *
          *     Wallets where the caller holds the scoped `user` role are returned as a reduced shell
-         *     (`uuid`, `name`, `display_name`, `tenant_id`, `kyc_info`, `created_at` + the role fields) — no `logo_url`.
+         *     (`uuid`, `name`, `display_name`, `tenant_id`, `kyc_entity_id`, `kyc_info`, `created_at` + the role fields) — no `logo_url`.
          *
          *     **Authentication**: Bearer token with x-tenant-id header required
          *
@@ -11319,20 +11323,18 @@ export interface paths {
                                 access_role: "owner" | "admin" | "user" | "auditor";
                                 /** @description True if user is the wallet owner */
                                 is_owner: boolean;
+                                /**
+                                 * Format: uuid
+                                 * @description KYC entity the wallet was opened for (`GET /kyc/entities`) — group the
+                                 *     list by it to see which accounts an entity already has. `null` for a
+                                 *     wallet created without one.
+                                 *
+                                 */
+                                kyc_entity_id: string | null;
                                 /** @description KYC entity attached to the wallet (joined from `kyc_entity`).
                                  *     `null` when the wallet has no KYC entity yet.
                                  *      */
-                                kyc_info: {
-                                    /** @description KYC entity type (e.g. INDIVIDUAL, BUSINESS) */
-                                    type: string;
-                                    /** @description KYC verification status (e.g. UNVERIFIED, PENDING, APPROVED, REJECTED) */
-                                    status: string;
-                                    business_name: string | null;
-                                    first_name: string | null;
-                                    last_name: string | null;
-                                    email: string | null;
-                                    phone: string | null;
-                                } | null;
+                                kyc_info: components["schemas"]["WalletKycInfo"] | null;
                             }[];
                             pagination: {
                                 offset: number;
@@ -11369,6 +11371,10 @@ export interface paths {
          *       - `empty_name: false` or omitted (default) → a random placeholder name
          *         is generated (e.g., "Golden Vault 42").
          *       - `empty_name: true` → the wallet is created with `name: null`.
+         *     - **purpose** — what the account is opened for, one of the listed codes.
+         *       `other` needs a free-text **purpose_other**; any other code refuses it.
+         *       Stored once with the wallet: it cannot be changed later and no
+         *       endpoint returns it.
          *
          *     **Authentication**: Bearer token with x-tenant-id header required
          *
@@ -11406,6 +11412,21 @@ export interface paths {
                          *
                          */
                         kyc_entity_id?: string;
+                        /**
+                         * @description What the account is opened for. Only the code travels — labels
+                         *     are the client's. Write-once and never returned.
+                         *
+                         * @example payroll
+                         * @enum {string}
+                         */
+                        purpose?: "payroll" | "client_or_project_funds" | "treasury_or_reserves" | "separate_by_team" | "separate_by_currency_or_region" | "other";
+                        /**
+                         * @description Free-text purpose. Required when `purpose` is `other`, refused
+                         *     with any other `purpose` (a blank value counts as absent).
+                         *
+                         * @example Contractor payouts
+                         */
+                        purpose_other?: string | null;
                     };
                 };
             };
@@ -11434,25 +11455,22 @@ export interface paths {
                                 tenant_id: string;
                                 /** Format: date-time */
                                 created_at: string;
+                                /**
+                                 * Format: uuid
+                                 * @description KYC entity the wallet was opened for. `null` for a wallet created without one.
+                                 */
+                                kyc_entity_id: string | null;
                                 /** @description Mirrors the GET-wallet shape. `null` when the wallet was created
                                  *     without `kyc_entity_id`; populated with the linked entity otherwise.
                                  *      */
-                                kyc_info: {
-                                    type: string;
-                                    status: string;
-                                    business_name: string | null;
-                                    first_name: string | null;
-                                    last_name: string | null;
-                                    email: string | null;
-                                    phone: string | null;
-                                } | null;
+                                kyc_info: components["schemas"]["WalletKycInfo"] | null;
                             };
                             /** @example Wallet created successfully */
                             message: string;
                         };
                     };
                 };
-                /** @description Bad request — invalid name, or `kyc_entity_id` is malformed / not an entity of the current user / belongs to another tenant */
+                /** @description Bad request — invalid name; `kyc_entity_id` is malformed / not an entity of the current user / belongs to another tenant; `purpose` is not a listed code; `purpose_other` is missing for `other`, longer than 255 characters or sent with another `purpose` */
                 400: {
                     headers: {
                         [name: string]: unknown;
@@ -11661,9 +11679,14 @@ export interface paths {
          *
          *     **Authentication**: Bearer token with x-tenant-id header required
          *
-         *     **Access Control**: Any active wallet member. The scoped `user` role receives a shell-only
-         *     response (`uuid`, `name`, `display_name`, `tenant_id`, `kyc_info`, `created_at` + the role fields) —
-         *     `logo_url`, `balance`, `fiat_accounts` and the totals are omitted for that role.
+         *     **Access Control**: Any active wallet member. The response shape depends on the caller's role and
+         *     is told apart by `access_role`:
+         *     - `owner` / `admin` / `auditor` — the full wallet (`WalletDetails`): identity, KYC, `balance`,
+         *       `fiat_accounts`, `base_currency` and the totals.
+         *     - `user` — a shell-only wallet (`WalletDetailsScopedUser`): `uuid`, `id`, `name`, `display_name`,
+         *       `tenant_id`, `kyc_entity_id`, `kyc_info`, `created_at` + the role fields. `logo_url`, `balance`, `fiat_accounts`,
+         *       `base_currency`, `fiat_total`, `crypto_total`, `pending_balance` and `total_amount` are absent
+         *       (not null) for that role — check `access_role` before reading them.
          *
          */
         get: {
@@ -11692,62 +11715,7 @@ export interface paths {
                         "application/json": {
                             /** @example true */
                             success: boolean;
-                            data: {
-                                /** Format: uuid */
-                                uuid: string;
-                                name: string | null;
-                                /**
-                                 * @description Computed label — wallet name, else KYC-derived (business_name / first+last), else "New account". Always present.
-                                 * @example Acme LLC
-                                 */
-                                display_name?: string;
-                                logo_url: string | null;
-                                /** Format: uuid */
-                                tenant_id: string;
-                                /** Format: date-time */
-                                created_at: string;
-                                kyc_info: {
-                                    type: string;
-                                    status: string;
-                                    business_name: string | null;
-                                    first_name: string | null;
-                                    last_name: string | null;
-                                    email: string | null;
-                                    phone: string | null;
-                                } | null;
-                                /** @description Aggregated crypto balances */
-                                balance: {
-                                    symbol: string;
-                                    icon?: string | null;
-                                    name: string;
-                                    is_crypto: boolean;
-                                    decimal: number;
-                                    amount: number;
-                                    fiat_amount: number;
-                                    details: components["schemas"]["AggregatedBalanceDetails"][];
-                                }[];
-                                fiat_accounts: Record<string, never>[];
-                                /** @description User's base currency */
-                                base_currency: string | null;
-                                fiat_total: number;
-                                crypto_total: number;
-                                pending_balance: number;
-                                total_amount: number;
-                                /**
-                                 * @description Legacy alias of `access_role`. Always equals `access_role` when
-                                 *     present. Kept for backward compatibility — prefer `access_role`.
-                                 *     Only present when called via member access.
-                                 *
-                                 * @enum {string}
-                                 */
-                                role?: "owner" | "admin" | "user" | "auditor";
-                                /**
-                                 * @description User's role for this wallet (only present when called via member access)
-                                 * @enum {string}
-                                 */
-                                access_role?: "owner" | "admin" | "user" | "auditor";
-                                is_owner?: boolean;
-                            };
+                            data: components["schemas"]["WalletDetails"] | components["schemas"]["WalletDetailsScopedUser"];
                         };
                     };
                 };
@@ -11834,18 +11802,15 @@ export interface paths {
                                 tenant_id: string;
                                 /** Format: date-time */
                                 created_at: string;
+                                /**
+                                 * Format: uuid
+                                 * @description KYC entity the wallet was opened for. `null` for a wallet created without one.
+                                 */
+                                kyc_entity_id: string | null;
                                 /** @description KYC entity attached to the wallet (joined from `kyc_entity`).
                                  *     `null` when the wallet has no KYC entity yet.
                                  *      */
-                                kyc_info: {
-                                    type: string;
-                                    status: string;
-                                    business_name: string | null;
-                                    first_name: string | null;
-                                    last_name: string | null;
-                                    email: string | null;
-                                    phone: string | null;
-                                } | null;
+                                kyc_info: components["schemas"]["WalletKycInfo"] | null;
                             };
                             /** @example Wallet updated successfully */
                             message: string;
@@ -15137,6 +15102,121 @@ export interface components {
             /** Format: date-time */
             created_at: string;
         };
+        /** @description KYC entity attached to the wallet. `null` when the wallet has no KYC entity yet. */
+        WalletKycInfo: {
+            /**
+             * @description KYC entity type, lower-case.
+             * @enum {string}
+             */
+            type: "individual" | "business" | "universal";
+            /**
+             * @description KYC verification status. A refusal is one of three values: `DECLINED`, `REJECT` or `SOFT_REJECT`. Only `APPROVED` (full access) and `HOLD` (read-only) open the wallet.
+             * @enum {string}
+             */
+            status: "APPROVED" | "DECLINED" | "PENDING" | "PROCESSING" | "HOLD" | "NEEDS_ATTENTION" | "DOUBLE" | "SOFT_REJECT" | "REJECT" | "UNVERIFIED" | "WAITING_ON_UBOS" | "WAITING_ON_REVIEW";
+            business_name: string | null;
+            first_name: string | null;
+            last_name: string | null;
+            email: string | null;
+            phone: string | null;
+        };
+        /** @description One aggregated crypto balance of the wallet: every balance row sharing the same symbol is merged into a single entry, and `details[]` keeps the per-row breakdown. */
+        WalletBalanceEntry: {
+            symbol: string;
+            icon?: string | null;
+            name: string;
+            is_crypto: boolean;
+            decimal: number;
+            amount: number;
+            /** @description Amount converted to `base_currency` */
+            fiat_amount: number;
+            details: components["schemas"]["AggregatedBalanceDetails"][];
+        };
+        /** @description Full wallet read for the `owner`, `admin` and `auditor` roles: identity, KYC, aggregated balances, fiat accounts and the totals. The scoped `user` role never receives this shape — see `WalletDetailsScopedUser`; the two are told apart by `access_role`. */
+        WalletDetails: {
+            /** Format: uuid */
+            uuid: string;
+            /** @description Legacy wallet identifier. Address the wallet by `uuid`; `id` is informational only. */
+            id: string | null;
+            name: string | null;
+            /**
+             * @description Computed label — wallet name, else KYC-derived (business_name / first+last), else "New account". Always present.
+             * @example Acme LLC
+             */
+            display_name: string;
+            logo_url: string | null;
+            /** Format: uuid */
+            tenant_id: string;
+            /** Format: date-time */
+            created_at: string;
+            /**
+             * Format: uuid
+             * @description KYC entity the wallet was opened for (`GET /kyc/entities`). `null` for a wallet created without one.
+             */
+            kyc_entity_id: string | null;
+            kyc_info: components["schemas"]["WalletKycInfo"] | null;
+            /** @description Aggregated crypto balances */
+            balance: components["schemas"]["WalletBalanceEntry"][];
+            fiat_accounts: {
+                [key: string]: unknown;
+            }[];
+            /** @description The caller's base currency; every `fiat_amount` and total is expressed in it. `null` when the caller has none. */
+            base_currency: string | null;
+            fiat_total: number;
+            crypto_total: number;
+            pending_balance: number;
+            total_amount: number;
+            /**
+             * @description The caller's role for this wallet. Never `user` on this shape. (enum property replaced by openapi-typescript)
+             * @enum {string}
+             */
+            access_role: "owner" | "admin" | "auditor";
+            /**
+             * @description Legacy alias of `access_role`. Always equals `access_role`. Kept for backward compatibility — prefer `access_role`.
+             * @enum {string}
+             */
+            role: "owner" | "admin" | "auditor";
+            /** @description `true` exactly when `access_role` is `owner`. */
+            is_owner: boolean;
+        };
+        /** @description Shell-only wallet read for the scoped `user` role: identity, KYC and display name. No main-account financials are ever included — `logo_url`, `balance`, `fiat_accounts`, `base_currency`, `fiat_total`, `crypto_total`, `pending_balance` and `total_amount` are absent, not null. Check `access_role` before reading balances. */
+        WalletDetailsScopedUser: {
+            /** Format: uuid */
+            uuid: string;
+            /** @description Legacy wallet identifier. Address the wallet by `uuid`; `id` is informational only. */
+            id: string | null;
+            name: string | null;
+            /**
+             * @description Computed label — wallet name, else KYC-derived (business_name / first+last), else "New account". Always present.
+             * @example Acme LLC
+             */
+            display_name: string;
+            /** Format: uuid */
+            tenant_id: string;
+            /** Format: date-time */
+            created_at: string;
+            /**
+             * Format: uuid
+             * @description KYC entity the wallet was opened for (`GET /kyc/entities`). `null` for a wallet created without one.
+             */
+            kyc_entity_id: string | null;
+            kyc_info: components["schemas"]["WalletKycInfo"] | null;
+            /**
+             * @description Always `user` on this shape. (enum property replaced by openapi-typescript)
+             * @enum {string}
+             */
+            access_role: "user";
+            /**
+             * @description Legacy alias of `access_role`. Always equals `access_role`. Kept for backward compatibility — prefer `access_role`.
+             * @enum {string}
+             */
+            role: "user";
+            /**
+             * @description Always `false` on this shape.
+             * @example false
+             */
+            is_owner: boolean;
+        };
         /** @description Unified currency record. `is_crypto: true` identifies a blockchain asset, `false` a fiat one. The joined `meta` JSONB blob carries currency-specific details (e.g. `chain_id`/contract for crypto, ISO code/country for fiat). */
         Currency: {
             id?: number;

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

@@ -1121,7 +1121,9 @@ export interface paths {
                      *
                      *     Common filter fields:
                      *     - `last4`: Filter by last 4 digits of card (partial, case-insensitive match)
-                     *     - `card_status`: Filter by status (ACTIVE, INACTIVE, CANCELED)
+                     *     - `card_status`: Filter by status (ACTIVE, INACTIVE, CANCELED). Cards whose
+                     *       creation the vendor refused (FAILED with no card behind them) are left out
+                     *       of the listing unless you ask for them with `card_status=FAILED`.
                      *     - `fiat_account.type`: Filter by account type (prepaid, balance)
                      *     - `from_created_at`: Filter cards created on or after this date (ISO 8601 format)
                      *     - `to_created_at`: Filter cards created on or before this date (ISO 8601 format)

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

@@ -1628,6 +1628,7 @@ export interface components {
         KycEntityDto: {
             id: string;
             user_data_uuid: string;
+            created_at: string;
             /** @enum {string} */
             type: "individual" | "business" | "universal";
             id_number?: string | null;
@@ -2009,6 +2010,12 @@ export interface components {
         MailingDataEntity: {
             readonly support_email?: string | null;
         };
+        AppLinksEntity: {
+            readonly terms_of_use_url?: string | null;
+            readonly privacy_policy_url?: string | null;
+            readonly fraud_and_security_url?: string | null;
+            readonly consumer_protection_url?: string | null;
+        };
         SupportedLocalesEntity: {
             default: string;
             supported: string[];
@@ -2051,6 +2058,7 @@ export interface components {
             readonly metrics_data?: components["schemas"]["MetricsDataEntity"] | null;
             readonly statement_branding?: components["schemas"]["StatementBrandingEntity"] | null;
             readonly mailing_data?: components["schemas"]["MailingDataEntity"] | null;
+            readonly app_links?: components["schemas"]["AppLinksEntity"] | null;
             /** @enum {string} */
             kyc_data_provider: "persona" | "sumsub";
             readonly supported_locales?: components["schemas"]["SupportedLocalesEntity"] | null;

package/package.json

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