squarefi-bff-api-module 1.36.63 → 1.36.64

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

@@ -4703,6 +4703,8 @@ export interface paths {
         /**
          * Calculate order
          * @description Pre-calculates order amounts, fees and exchange rates without creating an order.
+         *     The quote is priced for the wallet bound to the API key; a `wallet_id` in the
+         *     query is ignored.
          *
          *     **Authentication**: x-api-key header required
          *
@@ -4716,6 +4718,9 @@ export interface paths {
                     to_currency_id: string;
                     /** @description If `true`, calculates inputs needed to receive the given amount. */
                     is_reverse?: "true" | "false";
+                    /** @description If `true` (default), the network fee is subtracted from `result_amount`. If `false`, the fee is added on top of `from_amount` and the recipient gets the full converted amount. Ignored for reverse calculations.
+                     *      */
+                    is_subtract?: "true" | "false";
                     /** @description Destination address (for crypto withdrawals; affects network fee estimation). */
                     to_address?: string;
                 };
@@ -4734,30 +4739,7 @@ export interface paths {
                         "application/json": {
                             /** @example true */
                             success?: boolean;
-                            data?: {
-                                from_amount?: number;
-                                to_amount?: number;
-                                rate?: number;
-                                fee?: number;
-                                /** Format: uuid */
-                                fee_currency?: string;
-                                network_fee?: number | null;
-                                /** Format: uuid */
-                                network_fee_currency?: string | null;
-                                total_amount?: number;
-                                from_currency?: {
-                                    /** Format: uuid */
-                                    uuid?: string;
-                                    symbol?: string;
-                                    name?: string;
-                                };
-                                to_currency?: {
-                                    /** Format: uuid */
-                                    uuid?: string;
-                                    symbol?: string;
-                                    name?: string;
-                                };
-                            };
+                            data?: components["schemas"]["OrderCalculation"];
                         };
                     };
                 };
@@ -4770,6 +4752,15 @@ export interface paths {
                         "application/json": components["schemas"]["ApiErrorResponse"];
                     };
                 };
+                /** @description The wallet's KYC status does not allow the operation (`KYC_REQUIREMENTS_NOT_MET`) */
+                403: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ApiErrorResponse"];
+                    };
+                };
             };
         };
         put?: never;
