squarefi-bff-api-module 1.36.59 → 1.36.61

package/README.md

@@ -210,7 +210,7 @@ const publicUrl = getPublicUrl(path);
 | **developer**       | Vendor & API key management                                         |
 | **exchange**        | Exchange rates per order type / currency                            |
 | **issuing**         | Virtual & physical cards, limits, controls, transactions            |
-| **kyc**             | Data collection init/resume, Sumsub flows, rails & form submission  |
+| **kyc**             | KYC entities & data collection, Sumsub flows, rails & forms         |
 | **list**            | Static system lists – currencies, chains, countries                 |
 | **orders**          | Create / calculate orders (including internal transfer)             |
 | **tenants**         | Tenant configuration                                                |

package/dist/api/kyc.d.ts

@@ -1,7 +1,9 @@
 import { API } from './types/types';
 export declare const kyc: {
     dataCollection: {
-        init: ({ wallet_id, type, }: API.KYC.DataCollection.Init.Request) => Promise<API.KYC.DataCollection.Init.Response>;
+        /** @deprecated KYC is keyed by the KYC entity now, not the wallet (SFI-1924). Use `kyc.entity.init`. */
+        init: ({ wallet_id, type }: API.KYC.DataCollection.Init.Request) => Promise<API.KYC.DataCollection.Init.Response>;
+        /** @deprecated KYC is keyed by the KYC entity now, not the wallet (SFI-1924). Use `kyc.entity.resume`. */
         resume: ({ wallet_id, verification_ref, }: API.KYC.DataCollection.Resume.Request) => Promise<API.KYC.DataCollection.Resume.Response>;
     };
     sumsub: {
@@ -9,6 +11,11 @@ export declare const kyc: {
     };
     entity: {
         get: ({ wallet_id }: API.KYC.Entity.Get.Request) => Promise<API.KYC.Entity.Get.Response>;
+        create: (data: API.KYC.Entity.Create.Request) => Promise<API.KYC.Entity.Create.Response>;
+        getAll: () => Promise<API.KYC.Entity.List.Response>;
+        getById: ({ kyc_entity_id }: API.KYC.Entity.GetById.Request) => Promise<API.KYC.Entity.GetById.Response>;
+        init: ({ kyc_entity_id, ...params }: API.KYC.Entity.Init.Request) => Promise<API.KYC.Entity.Init.Response>;
+        resume: ({ kyc_entity_id, verification_ref, }: API.KYC.Entity.Resume.Request) => Promise<API.KYC.Entity.Resume.Response>;
     };
     rails: {
         info: {

package/dist/api/kyc.js

@@ -1,7 +1,9 @@
 import { apiClientV1, apiClientV2 } from '../utils/apiClientFactory';
 export const kyc = {
     dataCollection: {
-        init: ({ wallet_id, type, }) => apiClientV2.postRequest(`/kyc/init/${wallet_id}/${type}`),
+        /** @deprecated KYC is keyed by the KYC entity now, not the wallet (SFI-1924). Use `kyc.entity.init`. */
+        init: ({ wallet_id, type }) => apiClientV2.postRequest(`/kyc/init/${wallet_id}/${type}`),
+        /** @deprecated KYC is keyed by the KYC entity now, not the wallet (SFI-1924). Use `kyc.entity.resume`. */
         resume: ({ wallet_id, verification_ref, }) => apiClientV2.postRequest(`/kyc/resume/${wallet_id}/${verification_ref}`),
     },
     sumsub: {
@@ -9,6 +11,11 @@ export const kyc = {
     },
     entity: {
         get: ({ wallet_id }) => apiClientV2.getRequest(`/kyc/${wallet_id}/entity`),
+        create: (data) => apiClientV2.postRequest('/kyc/entities', { data }),
+        getAll: () => apiClientV2.getRequest('/kyc/entities'),
+        getById: ({ kyc_entity_id }) => apiClientV2.getRequest(`/kyc/entities/${kyc_entity_id}`),
+        init: ({ kyc_entity_id, ...params }) => apiClientV2.postRequest(`/kyc/entities/${kyc_entity_id}/init`, { params }),
+        resume: ({ kyc_entity_id, verification_ref, }) => apiClientV2.postRequest(`/kyc/entities/${kyc_entity_id}/resume/${verification_ref}`),
     },
     rails: {
         info: {

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

@@ -1109,7 +1109,7 @@ export interface paths {
         put?: never;
         /**
          * Create crypto wallet
-         * @description Creates a new crypto wallet (Utila wallet).
+         * @description Creates a new crypto wallet.
          *     Optionally specify chains to create addresses immediately.
          *
          */
@@ -1137,8 +1137,10 @@ export interface paths {
                         external_id?: string;
                         /**
                          * @description Optional list of chain IDs (from `GET /api/reference/chains`)
-                         *     to generate addresses for immediately. Omit to create the wallet
-                         *     without addresses and add them later.
+                         *     to generate addresses for immediately. Omit to create an empty
+                         *     wallet; the custody-provider wallet is then created together with
+                         *     the first address added via
+                         *     `POST /api/crypto_wallets/{crypto_wallet_id}/addresses/{chain}`.
                          *
                          * @example [
                          *       1,
@@ -1290,7 +1292,7 @@ export interface paths {
         post?: never;
         /**
          * Delete crypto wallet
-         * @description Soft-deletes a crypto wallet and archives it in Utila.
+         * @description Soft-deletes a crypto wallet and archives it with the custody provider.
          *     The wallet is marked as deleted and all addresses are deactivated.
          *
          */
@@ -1421,6 +1423,9 @@ export interface paths {
          *
          *     This endpoint does not require authentication and can be used for monitoring.
          *
+         *     `version` is the published Developer API version — the same value every
+         *     response carries in the `X-API-Version` header. See the Changelog section.
+         *
          */
         get: {
             parameters: {
@@ -1914,7 +1919,7 @@ export interface paths {
                          */
                         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).
+                         * @description Tax identifier of the cardholder, separate from the document number. Required by some CONSUMER programs when nationality is USA, where it must be a valid SSN (9 digits or XXX-XX-XXXX).
                          *
                          * @example 123-45-6789
                          */
@@ -2222,7 +2227,7 @@ export interface paths {
                         gov_id_issuance_date?: string;
                         /** Format: date */
                         gov_id_expiration_date?: string;
-                        /** @description Tax identifier (USA + Interlace CONSUMER: SSN, 9 digits or XXX-XX-XXXX) */
+                        /** @description Tax identifier (USA + CONSUMER programs that require it: SSN, 9 digits or XXX-XX-XXXX) */
                         tax_identification_number?: string;
                         address?: {
                             line1?: string;
@@ -4854,7 +4859,13 @@ export interface paths {
                     limit?: number;
                     sort_by?: string;
                     sort_order?: "asc" | "desc";
-                    /** @description JSON-encoded array of filters, e.g. `[{"status":"COMPLETE"}]`.
+                    /** @description JSON-encoded array of filters, e.g. `[{"status":"COMPLETE"}]`. A value may be an
+                     *     array to match any of several values: `[{"status":["NEW","PROCESSING"]}]`.
+                     *     Filter by order type with `[{"order_type":"TRANSFER_INTERNAL"}]` — the names are
+                     *     the ones `GET /api/reference/order_types` returns.
+                     *     To find an order by the `reference` sent at creation, filter on that meta field:
+                     *     `[{"meta->>reference":"invoice-2026-04-001"}]` — this is how an order is recovered
+                     *     when the create response was lost.
                      *     Besides order columns it accepts `mass_payout_id` (uuid), which narrows the
                      *     result to the orders of one mass payout batch — the same batch reported by
                      *     the `mass_payout_id` field of each order. A non-uuid value is rejected with 400.
@@ -5179,6 +5190,16 @@ export interface paths {
                          * @default false
                          */
                         is_reverse?: boolean;
+                        /**
+                         * @description Optional. Free-form reference visible in order/transaction listings. Kept on the order, so it is also how you find the transfer again if the create response was lost: `GET /api/orders/list?filters=[{"meta->>reference":"<your reference>"}]`.
+                         * @example invoice-2026-04-001
+                         */
+                        reference?: string;
+                        /**
+                         * @description Optional. Internal note attached to the order.
+                         * @example Fee collected for order 550e8400-e29b-41d4-a716-446655440000
+                         */
+                        note?: string;
                         /**
                          * Format: date-time
                          * @description Optional. Schedule the transfer for a future time (min 1 hour, max 90 days ahead). No funds are reserved; after approval the order waits in EXPECTED status and executes automatically.
@@ -5275,6 +5296,19 @@ export interface paths {
          *     - Sufficient balance in `from_currency_id` at approve time on the wallet
          *       bound to the API key.
          *
+         *     **Cross-currency send (optional).** Pass a `to_currency_id` different
+         *     from `from_currency_id` to convert on the way out, exactly like the fiat
+         *     offramps: the wallet is debited `amount` in `from_currency_id`, and the
+         *     destination receives `amount_to` (also `meta.transaction_amount`) in
+         *     `to_currency_id` at the tenant's exchange rate for this order type.
+         *     Requirements: the pair must be configured for the tenant
+         *     (`400 EXCHANGE_RATE_NOT_FOUND`), `to_currency_id` must be an on-chain
+         *     currency (`400 INVALID_REQUEST`), and the destination address must be
+         *     registered on the network of `to_currency_id`
+         *     (`400 DESTINATION_CHAIN_MISMATCH`). Preview with `POST /api/orders/calc`.
+         *     Without `to_currency_id` (or with the same value) nothing changes: one
+         *     currency, one chain.
+         *
          *     `wallet_id` is automatically resolved from the API key — do **not** pass it
          *     in the body.
          *
@@ -6042,7 +6076,9 @@ export interface paths {
         };
         /**
          * Get exchange rates
-         * @description Returns exchange rates with tenant-specific fees applied.
+         * @description Returns exchange rates with the tenant FX spread applied: `rate` is what the tenant
+         *     trades at, `base_rate` is the market rate it came from and `fx_spread_percent` is the
+         *     percent taken off. The three are equal-and-zero when the tenant configured no spread.
          *     Only currency pairs enabled for the tenant and configured in `tenant_exchange_rates` are returned.
          *
          *     **Authentication**: x-api-key header required
@@ -7104,7 +7140,7 @@ export interface components {
          * @example EXCHANGE_OMNI
          * @enum {string}
          */
-        OrderTypeId: "EXCHANGE_OMNI" | "EXCHANGE_OMNI_ONRAMP" | "EXCHANGE_OMNI_OFFRAMP" | "EXCHANGE_OMNI_CRYPTO" | "EXCHANGE_CRYPTO_INTERNAL" | "L2F_ACH_ONRAMP" | "L2F_ACH_OFFRAMP" | "L2F_SEPA_ONRAMP" | "L2F_SEPA_OFFRAMP" | "L2F_SWIFT_ONRAMP" | "L2F_SWIFT_OFFRAMP" | "L2F_WIRE_ONRAMP" | "L2F_WIRE_OFFRAMP" | "L2F_CHAPS_ONRAMP" | "L2F_CHAPS_OFFRAMP" | "L2F_FPS_ONRAMP" | "L2F_FPS_OFFRAMP" | "BRL_WIRE_ONRAMP" | "BRL_WIRE_OFFRAMP" | "BRL_ACH_ONRAMP" | "BRL_ACH_OFFRAMP" | "BRL_RTP_OFFRAMP" | "DLS_WIRE_ONRAMP" | "DLS_WIRE_OFFRAMP" | "DLS_ACH_ONRAMP" | "DLS_ACH_OFFRAMP" | "DLS_SEPA_ONRAMP" | "DLS_SEPA_OFFRAMP" | "DLS_SWIFT_ONRAMP" | "DLS_SWIFT_OFFRAMP" | "BC1_SEPA_ONRAMP" | "BC1_SEPA_OFFRAMP" | "BC1_SWIFT_ONRAMP" | "BC1_SWIFT_OFFRAMP" | "BC3_SEPA_ONRAMP" | "BC3_SEPA_OFFRAMP" | "OMNIBUS_CRYPTO_TRANSFER" | "OMNIBUS_CRYPTO_WITHDRAWAL" | "OMNIBUS_INTERNAL_TRANSFER" | "SEGREGATED_CRYPTO_TRANSFER" | "TRANSFER_INTERNAL" | "TRANSFER_CARD_PREPAID" | "TRANSFER_CARD_SUBACCOUNT" | "TRANSFER_CARD_WHOLESALE" | "WITHDRAW_CARD_PREPAID" | "WITHDRAW_CARD_SUBACCOUNT" | "REFUND_CARD_PREPAID" | "REFUND_CARD_SUBACCOUNT" | "RN_CARDS_OFFRAMP" | "CARD_ISSUING_FEE";
+        OrderTypeId: "EXCHANGE_OMNI" | "EXCHANGE_OMNI_ONRAMP" | "EXCHANGE_OMNI_OFFRAMP" | "EXCHANGE_OMNI_CRYPTO" | "EXCHANGE_CRYPTO_INTERNAL" | "L2F_ACH_ONRAMP" | "L2F_ACH_OFFRAMP" | "L2F_SEPA_ONRAMP" | "L2F_SEPA_OFFRAMP" | "L2F_SWIFT_ONRAMP" | "L2F_SWIFT_OFFRAMP" | "L2F_WIRE_ONRAMP" | "L2F_WIRE_OFFRAMP" | "L2F_CHAPS_ONRAMP" | "L2F_CHAPS_OFFRAMP" | "L2F_FPS_ONRAMP" | "L2F_FPS_OFFRAMP" | "BRL_WIRE_ONRAMP" | "BRL_WIRE_OFFRAMP" | "BRL_ACH_ONRAMP" | "BRL_ACH_OFFRAMP" | "BRL_RTP_OFFRAMP" | "DLS_WIRE_ONRAMP" | "DLS_WIRE_OFFRAMP" | "DLS_ACH_ONRAMP" | "DLS_ACH_OFFRAMP" | "DLS_SEPA_ONRAMP" | "DLS_SEPA_OFFRAMP" | "DLS_SWIFT_ONRAMP" | "DLS_SWIFT_OFFRAMP" | "BC1_SEPA_ONRAMP" | "BC1_SEPA_OFFRAMP" | "BC1_SWIFT_ONRAMP" | "BC1_SWIFT_OFFRAMP" | "BC3_SEPA_ONRAMP" | "BC3_SEPA_OFFRAMP" | "RPP_SWIFT_OFFRAMP" | "RPP_SEPA_OFFRAMP" | "RPP_FPS_OFFRAMP" | "RPP_ACH_OFFRAMP" | "OMNIBUS_CRYPTO_TRANSFER" | "OMNIBUS_CRYPTO_WITHDRAWAL" | "OMNIBUS_INTERNAL_TRANSFER" | "SEGREGATED_CRYPTO_TRANSFER" | "TRANSFER_INTERNAL" | "TRANSFER_CARD_PREPAID" | "TRANSFER_CARD_SUBACCOUNT" | "TRANSFER_CARD_WHOLESALE" | "WITHDRAW_CARD_PREPAID" | "WITHDRAW_CARD_SUBACCOUNT" | "REFUND_CARD_PREPAID" | "REFUND_CARD_SUBACCOUNT" | "RN_CARDS_OFFRAMP" | "CARD_ISSUING_FEE" | "MONTHLY_FEE";
         /** @description Card object with all properties */
         IssuingCard: {
             /**
@@ -7260,7 +7296,7 @@ export interface components {
              */
             cvv: string;
             /**
-             * @description 3-D Secure password where the vendor exposes one (Wallester); `null` otherwise.
+             * @description 3-D Secure password where the card program exposes one; `null` otherwise.
              * @example null
              */
             security_code: string | null;
@@ -7568,7 +7604,7 @@ export interface components {
                  */
                 level?: "minimal" | "basic" | "declared" | "full";
                 /**
-                 * @description Required field names; address fields are dotted (address.line1). Interlace CONSUMER also lists gov_id_issuance_date and gov_id_expiration_date (ISO YYYY-MM-DD).
+                 * @description Required field names; address fields are dotted (address.line1). Some CONSUMER programs also list gov_id_issuance_date and gov_id_expiration_date (ISO YYYY-MM-DD).
                  * @example [
                  *       "first_name",
                  *       "last_name",
@@ -7581,7 +7617,7 @@ export interface components {
                 required?: string[];
                 /** @description Documents that must be attached; empty below the full level */
                 required_documents?: ("gov_id_front" | "gov_id_back" | "selfie")[];
-                /** @description Human-readable constraints the field list cannot express. Interlace CONSUMER: if nationality is USA, tax_identification_number is required and must be a valid SSN. */
+                /** @description Human-readable constraints the field list cannot express — e.g. a CONSUMER program requiring tax_identification_number to be a valid SSN when nationality is USA. */
                 notes?: string[];
                 /** @description What each country changes, keyed by ISO 3166-1 alpha-3 with a `default` entry; empty when the vendor reviews nothing. These fields stay out of `required` because they only hold once the nationality or address country is known: read the rule for the nationality the user picked (required_by_nationality), the rule for the address country (required_by_address), and the rule for the country that issued the document (gov_id_types). */
                 country_rules?: {
@@ -8199,13 +8235,13 @@ export interface components {
             from_currency_id: string;
             /**
              * Format: uuid
-             * @description Optional. UUID of the destination currency. Defaults to `from_currency_id` when omitted (no on-chain conversion).
+             * @description Optional. UUID of the currency delivered on-chain to the destination. Omitted or equal to `from_currency_id`: a plain transfer of the same asset (unchanged behaviour). Different: a **cross-currency send** — the wallet is debited `amount` in `from_currency_id`, and the omnibus pays out `amount_to` (`meta.transaction_amount`) in `to_currency_id` at the tenant's exchange rate for `OMNIBUS_CRYPTO_TRANSFER`, the same way the fiat offramps convert. The pair must be configured for the tenant (`400 EXCHANGE_RATE_NOT_FOUND` otherwise), the currency must be on-chain (`400 INVALID_REQUEST`), and the counterparty destination must be registered on the same network as `to_currency_id` (`400 DESTINATION_CHAIN_MISMATCH`). Preview the rate and the delivered amount with `POST /api/orders/calc` using the same `from_currency_id` / `to_currency_id`.
              * @example 509eca03-bc0d-4a38-b7dc-d136d2bdaa43
              */
             to_currency_id?: string;
             /**
              * Format: uuid
-             * @description UUID of a `CRYPTO_EXTERNAL` counterparty destination previously created via `POST /api/counterparty/destinations`.
+             * @description UUID of a `CRYPTO_EXTERNAL` counterparty destination previously created via `POST /api/counterparty/destinations`. For a cross-currency send its address must sit on the network of `to_currency_id`.
              * @example b2f3d8c1-4a7e-4d22-9c5f-1e6a8d0b2a44
              */
             counterparty_destination_id: string;
@@ -8504,7 +8540,7 @@ export interface components {
             is_tenant_enabled?: boolean;
             chain?: components["schemas"]["ChainRef"];
         };
-        /** @description Exchange rate between two currencies with tenant fee applied */
+        /** @description Exchange rate between two currencies with the tenant FX spread applied */
         ExchangeRate: {
             id?: number;
             /** Format: date-time */
@@ -8520,10 +8556,20 @@ export interface components {
              */
             to?: string;
             /**
-             * @description Exchange rate (tenant fee already applied)
+             * @description Exchange rate the tenant trades at (FX spread already applied)
              * @example 45000
              */
             rate?: number;
+            /**
+             * @description Market rate before the tenant FX spread; equal to `rate` when no spread applies
+             * @example 45685
+             */
+            base_rate?: number;
+            /**
+             * @description Tenant FX spread already taken off `rate`, in whole percent
+             * @example 1.5
+             */
+            fx_spread_percent?: number;
             /**
              * @description Inverted exchange rate
              * @example 0.0000222

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

@@ -1154,7 +1154,9 @@ export interface paths {
                         "application/json": components["schemas"]["ErrorResponse"];
                     };
                 };
-                /** @description Access denied */
+                /** @description Access denied, or (Clerk tenants) the second-factor verification is
+                 *     stale — `TWO_FACTOR_REVERIFICATION_REQUIRED`: re-verify and retry.
+                 *      */
                 403: {
                     headers: {
                         [name: string]: unknown;
@@ -1255,7 +1257,9 @@ export interface paths {
                         };
                     };
                 };
-                /** @description Access denied */
+                /** @description Access denied, or (Clerk tenants) the second-factor verification is
+                 *     stale — `TWO_FACTOR_REVERIFICATION_REQUIRED`: re-verify and retry.
+                 *      */
                 403: {
                     headers: {
                         [name: string]: unknown;
@@ -1311,7 +1315,9 @@ export interface paths {
                         };
                     };
                 };
-                /** @description Access denied */
+                /** @description Access denied, or (Clerk tenants) the second-factor verification is
+                 *     stale — `TWO_FACTOR_REVERIFICATION_REQUIRED`: re-verify and retry.
+                 *      */
                 403: {
                     headers: {
                         [name: string]: unknown;
@@ -1477,7 +1483,9 @@ export interface paths {
                         };
                     };
                 };
-                /** @description Access denied */
+                /** @description Access denied, or (Clerk tenants) the second-factor verification is
+                 *     stale — `TWO_FACTOR_REVERIFICATION_REQUIRED`: re-verify and retry.
+                 *      */
                 403: {
                     headers: {
                         [name: string]: unknown;
@@ -1532,7 +1540,9 @@ export interface paths {
                         };
                     };
                 };
-                /** @description Access denied */
+                /** @description Access denied, or (Clerk tenants) the second-factor verification is
+                 *     stale — `TWO_FACTOR_REVERIFICATION_REQUIRED`: re-verify and retry.
+                 *      */
                 403: {
                     headers: {
                         [name: string]: unknown;
@@ -1641,7 +1651,7 @@ export interface paths {
          * Create destination
          * @description counterparty_account_id in body. Caller must be owner or admin of the account's wallet and the wallet's KYC must be APPROVED; other members receive 403.
          *
-         *     **Banking types**: banking_data required
+         *     **Banking types**: banking_data required. `banking_data.address` (the bank address) is mandatory; `banking_data.beneficiary_address` (the recipient's own postal address, same shape) is optional — when present it must be complete (city, country_id, postcode, street1; state_id on US rails), is never overwritten by bank-directory enrichment, is exempt from the bank-country check, and payouts use it in place of the bank address.
          *     **Crypto types**: crypto_data required
          *     **Internal type**: internal_data required (target wallet on the same platform)
          *
@@ -1703,7 +1713,9 @@ export interface paths {
                         "application/json": components["schemas"]["ErrorResponse"];
                     };
                 };
-                /** @description Access denied */
+                /** @description Access denied, or (Clerk tenants) the second-factor verification is
+                 *     stale — `TWO_FACTOR_REVERIFICATION_REQUIRED`: re-verify and retry.
+                 *      */
                 403: {
                     headers: {
                         [name: string]: unknown;
@@ -1782,7 +1794,7 @@ export interface paths {
         put?: never;
         /**
          * Create crypto wallet
-         * @description Creates a new crypto wallet (Utila wallet) for the platform wallet.
+         * @description Creates a new crypto wallet for the platform wallet.
          *     Optionally specify chains to create addresses immediately.
          *
          */
@@ -1800,6 +1812,7 @@ export interface paths {
                     "application/json": {
                         name: string;
                         external_id?: string;
+                        /** @description Chain IDs to create addresses on. Omit or leave empty to create a wallet without addresses; the first address added later creates the custody-provider wallet. */
                         chains?: number[];
                     };
                 };
@@ -1948,7 +1961,7 @@ export interface paths {
         post?: never;
         /**
          * Delete crypto wallet
-         * @description Soft-deletes a crypto wallet and archives it in Utila.
+         * @description Soft-deletes a crypto wallet and archives it with the custody provider.
          *     The wallet is marked as deleted and all addresses are deactivated.
          *
          */
@@ -3024,6 +3037,8 @@ export interface paths {
          * Delete card
          * @description Closes the card at the vendor and sets its status to `CANCELED`. The record is retained (still listable), the action cannot be undone, and a second call answers 400 (`already deleted`).
          *
+         *     **Balance sweep**: when this is the last live card on its sub-account, the sub-account's remaining balance is first returned to the wallet through the ordinary `WITHDRAW_CARD_SUBACCOUNT` withdrawal (priced and ledgered like a manual one), and only then is the card closed. The response reports what happened in `sweep`. The sweep is best effort and never blocks the close: when the program offers no withdrawal or the return fails, the card is closed anyway and `sweep.error` / `sweep.left_with_operator` say what stayed at the vendor.
+         *
          *     **Authentication**: Bearer token with x-tenant-id header required
          *
          *     **Access Control**: Wallet owner or admin of the card's wallet
@@ -3052,6 +3067,23 @@ export interface paths {
                             success?: boolean;
                             /** @example Card deleted successfully */
                             message?: string;
+                            /** @description What happened to the sub-account balance before the close */
+                            sweep?: {
+                                /** @enum {string} */
+                                decision?: "sweep" | "skip_no_sub_account" | "skip_shared_sub_account" | "skip_empty" | "skip_not_client_money" | "skip_no_withdrawal_rail";
+                                sub_account_id?: string | null;
+                                /** @description Balance found on the sub-account before the close */
+                                available?: number;
+                                currency?: string | null;
+                                /** @description Amount actually returned to the wallet (0 when skipped or failed) */
+                                swept?: number;
+                                /** @description The WITHDRAW_CARD_SUBACCOUNT order that carried the return */
+                                order_uuid?: string | null;
+                                /** @description Why a due return did not happen; the card was closed regardless */
+                                error?: string | null;
+                                /** @description Balance the vendor returned to the operator instead of the client on this close (0 when none) */
+                                left_with_operator?: number;
+                            } | null;
                         };
                     };
                 };
@@ -5017,7 +5049,7 @@ export interface paths {
                          */
                         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).
+                         * @description Tax identifier of the cardholder, separate from the document number. Required by some CONSUMER programs when nationality is USA, where it must be a valid SSN (9 digits or XXX-XX-XXXX).
                          *
                          * @example 123-45-6789
                          */
@@ -5317,7 +5349,7 @@ export interface paths {
                         gov_id_issuance_date?: string;
                         /** Format: date */
                         gov_id_expiration_date?: string;
-                        /** @description Tax identifier (USA + Interlace CONSUMER: SSN, 9 digits or XXX-XX-XXXX) */
+                        /** @description Tax identifier (USA + CONSUMER programs that require it: SSN, 9 digits or XXX-XX-XXXX) */
                         tax_identification_number?: string;
                         address?: {
                             line1?: string;
@@ -8166,6 +8198,17 @@ export interface paths {
          *     `GET /frontend/counterparty/destinations/{id}/internal-transfer` to
          *     offer that option when the destination supports it.
          *
+         *     **Cross-currency send (optional).** A `to_currency_id` different from
+         *     `from_currency_id` converts on the way out, like the fiat offramps: the
+         *     wallet is debited in `from_currency_id`, the destination receives
+         *     `amount_to` in `to_currency_id` at the tenant's exchange rate for this
+         *     order type. The pair must be configured (`400 EXCHANGE_RATE_NOT_FOUND`),
+         *     `to_currency_id` must be on-chain (`400 INVALID_REQUEST`) and the
+         *     destination must be registered on the network of `to_currency_id`
+         *     (`400 DESTINATION_CHAIN_MISMATCH`). Preview with
+         *     `POST /frontend/orders/calc`. Omitted or equal `to_currency_id` is the
+         *     plain same-asset transfer.
+         *
          */
         post: {
             parameters: {
@@ -9489,6 +9532,14 @@ export interface paths {
          *     carry `request_id` (idempotency key); `scheduled_at` is ignored.
          *     Prefer `POST /frontend/orders/withdrawal/crypto`.
          *
+         *     A `to_currency_id` different from `from_currency_id` is a cross-currency
+         *     send under the same rules as the preferred endpoint (`400
+         *     EXCHANGE_RATE_NOT_FOUND` / `INVALID_REQUEST` / `DESTINATION_CHAIN_MISMATCH`).
+         *     This alias still downgrades a send to an address of a wallet on this
+         *     platform to an off-chain internal transfer, which moves one currency
+         *     only — such a request with a different `to_currency_id` is refused with
+         *     `400 INVALID_REQUEST` instead of silently delivering `from_currency_id`.
+         *
          */
         post: {
             parameters: {
@@ -9710,7 +9761,12 @@ export interface paths {
         };
         /**
          * Get exchange rates
-         * @description Returns exchange rates with tenant-specific fees applied.
+         * @description Returns exchange rates for the pairs enabled for the tenant.
+         *
+         *     `rate` is what the tenant trades at: the tenant FX spread is already
+         *     applied. `base_rate` carries the market rate it was derived from and
+         *     `fx_spread_percent` the percent taken off, so the spread can be shown
+         *     as a line of its own.
          *
          *     **Authentication**: Bearer token + x-tenant-id header
          *
@@ -10539,8 +10595,8 @@ export interface paths {
         put?: never;
         /**
          * Sync virtual account
-         * @description Refreshes the bank account details and deposit instructions from the vendor
-         *     (Brale / Delos / BCB) and updates the local record. Historical Rail.io
+         * @description Refreshes the bank account details and deposit instructions from the provider
+         *     serving the account and updates the local record. Historical Rail.io
          *     (RAIL-B / RAIL-C) accounts cannot be refreshed — their stored requisites are
          *     returned unchanged.
          *
@@ -10629,7 +10685,7 @@ export interface paths {
         /**
          * Get virtual account
          * @description Retrieves detailed information about a specific virtual account.
-         *     For accounts linked to a vendor (Brale / Delos / BCB) the requisites are refreshed
+         *     For accounts linked to a provider the requisites are refreshed
          *     from the vendor on read unless `skip_sync=true`; a failed refresh falls back to the
          *     cached data (still 200). Accounts without a vendor link and historical Rail.io
          *     accounts return the stored data.
@@ -10718,7 +10774,6 @@ export interface paths {
          *
          *     **Supported identifier types:**
          *     - `uuid` — user_data.uuid
-         *     - `id` — user_data.id (numeric)
          *     - `email` — user_data.email (case-insensitive)
          *     - `phone` — user_data.phone
          *     - `telegram` — `telegram_user.tg_id`, or a case-insensitive `username` match (leading `@` ignored)
@@ -10732,7 +10787,7 @@ export interface paths {
                     /** @description The search value */
                     identifier: string;
                     /** @description Type of identifier to search by */
-                    type: "uuid" | "id" | "email" | "phone" | "telegram";
+                    type: "uuid" | "email" | "phone" | "telegram";
                 };
                 header?: never;
                 path?: never;
@@ -12134,7 +12189,7 @@ export interface paths {
          *
          *     **Access Control**: Owner or admin of the wallet; wallet KYC must be APPROVED
          *
-         *     **Note**: New addresses are always provisioned via Utila. The legacy Processing (Accepta) provider was decommissioned; existing `processing` addresses remain readable.
+         *     **Note**: New addresses are always provisioned with `type: utila`. The legacy `processing` provider was decommissioned; existing `processing` addresses remain readable.
          *
          */
         post: {
@@ -12639,7 +12694,10 @@ export interface paths {
                          */
                         user_data_uuid: string;
                         /**
-                         * @description Role to assign to the user
+                         * @description Role to assign to the user. Must be one of the roles enabled for the tenant
+                         *     (tenant config `allowed_roles`); any other role is refused with
+                         *     400 `ROLE_NOT_ALLOWED_FOR_TENANT`.
+                         *
                          * @enum {string}
                          */
                         role: "auditor" | "user" | "admin";
@@ -12813,7 +12871,10 @@ export interface paths {
                 content: {
                     "application/json": {
                         /**
-                         * @description New role for the user
+                         * @description New role for the user. Must be one of the roles enabled for the tenant
+                         *     (tenant config `allowed_roles`); any other role is refused with
+                         *     400 `ROLE_NOT_ALLOWED_FOR_TENANT`.
+                         *
                          * @enum {string}
                          */
                         role: "auditor" | "user" | "admin";
@@ -13146,7 +13207,10 @@ export interface paths {
                          */
                         email: string;
                         /**
-                         * @description Role to assign on acceptance
+                         * @description Role to assign on acceptance. Must be one of the roles enabled for the tenant
+                         *     (tenant config `allowed_roles`); any other role is refused with
+                         *     400 `ROLE_NOT_ALLOWED_FOR_TENANT`.
+                         *
                          * @enum {string}
                          */
                         role: "auditor" | "user" | "admin";
@@ -13406,7 +13470,7 @@ export interface components {
          * @example EXCHANGE_OMNI
          * @enum {string}
          */
-        OrderTypeId: "EXCHANGE_OMNI" | "EXCHANGE_OMNI_ONRAMP" | "EXCHANGE_OMNI_OFFRAMP" | "EXCHANGE_OMNI_CRYPTO" | "EXCHANGE_CRYPTO_INTERNAL" | "L2F_ACH_ONRAMP" | "L2F_ACH_OFFRAMP" | "L2F_SEPA_ONRAMP" | "L2F_SEPA_OFFRAMP" | "L2F_SWIFT_ONRAMP" | "L2F_SWIFT_OFFRAMP" | "L2F_WIRE_ONRAMP" | "L2F_WIRE_OFFRAMP" | "L2F_CHAPS_ONRAMP" | "L2F_CHAPS_OFFRAMP" | "L2F_FPS_ONRAMP" | "L2F_FPS_OFFRAMP" | "BRL_WIRE_ONRAMP" | "BRL_WIRE_OFFRAMP" | "BRL_ACH_ONRAMP" | "BRL_ACH_OFFRAMP" | "BRL_RTP_OFFRAMP" | "DLS_WIRE_ONRAMP" | "DLS_WIRE_OFFRAMP" | "DLS_ACH_ONRAMP" | "DLS_ACH_OFFRAMP" | "DLS_SEPA_ONRAMP" | "DLS_SEPA_OFFRAMP" | "DLS_SWIFT_ONRAMP" | "DLS_SWIFT_OFFRAMP" | "BC1_SEPA_ONRAMP" | "BC1_SEPA_OFFRAMP" | "BC1_SWIFT_ONRAMP" | "BC1_SWIFT_OFFRAMP" | "BC3_SEPA_ONRAMP" | "BC3_SEPA_OFFRAMP" | "OMNIBUS_CRYPTO_TRANSFER" | "OMNIBUS_CRYPTO_WITHDRAWAL" | "OMNIBUS_INTERNAL_TRANSFER" | "SEGREGATED_CRYPTO_TRANSFER" | "TRANSFER_INTERNAL" | "TRANSFER_CARD_PREPAID" | "TRANSFER_CARD_SUBACCOUNT" | "TRANSFER_CARD_WHOLESALE" | "WITHDRAW_CARD_PREPAID" | "WITHDRAW_CARD_SUBACCOUNT" | "REFUND_CARD_PREPAID" | "REFUND_CARD_SUBACCOUNT" | "RN_CARDS_OFFRAMP" | "CARD_ISSUING_FEE";
+        OrderTypeId: "EXCHANGE_OMNI" | "EXCHANGE_OMNI_ONRAMP" | "EXCHANGE_OMNI_OFFRAMP" | "EXCHANGE_OMNI_CRYPTO" | "EXCHANGE_CRYPTO_INTERNAL" | "L2F_ACH_ONRAMP" | "L2F_ACH_OFFRAMP" | "L2F_SEPA_ONRAMP" | "L2F_SEPA_OFFRAMP" | "L2F_SWIFT_ONRAMP" | "L2F_SWIFT_OFFRAMP" | "L2F_WIRE_ONRAMP" | "L2F_WIRE_OFFRAMP" | "L2F_CHAPS_ONRAMP" | "L2F_CHAPS_OFFRAMP" | "L2F_FPS_ONRAMP" | "L2F_FPS_OFFRAMP" | "BRL_WIRE_ONRAMP" | "BRL_WIRE_OFFRAMP" | "BRL_ACH_ONRAMP" | "BRL_ACH_OFFRAMP" | "BRL_RTP_OFFRAMP" | "DLS_WIRE_ONRAMP" | "DLS_WIRE_OFFRAMP" | "DLS_ACH_ONRAMP" | "DLS_ACH_OFFRAMP" | "DLS_SEPA_ONRAMP" | "DLS_SEPA_OFFRAMP" | "DLS_SWIFT_ONRAMP" | "DLS_SWIFT_OFFRAMP" | "BC1_SEPA_ONRAMP" | "BC1_SEPA_OFFRAMP" | "BC1_SWIFT_ONRAMP" | "BC1_SWIFT_OFFRAMP" | "BC3_SEPA_ONRAMP" | "BC3_SEPA_OFFRAMP" | "RPP_SWIFT_OFFRAMP" | "RPP_SEPA_OFFRAMP" | "RPP_FPS_OFFRAMP" | "RPP_ACH_OFFRAMP" | "OMNIBUS_CRYPTO_TRANSFER" | "OMNIBUS_CRYPTO_WITHDRAWAL" | "OMNIBUS_INTERNAL_TRANSFER" | "SEGREGATED_CRYPTO_TRANSFER" | "TRANSFER_INTERNAL" | "TRANSFER_CARD_PREPAID" | "TRANSFER_CARD_SUBACCOUNT" | "TRANSFER_CARD_WHOLESALE" | "WITHDRAW_CARD_PREPAID" | "WITHDRAW_CARD_SUBACCOUNT" | "REFUND_CARD_PREPAID" | "REFUND_CARD_SUBACCOUNT" | "RN_CARDS_OFFRAMP" | "CARD_ISSUING_FEE" | "MONTHLY_FEE";
         OrderCalculation: {
             /**
              * Format: uuid
@@ -13429,10 +13493,20 @@ export interface components {
              */
             result_amount: number;
             /**
-             * @description Exchange rate applied (source → destination), 6 decimals.
+             * @description Exchange rate applied (source → destination), 6 decimals. Includes the tenant FX spread.
              * @example 0.985
              */
             rate: number;
+            /**
+             * @description Market rate before the tenant FX spread. Equal to `rate` when no spread applies.
+             * @example 1
+             */
+            base_rate: number;
+            /**
+             * @description Tenant FX spread already taken off `rate`, in whole percent.
+             * @example 1.5
+             */
+            fx_spread: number;
             /**
              * @description Total fees (comission + network_fee), in the source currency.
              * @example 1.5
@@ -13530,7 +13604,7 @@ export interface components {
             /** @description Active destinations belonging to this account. */
             destinations: components["schemas"]["CounterpartyDestination"][];
         };
-        /** @description Registered postal address of the BANK (not the beneficiary). On create it is replaced atomically by the bank-directory address when the submitted bank code resolves to a complete one; otherwise the submitted address is kept. */
+        /** @description Postal address of a banking destination — whose address it is (the bank vs the beneficiary) is defined by the property that carries it. */
         CounterpartyBankingAddress: {
             city?: string | null;
             postcode?: string | null;
@@ -13555,7 +13629,10 @@ export interface components {
             /** @description Sort code (6 digits, UK banking) */
             sort_code?: string | null;
             note?: string | null;
+            /** @description Registered postal address of the BANK (not the beneficiary). On create it is replaced atomically by the bank-directory address when the submitted bank code resolves to a complete one; otherwise the submitted address is kept. */
             address?: components["schemas"]["CounterpartyBankingAddress"] | null;
+            /** @description The beneficiary's (recipient's) own postal address. Optional on create; never touched by bank-directory enrichment and exempt from the bank-country check (the recipient may live outside the bank's country). Null → payouts use `address` (the bank address). */
+            beneficiary_address?: components["schemas"]["CounterpartyBankingAddress"] | null;
             /** Format: date-time */
             created_at: string;
         } | null;
@@ -13766,10 +13843,10 @@ export interface components {
             cardholder_requirements?: {
                 /** @enum {string} */
                 level?: "minimal" | "basic" | "declared" | "full";
-                /** @description Required field names; address fields are dotted (address.line1). Interlace CONSUMER also lists gov_id_issuance_date and gov_id_expiration_date (ISO YYYY-MM-DD). */
+                /** @description Required field names; address fields are dotted (address.line1). Some CONSUMER programs also list gov_id_issuance_date and gov_id_expiration_date (ISO YYYY-MM-DD). */
                 required?: string[];
                 required_documents?: ("gov_id_front" | "gov_id_back" | "selfie")[];
-                /** @description Human-readable constraints the field list cannot express. Interlace CONSUMER: if nationality is USA, tax_identification_number is required and must be a valid SSN. */
+                /** @description Human-readable constraints the field list cannot express — e.g. a CONSUMER program requiring tax_identification_number to be a valid SSN when nationality is USA. */
                 notes?: string[];
                 /** @description What each country changes, keyed by ISO 3166-1 alpha-3 with a `default` entry; empty when the vendor reviews nothing. These fields stay out of `required` because they only hold once the nationality or address country is known: read the rule for the nationality the user picked (required_by_nationality), the rule for the address country (required_by_address), and the rule for the country that issued the document (gov_id_types). */
                 country_rules?: {
@@ -14008,7 +14085,7 @@ export interface components {
             transaction_amount: number;
             /** @example USD */
             transaction_currency: string;
-            /** @description What actually left the card: `billing_amount` plus `fee` for a debit. Show this one when a fee sits inside the operation. */
+            /** @description What actually left the card: `billing_amount` plus `fee` for a debit, minus it for a credit, and 0 when `status` is `DECLINED` — a refusal moves no money, however much the vendor quoted for it. Show this one when a fee sits inside the operation. */
             total_amount?: number;
             /** @description Fee charged inside this operation, in billing currency. 0 for vendors that bill fees as their own transactions (those arrive as separate rows with `transaction_type: FEE`). */
             fee?: number;
@@ -14889,11 +14966,20 @@ export interface components {
              * @default false
              */
             is_reverse: boolean;
-            /** Format: uuid */
+            /**
+             * Format: uuid
+             * @description Currency debited from the wallet.
+             */
             from_currency_id: string;
-            /** Format: uuid */
+            /**
+             * Format: uuid
+             * @description Optional. Currency delivered on-chain to the destination. Omitted or equal to `from_currency_id`: a plain transfer of the same asset. Different: a cross-currency send — the wallet is debited in `from_currency_id`, the destination receives `amount_to` in `to_currency_id` at the tenant's `OMNIBUS_CRYPTO_TRANSFER` exchange rate (like the fiat offramps). Requires a configured pair (`400 EXCHANGE_RATE_NOT_FOUND`), an on-chain currency (`400 INVALID_REQUEST`) and a destination registered on the network of `to_currency_id` (`400 DESTINATION_CHAIN_MISMATCH`). Preview with `POST /frontend/orders/calc`.
+             */
             to_currency_id?: string;
-            /** Format: uuid */
+            /**
+             * Format: uuid
+             * @description A `CRYPTO_EXTERNAL` counterparty destination. For a cross-currency send its address must be on the network of `to_currency_id`.
+             */
             counterparty_destination_id: string;
             /** Format: uuid */
             wallet_account_id?: string;
@@ -15361,7 +15447,7 @@ export interface components {
             /** Format: uuid */
             id: string;
             /** @enum {string} */
-            type: "DEPOSIT_RECEIVED" | "TRANSFER_RECEIVED" | "ORDER_STATUS_CHANGED" | "KYC_STATUS_CHANGED" | "ANNOUNCEMENT" | "SYSTEM_MESSAGE";
+            type: "DEPOSIT_RECEIVED" | "TRANSFER_RECEIVED" | "ORDER_STATUS_CHANGED" | "KYC_STATUS_CHANGED" | "ANNOUNCEMENT" | "SYSTEM_MESSAGE" | "MASS_PAYOUT_STATUS_CHANGED" | "CARD_OTP";
             /** @description Structured fact snapshot; the client renders the presentation. Shape depends on `type`; evolution is additive-only. */
             payload: Record<string, never>;
             /** Format: uuid */
@@ -15373,12 +15459,12 @@ export interface components {
         };
         NotificationPreference: {
             /** @enum {string} */
-            channel: "IN_APP" | "PUSH" | "EMAIL" | "TELEGRAM";
+            channel: "IN_APP" | "PUSH" | "EMAIL" | "TELEGRAM" | "SMS";
             enabled: boolean;
         };
         NotificationCategoryPreference: {
             /** @enum {string} */
-            category: "TRANSACTIONS" | "COMPLIANCE" | "ANNOUNCEMENTS" | "SYSTEM";
+            category: "TRANSACTIONS" | "COMPLIANCE" | "ANNOUNCEMENTS" | "SYSTEM" | "SECURITY";
             enabled: boolean;
         };
     };

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

@@ -1238,7 +1238,10 @@ export interface paths {
         post?: never;
         /**
          * Cancel a card
-         * @description Cancels (permanently deactivates) a card by its ID
+         * @description Cancels (permanently deactivates) a card by its ID.
+         *
+         *     When this is the last live card on its sub-account, the sub-account's remaining balance is first returned to the wallet through the ordinary `WITHDRAW_CARD_SUBACCOUNT` withdrawal, and only then is the card closed; the response carries the outcome in `sweep`. The sweep is best effort and never blocks the close: when the program offers no withdrawal or the return fails, the card is closed anyway and `sweep.error` / `sweep.left_with_operator` say what stayed at the vendor.
+         *
          */
         delete: {
             parameters: {
@@ -1252,7 +1255,7 @@ export interface paths {
             };
             requestBody?: never;
             responses: {
-                /** @description Card successfully canceled */
+                /** @description Card successfully canceled; `sweep` reports what happened to the balance */
                 200: {
                     headers: {
                         [name: string]: unknown;
@@ -5538,6 +5541,14 @@ export interface paths {
          *     **External transfer:** If the address is external, creates an `OMNIBUS_CRYPTO_TRANSFER` order
          *     in status `NEW`, triggers async QStash workflow for blockchain transaction.
          *
+         *     **Cross-currency send:** a `to_currency_id` different from `from_currency_id` debits
+         *     `from_currency_id` and delivers `amount_to` in `to_currency_id` on its own network, at the
+         *     tenant's exchange rate for this order type (`400 EXCHANGE_RATE_NOT_FOUND` when the pair is
+         *     not configured, `400 INVALID_REQUEST` when `to_currency_id` is not on-chain,
+         *     `400 DESTINATION_CHAIN_MISMATCH` when the destination is registered on another network).
+         *     The internal downgrade moves one currency only, so it refuses a different `to_currency_id`
+         *     with `400 INVALID_REQUEST`.
+         *
          */
         post: {
             parameters: {
@@ -5583,9 +5594,14 @@ export interface paths {
                         wallet_account_id?: string;
                         /**
                          * Format: uuid
-                         * @description Currency UUID
+                         * @description Currency debited from the wallet
                          */
                         from_currency_id: string;
+                        /**
+                         * Format: uuid
+                         * @description Optional. Currency delivered on-chain; omitted or equal to `from_currency_id` is a plain same-asset transfer, a different value is a cross-currency send (see above)
+                         */
+                        to_currency_id?: string;
                         /**
                          * @description Calculate in reverse (starting from the destination amount). Ignored for internal transfers.
                          * @example false
@@ -7151,7 +7167,7 @@ export interface components {
          * @example EXCHANGE_OMNI
          * @enum {string}
          */
-        OrderTypeId: "EXCHANGE_OMNI" | "EXCHANGE_OMNI_ONRAMP" | "EXCHANGE_OMNI_OFFRAMP" | "EXCHANGE_OMNI_CRYPTO" | "EXCHANGE_CRYPTO_INTERNAL" | "L2F_ACH_ONRAMP" | "L2F_ACH_OFFRAMP" | "L2F_SEPA_ONRAMP" | "L2F_SEPA_OFFRAMP" | "L2F_SWIFT_ONRAMP" | "L2F_SWIFT_OFFRAMP" | "L2F_WIRE_ONRAMP" | "L2F_WIRE_OFFRAMP" | "L2F_CHAPS_ONRAMP" | "L2F_CHAPS_OFFRAMP" | "L2F_FPS_ONRAMP" | "L2F_FPS_OFFRAMP" | "BRL_WIRE_ONRAMP" | "BRL_WIRE_OFFRAMP" | "BRL_ACH_ONRAMP" | "BRL_ACH_OFFRAMP" | "BRL_RTP_OFFRAMP" | "DLS_WIRE_ONRAMP" | "DLS_WIRE_OFFRAMP" | "DLS_ACH_ONRAMP" | "DLS_ACH_OFFRAMP" | "DLS_SEPA_ONRAMP" | "DLS_SEPA_OFFRAMP" | "DLS_SWIFT_ONRAMP" | "DLS_SWIFT_OFFRAMP" | "BC1_SEPA_ONRAMP" | "BC1_SEPA_OFFRAMP" | "BC1_SWIFT_ONRAMP" | "BC1_SWIFT_OFFRAMP" | "BC3_SEPA_ONRAMP" | "BC3_SEPA_OFFRAMP" | "OMNIBUS_CRYPTO_TRANSFER" | "OMNIBUS_CRYPTO_WITHDRAWAL" | "OMNIBUS_INTERNAL_TRANSFER" | "SEGREGATED_CRYPTO_TRANSFER" | "TRANSFER_INTERNAL" | "TRANSFER_CARD_PREPAID" | "TRANSFER_CARD_SUBACCOUNT" | "TRANSFER_CARD_WHOLESALE" | "WITHDRAW_CARD_PREPAID" | "WITHDRAW_CARD_SUBACCOUNT" | "REFUND_CARD_PREPAID" | "REFUND_CARD_SUBACCOUNT" | "RN_CARDS_OFFRAMP" | "CARD_ISSUING_FEE";
+        OrderTypeId: "EXCHANGE_OMNI" | "EXCHANGE_OMNI_ONRAMP" | "EXCHANGE_OMNI_OFFRAMP" | "EXCHANGE_OMNI_CRYPTO" | "EXCHANGE_CRYPTO_INTERNAL" | "L2F_ACH_ONRAMP" | "L2F_ACH_OFFRAMP" | "L2F_SEPA_ONRAMP" | "L2F_SEPA_OFFRAMP" | "L2F_SWIFT_ONRAMP" | "L2F_SWIFT_OFFRAMP" | "L2F_WIRE_ONRAMP" | "L2F_WIRE_OFFRAMP" | "L2F_CHAPS_ONRAMP" | "L2F_CHAPS_OFFRAMP" | "L2F_FPS_ONRAMP" | "L2F_FPS_OFFRAMP" | "BRL_WIRE_ONRAMP" | "BRL_WIRE_OFFRAMP" | "BRL_ACH_ONRAMP" | "BRL_ACH_OFFRAMP" | "BRL_RTP_OFFRAMP" | "DLS_WIRE_ONRAMP" | "DLS_WIRE_OFFRAMP" | "DLS_ACH_ONRAMP" | "DLS_ACH_OFFRAMP" | "DLS_SEPA_ONRAMP" | "DLS_SEPA_OFFRAMP" | "DLS_SWIFT_ONRAMP" | "DLS_SWIFT_OFFRAMP" | "BC1_SEPA_ONRAMP" | "BC1_SEPA_OFFRAMP" | "BC1_SWIFT_ONRAMP" | "BC1_SWIFT_OFFRAMP" | "BC3_SEPA_ONRAMP" | "BC3_SEPA_OFFRAMP" | "RPP_SWIFT_OFFRAMP" | "RPP_SEPA_OFFRAMP" | "RPP_FPS_OFFRAMP" | "RPP_ACH_OFFRAMP" | "OMNIBUS_CRYPTO_TRANSFER" | "OMNIBUS_CRYPTO_WITHDRAWAL" | "OMNIBUS_INTERNAL_TRANSFER" | "SEGREGATED_CRYPTO_TRANSFER" | "TRANSFER_INTERNAL" | "TRANSFER_CARD_PREPAID" | "TRANSFER_CARD_SUBACCOUNT" | "TRANSFER_CARD_WHOLESALE" | "WITHDRAW_CARD_PREPAID" | "WITHDRAW_CARD_SUBACCOUNT" | "REFUND_CARD_PREPAID" | "REFUND_CARD_SUBACCOUNT" | "RN_CARDS_OFFRAMP" | "CARD_ISSUING_FEE" | "MONTHLY_FEE";
         /** @description Order type reference with optional product guardrails, associated KYC rails and tenant billing rates */
         OrderType: {
             /** @description Order type identifier (e.g. EXCHANGE, WITHDRAWAL_CRYPTO) */

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

@@ -1033,6 +1033,7 @@ export interface paths {
                     "application/json": {
                         name: string;
                         external_id?: string;
+                        /** @description Chain IDs to create addresses on. Omit or leave empty to create a wallet without addresses; the first address added later creates the custody-provider wallet. */
                         chains?: number[];
                     };
                 };
@@ -1193,7 +1194,7 @@ export interface paths {
         post?: never;
         /**
          * Delete crypto wallet
-         * @description Soft-deletes a crypto wallet and archives it in Utila.
+         * @description Soft-deletes a crypto wallet and archives it with the custody provider.
          *     The wallet is marked as deleted and all addresses are deactivated.
          *
          */
@@ -2577,6 +2578,10 @@ export interface paths {
                          * @default false
                          */
                         is_reverse?: boolean;
+                        /** @description Free-form reference visible in order/transaction listings */
+                        reference?: string;
+                        /** @description Internal note attached to the order */
+                        note?: string;
                         /**
                          * Format: date-time
                          * @description Optional. Schedule the transfer for a future time (min 1 hour, max 90 days ahead). No funds are reserved; after approval the order waits in EXPECTED status and executes automatically.
@@ -2654,6 +2659,17 @@ export interface paths {
          *     a wallet on this platform. Internal (off-chain) transfers are created
          *     only through the internal transfer endpoint.
          *
+         *     **Cross-currency send (optional).** A `to_currency_id` different from
+         *     `from_currency_id` converts on the way out, like the fiat offramps: the
+         *     wallet is debited in `from_currency_id`, the destination receives
+         *     `amount_to` in `to_currency_id` at the tenant's exchange rate for this
+         *     order type. The pair must be configured (`400 EXCHANGE_RATE_NOT_FOUND`),
+         *     `to_currency_id` must be on-chain (`400 INVALID_REQUEST`) and the
+         *     destination must be registered on the network of `to_currency_id`
+         *     (`400 DESTINATION_CHAIN_MISMATCH`). Preview with
+         *     `POST /admin/orders/calc`. Omitted or equal `to_currency_id` is the
+         *     plain same-asset transfer.
+         *
          */
         post: {
             parameters: {
@@ -6212,7 +6228,7 @@ export interface paths {
                          */
                         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).
+                         * @description Tax identifier of the cardholder, separate from the document number. Required by some CONSUMER programs when nationality is USA, where it must be a valid SSN (9 digits or XXX-XX-XXXX).
                          *
                          * @example 123-45-6789
                          */
@@ -6408,7 +6424,7 @@ export interface paths {
                         gov_id_issuance_date?: string;
                         /** Format: date */
                         gov_id_expiration_date?: string;
-                        /** @description Tax identifier (USA + Interlace CONSUMER: SSN, 9 digits or XXX-XX-XXXX) */
+                        /** @description Tax identifier (USA + CONSUMER programs that require it: SSN, 9 digits or XXX-XX-XXXX) */
                         tax_identification_number?: string;
                         address?: {
                             line1?: string;
@@ -7927,7 +7943,7 @@ export interface components {
              */
             cvv: string;
             /**
-             * @description 3-D Secure password where the vendor exposes one (Wallester); `null` otherwise.
+             * @description 3-D Secure password where the card program exposes one; `null` otherwise.
              * @example null
              */
             security_code: string | null;
@@ -8677,7 +8693,7 @@ export interface components {
          * @example EXCHANGE_OMNI
          * @enum {string}
          */
-        OrderTypeId: "EXCHANGE_OMNI" | "EXCHANGE_OMNI_ONRAMP" | "EXCHANGE_OMNI_OFFRAMP" | "EXCHANGE_OMNI_CRYPTO" | "EXCHANGE_CRYPTO_INTERNAL" | "L2F_ACH_ONRAMP" | "L2F_ACH_OFFRAMP" | "L2F_SEPA_ONRAMP" | "L2F_SEPA_OFFRAMP" | "L2F_SWIFT_ONRAMP" | "L2F_SWIFT_OFFRAMP" | "L2F_WIRE_ONRAMP" | "L2F_WIRE_OFFRAMP" | "L2F_CHAPS_ONRAMP" | "L2F_CHAPS_OFFRAMP" | "L2F_FPS_ONRAMP" | "L2F_FPS_OFFRAMP" | "BRL_WIRE_ONRAMP" | "BRL_WIRE_OFFRAMP" | "BRL_ACH_ONRAMP" | "BRL_ACH_OFFRAMP" | "BRL_RTP_OFFRAMP" | "DLS_WIRE_ONRAMP" | "DLS_WIRE_OFFRAMP" | "DLS_ACH_ONRAMP" | "DLS_ACH_OFFRAMP" | "DLS_SEPA_ONRAMP" | "DLS_SEPA_OFFRAMP" | "DLS_SWIFT_ONRAMP" | "DLS_SWIFT_OFFRAMP" | "BC1_SEPA_ONRAMP" | "BC1_SEPA_OFFRAMP" | "BC1_SWIFT_ONRAMP" | "BC1_SWIFT_OFFRAMP" | "BC3_SEPA_ONRAMP" | "BC3_SEPA_OFFRAMP" | "OMNIBUS_CRYPTO_TRANSFER" | "OMNIBUS_CRYPTO_WITHDRAWAL" | "OMNIBUS_INTERNAL_TRANSFER" | "SEGREGATED_CRYPTO_TRANSFER" | "TRANSFER_INTERNAL" | "TRANSFER_CARD_PREPAID" | "TRANSFER_CARD_SUBACCOUNT" | "TRANSFER_CARD_WHOLESALE" | "WITHDRAW_CARD_PREPAID" | "WITHDRAW_CARD_SUBACCOUNT" | "REFUND_CARD_PREPAID" | "REFUND_CARD_SUBACCOUNT" | "RN_CARDS_OFFRAMP" | "CARD_ISSUING_FEE";
+        OrderTypeId: "EXCHANGE_OMNI" | "EXCHANGE_OMNI_ONRAMP" | "EXCHANGE_OMNI_OFFRAMP" | "EXCHANGE_OMNI_CRYPTO" | "EXCHANGE_CRYPTO_INTERNAL" | "L2F_ACH_ONRAMP" | "L2F_ACH_OFFRAMP" | "L2F_SEPA_ONRAMP" | "L2F_SEPA_OFFRAMP" | "L2F_SWIFT_ONRAMP" | "L2F_SWIFT_OFFRAMP" | "L2F_WIRE_ONRAMP" | "L2F_WIRE_OFFRAMP" | "L2F_CHAPS_ONRAMP" | "L2F_CHAPS_OFFRAMP" | "L2F_FPS_ONRAMP" | "L2F_FPS_OFFRAMP" | "BRL_WIRE_ONRAMP" | "BRL_WIRE_OFFRAMP" | "BRL_ACH_ONRAMP" | "BRL_ACH_OFFRAMP" | "BRL_RTP_OFFRAMP" | "DLS_WIRE_ONRAMP" | "DLS_WIRE_OFFRAMP" | "DLS_ACH_ONRAMP" | "DLS_ACH_OFFRAMP" | "DLS_SEPA_ONRAMP" | "DLS_SEPA_OFFRAMP" | "DLS_SWIFT_ONRAMP" | "DLS_SWIFT_OFFRAMP" | "BC1_SEPA_ONRAMP" | "BC1_SEPA_OFFRAMP" | "BC1_SWIFT_ONRAMP" | "BC1_SWIFT_OFFRAMP" | "BC3_SEPA_ONRAMP" | "BC3_SEPA_OFFRAMP" | "RPP_SWIFT_OFFRAMP" | "RPP_SEPA_OFFRAMP" | "RPP_FPS_OFFRAMP" | "RPP_ACH_OFFRAMP" | "OMNIBUS_CRYPTO_TRANSFER" | "OMNIBUS_CRYPTO_WITHDRAWAL" | "OMNIBUS_INTERNAL_TRANSFER" | "SEGREGATED_CRYPTO_TRANSFER" | "TRANSFER_INTERNAL" | "TRANSFER_CARD_PREPAID" | "TRANSFER_CARD_SUBACCOUNT" | "TRANSFER_CARD_WHOLESALE" | "WITHDRAW_CARD_PREPAID" | "WITHDRAW_CARD_SUBACCOUNT" | "REFUND_CARD_PREPAID" | "REFUND_CARD_SUBACCOUNT" | "RN_CARDS_OFFRAMP" | "CARD_ISSUING_FEE" | "MONTHLY_FEE";
         OrderType: {
             id?: components["schemas"]["OrderTypeId"];
             description?: string;
@@ -8731,9 +8747,20 @@ export interface components {
              * @default false
              */
             is_reverse: boolean;
-            /** Format: uuid */
+            /**
+             * Format: uuid
+             * @description Currency debited from the wallet.
+             */
             from_currency_id: string;
-            /** Format: uuid */
+            /**
+             * Format: uuid
+             * @description Optional. Currency delivered on-chain to the destination. Omitted or equal to `from_currency_id`: a plain transfer of the same asset. Different: a cross-currency send — the wallet is debited in `from_currency_id`, the destination receives `amount_to` in `to_currency_id` at the tenant's `OMNIBUS_CRYPTO_TRANSFER` exchange rate (like the fiat offramps). Requires a configured pair (`400 EXCHANGE_RATE_NOT_FOUND`), an on-chain currency (`400 INVALID_REQUEST`) and a destination registered on the network of `to_currency_id` (`400 DESTINATION_CHAIN_MISMATCH`). Preview with `POST /admin/orders/calc`.
+             */
+            to_currency_id?: string;
+            /**
+             * Format: uuid
+             * @description A `CRYPTO_EXTERNAL` counterparty destination. For a cross-currency send its address must be on the network of `to_currency_id`.
+             */
             counterparty_destination_id: string;
             /** @description Free-form reference visible in order/transaction listings */
             reference?: string;

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

@@ -2036,6 +2036,12 @@ export interface components {
              *       "business"
              *     ] */
             allowed_kyc_entity_types: ("individual" | "business" | "universal")[] | null;
+            /** @example [
+             *       "owner",
+             *       "admin",
+             *       "auditor"
+             *     ] */
+            allowed_roles: ("owner" | "admin" | "user" | "auditor")[];
             tg_bot_name: string | null;
             theme_switch: boolean;
             enable_exchange: boolean;
@@ -3844,6 +3850,8 @@ export interface operations {
             query?: {
                 /** @description Whether to prefill the provider verification with the current user data (email, phone, name). Defaults to true. */
                 prefill?: boolean;
+                /** @description Reuse the current user's approved user-level verification for this entity instead of collecting it again. Omit to take the per-type default: individual reuses it (the dossier is the user), business does not (reuse means "I am a UBO of this company" and is opt-in). Pass false to opt out, true to require it — an explicit true fails when the user-level verification is not approved, while the default silently falls back to a normal verification. Only honoured by providers that keep a reusable user-level verification. */
+                reuse_user_verification?: boolean;
             };
             header?: never;
             path: {
@@ -3861,6 +3869,13 @@ export interface operations {
                     "application/json": components["schemas"]["InitKycDataCollectionResponseDto"];
                 };
             };
+            /** @description reuse_user_verification requested for an entity type that supports no reuse */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
             /** @description Unauthorized */
             401: {
                 headers: {

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

@@ -526,7 +526,7 @@ export declare namespace API {
                     counterparty_account_id: string;
                     type: CounterpartyDestinationType;
                     nickname?: string;
-                    external_banking_data?: Pick<List.DestinationListItemExternalBankingData, 'account_number' | 'routing_number' | 'bank_name' | 'swift_bic' | 'iban' | 'sort_code' | 'note' | 'address'>;
+                    external_banking_data?: Pick<List.DestinationListItemExternalBankingData, 'account_number' | 'routing_number' | 'bank_name' | 'swift_bic' | 'iban' | 'sort_code' | 'note' | 'address' | 'beneficiary_address'>;
                     external_crypto_data?: Pick<List.DestinationListItemExternalCryptoData, 'currency_id' | 'address' | 'memo'>;
                     internal_data?: Pick<List.DestinationInternalData, 'wallet_id' | 'description'>;
                 }
@@ -1287,6 +1287,25 @@ export declare namespace API {
                 type Request = operations['KycEntitiesController_findOne']['parameters']['path'];
                 type Response = operations['KycEntitiesController_findOne']['responses']['200']['content']['application/json'];
             }
+            namespace Create {
+                type Request = operations['KycEntitiesController_create']['requestBody']['content']['application/json'];
+                type Response = operations['KycEntitiesController_create']['responses']['201']['content']['application/json'];
+            }
+            namespace List {
+                type Response = operations['KycEntitiesController_findMy']['responses']['200']['content']['application/json'];
+            }
+            namespace GetById {
+                type Request = operations['KycEntitiesController_findById']['parameters']['path'];
+                type Response = operations['KycEntitiesController_findById']['responses']['200']['content']['application/json'];
+            }
+            namespace Init {
+                type Request = operations['KycEntitiesController_initDataCollection']['parameters']['path'] & NonNullable<operations['KycEntitiesController_initDataCollection']['parameters']['query']>;
+                type Response = operations['KycEntitiesController_initDataCollection']['responses']['200']['content']['application/json'];
+            }
+            namespace Resume {
+                type Request = operations['KycEntitiesController_resumeDataCollection']['parameters']['path'];
+                type Response = operations['KycEntitiesController_resumeDataCollection']['responses']['200']['content']['application/json'];
+            }
         }
         export namespace Forms {
             namespace FormField {

package/package.json

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