squarefi-bff-api-module 1.36.1 → 1.36.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -4363,7 +4363,7 @@ export interface paths {
4363
4363
  put?: never;
4364
4364
  /**
4365
4365
  * Cancel order
4366
- * @description Cancels an order. Orders in PENDING or PROCESSING status can be canceled.
4366
+ * @description Cancels an order. Orders in PENDING or FAILED status can be canceled.
4367
4367
  * Optionally provide a cancellation reason.
4368
4368
  *
4369
4369
  */
@@ -7523,11 +7523,9 @@ export interface components {
7523
7523
  * @description External vendor account ID
7524
7524
  */
7525
7525
  vendor_account_id?: string | null;
7526
- /** @description When false, deposit_instructions and account_details are returned as null (deposits disabled for this account) */
7527
- is_deposit_enabled?: boolean;
7528
- /** @description Bank account details for deposits. Returned null when is_deposit_enabled is false. */
7526
+ /** @description Bank account details for deposits. Returned null when deposits are disabled for the account. */
7529
7527
  account_details?: components["schemas"]["BankAccountDetails"];
7530
- /** @description Deposit requisites. Returned null when is_deposit_enabled is false. */
7528
+ /** @description Deposit requisites. Returned null when deposits are disabled for the account. */
7531
7529
  deposit_instructions?: Record<string, never> | null;
7532
7530
  current_balance?: number | null;
7533
7531
  available_balance?: number | null;
@@ -7604,7 +7602,10 @@ export interface components {
7604
7602
  /** @description Array of order_type IDs */
7605
7603
  order_types?: string[];
7606
7604
  /** @description KYC rail configuration */
7607
- kyc_rails?: Record<string, never> | null;
7605
+ kyc_rails?: {
7606
+ /** @description When false, deposits are not accepted for accounts on this rail and their requisites are suppressed in public responses */
7607
+ is_deposit_enabled?: boolean;
7608
+ } | null;
7608
7609
  /**
7609
7610
  * Format: uuid
7610
7611
  * @description Required KYC rail ID
@@ -1734,8 +1734,8 @@ export interface paths {
1734
1734
  program_id?: string;
1735
1735
  /** @description Filter cards by program sub-account type (prepaid or balance) */
1736
1736
  sub_account_type?: "prepaid" | "balance";
1737
- /** @description Filter cards by status */
1738
- status?: "ACTIVE" | "INACTIVE" | "SUSPENDED" | "CANCELED";
1737
+ /** @description Filter cards by status (matches issuing_cards.card_status) */
1738
+ status?: "ACTIVE" | "INACTIVE" | "FROZEN" | "CANCELED" | "CLOSED" | "BLOCKED" | "FAILED" | "PENDING";
1739
1739
  /** @description Filter cards by last 4 digits of the card number (partial, case-insensitive match) */
1740
1740
  last4?: string;
1741
1741
  /** @description Number of items to skip */
@@ -1758,7 +1758,7 @@ export interface paths {
1758
1758
  "application/json": {
1759
1759
  /** @example true */
1760
1760
  success?: boolean;
1761
- data?: Record<string, never>[];
1761
+ data?: components["schemas"]["IssuingCard"][];
1762
1762
  pagination?: {
1763
1763
  offset?: number;
1764
1764
  limit?: number;
@@ -1845,6 +1845,16 @@ export interface paths {
1845
1845
  * @example My Card
1846
1846
  */
1847
1847
  card_name: string;
1848
+ /**
1849
+ * Format: uuid
1850
+ * @description Optional. Binds the card to a wallet member so a scoped `user` role can
1851
+ * access ONLY this card (view, sensitive data, transactions, freeze/unfreeze),
1852
+ * and nothing else in the wallet (SFI-1382). Must be the `user_data.uuid` of an
1853
+ * active member of the target wallet; resolved server-side to the card's owner.
1854
+ *
1855
+ * @example a1b2c3d4-e5f6-7890-abcd-ef1234567890
1856
+ */
1857
+ assigned_user_data_uuid?: string;
1848
1858
  /**
1849
1859
  * Format: email
1850
1860
  * @deprecated
@@ -1882,8 +1892,7 @@ export interface paths {
1882
1892
  "application/json": {
1883
1893
  /** @example true */
1884
1894
  success?: boolean;
1885
- /** @description Created card details */
1886
- data?: Record<string, never>;
1895
+ data?: components["schemas"]["IssuingCard"];
1887
1896
  /** @example Card created successfully */
1888
1897
  message?: string;
1889
1898
  };
@@ -1997,8 +2006,7 @@ export interface paths {
1997
2006
  "application/json": {
1998
2007
  /** @example true */
1999
2008
  success?: boolean;
2000
- /** @description Card details */
2001
- data?: Record<string, never>;
2009
+ data?: components["schemas"]["IssuingCard"];
2002
2010
  };
2003
2011
  };
2004
2012
  };
@@ -2118,8 +2126,7 @@ export interface paths {
2118
2126
  "application/json": {
2119
2127
  /** @example true */
2120
2128
  success?: boolean;
2121
- /** @description Updated card details */
2122
- data?: Record<string, never>;
2129
+ data?: components["schemas"]["IssuingCard"];
2123
2130
  };
2124
2131
  };
2125
2132
  };
@@ -2399,7 +2406,7 @@ export interface paths {
2399
2406
  "application/json": {
2400
2407
  /** @example true */
2401
2408
  success?: boolean;
2402
- data?: Record<string, never>[];
2409
+ data?: components["schemas"]["IssuingTransaction"][];
2403
2410
  pagination?: {
2404
2411
  offset?: number;
2405
2412
  limit?: number;
@@ -2498,8 +2505,7 @@ export interface paths {
2498
2505
  "application/json": {
2499
2506
  /** @example true */
2500
2507
  success?: boolean;
2501
- /** @description Updated limits */
2502
- data?: Record<string, never>;
2508
+ data?: components["schemas"]["IssuingCardLimits"];
2503
2509
  };
2504
2510
  };
2505
2511
  };
@@ -2786,7 +2792,7 @@ export interface paths {
2786
2792
  "application/json": {
2787
2793
  /** @example true */
2788
2794
  success?: boolean;
2789
- data?: Record<string, never>[];
2795
+ data?: components["schemas"]["IssuingSubAccount"][];
2790
2796
  pagination?: {
2791
2797
  offset?: number;
2792
2798
  limit?: number;
@@ -2874,8 +2880,7 @@ export interface paths {
2874
2880
  "application/json": {
2875
2881
  /** @example true */
2876
2882
  success?: boolean;
2877
- /** @description Created sub-account details */
2878
- data?: Record<string, never>;
2883
+ data?: components["schemas"]["IssuingSubAccountResource"];
2879
2884
  };
2880
2885
  };
2881
2886
  };
@@ -2984,8 +2989,7 @@ export interface paths {
2984
2989
  "application/json": {
2985
2990
  /** @example true */
2986
2991
  success?: boolean;
2987
- /** @description Sub-account details */
2988
- data?: Record<string, never>;
2992
+ data?: components["schemas"]["IssuingSubAccountResource"];
2989
2993
  };
2990
2994
  };
2991
2995
  };
@@ -3050,8 +3054,7 @@ export interface paths {
3050
3054
  "application/json": {
3051
3055
  /** @example true */
3052
3056
  success?: boolean;
3053
- /** @description Updated sub-account details */
3054
- data?: Record<string, never>;
3057
+ data?: components["schemas"]["IssuingSubAccountResource"];
3055
3058
  /** @example Sub-account updated successfully */
3056
3059
  message?: string;
3057
3060
  };
@@ -3130,7 +3133,7 @@ export interface paths {
3130
3133
  "application/json": {
3131
3134
  /** @example true */
3132
3135
  success?: boolean;
3133
- data?: Record<string, never>[];
3136
+ data?: components["schemas"]["IssuingTransaction"][];
3134
3137
  pagination?: {
3135
3138
  offset?: number;
3136
3139
  limit?: number;
@@ -3724,7 +3727,7 @@ export interface paths {
3724
3727
  "application/json": {
3725
3728
  /** @example true */
3726
3729
  success?: boolean;
3727
- data?: Record<string, never>[];
3730
+ data?: components["schemas"]["IssuingCardholder"][];
3728
3731
  pagination?: {
3729
3732
  offset?: number;
3730
3733
  limit?: number;
@@ -3854,8 +3857,7 @@ export interface paths {
3854
3857
  "application/json": {
3855
3858
  /** @example true */
3856
3859
  success?: boolean;
3857
- /** @description Created cardholder with vendor fields */
3858
- data?: Record<string, never>;
3860
+ data?: components["schemas"]["IssuingCardholder"];
3859
3861
  /** @example Cardholder created successfully */
3860
3862
  message?: string;
3861
3863
  };
@@ -3944,8 +3946,7 @@ export interface paths {
3944
3946
  "application/json": {
3945
3947
  /** @example true */
3946
3948
  success?: boolean;
3947
- /** @description Cardholder details */
3948
- data?: Record<string, never>;
3949
+ data?: components["schemas"]["IssuingCardholder"];
3949
3950
  };
3950
3951
  };
3951
3952
  };
@@ -4092,8 +4093,7 @@ export interface paths {
4092
4093
  "application/json": {
4093
4094
  /** @example true */
4094
4095
  success?: boolean;
4095
- /** @description Updated cardholder details */
4096
- data?: Record<string, never>;
4096
+ data?: components["schemas"]["IssuingCardholder"];
4097
4097
  /** @example Cardholder updated successfully */
4098
4098
  message?: string;
4099
4099
  };
@@ -7113,7 +7113,7 @@ export interface paths {
7113
7113
  /** Format: uuid */
7114
7114
  wallet_id?: string;
7115
7115
  /** @enum {string} */
7116
- role?: "user" | "admin";
7116
+ role?: "auditor" | "user" | "admin";
7117
7117
  };
7118
7118
  };
7119
7119
  };
@@ -7281,7 +7281,7 @@ export interface paths {
7281
7281
  */
7282
7282
  wallet_name?: string;
7283
7283
  /** @enum {string} */
7284
- role?: "user" | "admin";
7284
+ role?: "auditor" | "user" | "admin";
7285
7285
  };
7286
7286
  };
7287
7287
  };
@@ -7328,7 +7328,7 @@ export interface paths {
7328
7328
  * List wallets
7329
7329
  * @description Retrieves a list of wallets for the authenticated user (owned + shared via wallets_users).
7330
7330
  *
7331
- * Each wallet includes `access_role` (owner/admin/manager/user) and `is_owner` boolean.
7331
+ * Each wallet includes `access_role` (owner/admin/user/auditor) and `is_owner` boolean.
7332
7332
  *
7333
7333
  * **Authentication**: Bearer token with x-tenant-id header required
7334
7334
  *
@@ -7341,7 +7341,7 @@ export interface paths {
7341
7341
  /** @description Number of items to return */
7342
7342
  limit?: number;
7343
7343
  /** @description Filter wallets by user's access role */
7344
- role?: "owner" | "admin" | "manager" | "user";
7344
+ role?: "owner" | "admin" | "user" | "auditor";
7345
7345
  /** @description Include shared wallets (via wallets_users table) */
7346
7346
  include_shared?: boolean;
7347
7347
  /** @description Field to sort the merged owned + shared wallet list by */
@@ -7388,12 +7388,12 @@ export interface paths {
7388
7388
  *
7389
7389
  * @enum {string}
7390
7390
  */
7391
- role: "owner" | "admin" | "manager" | "user";
7391
+ role: "owner" | "admin" | "user" | "auditor";
7392
7392
  /**
7393
7393
  * @description User's access role for this wallet
7394
7394
  * @enum {string}
7395
7395
  */
7396
- access_role: "owner" | "admin" | "manager" | "user";
7396
+ access_role: "owner" | "admin" | "user" | "auditor";
7397
7397
  /** @description True if user is the wallet owner */
7398
7398
  is_owner: boolean;
7399
7399
  /** @description KYC entity attached to the wallet (joined from `kyc_entity`).
@@ -7809,12 +7809,12 @@ export interface paths {
7809
7809
  *
7810
7810
  * @enum {string}
7811
7811
  */
7812
- role?: "owner" | "admin" | "manager" | "user";
7812
+ role?: "owner" | "admin" | "user" | "auditor";
7813
7813
  /**
7814
7814
  * @description User's role for this wallet (only present when called via member access)
7815
7815
  * @enum {string}
7816
7816
  */
7817
- access_role?: "owner" | "admin" | "manager" | "user";
7817
+ access_role?: "owner" | "admin" | "user" | "auditor";
7818
7818
  is_owner?: boolean;
7819
7819
  };
7820
7820
  };
@@ -8659,7 +8659,7 @@ export interface paths {
8659
8659
  /** @description Search by first_name, last_name, email, or phone */
8660
8660
  search?: string;
8661
8661
  /** @description Filter by role */
8662
- role?: "owner" | "admin" | "user";
8662
+ role?: "owner" | "admin" | "user" | "auditor";
8663
8663
  /** @description Filter by active status (default true) */
8664
8664
  is_active?: boolean;
8665
8665
  };
@@ -8685,7 +8685,7 @@ export interface paths {
8685
8685
  /** Format: uuid */
8686
8686
  user_data_uuid?: string;
8687
8687
  /** @enum {string} */
8688
- role?: "owner" | "admin" | "user";
8688
+ role?: "owner" | "admin" | "user" | "auditor";
8689
8689
  is_active?: boolean;
8690
8690
  /** Format: date-time */
8691
8691
  created_at?: string;
@@ -8766,7 +8766,7 @@ export interface paths {
8766
8766
  * @description Role to assign to the user
8767
8767
  * @enum {string}
8768
8768
  */
8769
- role: "user" | "admin";
8769
+ role: "auditor" | "user" | "admin";
8770
8770
  };
8771
8771
  };
8772
8772
  };
@@ -8786,7 +8786,7 @@ export interface paths {
8786
8786
  /** Format: uuid */
8787
8787
  user_data_uuid?: string;
8788
8788
  /** @enum {string} */
8789
- role?: "user" | "admin";
8789
+ role?: "auditor" | "user" | "admin";
8790
8790
  is_active?: boolean;
8791
8791
  /** Format: date-time */
8792
8792
  created_at?: string;
@@ -8947,7 +8947,7 @@ export interface paths {
8947
8947
  * @description New role for the user
8948
8948
  * @enum {string}
8949
8949
  */
8950
- role: "user" | "admin";
8950
+ role: "auditor" | "user" | "admin";
8951
8951
  };
8952
8952
  };
8953
8953
  };
@@ -9185,7 +9185,7 @@ export interface paths {
9185
9185
  * List wallet invites
9186
9186
  * @description Returns a paginated list of invites for the wallet.
9187
9187
  *
9188
- * **Access Control**: Owner only (invites expose the invite code and invitee email)
9188
+ * **Access Control**: Owner or admin (invites expose the invite code and invitee email)
9189
9189
  *
9190
9190
  */
9191
9191
  get: {
@@ -9195,7 +9195,9 @@ export interface paths {
9195
9195
  limit?: number;
9196
9196
  /** @description When true — only used invites; when false — only pending; omit for all. */
9197
9197
  is_completed?: boolean;
9198
- role?: "user" | "admin";
9198
+ /** @description When true — only expired invites (expires_at in the past); when false — only non-expired; omit for all. */
9199
+ is_expired?: boolean;
9200
+ role?: "auditor" | "user" | "admin";
9199
9201
  /** @description Case-insensitive search by email */
9200
9202
  search?: string;
9201
9203
  };
@@ -9243,8 +9245,8 @@ export interface paths {
9243
9245
  * @description Creates a wallet invite that can be redeemed by a user matching the specified email.
9244
9246
  *
9245
9247
  * **Rules:**
9246
- * - Only the wallet **owner** can create invites
9247
- * - `role` must be one of: `user`, `admin` (owner cannot be assigned via invite)
9248
+ * - The wallet **owner** or an **admin** can create invites
9249
+ * - `role` must be one of: `auditor`, `user`, `admin` (owner cannot be assigned via invite)
9248
9250
  * - If an active (not used, not expired) invite for the same email already exists,
9249
9251
  * it is superseded (expired) and replaced with a new one
9250
9252
  * - Cannot invite yourself
@@ -9276,7 +9278,7 @@ export interface paths {
9276
9278
  * @description Role to assign on acceptance
9277
9279
  * @enum {string}
9278
9280
  */
9279
- role: "user" | "admin";
9281
+ role: "auditor" | "user" | "admin";
9280
9282
  };
9281
9283
  };
9282
9284
  };
@@ -9303,7 +9305,7 @@ export interface paths {
9303
9305
  };
9304
9306
  content?: never;
9305
9307
  };
9306
- /** @description Access denied (not the owner) */
9308
+ /** @description Access denied (insufficient wallet role) */
9307
9309
  403: {
9308
9310
  headers: {
9309
9311
  [name: string]: unknown;
@@ -9334,7 +9336,7 @@ export interface paths {
9334
9336
  };
9335
9337
  /**
9336
9338
  * Get wallet invite by id
9337
- * @description **Access Control**: Owner only (invites expose the invite code and invitee email)
9339
+ * @description **Access Control**: Owner or admin (invites expose the invite code and invitee email)
9338
9340
  *
9339
9341
  */
9340
9342
  get: {
@@ -9384,7 +9386,7 @@ export interface paths {
9384
9386
  * Cancel wallet invite
9385
9387
  * @description Cancels (deletes) a pending invite. Already used invites cannot be cancelled.
9386
9388
  *
9387
- * **Access Control**: Owner only
9389
+ * **Access Control**: Owner or admin
9388
9390
  *
9389
9391
  */
9390
9392
  delete: {
@@ -9420,7 +9422,7 @@ export interface paths {
9420
9422
  };
9421
9423
  content?: never;
9422
9424
  };
9423
- /** @description Access denied (not the owner) */
9425
+ /** @description Access denied (insufficient wallet role) */
9424
9426
  403: {
9425
9427
  headers: {
9426
9428
  [name: string]: unknown;
@@ -9465,6 +9467,317 @@ export interface components {
9465
9467
  message?: string;
9466
9468
  };
9467
9469
  };
9470
+ /** @description Bank / rail account coordinates for a sub-account. Rail-dependent — some rails return only a subset of these. */
9471
+ BankAccountDetails: {
9472
+ swift?: string;
9473
+ bank_name?: string;
9474
+ bank_address?: string;
9475
+ account_number?: string;
9476
+ reference_number?: string;
9477
+ };
9478
+ /** @description Account currency record (from the `crypto` table). */
9479
+ CurrencyRef: {
9480
+ /** Format: uuid */
9481
+ uuid: string;
9482
+ is_crypto: boolean;
9483
+ enabled: boolean;
9484
+ /** @description Number of minor-unit decimals */
9485
+ decimal: number;
9486
+ /** @description Currency metadata; shape depends on the currency. Fiat: { code, name, symbol, sign, icon, iso_code, description, type:"fiat" }. Crypto: { name, symbol, icon, type, chain_id, chain_name, contract, description }. */
9487
+ meta?: {
9488
+ [key: string]: unknown;
9489
+ } | null;
9490
+ };
9491
+ /** @description Sub-account funding a card — the subset of `fiat_accounts` columns joined onto each card. */
9492
+ IssuingCardSubAccount: {
9493
+ /** Format: uuid */
9494
+ id: string;
9495
+ nick_name?: string | null;
9496
+ balance?: number | null;
9497
+ /** @enum {string} */
9498
+ type: "balance" | "prepaid";
9499
+ /**
9500
+ * @description Sub-account (fiat_account) status — only these 4 of the card_status enum are used for fiat_accounts
9501
+ * @enum {string}
9502
+ */
9503
+ status: "ACTIVE" | "CLOSED" | "BLOCKED" | "CANCELED";
9504
+ /**
9505
+ * Format: uuid
9506
+ * @description crypto.uuid of the account currency
9507
+ */
9508
+ account_currency: string;
9509
+ /** Format: uuid */
9510
+ program_id?: string | null;
9511
+ /** Format: uuid */
9512
+ wallet_id: string;
9513
+ vendor_sub_account_id?: string | null;
9514
+ vendor_id?: string | null;
9515
+ /** Format: date-time */
9516
+ created_at: string;
9517
+ };
9518
+ /** @description Issuing program configuration (`issuing_programs` row). When joined it also carries nested `order_types`, `kyc_rails` and `integration_vendors` (hence additionalProperties). */
9519
+ IssuingProgram: {
9520
+ /** Format: uuid */
9521
+ id: string;
9522
+ name?: string | null;
9523
+ /** @enum {string} */
9524
+ status: "DRAFT" | "ACTIVE" | "ARCHIVED";
9525
+ /** @enum {string} */
9526
+ sub_account_type: "balance" | "prepaid";
9527
+ /** @enum {string|null} */
9528
+ type?: "CREDIT" | "DEBIT" | null;
9529
+ /** @enum {string|null} */
9530
+ brand?: "VISA" | "MASTERCARD" | "AMEX" | "UNIONPAY" | null;
9531
+ /** @enum {string|null} */
9532
+ form_factor?: "PHYSICAL" | "VIRTUAL" | null;
9533
+ tokenizable: boolean;
9534
+ /** Format: uuid */
9535
+ account_currency: string;
9536
+ card_limit: number;
9537
+ vendor_id?: string | null;
9538
+ realtime_auth?: boolean | null;
9539
+ /** Format: uuid */
9540
+ tenant_id?: string | null;
9541
+ description?: string | null;
9542
+ icon?: string | null;
9543
+ code?: string | null;
9544
+ card_issuing_fee?: number | null;
9545
+ card_monthly_fee?: number | null;
9546
+ initial_topup?: number | null;
9547
+ card_design?: {
9548
+ [key: string]: unknown;
9549
+ } | null;
9550
+ /** Format: uuid */
9551
+ kyc_rails_id?: string | null;
9552
+ /** Format: uuid */
9553
+ integration_vendors_id?: string | null;
9554
+ is_hidden?: boolean | null;
9555
+ max_cards: number;
9556
+ } & {
9557
+ [key: string]: unknown;
9558
+ };
9559
+ /** @description Merchant of a card transaction. */
9560
+ TransactionMerchant: {
9561
+ name?: string;
9562
+ category_code?: string;
9563
+ city?: string;
9564
+ country?: string;
9565
+ };
9566
+ /** @description Per-period card spend limits. Each period has `_enabled` (bool), `_cap` (number) and `_spent` (number). Vendor-provided; periods may be omitted when the card has no limits configured. */
9567
+ IssuingCardLimits: {
9568
+ all_time_enabled?: boolean;
9569
+ all_time_cap?: number;
9570
+ all_time_spent?: number;
9571
+ daily_enabled?: boolean;
9572
+ daily_cap?: number;
9573
+ daily_spent?: number;
9574
+ weekly_enabled?: boolean;
9575
+ weekly_cap?: number;
9576
+ weekly_spent?: number;
9577
+ monthly_enabled?: boolean;
9578
+ monthly_cap?: number;
9579
+ monthly_spent?: number;
9580
+ yearly_enabled?: boolean;
9581
+ yearly_cap?: number;
9582
+ yearly_spent?: number;
9583
+ per_transaction_enabled?: boolean;
9584
+ per_transaction_cap?: number;
9585
+ per_transaction_spent?: number;
9586
+ };
9587
+ /** @description Issuing card. GET /cards (list) and GET /cards/{card_id} (single) share this shape. Most scalar fields pass through from the issuing vendor; only `sub_account`, `sub_account_id` and `user_data_id` are added/normalized by CORE. `required` documents the normal (vendor-enriched) contract. NOTE: if the vendor API is unavailable, the list endpoint degrades to a reduced local-only shape (omits `sub_account` and most vendor fields); this is an error-mode anomaly, not part of the contract. */
9588
+ IssuingCard: {
9589
+ /**
9590
+ * Format: uuid
9591
+ * @description Card id (also the vendor card id)
9592
+ */
9593
+ id: string;
9594
+ /** @description Internal card title */
9595
+ title?: string;
9596
+ /** @description Cardholder name on the card */
9597
+ card_name?: string;
9598
+ /** @description Last 4 PAN digits */
9599
+ last4?: string;
9600
+ /**
9601
+ * @description Card network
9602
+ * @example VISA
9603
+ */
9604
+ brand?: string;
9605
+ /** @description Funding model — true: prepaid (dedicated sub-account), false: balance (shared sub-account). Sourced from issuing_cards.is_prepaid (reliable); present for CORE-issued cards. Replaces the removed vendor `type` field. */
9606
+ is_prepaid: boolean;
9607
+ /** @enum {string} */
9608
+ form_factor?: "VIRTUAL" | "PHYSICAL";
9609
+ /**
9610
+ * @description Vendor card status
9611
+ * @enum {string}
9612
+ */
9613
+ status?: "ACTIVE" | "INACTIVE" | "FROZEN" | "CANCELED" | "CLOSED" | "BLOCKED" | "FAILED" | "PENDING";
9614
+ /** @example USD */
9615
+ currency?: string;
9616
+ /** Format: date-time */
9617
+ expiration_date?: string;
9618
+ /**
9619
+ * @description MM/YY
9620
+ * @example 06/29
9621
+ */
9622
+ expiration_date_short?: string;
9623
+ tokenizable?: boolean;
9624
+ spend_cap?: number;
9625
+ spent_amount?: number;
9626
+ /** Format: uuid */
9627
+ wallet_id?: string;
9628
+ /** Format: uuid */
9629
+ program_id?: string;
9630
+ /**
9631
+ * Format: uuid
9632
+ * @description Sub-account funding this card (backfilled from issuing_cards.fiat_account for prepaid)
9633
+ */
9634
+ sub_account_id?: string;
9635
+ vendor_sub_account_id?: string;
9636
+ /** @description Card id in the external issuing vendor */
9637
+ vendor_card_id?: string;
9638
+ /** Format: uuid */
9639
+ cardholder_id?: string | null;
9640
+ /** @description Cardholder record, or null */
9641
+ cardholder?: components["schemas"]["IssuingCardholder"] | null;
9642
+ /** @description user_data.id the card is assigned to; omitted (absent) when the card is not assigned to a member */
9643
+ user_data_id?: number;
9644
+ /** @description Embedded sub-account summary, or null when no sub-account is linked. Present on the normal (vendor-enriched) response; omitted only in the degraded local-only error mode. */
9645
+ sub_account: components["schemas"]["IssuingCardSubAccount"] | null;
9646
+ limits?: components["schemas"]["IssuingCardLimits"] | null;
9647
+ /** Format: date-time */
9648
+ created_at?: string;
9649
+ /** Format: date-time */
9650
+ updated_at?: string;
9651
+ };
9652
+ /** @description Sub-account as returned by GET /sub-accounts (list): a `fiat_accounts` row enriched with computed balances, currency, program and (when available) external bank details. */
9653
+ IssuingSubAccount: {
9654
+ /** Format: uuid */
9655
+ id: string;
9656
+ nick_name?: string | null;
9657
+ /** @enum {string} */
9658
+ type: "balance" | "prepaid";
9659
+ /**
9660
+ * @description Sub-account (fiat_account) status — only these 4 of the card_status enum are used for fiat_accounts
9661
+ * @enum {string}
9662
+ */
9663
+ status: "ACTIVE" | "CLOSED" | "BLOCKED" | "CANCELED";
9664
+ /** @description Effective balance (external balance for `balance` type, else DB balance; defaults to 0) */
9665
+ balance: number;
9666
+ fiat_balance: number;
9667
+ total_balance: number;
9668
+ realtimeauth_balance: number;
9669
+ /**
9670
+ * Format: uuid
9671
+ * @description crypto.uuid of the account currency
9672
+ */
9673
+ account_currency: string;
9674
+ /** Format: uuid */
9675
+ wallet_id: string;
9676
+ /** Format: uuid */
9677
+ program_id?: string | null;
9678
+ vendor_sub_account_id?: string | null;
9679
+ vendor_id?: string | null;
9680
+ /** @description Number of issuing_cards linked to this sub-account */
9681
+ cards_count: number;
9682
+ currency: components["schemas"]["CurrencyRef"];
9683
+ /** @description Program embed; null when program_id is null */
9684
+ issuing_program?: components["schemas"]["IssuingProgram"] | null;
9685
+ /** @description Bank details persisted on fiat_accounts; null when absent */
9686
+ bank_account_details?: components["schemas"]["BankAccountDetails"] | null;
9687
+ /** @description Bank details from the external API meta; empty string `""` when none are available. */
9688
+ account_details: components["schemas"]["BankAccountDetails"] | "";
9689
+ /** Format: date-time */
9690
+ created_at: string;
9691
+ /** Format: date-time */
9692
+ updated_at?: string | null;
9693
+ };
9694
+ /** @description Single sub-account (GET /sub-accounts/{sub_account_id}) — the raw vendor resource shape. Scalar fields below pass through from the issuing vendor. */
9695
+ IssuingSubAccountResource: {
9696
+ /** Format: uuid */
9697
+ id: string;
9698
+ title?: string;
9699
+ /** @example ACTIVE */
9700
+ status?: string;
9701
+ /** @example active */
9702
+ task_status?: string;
9703
+ /** @example USD */
9704
+ currency?: string;
9705
+ total_allocated?: number;
9706
+ total_available?: number;
9707
+ /** Format: uuid */
9708
+ wallet_id?: string;
9709
+ /** Format: uuid */
9710
+ program_id?: string;
9711
+ vendor_sub_account_id?: string;
9712
+ vendor_id?: string;
9713
+ /** Format: uuid */
9714
+ api_access_id?: string;
9715
+ /** Format: uuid */
9716
+ user_id?: string | null;
9717
+ vendor_user_id?: string | null;
9718
+ vendor_business_id?: string | null;
9719
+ /** @description Vendor meta. */
9720
+ meta?: ({
9721
+ bank_account_details?: components["schemas"]["BankAccountDetails"];
9722
+ } & {
9723
+ [key: string]: unknown;
9724
+ }) | null;
9725
+ internal_meta?: {
9726
+ [key: string]: unknown;
9727
+ } | null;
9728
+ /** Format: date-time */
9729
+ created_at?: string;
9730
+ /** Format: date-time */
9731
+ updated_at?: string;
9732
+ };
9733
+ /** @description Card / sub-account transaction (GET /cards/{card_id}/transactions and GET /sub-accounts/{sub_account_id}/transactions). Fields pass through from the issuing vendor. */
9734
+ IssuingTransaction: {
9735
+ /** @description Transaction id in the issuing vendor */
9736
+ vendor_transaction_id?: string;
9737
+ title?: string;
9738
+ last4?: string;
9739
+ /** @example APPROVED */
9740
+ status?: string;
9741
+ /** @example PURCHASE */
9742
+ transaction_type?: string;
9743
+ /** @example Purchase */
9744
+ group?: string;
9745
+ is_credit?: boolean;
9746
+ billing_amount?: number;
9747
+ /** @example USD */
9748
+ billing_currency?: string;
9749
+ transaction_amount?: number;
9750
+ /** @example USD */
9751
+ transaction_currency?: string;
9752
+ total_amount?: number;
9753
+ conversion_rate?: number;
9754
+ failure_reason?: string;
9755
+ adjustment_type?: string | null;
9756
+ review_status?: string | null;
9757
+ has_receipt?: boolean;
9758
+ merchant?: components["schemas"]["TransactionMerchant"];
9759
+ /** Format: date-time */
9760
+ created_at?: string;
9761
+ /** Format: date-time */
9762
+ cleared_at?: string | null;
9763
+ };
9764
+ /** @description Cardholder — the consumed subset (mirrors the frontend CardCardholder). The live vendor-proxied endpoint may return additional fields; only the supported subset is documented here. */
9765
+ IssuingCardholder: {
9766
+ /** Format: uuid */
9767
+ id: string;
9768
+ first_name: string;
9769
+ last_name: string;
9770
+ /** Format: email */
9771
+ email?: string | null;
9772
+ phone?: string | null;
9773
+ /** @description Date of birth */
9774
+ birth_date?: string | null;
9775
+ /**
9776
+ * @description ISO 3166 alpha-3
9777
+ * @example ESP
9778
+ */
9779
+ nationality?: string | null;
9780
+ };
9468
9781
  /** @description Crypto wallet with nested addresses */
9469
9782
  CryptoWallet: {
9470
9783
  /**
@@ -9589,11 +9902,9 @@ export interface components {
9589
9902
  /** Format: uuid */
9590
9903
  destination_currency?: string;
9591
9904
  vendor_account_id?: string | null;
9592
- /** @description When false, deposit_instructions and account_details are returned as null (deposits disabled for this account) */
9593
- is_deposit_enabled?: boolean;
9594
- /** @description Bank account details for deposits. Returned null when is_deposit_enabled is false. */
9905
+ /** @description Bank account details for deposits. Returned null when deposits are disabled for the account. */
9595
9906
  account_details?: Record<string, never> | null;
9596
- /** @description Deposit requisites. Returned null when is_deposit_enabled is false. */
9907
+ /** @description Deposit requisites. Returned null when deposits are disabled for the account. */
9597
9908
  deposit_instructions?: Record<string, never> | null;
9598
9909
  current_balance?: number | null;
9599
9910
  available_balance?: number | null;
@@ -9722,7 +10033,7 @@ export interface components {
9722
10033
  * @description Role granted upon acceptance
9723
10034
  * @enum {string}
9724
10035
  */
9725
- role: "user" | "admin";
10036
+ role: "auditor" | "user" | "admin";
9726
10037
  /** @description 16-char uppercase hex code delivered by email */
9727
10038
  code: string;
9728
10039
  /** Format: date-time */
@@ -3328,7 +3328,7 @@ export interface paths {
3328
3328
  put?: never;
3329
3329
  /**
3330
3330
  * Cancel order
3331
- * @description Cancels an order. Orders in PENDING or PROCESSING status can be canceled.
3331
+ * @description Cancels an order. Orders in PENDING or FAILED status can be canceled.
3332
3332
  * Optionally provide a cancellation reason.
3333
3333
  *
3334
3334
  */
@@ -7628,6 +7628,8 @@ export interface components {
7628
7628
  id?: string;
7629
7629
  type?: string;
7630
7630
  name?: string;
7631
+ /** @description When false, deposits are not accepted for accounts on this rail and their requisites are suppressed in public responses */
7632
+ is_deposit_enabled?: boolean;
7631
7633
  } | null;
7632
7634
  /** @description Tenant-specific billing rates */
7633
7635
  tenant_rates?: {
@@ -7736,7 +7738,7 @@ export interface components {
7736
7738
  account_currency?: string;
7737
7739
  /** Format: uuid */
7738
7740
  destination_currency?: string;
7739
- /** @description Whether deposits are enabled for this account. When false, public (Frontend/Developer) responses suppress deposit_instructions/account_details; admin responses still expose them. */
7741
+ /** @description Whether deposits are enabled for this account, resolved from the account's KYC rail (virtual_accounts_programs.kyc_rails.is_deposit_enabled). When false, public (Frontend/Developer) responses suppress deposit_instructions/account_details; admin responses still expose them. */
7740
7742
  is_deposit_enabled?: boolean;
7741
7743
  /** @description Bank deposit instructions grouped by instruction type (ACH, FEDWIRE, SWIFT) */
7742
7744
  deposit_instructions?: {
@@ -1447,7 +1447,7 @@ export interface components {
1447
1447
  /** @description Is main wallet for user */
1448
1448
  is_main: boolean;
1449
1449
  /** @enum {string} */
1450
- role: "owner" | "admin" | "user";
1450
+ role: "owner" | "admin" | "user" | "auditor";
1451
1451
  readonly kyc_info?: components["schemas"]["WalletKycInfoDto"];
1452
1452
  };
1453
1453
  WalletsFilter: Record<string, never>;
@@ -1478,7 +1478,7 @@ export interface components {
1478
1478
  /** @description Is main wallet for user */
1479
1479
  is_main: boolean;
1480
1480
  /** @enum {string} */
1481
- role: "owner" | "admin" | "user";
1481
+ role: "owner" | "admin" | "user" | "auditor";
1482
1482
  readonly kyc_info?: components["schemas"]["WalletKycInfoDto"];
1483
1483
  fiat_total: number;
1484
1484
  crypto_total: number;
@@ -1597,6 +1597,7 @@ export interface components {
1597
1597
  InitKycDataCollectionResponseDto: {
1598
1598
  providerType: string;
1599
1599
  verificationId: string;
1600
+ verificationToken?: string;
1600
1601
  };
1601
1602
  ResumeKycDataCollectionResponseDto: {
1602
1603
  providerType: string;
@@ -2298,6 +2299,8 @@ export interface components {
2298
2299
  enable_referral_program: boolean;
2299
2300
  readonly metrics_data?: components["schemas"]["MetricsDataEntity"] | null;
2300
2301
  readonly statement_branding?: components["schemas"]["StatementBrandingEntity"] | null;
2302
+ /** @enum {string} */
2303
+ kyc_data_provider: "persona" | "sumsub";
2301
2304
  base_currency: string;
2302
2305
  };
2303
2306
  SystemChainsResponseDto: {
@@ -2359,19 +2362,19 @@ export interface components {
2359
2362
  };
2360
2363
  WalletUserDto: {
2361
2364
  /** @enum {string} */
2362
- readonly role: "owner" | "admin" | "user";
2365
+ readonly role: "owner" | "admin" | "user" | "auditor";
2363
2366
  is_active: boolean;
2364
2367
  user_info?: components["schemas"]["WalletUserInfoDto"][];
2365
2368
  };
2366
2369
  WalletUsersFilterDto: {
2367
2370
  is_active?: boolean;
2368
2371
  /** @enum {string} */
2369
- role?: "owner" | "admin" | "user";
2372
+ role?: "owner" | "admin" | "user" | "auditor";
2370
2373
  search?: string;
2371
2374
  };
2372
2375
  UpdateWalletUserRoleDto: {
2373
2376
  /** @enum {string} */
2374
- role: "user";
2377
+ role: "user" | "auditor";
2375
2378
  };
2376
2379
  };
2377
2380
  responses: never;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "squarefi-bff-api-module",
3
- "version": "1.36.1",
3
+ "version": "1.36.3",
4
4
  "description": "Squarefi BFF API client module",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",