squarefi-bff-api-module 1.36.59 → 1.36.60

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.
@@ -1137,8 +1137,10 @@ export interface paths {
1137
1137
  external_id?: string;
1138
1138
  /**
1139
1139
  * @description Optional list of chain IDs (from `GET /api/reference/chains`)
1140
- * to generate addresses for immediately. Omit to create the wallet
1141
- * without addresses and add them later.
1140
+ * to generate addresses for immediately. Omit to create an empty
1141
+ * wallet; the custody-provider wallet is then created together with
1142
+ * the first address added via
1143
+ * `POST /api/crypto_wallets/{crypto_wallet_id}/addresses/{chain}`.
1142
1144
  *
1143
1145
  * @example [
1144
1146
  * 1,
@@ -1421,6 +1423,9 @@ export interface paths {
1421
1423
  *
1422
1424
  * This endpoint does not require authentication and can be used for monitoring.
1423
1425
  *
1426
+ * `version` is the published Developer API version — the same value every
1427
+ * response carries in the `X-API-Version` header. See the Changelog section.
1428
+ *
1424
1429
  */
1425
1430
  get: {
1426
1431
  parameters: {
@@ -6042,7 +6047,9 @@ export interface paths {
6042
6047
  };
6043
6048
  /**
6044
6049
  * Get exchange rates
6045
- * @description Returns exchange rates with tenant-specific fees applied.
6050
+ * @description Returns exchange rates with the tenant FX spread applied: `rate` is what the tenant
6051
+ * trades at, `base_rate` is the market rate it came from and `fx_spread_percent` is the
6052
+ * percent taken off. The three are equal-and-zero when the tenant configured no spread.
6046
6053
  * Only currency pairs enabled for the tenant and configured in `tenant_exchange_rates` are returned.
6047
6054
  *
6048
6055
  * **Authentication**: x-api-key header required
@@ -7104,7 +7111,7 @@ export interface components {
7104
7111
  * @example EXCHANGE_OMNI
7105
7112
  * @enum {string}
7106
7113
  */
7107
- 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";
7114
+ 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";
7108
7115
  /** @description Card object with all properties */
7109
7116
  IssuingCard: {
7110
7117
  /**
@@ -8504,7 +8511,7 @@ export interface components {
8504
8511
  is_tenant_enabled?: boolean;
8505
8512
  chain?: components["schemas"]["ChainRef"];
8506
8513
  };
8507
- /** @description Exchange rate between two currencies with tenant fee applied */
8514
+ /** @description Exchange rate between two currencies with the tenant FX spread applied */
8508
8515
  ExchangeRate: {
8509
8516
  id?: number;
8510
8517
  /** Format: date-time */
@@ -8520,10 +8527,20 @@ export interface components {
8520
8527
  */
8521
8528
  to?: string;
8522
8529
  /**
8523
- * @description Exchange rate (tenant fee already applied)
8530
+ * @description Exchange rate the tenant trades at (FX spread already applied)
8524
8531
  * @example 45000
8525
8532
  */
8526
8533
  rate?: number;
8534
+ /**
8535
+ * @description Market rate before the tenant FX spread; equal to `rate` when no spread applies
8536
+ * @example 45685
8537
+ */
8538
+ base_rate?: number;
8539
+ /**
8540
+ * @description Tenant FX spread already taken off `rate`, in whole percent
8541
+ * @example 1.5
8542
+ */
8543
+ fx_spread_percent?: number;
8527
8544
  /**
8528
8545
  * @description Inverted exchange rate
8529
8546
  * @example 0.0000222
@@ -1641,7 +1641,7 @@ export interface paths {
1641
1641
  * Create destination
1642
1642
  * @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.
1643
1643
  *
1644
- * **Banking types**: banking_data required
1644
+ * **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.
1645
1645
  * **Crypto types**: crypto_data required
1646
1646
  * **Internal type**: internal_data required (target wallet on the same platform)
1647
1647
  *
@@ -1800,6 +1800,7 @@ export interface paths {
1800
1800
  "application/json": {
1801
1801
  name: string;
1802
1802
  external_id?: string;
1803
+ /** @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. */
1803
1804
  chains?: number[];
1804
1805
  };
1805
1806
  };
@@ -3024,6 +3025,8 @@ export interface paths {
3024
3025
  * Delete card
3025
3026
  * @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`).
3026
3027
  *
3028
+ * **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.
3029
+ *
3027
3030
  * **Authentication**: Bearer token with x-tenant-id header required
3028
3031
  *
3029
3032
  * **Access Control**: Wallet owner or admin of the card's wallet
@@ -3052,6 +3055,23 @@ export interface paths {
3052
3055
  success?: boolean;
3053
3056
  /** @example Card deleted successfully */
3054
3057
  message?: string;
3058
+ /** @description What happened to the sub-account balance before the close */
3059
+ sweep?: {
3060
+ /** @enum {string} */
3061
+ decision?: "sweep" | "skip_no_sub_account" | "skip_shared_sub_account" | "skip_empty" | "skip_not_client_money" | "skip_no_withdrawal_rail";
3062
+ sub_account_id?: string | null;
3063
+ /** @description Balance found on the sub-account before the close */
3064
+ available?: number;
3065
+ currency?: string | null;
3066
+ /** @description Amount actually returned to the wallet (0 when skipped or failed) */
3067
+ swept?: number;
3068
+ /** @description The WITHDRAW_CARD_SUBACCOUNT order that carried the return */
3069
+ order_uuid?: string | null;
3070
+ /** @description Why a due return did not happen; the card was closed regardless */
3071
+ error?: string | null;
3072
+ /** @description Balance the vendor returned to the operator instead of the client on this close (0 when none) */
3073
+ left_with_operator?: number;
3074
+ } | null;
3055
3075
  };
3056
3076
  };
3057
3077
  };
@@ -9710,7 +9730,12 @@ export interface paths {
9710
9730
  };
9711
9731
  /**
9712
9732
  * Get exchange rates
9713
- * @description Returns exchange rates with tenant-specific fees applied.
9733
+ * @description Returns exchange rates for the pairs enabled for the tenant.
9734
+ *
9735
+ * `rate` is what the tenant trades at: the tenant FX spread is already
9736
+ * applied. `base_rate` carries the market rate it was derived from and
9737
+ * `fx_spread_percent` the percent taken off, so the spread can be shown
9738
+ * as a line of its own.
9714
9739
  *
9715
9740
  * **Authentication**: Bearer token + x-tenant-id header
9716
9741
  *
@@ -10718,7 +10743,6 @@ export interface paths {
10718
10743
  *
10719
10744
  * **Supported identifier types:**
10720
10745
  * - `uuid` — user_data.uuid
10721
- * - `id` — user_data.id (numeric)
10722
10746
  * - `email` — user_data.email (case-insensitive)
10723
10747
  * - `phone` — user_data.phone
10724
10748
  * - `telegram` — `telegram_user.tg_id`, or a case-insensitive `username` match (leading `@` ignored)
@@ -10732,7 +10756,7 @@ export interface paths {
10732
10756
  /** @description The search value */
10733
10757
  identifier: string;
10734
10758
  /** @description Type of identifier to search by */
10735
- type: "uuid" | "id" | "email" | "phone" | "telegram";
10759
+ type: "uuid" | "email" | "phone" | "telegram";
10736
10760
  };
10737
10761
  header?: never;
10738
10762
  path?: never;
@@ -13406,7 +13430,7 @@ export interface components {
13406
13430
  * @example EXCHANGE_OMNI
13407
13431
  * @enum {string}
13408
13432
  */
13409
- 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";
13433
+ 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";
13410
13434
  OrderCalculation: {
13411
13435
  /**
13412
13436
  * Format: uuid
@@ -13429,10 +13453,20 @@ export interface components {
13429
13453
  */
13430
13454
  result_amount: number;
13431
13455
  /**
13432
- * @description Exchange rate applied (source → destination), 6 decimals.
13456
+ * @description Exchange rate applied (source → destination), 6 decimals. Includes the tenant FX spread.
13433
13457
  * @example 0.985
13434
13458
  */
13435
13459
  rate: number;
13460
+ /**
13461
+ * @description Market rate before the tenant FX spread. Equal to `rate` when no spread applies.
13462
+ * @example 1
13463
+ */
13464
+ base_rate: number;
13465
+ /**
13466
+ * @description Tenant FX spread already taken off `rate`, in whole percent.
13467
+ * @example 1.5
13468
+ */
13469
+ fx_spread: number;
13436
13470
  /**
13437
13471
  * @description Total fees (comission + network_fee), in the source currency.
13438
13472
  * @example 1.5
@@ -13530,7 +13564,7 @@ export interface components {
13530
13564
  /** @description Active destinations belonging to this account. */
13531
13565
  destinations: components["schemas"]["CounterpartyDestination"][];
13532
13566
  };
13533
- /** @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. */
13567
+ /** @description Postal address of a banking destination whose address it is (the bank vs the beneficiary) is defined by the property that carries it. */
13534
13568
  CounterpartyBankingAddress: {
13535
13569
  city?: string | null;
13536
13570
  postcode?: string | null;
@@ -13555,7 +13589,10 @@ export interface components {
13555
13589
  /** @description Sort code (6 digits, UK banking) */
13556
13590
  sort_code?: string | null;
13557
13591
  note?: string | null;
13592
+ /** @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. */
13558
13593
  address?: components["schemas"]["CounterpartyBankingAddress"] | null;
13594
+ /** @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). */
13595
+ beneficiary_address?: components["schemas"]["CounterpartyBankingAddress"] | null;
13559
13596
  /** Format: date-time */
13560
13597
  created_at: string;
13561
13598
  } | null;
@@ -1238,7 +1238,10 @@ export interface paths {
1238
1238
  post?: never;
1239
1239
  /**
1240
1240
  * Cancel a card
1241
- * @description Cancels (permanently deactivates) a card by its ID
1241
+ * @description Cancels (permanently deactivates) a card by its ID.
1242
+ *
1243
+ * 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.
1244
+ *
1242
1245
  */
1243
1246
  delete: {
1244
1247
  parameters: {
@@ -1252,7 +1255,7 @@ export interface paths {
1252
1255
  };
1253
1256
  requestBody?: never;
1254
1257
  responses: {
1255
- /** @description Card successfully canceled */
1258
+ /** @description Card successfully canceled; `sweep` reports what happened to the balance */
1256
1259
  200: {
1257
1260
  headers: {
1258
1261
  [name: string]: unknown;
@@ -7151,7 +7154,7 @@ export interface components {
7151
7154
  * @example EXCHANGE_OMNI
7152
7155
  * @enum {string}
7153
7156
  */
7154
- 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";
7157
+ 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";
7155
7158
  /** @description Order type reference with optional product guardrails, associated KYC rails and tenant billing rates */
7156
7159
  OrderType: {
7157
7160
  /** @description Order type identifier (e.g. EXCHANGE, WITHDRAWAL_CRYPTO) */
@@ -1033,6 +1033,7 @@ export interface paths {
1033
1033
  "application/json": {
1034
1034
  name: string;
1035
1035
  external_id?: string;
1036
+ /** @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. */
1036
1037
  chains?: number[];
1037
1038
  };
1038
1039
  };
@@ -8677,7 +8678,7 @@ export interface components {
8677
8678
  * @example EXCHANGE_OMNI
8678
8679
  * @enum {string}
8679
8680
  */
8680
- 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";
8681
+ 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";
8681
8682
  OrderType: {
8682
8683
  id?: components["schemas"]["OrderTypeId"];
8683
8684
  description?: string;
@@ -526,7 +526,7 @@ export declare namespace API {
526
526
  counterparty_account_id: string;
527
527
  type: CounterpartyDestinationType;
528
528
  nickname?: string;
529
- external_banking_data?: Pick<List.DestinationListItemExternalBankingData, 'account_number' | 'routing_number' | 'bank_name' | 'swift_bic' | 'iban' | 'sort_code' | 'note' | 'address'>;
529
+ external_banking_data?: Pick<List.DestinationListItemExternalBankingData, 'account_number' | 'routing_number' | 'bank_name' | 'swift_bic' | 'iban' | 'sort_code' | 'note' | 'address' | 'beneficiary_address'>;
530
530
  external_crypto_data?: Pick<List.DestinationListItemExternalCryptoData, 'currency_id' | 'address' | 'memo'>;
531
531
  internal_data?: Pick<List.DestinationInternalData, 'wallet_id' | 'description'>;
532
532
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "squarefi-bff-api-module",
3
- "version": "1.36.59",
3
+ "version": "1.36.60",
4
4
  "description": "Squarefi BFF API client module",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",