@@ -7141,6 +7132,144 @@ export interface components {
          * @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" | "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
+             * @description Source currency UUID.
+             */
+            from_currency: string;
+            /**
+             * Format: uuid
+             * @description Destination currency UUID.
+             */
+            to_currency: string;
+            /**
+             * @description Source currency symbol.
+             * @example USDT
+             */
+            from_symbol: string;
+            /**
+             * @description Destination currency symbol.
+             * @example USD
+             */
+            to_symbol: string;
+            /**
+             * @description Decimals the source-currency amounts are truncated to.
+             * @example 6
+             */
+            from_decimals: number;
+            /**
+             * @description Decimals the destination-currency amounts are truncated to.
+             * @example 2
+             */
+            to_decimals: number;
+            /**
+             * @description Amount to be spent in the source currency.
+             * @example 100
+             */
+            from_amount: number;
+            /**
+             * @description Amount to be received in the destination currency.
+             * @example 98.5
+             */
+            result_amount: number;
+            /**
+             * @description Amount converted before fees, in the destination currency.
+             * @example 100
+             */
+            net_amount: number;
+            /**
+             * @description Total fees (`comission` + `network_fee`), in the source currency.
+             * @example 1.5
+             */
+            fees: number;
+            /**
+             * @description Service commission excluding the network fee (wire name is intentionally `comission`).
+             * @example 1.5
+             */
+            comission: number;
+            /**
+             * Format: uuid
+             * @description Currency UUID `comission` is denominated in. Omitted by older engines — then it is the same currency on both sides.
+             */
+            commission_currency?: string;
+            /**
+             * @description Percentage part of the commission, in the commission currency.
+             * @example 1
+             */
+            percent_commission: number;
+            /**
+             * @description Fixed part of the commission, in the commission currency.
+             * @example 0.5
+             */
+            fixed_commission: number;
+            /**
+             * @description Markup applied, in whole percent.
+             * @example 1.5
+             */
+            base_markup: number;
+            /**
+             * @description Estimated blockchain network fee in the source currency (crypto withdrawals only, otherwise 0).
+             * @example 0
+             */
+            network_fee: number;
+            /**
+             * @description Network fee in the chain native currency (ETH, BNB, …), 18 decimals.
+             * @example 0
+             */
+            network_fee_native: number;
+            /**
+             * @description Network fee in USD, 8 decimals.
+             * @example 0
+             */
+            network_fee_usd: number;
+            /**
+             * @description Transaction fee. Always 0 for now.
+             * @example 0
+             */
+            transaction_fee: number;
+            /**
+             * @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 Percent markup of the applied tariff.
+             * @example 1.5
+             */
+            markup: number;
+            /**
+             * @description Fixed USD markup of the applied tariff.
+             * @example 0.5
+             */
+            markup_usd: number;
+            /**
+             * @description Percent markup on the network fee.
+             * @example 0
+             */
+            gas_markup: number;
+            /**
+             * @description Percent discount on the network fee.
+             * @example 0
+             */
+            gas_discount: number;
+            /** @description Whether the order type is an internal (on-platform) operation. */
+            is_internal: boolean;
+            /** @description Whether the operation is allowed for the caller with these inputs. */
+            allowed: boolean;
+            /** @description Calculation error text, `null` on success. */
+            error: string | null;
+        };
         /** @description Card object with all properties */
         IssuingCard: {
             /**

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

@@ -12013,7 +12013,16 @@ export interface paths {
         };
         /**
          * List crypto addresses
-         * @description Retrieves a list of crypto addresses associated with a wallet.
+         * @description Retrieves the crypto addresses of a wallet, newest first.
+         *
+         *     Every item embeds the full network object in `chain` (schema `Chain`) — read `chain.id`
+         *     for the numeric chain ID. The single-address endpoints
+         *     (`GET` / `POST /frontend/wallets/{wallet_id}/addresses/{chain}`) return the same row with
+         *     `chain` as that number instead. Match an address across endpoints by `uuid`.
+         *
+         *     Without `is_active` only active addresses are returned. Creation is idempotent per chain,
+         *     so a wallet normally holds one active address per chain; should several be active, the
+         *     first item with a given `chain.id` is the one `GET …/addresses/{chain}` returns for it.
          *
          *     **Authentication**: Bearer token with x-tenant-id header required
          *
@@ -12023,9 +12032,9 @@ export interface paths {
         get: {
             parameters: {
                 query?: {
-                    /** @description Filter by blockchain (chain ID) */
-                    chain?: string;
-                    /** @description Filter by active status */
+                    /** @description Filter by numeric chain ID (`chain.id` of the items) */
+                    chain?: number;
+                    /** @description Filter by active status. Omitted → active addresses only. */
                     is_active?: boolean;
                     /** @description Number of items to skip */
                     offset?: number;
@@ -12050,22 +12059,7 @@ export interface paths {
                         "application/json": {
                             /** @example true */
                             success: boolean;
-                            data: {
-                                /** Format: uuid */
-                                uuid: string;
-                                /** @description The blockchain address */
-                                address: string;
-                                /** @description Numeric chain ID */
-                                chain: number;
-                                /** Format: uuid */
-                                wallet_uuid: string;
-                                is_active: boolean;
-                                label: string | null;
-                                /** @enum {string} */
-                                type: "utila" | "processing";
-                                /** Format: date-time */
-                                created_at: string;
-                            }[];
+                            data: components["schemas"]["CryptoAddressListItem"][];
                             pagination: {
                                 offset: number;
                                 limit: number;
@@ -12108,10 +12102,15 @@ export interface paths {
         };
         /**
          * Get crypto address by chain
-         * @description Returns the single crypto address for the given wallet and chain.
+         * @description Returns the active crypto address of the wallet on the given chain.
          *     Useful when the caller already knows which chain they need and wants
          *     to avoid paginated list traversal.
          *
+         *     `chain` in the response is the numeric chain ID — no network object is embedded
+         *     (unlike the items of `GET /frontend/wallets/{wallet_id}/addresses`). Should the wallet
+         *     hold several active addresses on the chain, the newest is returned — the same row the
+         *     list shows first for that `chain.id`.
+         *
          *     **Authentication**: Bearer token with x-tenant-id header required
          *
          *     **Access Control**: Any owner/admin/auditor member of the wallet (the scoped `user` role is rejected with 403); wallet KYC must be APPROVED or HOLD
@@ -12140,20 +12139,7 @@ export interface paths {
                         "application/json": {
                             /** @example true */
                             success: boolean;
-                            data: {
-                                /** Format: uuid */
-                                uuid: string;
-                                address: string;
-                                chain: number;
-                                /** Format: uuid */
-                                wallet_uuid: string;
-                                is_active: boolean;
-                                label: string | null;
-                                /** @enum {string} */
-                                type: "utila" | "processing";
-                                /** Format: date-time */
-                                created_at: string;
-                            };
+                            data: components["schemas"]["CryptoAddress"];
                         };
                     };
                 };
@@ -12183,7 +12169,11 @@ export interface paths {
         put?: never;
         /**
          * Create crypto address
-         * @description Creates a new crypto address for a specific blockchain.
+         * @description Creates a crypto address for a specific blockchain. Idempotent per chain: if the wallet
+         *     already holds an active address on that chain, that address is returned (the same row
+         *     `GET /frontend/wallets/{wallet_id}/addresses/{chain}` gives) and nothing is provisioned.
+         *
+         *     `chain` in the response is the numeric chain ID — no network object is embedded.
          *
          *     **Authentication**: Bearer token with x-tenant-id header required
          *
@@ -12225,21 +12215,7 @@ export interface paths {
                         "application/json": {
                             /** @example true */
                             success: boolean;
-                            data: {
-                                /** Format: uuid */
-                                uuid: string;
-                                /** @description The blockchain address */
-                                address: string;
-                                chain: number;
-                                /** Format: uuid */
-                                wallet_uuid: string;
-                                is_active: boolean;
-                                label: string | null;
-                                /** @enum {string} */
-                                type: "utila" | "processing";
-                                /** Format: date-time */
-                                created_at: string;
-                            };
+                            data: components["schemas"]["CryptoAddress"];
                             /** @example Crypto address created successfully */
                             message: string;
                         };
@@ -14274,6 +14250,84 @@ export interface components {
             /** Format: date-time */
             created_at?: string;
         };
+        /** @description Blockchain network as stored in the `chain` reference table. Embedded whole into every item of `GET /frontend/wallets/{wallet_id}/addresses`; `GET /frontend/reference/chains` returns the `id` / `name` / `symbol` / `enabled` subset of the same rows. Rely on those four fields — the rest is the raw reference row and is not a stable contract. */
+        Chain: {
+            /**
+             * @description Numeric chain ID — the value `chain` carries on the single-address endpoints and in the `{chain}` path parameter
+             * @example 1
+             */
+            id: number;
+            /** @example Tron */
+            name: string | null;
+            /** @example TRON */
+            symbol: string | null;
+            /** @description Whether new addresses can be created on this network */
+            enabled: boolean;
+            is_beta?: boolean | null;
+            is_testnet?: boolean | null;
+            /** @description Public RPC endpoint of the network */
+            rpc_url?: string | null;
+            /** @description Network identifier at the custody provider (e.g. `tron-mainnet`) */
+            utila_name?: string | null;
+            /** @description Gas units of a token transfer */
+            token_transfer_gas?: number | null;
+            /** @description Gas units of a native-coin transfer */
+            native_transfer_gas?: number | null;
+        };
+        /** @description Fields shared by every representation of a wallet crypto address (a `crypto_addresses` row). */
+        CryptoAddressBase: {
+            /**
+             * @description Numeric row ID. Identify an address across endpoints by `uuid`, not by this number.
+             * @example 2405
+             */
+            id: number;
+            /**
+             * Format: uuid
+             * @description Stable address identifier — the same value on the list and on the single-address endpoints. `null` only on a few legacy `processing` rows.
+             */
+            uuid: string | null;
+            /**
+             * @description The on-chain address
+             * @example TN3W4H6rK2ce4vX9YnFQhwKENnHjoxb3m9
+             */
+            address: string;
+            /**
+             * Format: uuid
+             * @description Owning wallet
+             */
+            wallet_uuid: string;
+            is_active: boolean;
+            /**
+             * @description Free-form label: the one passed on creation (clients send e.g. `default` or `VA`), otherwise `<chain name> Address`.
+             * @example default
+             */
+            label: string | null;
+            /** @description Derivation index of the legacy `processing` provider; always `null` for `utila` addresses */
+            index_id: number | null;
+            /**
+             * @description Provisioning provider. New addresses are always `utila`; `processing` rows are legacy and read-only.
+             * @enum {string}
+             */
+            type: "utila" | "processing";
+            /** @description Provider bookkeeping (network name, integration and address IDs at the custody provider). Not a stable contract. */
+            meta: {
+                [key: string]: unknown;
+            } | null;
+            /** Format: date-time */
+            created_at: string;
+        };
+        /** @description A single wallet crypto address as returned by `GET` and `POST /frontend/wallets/{wallet_id}/addresses/{chain}`. `chain` is the numeric chain ID; no network object is embedded. */
+        CryptoAddress: components["schemas"]["CryptoAddressBase"] & {
+            /**
+             * @description Numeric chain ID (see `GET /frontend/reference/chains`)
+             * @example 1
+             */
+            chain: number;
+        };
+        /** @description An item of `GET /frontend/wallets/{wallet_id}/addresses`. The same row as `CryptoAddress`, but `chain` is the embedded network object — read `chain.id` to get the numeric chain ID used everywhere else. */
+        CryptoAddressListItem: components["schemas"]["CryptoAddressBase"] & {
+            chain: components["schemas"]["Chain"];
+        };
         CryptoWalletDeleteResponse: {
             /**
              * Format: uuid