squarefi-bff-api-module 1.36.36 → 1.36.38

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

@@ -1067,104 +1067,6 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
-    "/tenant/me": {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        /**
-         * Get authenticated tenant
-         * @deprecated
-         * @description Returns information about the authenticated tenant
-         */
-        get: {
-            parameters: {
-                query?: never;
-                header?: never;
-                path?: never;
-                cookie?: never;
-            };
-            requestBody?: never;
-            responses: {
-                /** @description Authenticated tenant information */
-                200: {
-                    headers: {
-                        [name: string]: unknown;
-                    };
-                    content: {
-                        "application/json": components["schemas"]["Tenant"];
-                    };
-                };
-                /** @description Server error */
-                500: {
-                    headers: {
-                        [name: string]: unknown;
-                    };
-                    content: {
-                        "application/json": components["schemas"]["Error"];
-                    };
-                };
-            };
-        };
-        put?: never;
-        post?: never;
-        delete?: never;
-        options?: never;
-        head?: never;
-        patch?: never;
-        trace?: never;
-    };
-    "/tenant/config": {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        /**
-         * Get tenant configuration
-         * @deprecated
-         * @description Returns configuration for the authenticated tenant
-         */
-        get: {
-            parameters: {
-                query?: never;
-                header?: never;
-                path?: never;
-                cookie?: never;
-            };
-            requestBody?: never;
-            responses: {
-                /** @description Tenant configuration */
-                200: {
-                    headers: {
-                        [name: string]: unknown;
-                    };
-                    content: {
-                        "application/json": components["schemas"]["TenantConfig"];
-                    };
-                };
-                /** @description Server error */
-                500: {
-                    headers: {
-                        [name: string]: unknown;
-                    };
-                    content: {
-                        "application/json": components["schemas"]["Error"];
-                    };
-                };
-            };
-        };
-        put?: never;
-        post?: never;
-        delete?: never;
-        options?: never;
-        head?: never;
-        patch?: never;
-        trace?: never;
-    };
     "/issuing/cards": {
         parameters: {
             query?: never;
@@ -2201,17 +2103,7 @@ export interface paths {
         };
         /**
          * Get card transactions
-         * @description Retrieves a list of transactions for a specific card with filtering and pagination options.
-         *     This endpoint now combines external card transactions with local top-up transactions.
-         *
-         *     **Pagination Strategy**: Due to combining two data sources (external API and local DB),
-         *     pagination fetches larger batches from both sources to ensure proper sorting before
-         *     applying the requested pagination. This prevents missing transactions that should appear
-         *     on the current page after sorting.
-         *
-         *     **Note**: For cards, the system needs to find the associated fiat_account to match local top-up transactions.
-         *     This should be replaced with direct card_id in transaction metadata in the future.
-         *
+         * @description Retrieves a list of transactions for a specific card, including card top-ups, with filtering and pagination options.
          */
         get: {
             parameters: {
@@ -2226,14 +2118,14 @@ export interface paths {
                     offset?: number;
                     /** @description Whether to use the new response format */
                     new_scheme?: boolean;
-                    /** @description Filter by transaction type */
-                    transaction_type?: string;
-                    /** @description Filter by start date (ISO 8601). Sent to external provider as `from_timestamp` and post-filtered against `cleared_at`/`created_at`. */
+                    /** @description Filter by transaction type (case-insensitive). Unknown values are rejected with a validation error. */
+                    transaction_type?: "AUTHORIZATION" | "CLEARING" | "REFUND" | "REVERSAL" | "DEPOSIT" | "WITHDRAWAL" | "TRANSFER" | "FEE" | "ATM" | "ACCOUNT_VERIFICATION" | "ORIGINAL_CREDIT" | "OTHER";
+                    /** @description Filter by start date (ISO 8601), matched against `cleared_at` (fallback `created_at`). */
                     from?: string;
-                    /** @description Filter by end date (ISO 8601). Sent to external provider as `to_timestamp` and post-filtered against `cleared_at`/`created_at`. */
+                    /** @description Filter by end date (ISO 8601), matched against `cleared_at` (fallback `created_at`). */
                     to?: string;
-                    /** @description Filter by transaction status. Forwarded to external provider and applied as a post-filter on the combined result. */
-                    status?: "PENDING" | "APPROVED" | "DECLINED" | "CANCELED";
+                    /** @description Filter by transaction status (case-insensitive). */
+                    status?: "PENDING" | "APPROVED" | "COMPLETED" | "DECLINED" | "CANCELED" | "REVERSED" | "EXPIRED";
                 };
                 header?: never;
                 path?: never;
@@ -2241,7 +2133,7 @@ export interface paths {
             };
             requestBody?: never;
             responses: {
-                /** @description List of transactions retrieved successfully (includes both external and local top-up transactions) */
+                /** @description List of transactions retrieved successfully (includes card top-ups) */
                 200: {
                     headers: {
                         [name: string]: unknown;
@@ -2250,6 +2142,15 @@ export interface paths {
                         "application/json": components["schemas"]["IssuingTransactionList"];
                     };
                 };
+                /** @description Validation error (unknown transaction_type) */
+                400: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["Error"];
+                    };
+                };
                 /** @description Server Error */
                 500: {
                     headers: {
@@ -8371,8 +8272,6 @@ export interface components {
         Transaction: unknown;
         CryptoCurrency: unknown;
         Country: unknown;
-        Tenant: unknown;
-        TenantConfig: unknown;
         IssuingCardList: unknown;
         IssuingCard: unknown;
         CardSensitiveData: unknown;

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

@@ -2643,10 +2643,10 @@ export interface paths {
          * @description Sends crypto from the wallet's omnibus balance via a counterparty
          *     destination. Two-phase: created `NEW` without touching the balance;
          *     `POST /admin/orders/{id}/approve` checks the balance, debits the funds
-         *     and dispatches the on-chain send. A destination address internal to
-         *     the tenant downgrades the order to `OMNIBUS_INTERNAL_TRANSFER` —
-         *     still `NEW` at create, debited + settled synchronously to `COMPLETE`
-         *     at approve.
+         *     and dispatches the on-chain send. This endpoint is external-only: the
+         *     order always goes on-chain, even if the destination address belongs to
+         *     a wallet on this platform. Internal (off-chain) transfers are created
+         *     only through the internal transfer endpoint.
          *
          */
         post: {
@@ -6079,11 +6079,12 @@ export interface paths {
                          */
                         cardholder_relationship?: "EMPLOYEE" | "CONTRACTOR";
                         /**
-                         * @description Identity document type (KYC vendors)
+                         * @description Identity document type (KYC vendors). Which values are accepted depends on the country that issued the document — read cardholder_requirements.country_rules[gov_id_country].gov_id_types instead of hardcoding the list (id_card_cn is the mainland China resident ID, id_card_hk the HKID).
+                         *
                          * @enum {string}
                          */
-                        gov_id_type?: "passport" | "id_card" | "driving_license";
-                        /** @description Identity document number */
+                        gov_id_type?: "passport" | "id_card" | "driving_license" | "residence_permit_eu" | "residence_permit_ae" | "id_card_cn" | "id_card_hk";
+                        /** @description Identity document number (passport / driving licence / national ID). */
                         gov_id_number?: string;
                         /**
                          * @description Issuing country of the identity document (2-3 letter code)
@@ -6097,9 +6098,16 @@ export interface paths {
                         gov_id_issuance_date?: string;
                         /**
                          * Format: date
-                         * @description Identity document expiry date (YYYY-MM-DD)
+                         * @description Identity document expiry date (YYYY-MM-DD). Required by the vendor review even for a document issued for life (an Indonesian KTP, "SEUMUR HIDUP"), which has no expiry printed on it — send the issuance date plus 100 years.
+                         *
                          */
                         gov_id_expiration_date?: string;
+                        /**
+                         * @description Tax identifier of the cardholder, separate from the document number. Required by Interlace CONSUMER programs when nationality is USA, where it must be a valid SSN (9 digits or XXX-XX-XXXX).
+                         *
+                         * @example 123-45-6789
+                         */
+                        tax_identification_number?: string;
                         /** @description Cardholder's address */
                         address?: {
                             /**
@@ -6114,7 +6122,11 @@ export interface paths {
                             line2?: string;
                             /** @example New York */
                             city?: string;
-                            /** @example NY */
+                            /**
+                             * @description Subdivision. Required for a US or Canadian address and must be the two-letter code (AL, ON); optional elsewhere.
+                             *
+                             * @example NY
+                             */
                             state?: string;
                             /** @example 10001 */
                             postal_code?: string;
@@ -6236,67 +6248,7 @@ export interface paths {
         };
         options?: never;
         head?: never;
-        /** Update cardholder */
-        patch: {
-            parameters: {
-                query?: never;
-                header?: never;
-                path: {
-                    cardholder_id: string;
-                };
-                cookie?: never;
-            };
-            requestBody: {
-                content: {
-                    "application/json": {
-                        /** Format: uuid */
-                        wallet_id: string;
-                        first_name?: string;
-                        last_name?: string;
-                        email?: string;
-                        phone?: string;
-                        /** @description ISO 3166-1 alpha-3 country code */
-                        nationality?: string;
-                        /** @enum {string} */
-                        gender?: "M" | "F";
-                        /** @enum {string} */
-                        cardholder_relationship?: "EMPLOYEE" | "CONTRACTOR";
-                        /** @enum {string} */
-                        gov_id_type?: "passport" | "id_card" | "driving_license";
-                        gov_id_number?: string;
-                        /** @description 2-3 letter uppercase country code */
-                        gov_id_country?: string;
-                        /** Format: date */
-                        gov_id_issuance_date?: string;
-                        /** Format: date */
-                        gov_id_expiration_date?: string;
-                        address?: {
-                            line1?: string;
-                            line2?: string;
-                            city?: string;
-                            state?: string;
-                            postal_code?: string;
-                            country?: string;
-                        };
-                    };
-                };
-            };
-            responses: {
-                /** @description Cardholder updated */
-                200: {
-                    headers: {
-                        [name: string]: unknown;
-                    };
-                    content: {
-                        "application/json": {
-                            /** @example true */
-                            success?: boolean;
-                            data?: components["schemas"]["Cardholder"];
-                        };
-                    };
-                };
-            };
-        };
+        patch?: never;
         trace?: never;
     };
     "/admin/issuing/cardholders/{cardholder_id}/documents": {
@@ -6395,8 +6347,14 @@ export interface paths {
          * Upload KYC document files
          * @description Uploads KYC files against a wallet via `multipart/form-data`, with no
          *     cardholder involved. The form field name is the document type (`selfie`,
-         *     `gov_id_front`, `gov_id_back`); one file per type, 5MB max each, formats
-         *     png/jpeg/pdf.
+         *     `gov_id_front`, `gov_id_back`); one file per type, 5MB max each, photos
+         *     only (png/jpeg).
+         *
+         *     Send the file the camera produced, unchanged: cropping, resizing or
+         *     re-encoding a document photo can make the vendor's tampering check
+         *     answer `Forgery attempt has been made.` — a verdict far worse than the
+         *     poor quality it was meant to fix. Too small to read means retake it
+         *     (card filling the frame, straight, no glare), not improve the file.
          *
          *     The response returns an `id` per file; pass those to
          *     `POST /admin/issuing/cardholders/{cardholder_id}/documents` to attach
@@ -6540,6 +6498,13 @@ export interface paths {
          *     not met; `error.details.missing` lists every field and file still needed. A failed
          *     submit leaves the draft untouched, so it can be retried.
          *
+         *     A cardholder whose identity review came back `review_status: REJECTED` or `REQUEST`
+         *     (both readable, with `reject_reason`, on the cardholder) may be submitted again: fix
+         *     what the vendor named, replace the document if that is what it disliked, and call this
+         *     endpoint once more. The review restarts on the vendor account the person already has —
+         *     the same document cannot be registered twice at the vendor, so a fresh cardholder is
+         *     NOT the way to retry. While a review is running, another submit is refused with `409`.
+         *
          */
         post: {
             parameters: {
@@ -6581,7 +6546,7 @@ export interface paths {
                     };
                     content?: never;
                 };
-                /** @description Cardholder is not a draft (already submitted) */
+                /** @description Cardholder is live at the vendor, or its review is still running */
                 409: {
                     headers: {
                         [name: string]: unknown;
@@ -8551,7 +8516,13 @@ export interface components {
             } | null;
         };
         CryptoTransferRequest: {
+            /** @description Amount to send, in `from_currency_id` units. With `is_reverse: true` — the amount the recipient must receive, in destination-currency units. */
             amount: number;
+            /**
+             * @description When true, `amount` is the receive-amount and the debited amount is grossed up with fees.
+             * @default false
+             */
+            is_reverse: boolean;
             /** Format: uuid */
             from_currency_id: string;
             /** Format: uuid */
@@ -8567,7 +8538,13 @@ export interface components {
             scheduled_at?: string;
         };
         OfframpOrderRequest: {
+            /** @description Amount to send, in `from_currency_id` units. With `is_reverse: true` — the amount the recipient must receive, in destination-currency units. */
             amount: number;
+            /**
+             * @description When true, `amount` is the receive-amount and the debited amount is grossed up with fees.
+             * @default false
+             */
+            is_reverse: boolean;
             /** Format: uuid */
             from_currency_id: string;
             /** Format: uuid */
@@ -8590,8 +8567,13 @@ export interface components {
             scheduled_at?: string;
         };
         ExchangeOrderRequest: {
-            /** @description Amount to exchange (in source currency) */
+            /** @description Amount to exchange, in `from_currency_id` units. With `is_reverse: true` — the amount to receive, in `to_currency_id` units. */
             amount: number;
+            /**
+             * @description When true, `amount` is the receive-amount and the debited amount is grossed up with fees.
+             * @default false
+             */
+            is_reverse: boolean;
             /**
              * Format: uuid
              * @description Source currency UUID

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

@@ -1969,11 +1969,16 @@ export interface components {
             readonly support_text?: string | null;
             readonly support_phone?: string | null;
         };
+        MailingDataEntity: {
+            readonly support_email?: string | null;
+        };
         SupportedLocalesEntity: {
             default: string;
             supported: string[];
         };
         SystemConfigDto: {
+            tenant_id: string;
+            app_url: string | null;
             /** @enum {string} */
             default_theme_mode: "dark" | "light";
             enable_kyc: boolean;
@@ -1990,6 +1995,7 @@ export interface components {
             enable_referral_program: boolean;
             readonly metrics_data?: components["schemas"]["MetricsDataEntity"] | null;
             readonly statement_branding?: components["schemas"]["StatementBrandingEntity"] | null;
+            readonly mailing_data?: components["schemas"]["MailingDataEntity"] | 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.36",
+  "version": "1.36.38",
   "description": "Squarefi BFF API client module",
   "type": "module",
   "main": "./dist/index.js",