squarefi-bff-api-module 1.36.73 → 1.36.75

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.
@@ -6194,7 +6194,7 @@ export interface paths {
6194
6194
  *
6195
6195
  * Each returned item includes a `tenant_rates` object (`markup_percent`,
6196
6196
  * `markup_fixed`, `mon_min_usd`) and may expose product-facing guardrails
6197
- * such as `min_amount`, `max_amount`, and `first_party_only`.
6197
+ * such as `min_amount`, `max_amount`, `first_party_only` and `documents_required_from_amount`.
6198
6198
  *
6199
6199
  * **Authentication**: x-api-key header required
6200
6200
  *
@@ -8685,6 +8685,11 @@ export interface components {
8685
8685
  max_amount?: number | null;
8686
8686
  /** @description Whether payouts for this order type are limited to the wallet owner's own account */
8687
8687
  first_party_only?: boolean;
8688
+ /**
8689
+ * @description Amount in the send currency from which an order of this type needs supporting documents (`documents`); `0` — always, `null` — never
8690
+ * @example 20000
8691
+ */
8692
+ documents_required_from_amount?: number | null;
8688
8693
  /** @description Tenant-specific billing rates (present when tenant context is available) */
8689
8694
  tenant_rates?: {
8690
8695
  /**
@@ -9518,6 +9518,13 @@ export interface paths {
9518
9518
  is_subtract?: boolean;
9519
9519
  /** @description Destination address (for crypto withdrawals; affects network fee estimation). */
9520
9520
  to_address?: string;
9521
+ /** @description The wallet the order would be for. When the caller may act on it, the quote is priced with the
9522
+ * wallet OWNER's tariff — the one every order on the wallet is charged at — so a member of a shared
9523
+ * wallet is quoted what will be debited. Without it, or for a wallet the caller may not act on, the
9524
+ * caller's own tariff prices the quote. On a tenant priced by tariff plans, the quote uses the named
9525
+ * wallet's plan — the tenant's default plan without `wallet_id`.
9526
+ * */
9527
+ wallet_id?: string;
9521
9528
  };
9522
9529
  header?: never;
9523
9530
  path?: never;
@@ -10197,7 +10204,7 @@ export interface paths {
10197
10204
  *
10198
10205
  * Each returned item includes a `tenant_rates` object (`markup_percent`,
10199
10206
  * `markup_fixed`, `mon_min_usd`) and may expose product-facing guardrails
10200
- * such as `min_amount`, `max_amount`, and `first_party_only`.
10207
+ * such as `min_amount`, `max_amount`, `first_party_only` and `documents_required_from_amount`.
10201
10208
  *
10202
10209
  * **Authentication**: Bearer token + x-tenant-id header
10203
10210
  *
@@ -14821,6 +14828,8 @@ export interface components {
14821
14828
  min_amount: number | null;
14822
14829
  /** @description Maximum amount the product should allow */
14823
14830
  max_amount: number | null;
14831
+ /** @description Amount in the send currency from which the order needs supporting documents (`documents`); `0` — always, `null` — never */
14832
+ documents_required_from_amount: number | null;
14824
14833
  order_types_kyc_rails: {
14825
14834
  /** Format: uuid */
14826
14835
  id: string;
@@ -14840,6 +14849,8 @@ export interface components {
14840
14849
  min_amount: number | null;
14841
14850
  max_amount: number | null;
14842
14851
  first_party_only: boolean;
14852
+ /** @description Amount in the send currency from which the order needs supporting documents (`documents`); `0` — always, `null` — never */
14853
+ documents_required_from_amount: number | null;
14843
14854
  tenant_rates: components["schemas"]["OrderTypeTenantRates"];
14844
14855
  };
14845
14856
  ErrorResponse: {
@@ -3191,6 +3191,13 @@ export interface paths {
3191
3191
  is_reverse?: boolean;
3192
3192
  /** @description Destination address for withdrawals */
3193
3193
  to_address?: string;
3194
+ /** @description The wallet the order would be for. When the caller may act on it, the quote is priced with the
3195
+ * wallet OWNER's tariff — the one every order on the wallet is charged at — so a member of a shared
3196
+ * wallet is quoted what will be debited. Without it, or for a wallet the caller may not act on, the
3197
+ * caller's own tariff prices the quote. On a tenant priced by tariff plans, the quote uses the named
3198
+ * wallet's plan — the tenant's default plan without `wallet_id`.
3199
+ * */
3200
+ wallet_id?: string;
3194
3201
  };
3195
3202
  header?: never;
3196
3203
  path?: never;
@@ -5254,6 +5261,13 @@ export interface paths {
5254
5261
  is_reverse?: "true" | "false";
5255
5262
  /** @description Destination address for withdrawals (affects network fee estimation) */
5256
5263
  to_address?: string;
5264
+ /** @description The wallet the order would be for. When the caller may act on it, the quote is priced with the
5265
+ * wallet OWNER's tariff — the one every order on the wallet is charged at — so a member of a shared
5266
+ * wallet is quoted what will be debited. Without it, or for a wallet the caller may not act on, the
5267
+ * caller's own tariff prices the quote. On a tenant priced by tariff plans, the quote uses the named
5268
+ * wallet's plan — the tenant's default plan without `wallet_id`.
5269
+ * */
5270
+ wallet_id?: string;
5257
5271
  };
5258
5272
  header?: never;
5259
5273
  path?: never;
@@ -7397,6 +7411,11 @@ export interface components {
7397
7411
  max_amount?: number | null;
7398
7412
  /** @description Whether payouts for this order type are limited to the wallet owner's own account */
7399
7413
  first_party_only?: boolean;
7414
+ /**
7415
+ * @description Amount in the send currency from which an order of this type needs supporting documents (`documents`); `0` — always, `null` — never
7416
+ * @example 20000
7417
+ */
7418
+ documents_required_from_amount?: number | null;
7400
7419
  /** @description Associated KYC rails for this order type */
7401
7420
  order_types_kyc_rails?: {
7402
7421
  /**
@@ -3911,7 +3911,7 @@ export interface paths {
3911
3911
  * i.e. those having a row in `tenant_order_type_rates`. Each returned item is
3912
3912
  * enriched with `tenant_rates` (`markup_percent`, `markup_fixed`, `mon_min_usd`)
3913
3913
  * and may expose product-facing guardrails such as `min_amount`,
3914
- * `max_amount`, and `first_party_only`.
3914
+ * `max_amount`, `first_party_only` and `documents_required_from_amount`.
3915
3915
  * - Without a tenant scope (admin global view), the full catalogue is returned
3916
3916
  * and `tenant_rates` is omitted.
3917
3917
  *
@@ -8717,6 +8717,11 @@ export interface components {
8717
8717
  max_amount?: number | null;
8718
8718
  /** @description Whether payouts for this order type are limited to the wallet owner's own account */
8719
8719
  first_party_only?: boolean;
8720
+ /**
8721
+ * @description Amount in the send currency from which an order of this type needs supporting documents (`documents`); `0` — always, `null` — never
8722
+ * @example 20000
8723
+ */
8724
+ documents_required_from_amount?: number | null;
8720
8725
  kyc_rails?: {
8721
8726
  /** Format: uuid */
8722
8727
  id?: string;
@@ -1943,6 +1943,11 @@ export declare namespace API {
1943
1943
  max_amount: number | null;
1944
1944
  /** Whether payouts for this order type are limited to the wallet owner's own account */
1945
1945
  first_party_only: boolean;
1946
+ /**
1947
+ * Amount in the send currency from which an order needs supporting documents; `0` — always, `null` — never.
1948
+ * Absent on a backend that predates the field, which means the same as `null`.
1949
+ */
1950
+ documents_required_from_amount?: number | null;
1946
1951
  }
1947
1952
  namespace List {
1948
1953
  type Response = OrderInfo[];
@@ -2276,6 +2281,11 @@ export declare namespace API {
2276
2281
  max_amount: number | null;
2277
2282
  /** Whether payouts for this order type are limited to the wallet owner's own account */
2278
2283
  first_party_only: boolean;
2284
+ /**
2285
+ * Amount in the send currency from which an order needs supporting documents; `0` — always, `null` — never.
2286
+ * Absent on a backend that predates the field, which means the same as `null`.
2287
+ */
2288
+ documents_required_from_amount?: number | null;
2279
2289
  order_types_kyc_rails: OrderTypeKycRail[];
2280
2290
  }
2281
2291
  namespace List {
@@ -148,6 +148,10 @@ export declare enum OrderType {
148
148
  BC3_SEPA_OFFRAMP = "BC3_SEPA_OFFRAMP",
149
149
  NARVI_SEPA_ONRAMP = "NARVI_SEPA_ONRAMP",
150
150
  NARVI_SEPA_OFFRAMP = "NARVI_SEPA_OFFRAMP",
151
+ RPP_SWIFT_OFFRAMP = "RPP_SWIFT_OFFRAMP",
152
+ RPP_SEPA_OFFRAMP = "RPP_SEPA_OFFRAMP",
153
+ RPP_FPS_OFFRAMP = "RPP_FPS_OFFRAMP",
154
+ RPP_ACH_OFFRAMP = "RPP_ACH_OFFRAMP",
151
155
  EXCHANGE_OMNI_ONRAMP = "EXCHANGE_OMNI_ONRAMP",
152
156
  EXCHANGE_OMNI_OFFRAMP = "EXCHANGE_OMNI_OFFRAMP",
153
157
  EXCHANGE_OMNI_CRYPTO = "EXCHANGE_OMNI_CRYPTO",
@@ -260,6 +264,10 @@ export declare enum WalletTransactionRecordType {
260
264
  BC3_SEPA_OFFRAMP = "BC3_SEPA_OFFRAMP",
261
265
  NARVI_SEPA_ONRAMP = "NARVI_SEPA_ONRAMP",
262
266
  NARVI_SEPA_OFFRAMP = "NARVI_SEPA_OFFRAMP",
267
+ RPP_SWIFT_OFFRAMP = "RPP_SWIFT_OFFRAMP",
268
+ RPP_SEPA_OFFRAMP = "RPP_SEPA_OFFRAMP",
269
+ RPP_FPS_OFFRAMP = "RPP_FPS_OFFRAMP",
270
+ RPP_ACH_OFFRAMP = "RPP_ACH_OFFRAMP",
263
271
  EXCHANGE_OMNI_ONRAMP = "EXCHANGE_OMNI_ONRAMP",
264
272
  EXCHANGE_OMNI_OFFRAMP = "EXCHANGE_OMNI_OFFRAMP",
265
273
  EXCHANGE_OMNI_CRYPTO = "EXCHANGE_OMNI_CRYPTO",
package/dist/constants.js CHANGED
@@ -149,6 +149,10 @@ export var OrderType;
149
149
  OrderType["BC3_SEPA_OFFRAMP"] = "BC3_SEPA_OFFRAMP";
150
150
  OrderType["NARVI_SEPA_ONRAMP"] = "NARVI_SEPA_ONRAMP";
151
151
  OrderType["NARVI_SEPA_OFFRAMP"] = "NARVI_SEPA_OFFRAMP";
152
+ OrderType["RPP_SWIFT_OFFRAMP"] = "RPP_SWIFT_OFFRAMP";
153
+ OrderType["RPP_SEPA_OFFRAMP"] = "RPP_SEPA_OFFRAMP";
154
+ OrderType["RPP_FPS_OFFRAMP"] = "RPP_FPS_OFFRAMP";
155
+ OrderType["RPP_ACH_OFFRAMP"] = "RPP_ACH_OFFRAMP";
152
156
  OrderType["EXCHANGE_OMNI_ONRAMP"] = "EXCHANGE_OMNI_ONRAMP";
153
157
  OrderType["EXCHANGE_OMNI_OFFRAMP"] = "EXCHANGE_OMNI_OFFRAMP";
154
158
  OrderType["EXCHANGE_OMNI_CRYPTO"] = "EXCHANGE_OMNI_CRYPTO";
@@ -263,6 +267,10 @@ export var WalletTransactionRecordType;
263
267
  WalletTransactionRecordType["BC3_SEPA_OFFRAMP"] = "BC3_SEPA_OFFRAMP";
264
268
  WalletTransactionRecordType["NARVI_SEPA_ONRAMP"] = "NARVI_SEPA_ONRAMP";
265
269
  WalletTransactionRecordType["NARVI_SEPA_OFFRAMP"] = "NARVI_SEPA_OFFRAMP";
270
+ WalletTransactionRecordType["RPP_SWIFT_OFFRAMP"] = "RPP_SWIFT_OFFRAMP";
271
+ WalletTransactionRecordType["RPP_SEPA_OFFRAMP"] = "RPP_SEPA_OFFRAMP";
272
+ WalletTransactionRecordType["RPP_FPS_OFFRAMP"] = "RPP_FPS_OFFRAMP";
273
+ WalletTransactionRecordType["RPP_ACH_OFFRAMP"] = "RPP_ACH_OFFRAMP";
266
274
  WalletTransactionRecordType["EXCHANGE_OMNI_ONRAMP"] = "EXCHANGE_OMNI_ONRAMP";
267
275
  WalletTransactionRecordType["EXCHANGE_OMNI_OFFRAMP"] = "EXCHANGE_OMNI_OFFRAMP";
268
276
  WalletTransactionRecordType["EXCHANGE_OMNI_CRYPTO"] = "EXCHANGE_OMNI_CRYPTO";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "squarefi-bff-api-module",
3
- "version": "1.36.73",
3
+ "version": "1.36.75",
4
4
  "description": "Squarefi BFF API client module",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",