squarefi-bff-api-module 1.36.71 → 1.36.73

package/dist/api/frontend.js

@@ -23,13 +23,6 @@ export const frontend = {
             }),
             deposit: ({ card_id, ...data }) => apiClientV1Frontend.postRequest(`/frontend/issuing/cards/${card_id}/deposit`, { data }),
             withdraw: ({ card_id, ...data }) => apiClientV1Frontend.postRequest(`/frontend/issuing/cards/${card_id}/withdraw`, { data }),
-            // Unified create — the backend routes to the balance or prepaid flow by the program's
-            // `sub_account_type`, so there is one method for both. Replaces the legacy
-            // `issuing.cards.create.*` methods. The cardholder is either an explicit `cardholder_id`
-            // or resolved from `assigned_user_data_uuid` via the user's linked cardholder (provision it
-            // first through `cardholders.*` — an unlinked user gets `400 CARDHOLDER_NOT_LINKED`).
-            // Issuing fee / initial top-up follow the group tariff; pass `currency_id` (and optionally
-            // `initial_topup`) whenever the tariff carries money.
             getById: ({ card_id, }) => apiClientV1Frontend.getRequest(`/frontend/issuing/cards/${card_id}`),
             /** Rename (and other editable card fields). */
             update: ({ card_id, ...data }) => apiClientV1Frontend.patchRequest(`/frontend/issuing/cards/${card_id}`, { data }),
@@ -57,6 +50,14 @@ export const frontend = {
                 });
             },
             transactions: ({ card_id, ...params }) => apiClientV1Frontend.getRequest(`/frontend/issuing/cards/${card_id}/transactions`, { params }),
+            // Unified create — the backend routes to the balance or prepaid flow by the program's
+            // `sub_account_type`, so there is one method for both. Replaces the legacy
+            // `issuing.cards.create.*` methods. The cardholder is either an explicit `cardholder_id`
+            // or resolved from `assigned_user_data_uuid` via the user's linked cardholder (provision it
+            // first through `cardholders.*` — an unlinked user gets `400 CARDHOLDER_NOT_LINKED`).
+            // Issuing fee / initial top-up follow the group tariff; pass `currency_id` (and optionally
+            // `initial_topup`) whenever the tariff carries money. With `is_reverse: true`,
+            // `initial_topup` is what lands on the card and the fee and top-up commission come on top.
             create: (data) => apiClientV1Frontend.postRequest('/frontend/issuing/cards', {
                 data,
             }),

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

@@ -2173,7 +2173,9 @@ export interface paths {
         head?: never;
         /**
          * Update cardholder
-         * @description Updates cardholder information (local row + vendor propagation of personal fields).
+         * @description Updates cardholder information. Email and phone of an Interlace or PhotonPay
+         *     cardholder are sent to the vendor first; every other field, and every other
+         *     vendor, is stored locally only.
          *     Same contract as `PATCH /frontend/issuing/cardholders/{cardholder_id}`.
          *
          *     **Authentication**: x-api-key header required
@@ -2690,6 +2692,44 @@ export interface paths {
                          *
                          */
                         vendor_user_id?: string;
+                        /**
+                         * @description TOTAL wallet debit at issuance, in the currency of `currency_id`: the issuing fee
+                         *     plus the amount to land on the card, from which the top-up commission is taken.
+                         *     When omitted, the tariff's default total applies: it is stated in the card's
+                         *     currency and converted into `currency_id` at the pair's rate. On a program whose cards open holding
+                         *     a mandatory minimum balance, what it pays toward the card after the issuing fee must be
+                         *     at least that balance — refused with `400 INITIAL_TOPUP_BELOW_OPENING_LOAD` otherwise,
+                         *     nothing charged. The top-up commission is not held against it: the card opens holding
+                         *     the minimum even when the commission takes the top-up a few cents under.
+                         *     Not charged at all where the wallet has no issuance tariff on the program.
+                         *
+                         * @example 80.4
+                         */
+                        initial_topup?: number;
+                        /**
+                         * @description When `true`, `initial_topup` is the amount to land on the card, in the card's currency,
+                         *     instead of the total debit: the issuing fee and the top-up commission are charged on top.
+                         *     The commission is added to the amount, as with a reverse card deposit, so the card gets
+                         *     exactly `initial_topup`. The top-up debit is the `from_amount` of
+                         *     `GET /api/orders/calc?order_type=TRANSFER_CARD_SUBACCOUNT&is_reverse=true&amount=<initial_topup>`
+                         *     (from `currency_id` to the card's currency); the issuing fee comes on top of it.
+                         *     What the tariff puts on the card at minimum (its minimum total less the issuing fee — 25
+                         *     on a 50 / 75 tariff) and a program's mandatory opening balance are held against the
+                         *     amount that lands. Needs `initial_topup` of at least 0.01; a boolean only, refused
+                         *     with `400` otherwise — also where the program does not bill issuance and the field
+                         *     is ignored.
+                         *
+                         * @default false
+                         */
+                        is_reverse?: boolean;
+                        /**
+                         * Format: uuid
+                         * @description Wallet currency to debit for the issuing fee and `initial_topup`. Required
+                         *     whenever issuance is billed on the program — the request is refused with `400`
+                         *     otherwise.
+                         *
+                         */
+                        currency_id?: string;
                     };
                 };
             };
@@ -2713,6 +2753,12 @@ export interface paths {
                  *     - Missing program_id
                  *     - Missing required fields based on program type
                  *     - Unsupported program type
+                 *     - `INITIAL_TOPUP_BELOW_OPENING_LOAD` — `initial_topup` less the issuing fee is below the
+                 *       program's mandatory opening balance; the message names the total accepted at the current rate
+                 *     - `OPENING_LOAD_NOT_PAID` — the program's cards open holding a mandatory balance and
+                 *       this issuance charges nothing for it (issuance not billed here, or no issuance tariff
+                 *       for the wallet on the program), or the card spends from a sub-account, whose top-up
+                 *       funds the sub-account rather than the card
                  *      */
                 400: {
                     headers: {

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

@@ -3151,13 +3151,35 @@ export interface paths {
                         vendor_user_id?: string;
                         /**
                          * @description TOTAL wallet debit asked for at issuance: the issuing fee is subtracted and
-                         *     the remainder lands on the card's sub-account. Accepted only on group tariffs
-                         *     that already mandate an initial top-up (`initial_topup_usd > 0`); otherwise the
-                         *     group amount stands. Requires `currency_id`.
+                         *     the remainder, less the top-up commission, lands on the card's sub-account.
+                         *     When omitted, the group tariff's total applies, stated in the card's currency and
+                         *     converted into `currency_id` at the pair's rate. On a program whose cards open
+                         *     holding a mandatory minimum balance, what it pays toward the card after the
+                         *     issuing fee must be at least that balance — refused with
+                         *     `400 INITIAL_TOPUP_BELOW_OPENING_LOAD` otherwise, nothing charged. The top-up
+                         *     commission is not held against it: the card opens holding the minimum even when
+                         *     the commission takes the top-up a few cents under. Requires `currency_id`.
                          *
                          * @example 100
                          */
                         initial_topup?: number;
+                        /**
+                         * @description When `true`, `initial_topup` is the amount to land on the card, in the card's currency,
+                         *     instead of the total debit: the issuing fee and the top-up commission are charged on top.
+                         *     The commission is added to the amount, as with a reverse card deposit, so the card gets
+                         *     exactly `initial_topup`. The top-up debit is the `from_amount` of
+                         *     `GET /frontend/orders/calc?order_type=TRANSFER_CARD_SUBACCOUNT&is_reverse=true&amount=<initial_topup>`
+                         *     (from `currency_id` to the card's currency, with `wallet_id`); the issuing fee comes on top
+                         *     of it.
+                         *     What the tariff puts on the card at minimum (its minimum total less the issuing fee — 25
+                         *     on a 50 / 75 tariff) and a program's mandatory opening balance are held against the
+                         *     amount that lands. Needs `initial_topup` of at least 0.01; a boolean only, refused
+                         *     with `400` otherwise — also where the program does not bill issuance and the field
+                         *     is ignored.
+                         *
+                         * @default false
+                         */
+                        is_reverse?: boolean;
                         /**
                          * Format: uuid
                          * @description Wallet currency to debit for the issuing fee / initial top-up.
@@ -3215,6 +3237,12 @@ export interface paths {
                  *     - Missing program_id
                  *     - Missing required fields based on program type
                  *     - Unsupported program type
+                 *     - `INITIAL_TOPUP_BELOW_OPENING_LOAD` — `initial_topup` less the issuing fee is below the
+                 *       program's mandatory opening balance; the message names the total accepted at the current rate
+                 *     - `OPENING_LOAD_NOT_PAID` — the program's cards open holding a mandatory balance and
+                 *       this issuance charges nothing for it (issuance not billed here, or no issuance tariff
+                 *       for the wallet on the program), or the card spends from a sub-account, whose top-up
+                 *       funds the sub-account rather than the card
                  *      */
                 400: {
                     headers: {

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

@@ -1555,7 +1555,9 @@ export interface paths {
         /**
          * Create a new card
          * @deprecated
-         * @description Creates a new card for the user. Initial topup amount is now determined by user group settings, not by request parameters.
+         * @description Creates a new card for the user. The amount charged is `initial_topup` when sent — with
+         *     `is_reverse`, the fee plus what lands `initial_topup` on the card — otherwise the tariff's
+         *     default total. Without `is_reverse`, a tariff with no issuing fee charges nothing here.
          *     This endpoint is deprecated, please use `POST /api/issuing/cards` or `POST /frontend/issuing/cards` instead.
          *
          *     **Cardholder is required**: Every card must be associated with a cardholder.
@@ -1590,6 +1592,28 @@ export interface paths {
                          *
                          */
                         cardholder_id: string;
+                        /** @description TOTAL wallet debit at issuance, in the currency of `currency_id`: the issuing fee plus the
+                         *     amount to land on the card, from which the top-up commission is taken — unless
+                         *     `is_reverse` is set. Charged only on a group tariff with an issuing fee, unless `is_reverse`
+                         *     is set.
+                         *      */
+                        initial_topup?: number;
+                        /**
+                         * @description When `true`, `initial_topup` is the amount to land on the card, in the card's currency,
+                         *     instead of the total debit: the issuing fee and the top-up commission are charged on top.
+                         *     The commission is added to the amount, as with a reverse card deposit, so the card gets
+                         *     exactly `initial_topup`. The top-up debit is the `from_amount` of
+                         *     `GET /frontend/orders/calc?order_type=TRANSFER_CARD_SUBACCOUNT&is_reverse=true&amount=<initial_topup>`
+                         *     (from `currency_id` to the card's currency, with `wallet_id`); the issuing fee comes on top
+                         *     of it.
+                         *     What the tariff puts on the card at minimum (its minimum total less the issuing fee — 25
+                         *     on a 50 / 75 tariff) and a program's mandatory opening balance are held against the
+                         *     amount that lands. Needs `initial_topup` of at least 0.01; a boolean only, refused
+                         *     with `400` otherwise.
+                         *
+                         * @default false
+                         */
+                        is_reverse?: boolean;
                         /**
                          * Format: uuid
                          * @description Currency ID for card fees (required if card has issuing fee or initial topup)

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

@@ -6727,6 +6727,16 @@ export interface paths {
                         };
                     };
                 };
+                /** @description `OPENING_LOAD_NOT_PAID` — the program's cards open holding a mandatory balance, and an
+                 *     issuance through this API charges nothing for it (nor can a card spending from a
+                 *     sub-account), so the card is not issued.
+                 *      */
+                400: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
             };
         };
         delete?: never;

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

@@ -1080,6 +1080,7 @@ export interface components {
             default_currency: string;
             user_groups_id: string | null;
             is_developer: boolean;
+            is_onboarded: boolean;
             first_name?: string | null;
             last_name?: string | null;
             /** @description User birth date in ISO 8601 format */
@@ -2019,6 +2020,81 @@ export interface components {
             readonly fraud_and_security_url?: string | null;
             readonly consumer_protection_url?: string | null;
         };
+        UiBrandingIdentityEntity: {
+            readonly name?: string;
+            /** @description Installed-app label, at most 12 characters. */
+            readonly short_name?: string;
+            readonly seo_title?: string;
+            readonly seo_description?: string;
+        };
+        UiBrandingSupportEntity: {
+            /** @description https support link; absent = fall back to mailto. */
+            readonly url?: string;
+            readonly email?: string;
+        };
+        UiBrandingAssetsEntity: {
+            /** @description Public URL of the image in the tenant-branding bucket; absent = not set. */
+            readonly logo_light?: string;
+            /** @description Public URL of the image in the tenant-branding bucket; absent = not set. */
+            readonly logo_dark?: string;
+            /** @description Public URL of the image in the tenant-branding bucket; absent = not set. */
+            readonly mark_light?: string;
+            /** @description Public URL of the image in the tenant-branding bucket; absent = not set. */
+            readonly mark_dark?: string;
+            /** @description Public URL of the image in the tenant-branding bucket; absent = not set. */
+            readonly header_logo_light?: string;
+            /** @description Public URL of the image in the tenant-branding bucket; absent = not set. */
+            readonly header_logo_dark?: string;
+            /** @description Public URL of the image in the tenant-branding bucket; absent = not set. */
+            readonly loader_logo_light?: string;
+            /** @description Public URL of the image in the tenant-branding bucket; absent = not set. */
+            readonly loader_logo_dark?: string;
+            /** @description Public URL of the image in the tenant-branding bucket; absent = not set. */
+            readonly footer_logo_light?: string;
+            /** @description Public URL of the image in the tenant-branding bucket; absent = not set. */
+            readonly footer_logo_dark?: string;
+            /** @description Public URL of the image in the tenant-branding bucket; absent = not set. */
+            readonly card_logo?: string;
+            /** @description Public URL of the image in the tenant-branding bucket; absent = not set. */
+            readonly card_logo_pale?: string;
+            /** @description Public URL of the image in the tenant-branding bucket; absent = not set. */
+            readonly card_default_design?: string;
+            /** @description Public URL of the image in the tenant-branding bucket; absent = not set. */
+            readonly favicon?: string;
+            /** @description Public URL of the image in the tenant-branding bucket; absent = not set. */
+            readonly apple_touch?: string;
+            /** @description Public URL of the image in the tenant-branding bucket; absent = not set. */
+            readonly pwa_192?: string;
+            /** @description Public URL of the image in the tenant-branding bucket; absent = not set. */
+            readonly pwa_512?: string;
+            /** @description Public URL of the image in the tenant-branding bucket; absent = not set. */
+            readonly pwa_maskable_192?: string;
+            /** @description Public URL of the image in the tenant-branding bucket; absent = not set. */
+            readonly pwa_maskable_512?: string;
+            /** @description Public URL of the image in the tenant-branding bucket; absent = not set. */
+            readonly og_image?: string;
+            /** @description Public URL of the image in the tenant-branding bucket; absent = not set. */
+            readonly pdf_logo?: string;
+            /** @description Public URL of the image in the tenant-branding bucket; absent = not set. */
+            readonly cards_placeholder_light?: string;
+            /** @description Public URL of the image in the tenant-branding bucket; absent = not set. */
+            readonly cards_placeholder_dark?: string;
+            /** @description Public URL of the image in the tenant-branding bucket; absent = not set. */
+            readonly auth_background?: string;
+            /** @description Public URL of the image in the tenant-branding bucket; absent = not set. */
+            readonly sidebar_background_light?: string;
+            /** @description Public URL of the image in the tenant-branding bucket; absent = not set. */
+            readonly sidebar_background_dark?: string;
+        };
+        UiBrandingEntity: {
+            /** @enum {number} */
+            readonly version?: 1;
+            /** @description Key of the design preset committed in every frontend repo; a build with an unknown key fails. */
+            readonly preset?: string;
+            readonly identity?: components["schemas"]["UiBrandingIdentityEntity"];
+            readonly support?: components["schemas"]["UiBrandingSupportEntity"];
+            readonly assets?: components["schemas"]["UiBrandingAssetsEntity"];
+        };
         SupportedLocalesEntity: {
             default: string;
             supported: string[];
@@ -2064,10 +2140,12 @@ export interface components {
             enable_auto_exchange: boolean;
             enable_crypto_withdrawal: boolean;
             enable_referral_program: boolean;
+            enable_card_onboarding: boolean;
             readonly metrics_data?: components["schemas"]["MetricsDataEntity"] | null;
             readonly statement_branding?: components["schemas"]["StatementBrandingEntity"] | null;
             readonly mailing_data?: components["schemas"]["MailingDataEntity"] | null;
             readonly app_links?: components["schemas"]["AppLinksEntity"] | null;
+            readonly ui_branding?: components["schemas"]["UiBrandingEntity"] | null;
             /** @enum {string} */
             kyc_data_provider: "persona" | "sumsub";
             readonly supported_locales?: components["schemas"]["SupportedLocalesEntity"] | null;

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

@@ -395,7 +395,22 @@ export declare namespace API {
                 currency_id?: string;
                 user_data_id: string;
             }
-            type StandAloneRequest = CommonRequest;
+            /** `POST /issuing/cards/create`. */
+            interface StandAloneRequest extends CommonRequest {
+                /**
+                 * TOTAL wallet debit (fee + top-up), in `currency_id` — charged only on a tariff with an
+                 * issuing fee; on a tariff without one nothing is charged unless `is_reverse` is set. With
+                 * `is_reverse`, the amount to land on the card instead.
+                 */
+                initial_topup?: number;
+                /**
+                 * `initial_topup` is the amount to land on the card, in the card's currency; the issuing fee
+                 * and the top-up commission are charged on top, on every tariff. Its cost is the
+                 * `from_amount` of a reverse `TRANSFER_CARD_SUBACCOUNT` calc for that amount. Needs
+                 * `initial_topup` of at least 0.01. A backend without base_backend#1710 ignores the flag.
+                 */
+                is_reverse?: boolean;
+            }
             interface SubAccountRequest extends CommonRequest {
                 sub_account_id: string;
             }
@@ -968,15 +983,6 @@ export declare namespace API {
                         cardholder_id?: string;
                         /** Card assignee (`user_data.uuid`); their linked cardholder is used. */
                         assigned_user_data_uuid?: string;
-                        /**
-                         * TOTAL wallet debit at issuance (fee + card top-up). Accepted only on group
-                         * tariffs that already mandate an initial top-up. Requires `currency_id`.
-                         */
-                        initial_topup?: number;
-                        /** Wallet currency to debit; required whenever the tariff has a fee or a top-up. */
-                        currency_id?: string;
-                        /** Client-generated id stored with the card (idempotency/tracing reference). */
-                        request_id?: string;
                     };
                     type Response = CardsRoot['post']['responses']['201']['content']['application/json'] & {
                         /**

package/package.json

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