squarefi-bff-api-module 1.36.72 → 1.36.74

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.
@@ -23,13 +23,6 @@ export const frontend = {
23
23
  }),
24
24
  deposit: ({ card_id, ...data }) => apiClientV1Frontend.postRequest(`/frontend/issuing/cards/${card_id}/deposit`, { data }),
25
25
  withdraw: ({ card_id, ...data }) => apiClientV1Frontend.postRequest(`/frontend/issuing/cards/${card_id}/withdraw`, { data }),
26
- // Unified create — the backend routes to the balance or prepaid flow by the program's
27
- // `sub_account_type`, so there is one method for both. Replaces the legacy
28
- // `issuing.cards.create.*` methods. The cardholder is either an explicit `cardholder_id`
29
- // or resolved from `assigned_user_data_uuid` via the user's linked cardholder (provision it
30
- // first through `cardholders.*` — an unlinked user gets `400 CARDHOLDER_NOT_LINKED`).
31
- // Issuing fee / initial top-up follow the group tariff; pass `currency_id` (and optionally
32
- // `initial_topup`) whenever the tariff carries money.
33
26
  getById: ({ card_id, }) => apiClientV1Frontend.getRequest(`/frontend/issuing/cards/${card_id}`),
34
27
  /** Rename (and other editable card fields). */
35
28
  update: ({ card_id, ...data }) => apiClientV1Frontend.patchRequest(`/frontend/issuing/cards/${card_id}`, { data }),
@@ -57,6 +50,14 @@ export const frontend = {
57
50
  });
58
51
  },
59
52
  transactions: ({ card_id, ...params }) => apiClientV1Frontend.getRequest(`/frontend/issuing/cards/${card_id}/transactions`, { params }),
53
+ // Unified create — the backend routes to the balance or prepaid flow by the program's
54
+ // `sub_account_type`, so there is one method for both. Replaces the legacy
55
+ // `issuing.cards.create.*` methods. The cardholder is either an explicit `cardholder_id`
56
+ // or resolved from `assigned_user_data_uuid` via the user's linked cardholder (provision it
57
+ // first through `cardholders.*` — an unlinked user gets `400 CARDHOLDER_NOT_LINKED`).
58
+ // Issuing fee / initial top-up follow the group tariff; pass `currency_id` (and optionally
59
+ // `initial_topup`) whenever the tariff carries money. With `is_reverse: true`,
60
+ // `initial_topup` is what lands on the card and the fee and top-up commission come on top.
60
61
  create: (data) => apiClientV1Frontend.postRequest('/frontend/issuing/cards', {
61
62
  data,
62
63
  }),
@@ -2173,7 +2173,9 @@ export interface paths {
2173
2173
  head?: never;
2174
2174
  /**
2175
2175
  * Update cardholder
2176
- * @description Updates cardholder information (local row + vendor propagation of personal fields).
2176
+ * @description Updates cardholder information. Email and phone of an Interlace or PhotonPay
2177
+ * cardholder are sent to the vendor first; every other field, and every other
2178
+ * vendor, is stored locally only.
2177
2179
  * Same contract as `PATCH /frontend/issuing/cardholders/{cardholder_id}`.
2178
2180
  *
2179
2181
  * **Authentication**: x-api-key header required
@@ -2690,6 +2692,44 @@ export interface paths {
2690
2692
  *
2691
2693
  */
2692
2694
  vendor_user_id?: string;
2695
+ /**
2696
+ * @description TOTAL wallet debit at issuance, in the currency of `currency_id`: the issuing fee
2697
+ * plus the amount to land on the card, from which the top-up commission is taken.
2698
+ * When omitted, the tariff's default total applies: it is stated in the card's
2699
+ * currency and converted into `currency_id` at the pair's rate. On a program whose cards open holding
2700
+ * a mandatory minimum balance, what it pays toward the card after the issuing fee must be
2701
+ * at least that balance — refused with `400 INITIAL_TOPUP_BELOW_OPENING_LOAD` otherwise,
2702
+ * nothing charged. The top-up commission is not held against it: the card opens holding
2703
+ * the minimum even when the commission takes the top-up a few cents under.
2704
+ * Not charged at all where the wallet has no issuance tariff on the program.
2705
+ *
2706
+ * @example 80.4
2707
+ */
2708
+ initial_topup?: number;
2709
+ /**
2710
+ * @description When `true`, `initial_topup` is the amount to land on the card, in the card's currency,
2711
+ * instead of the total debit: the issuing fee and the top-up commission are charged on top.
2712
+ * The commission is added to the amount, as with a reverse card deposit, so the card gets
2713
+ * exactly `initial_topup`. The top-up debit is the `from_amount` of
2714
+ * `GET /api/orders/calc?order_type=TRANSFER_CARD_SUBACCOUNT&is_reverse=true&amount=<initial_topup>`
2715
+ * (from `currency_id` to the card's currency); the issuing fee comes on top of it.
2716
+ * What the tariff puts on the card at minimum (its minimum total less the issuing fee — 25
2717
+ * on a 50 / 75 tariff) and a program's mandatory opening balance are held against the
2718
+ * amount that lands. Needs `initial_topup` of at least 0.01; a boolean only, refused
2719
+ * with `400` otherwise — also where the program does not bill issuance and the field
2720
+ * is ignored.
2721
+ *
2722
+ * @default false
2723
+ */
2724
+ is_reverse?: boolean;
2725
+ /**
2726
+ * Format: uuid
2727
+ * @description Wallet currency to debit for the issuing fee and `initial_topup`. Required
2728
+ * whenever issuance is billed on the program — the request is refused with `400`
2729
+ * otherwise.
2730
+ *
2731
+ */
2732
+ currency_id?: string;
2693
2733
  };
2694
2734
  };
2695
2735
  };
@@ -2713,6 +2753,12 @@ export interface paths {
2713
2753
  * - Missing program_id
2714
2754
  * - Missing required fields based on program type
2715
2755
  * - Unsupported program type
2756
+ * - `INITIAL_TOPUP_BELOW_OPENING_LOAD` — `initial_topup` less the issuing fee is below the
2757
+ * program's mandatory opening balance; the message names the total accepted at the current rate
2758
+ * - `OPENING_LOAD_NOT_PAID` — the program's cards open holding a mandatory balance and
2759
+ * this issuance charges nothing for it (issuance not billed here, or no issuance tariff
2760
+ * for the wallet on the program), or the card spends from a sub-account, whose top-up
2761
+ * funds the sub-account rather than the card
2716
2762
  * */
2717
2763
  400: {
2718
2764
  headers: {
@@ -6148,7 +6194,7 @@ export interface paths {
6148
6194
  *
6149
6195
  * Each returned item includes a `tenant_rates` object (`markup_percent`,
6150
6196
  * `markup_fixed`, `mon_min_usd`) and may expose product-facing guardrails
6151
- * 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`.
6152
6198
  *
6153
6199
  * **Authentication**: x-api-key header required
6154
6200
  *
@@ -8639,6 +8685,11 @@ export interface components {
8639
8685
  max_amount?: number | null;
8640
8686
  /** @description Whether payouts for this order type are limited to the wallet owner's own account */
8641
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;
8642
8693
  /** @description Tenant-specific billing rates (present when tenant context is available) */
8643
8694
  tenant_rates?: {
8644
8695
  /**
@@ -3151,13 +3151,35 @@ export interface paths {
3151
3151
  vendor_user_id?: string;
3152
3152
  /**
3153
3153
  * @description TOTAL wallet debit asked for at issuance: the issuing fee is subtracted and
3154
- * the remainder lands on the card's sub-account. Accepted only on group tariffs
3155
- * that already mandate an initial top-up (`initial_topup_usd > 0`); otherwise the
3156
- * group amount stands. Requires `currency_id`.
3154
+ * the remainder, less the top-up commission, lands on the card's sub-account.
3155
+ * When omitted, the group tariff's total applies, stated in the card's currency and
3156
+ * converted into `currency_id` at the pair's rate. On a program whose cards open
3157
+ * holding a mandatory minimum balance, what it pays toward the card after the
3158
+ * issuing fee must be at least that balance — refused with
3159
+ * `400 INITIAL_TOPUP_BELOW_OPENING_LOAD` otherwise, nothing charged. The top-up
3160
+ * commission is not held against it: the card opens holding the minimum even when
3161
+ * the commission takes the top-up a few cents under. Requires `currency_id`.
3157
3162
  *
3158
3163
  * @example 100
3159
3164
  */
3160
3165
  initial_topup?: number;
3166
+ /**
3167
+ * @description When `true`, `initial_topup` is the amount to land on the card, in the card's currency,
3168
+ * instead of the total debit: the issuing fee and the top-up commission are charged on top.
3169
+ * The commission is added to the amount, as with a reverse card deposit, so the card gets
3170
+ * exactly `initial_topup`. The top-up debit is the `from_amount` of
3171
+ * `GET /frontend/orders/calc?order_type=TRANSFER_CARD_SUBACCOUNT&is_reverse=true&amount=<initial_topup>`
3172
+ * (from `currency_id` to the card's currency, with `wallet_id`); the issuing fee comes on top
3173
+ * of it.
3174
+ * What the tariff puts on the card at minimum (its minimum total less the issuing fee — 25
3175
+ * on a 50 / 75 tariff) and a program's mandatory opening balance are held against the
3176
+ * amount that lands. Needs `initial_topup` of at least 0.01; a boolean only, refused
3177
+ * with `400` otherwise — also where the program does not bill issuance and the field
3178
+ * is ignored.
3179
+ *
3180
+ * @default false
3181
+ */
3182
+ is_reverse?: boolean;
3161
3183
  /**
3162
3184
  * Format: uuid
3163
3185
  * @description Wallet currency to debit for the issuing fee / initial top-up.
@@ -3215,6 +3237,12 @@ export interface paths {
3215
3237
  * - Missing program_id
3216
3238
  * - Missing required fields based on program type
3217
3239
  * - Unsupported program type
3240
+ * - `INITIAL_TOPUP_BELOW_OPENING_LOAD` — `initial_topup` less the issuing fee is below the
3241
+ * program's mandatory opening balance; the message names the total accepted at the current rate
3242
+ * - `OPENING_LOAD_NOT_PAID` — the program's cards open holding a mandatory balance and
3243
+ * this issuance charges nothing for it (issuance not billed here, or no issuance tariff
3244
+ * for the wallet on the program), or the card spends from a sub-account, whose top-up
3245
+ * funds the sub-account rather than the card
3218
3246
  * */
3219
3247
  400: {
3220
3248
  headers: {
@@ -10169,7 +10197,7 @@ export interface paths {
10169
10197
  *
10170
10198
  * Each returned item includes a `tenant_rates` object (`markup_percent`,
10171
10199
  * `markup_fixed`, `mon_min_usd`) and may expose product-facing guardrails
10172
- * such as `min_amount`, `max_amount`, and `first_party_only`.
10200
+ * such as `min_amount`, `max_amount`, `first_party_only` and `documents_required_from_amount`.
10173
10201
  *
10174
10202
  * **Authentication**: Bearer token + x-tenant-id header
10175
10203
  *
@@ -14793,6 +14821,8 @@ export interface components {
14793
14821
  min_amount: number | null;
14794
14822
  /** @description Maximum amount the product should allow */
14795
14823
  max_amount: number | null;
14824
+ /** @description Amount in the send currency from which the order needs supporting documents (`documents`); `0` — always, `null` — never */
14825
+ documents_required_from_amount: number | null;
14796
14826
  order_types_kyc_rails: {
14797
14827
  /** Format: uuid */
14798
14828
  id: string;
@@ -14812,6 +14842,8 @@ export interface components {
14812
14842
  min_amount: number | null;
14813
14843
  max_amount: number | null;
14814
14844
  first_party_only: boolean;
14845
+ /** @description Amount in the send currency from which the order needs supporting documents (`documents`); `0` — always, `null` — never */
14846
+ documents_required_from_amount: number | null;
14815
14847
  tenant_rates: components["schemas"]["OrderTypeTenantRates"];
14816
14848
  };
14817
14849
  ErrorResponse: {
@@ -1555,7 +1555,9 @@ export interface paths {
1555
1555
  /**
1556
1556
  * Create a new card
1557
1557
  * @deprecated
1558
- * @description Creates a new card for the user. Initial topup amount is now determined by user group settings, not by request parameters.
1558
+ * @description Creates a new card for the user. The amount charged is `initial_topup` when sent — with
1559
+ * `is_reverse`, the fee plus what lands `initial_topup` on the card — otherwise the tariff's
1560
+ * default total. Without `is_reverse`, a tariff with no issuing fee charges nothing here.
1559
1561
  * This endpoint is deprecated, please use `POST /api/issuing/cards` or `POST /frontend/issuing/cards` instead.
1560
1562
  *
1561
1563
  * **Cardholder is required**: Every card must be associated with a cardholder.
@@ -1590,6 +1592,28 @@ export interface paths {
1590
1592
  *
1591
1593
  */
1592
1594
  cardholder_id: string;
1595
+ /** @description TOTAL wallet debit at issuance, in the currency of `currency_id`: the issuing fee plus the
1596
+ * amount to land on the card, from which the top-up commission is taken — unless
1597
+ * `is_reverse` is set. Charged only on a group tariff with an issuing fee, unless `is_reverse`
1598
+ * is set.
1599
+ * */
1600
+ initial_topup?: number;
1601
+ /**
1602
+ * @description When `true`, `initial_topup` is the amount to land on the card, in the card's currency,
1603
+ * instead of the total debit: the issuing fee and the top-up commission are charged on top.
1604
+ * The commission is added to the amount, as with a reverse card deposit, so the card gets
1605
+ * exactly `initial_topup`. The top-up debit is the `from_amount` of
1606
+ * `GET /frontend/orders/calc?order_type=TRANSFER_CARD_SUBACCOUNT&is_reverse=true&amount=<initial_topup>`
1607
+ * (from `currency_id` to the card's currency, with `wallet_id`); the issuing fee comes on top
1608
+ * of it.
1609
+ * What the tariff puts on the card at minimum (its minimum total less the issuing fee — 25
1610
+ * on a 50 / 75 tariff) and a program's mandatory opening balance are held against the
1611
+ * amount that lands. Needs `initial_topup` of at least 0.01; a boolean only, refused
1612
+ * with `400` otherwise.
1613
+ *
1614
+ * @default false
1615
+ */
1616
+ is_reverse?: boolean;
1593
1617
  /**
1594
1618
  * Format: uuid
1595
1619
  * @description Currency ID for card fees (required if card has issuing fee or initial topup)
@@ -7373,6 +7397,11 @@ export interface components {
7373
7397
  max_amount?: number | null;
7374
7398
  /** @description Whether payouts for this order type are limited to the wallet owner's own account */
7375
7399
  first_party_only?: boolean;
7400
+ /**
7401
+ * @description Amount in the send currency from which an order of this type needs supporting documents (`documents`); `0` — always, `null` — never
7402
+ * @example 20000
7403
+ */
7404
+ documents_required_from_amount?: number | null;
7376
7405
  /** @description Associated KYC rails for this order type */
7377
7406
  order_types_kyc_rails?: {
7378
7407
  /**
@@ -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
  *
@@ -6727,6 +6727,16 @@ export interface paths {
6727
6727
  };
6728
6728
  };
6729
6729
  };
6730
+ /** @description `OPENING_LOAD_NOT_PAID` — the program's cards open holding a mandatory balance, and an
6731
+ * issuance through this API charges nothing for it (nor can a card spending from a
6732
+ * sub-account), so the card is not issued.
6733
+ * */
6734
+ 400: {
6735
+ headers: {
6736
+ [name: string]: unknown;
6737
+ };
6738
+ content?: never;
6739
+ };
6730
6740
  };
6731
6741
  };
6732
6742
  delete?: never;
@@ -8707,6 +8717,11 @@ export interface components {
8707
8717
  max_amount?: number | null;
8708
8718
  /** @description Whether payouts for this order type are limited to the wallet owner's own account */
8709
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;
8710
8725
  kyc_rails?: {
8711
8726
  /** Format: uuid */
8712
8727
  id?: string;
@@ -2020,6 +2020,81 @@ export interface components {
2020
2020
  readonly fraud_and_security_url?: string | null;
2021
2021
  readonly consumer_protection_url?: string | null;
2022
2022
  };
2023
+ UiBrandingIdentityEntity: {
2024
+ readonly name?: string;
2025
+ /** @description Installed-app label, at most 12 characters. */
2026
+ readonly short_name?: string;
2027
+ readonly seo_title?: string;
2028
+ readonly seo_description?: string;
2029
+ };
2030
+ UiBrandingSupportEntity: {
2031
+ /** @description https support link; absent = fall back to mailto. */
2032
+ readonly url?: string;
2033
+ readonly email?: string;
2034
+ };
2035
+ UiBrandingAssetsEntity: {
2036
+ /** @description Public URL of the image in the tenant-branding bucket; absent = not set. */
2037
+ readonly logo_light?: string;
2038
+ /** @description Public URL of the image in the tenant-branding bucket; absent = not set. */
2039
+ readonly logo_dark?: string;
2040
+ /** @description Public URL of the image in the tenant-branding bucket; absent = not set. */
2041
+ readonly mark_light?: string;
2042
+ /** @description Public URL of the image in the tenant-branding bucket; absent = not set. */
2043
+ readonly mark_dark?: string;
2044
+ /** @description Public URL of the image in the tenant-branding bucket; absent = not set. */
2045
+ readonly header_logo_light?: string;
2046
+ /** @description Public URL of the image in the tenant-branding bucket; absent = not set. */
2047
+ readonly header_logo_dark?: string;
2048
+ /** @description Public URL of the image in the tenant-branding bucket; absent = not set. */
2049
+ readonly loader_logo_light?: string;
2050
+ /** @description Public URL of the image in the tenant-branding bucket; absent = not set. */
2051
+ readonly loader_logo_dark?: string;
2052
+ /** @description Public URL of the image in the tenant-branding bucket; absent = not set. */
2053
+ readonly footer_logo_light?: string;
2054
+ /** @description Public URL of the image in the tenant-branding bucket; absent = not set. */
2055
+ readonly footer_logo_dark?: string;
2056
+ /** @description Public URL of the image in the tenant-branding bucket; absent = not set. */
2057
+ readonly card_logo?: string;
2058
+ /** @description Public URL of the image in the tenant-branding bucket; absent = not set. */
2059
+ readonly card_logo_pale?: string;
2060
+ /** @description Public URL of the image in the tenant-branding bucket; absent = not set. */
2061
+ readonly card_default_design?: string;
2062
+ /** @description Public URL of the image in the tenant-branding bucket; absent = not set. */
2063
+ readonly favicon?: string;
2064
+ /** @description Public URL of the image in the tenant-branding bucket; absent = not set. */
2065
+ readonly apple_touch?: string;
2066
+ /** @description Public URL of the image in the tenant-branding bucket; absent = not set. */
2067
+ readonly pwa_192?: string;
2068
+ /** @description Public URL of the image in the tenant-branding bucket; absent = not set. */
2069
+ readonly pwa_512?: string;
2070
+ /** @description Public URL of the image in the tenant-branding bucket; absent = not set. */
2071
+ readonly pwa_maskable_192?: string;
2072
+ /** @description Public URL of the image in the tenant-branding bucket; absent = not set. */
2073
+ readonly pwa_maskable_512?: string;
2074
+ /** @description Public URL of the image in the tenant-branding bucket; absent = not set. */
2075
+ readonly og_image?: string;
2076
+ /** @description Public URL of the image in the tenant-branding bucket; absent = not set. */
2077
+ readonly pdf_logo?: string;
2078
+ /** @description Public URL of the image in the tenant-branding bucket; absent = not set. */
2079
+ readonly cards_placeholder_light?: string;
2080
+ /** @description Public URL of the image in the tenant-branding bucket; absent = not set. */
2081
+ readonly cards_placeholder_dark?: string;
2082
+ /** @description Public URL of the image in the tenant-branding bucket; absent = not set. */
2083
+ readonly auth_background?: string;
2084
+ /** @description Public URL of the image in the tenant-branding bucket; absent = not set. */
2085
+ readonly sidebar_background_light?: string;
2086
+ /** @description Public URL of the image in the tenant-branding bucket; absent = not set. */
2087
+ readonly sidebar_background_dark?: string;
2088
+ };
2089
+ UiBrandingEntity: {
2090
+ /** @enum {number} */
2091
+ readonly version?: 1;
2092
+ /** @description Key of the design preset committed in every frontend repo; a build with an unknown key fails. */
2093
+ readonly preset?: string;
2094
+ readonly identity?: components["schemas"]["UiBrandingIdentityEntity"];
2095
+ readonly support?: components["schemas"]["UiBrandingSupportEntity"];
2096
+ readonly assets?: components["schemas"]["UiBrandingAssetsEntity"];
2097
+ };
2023
2098
  SupportedLocalesEntity: {
2024
2099
  default: string;
2025
2100
  supported: string[];
@@ -2070,6 +2145,7 @@ export interface components {
2070
2145
  readonly statement_branding?: components["schemas"]["StatementBrandingEntity"] | null;
2071
2146
  readonly mailing_data?: components["schemas"]["MailingDataEntity"] | null;
2072
2147
  readonly app_links?: components["schemas"]["AppLinksEntity"] | null;
2148
+ readonly ui_branding?: components["schemas"]["UiBrandingEntity"] | null;
2073
2149
  /** @enum {string} */
2074
2150
  kyc_data_provider: "persona" | "sumsub";
2075
2151
  readonly supported_locales?: components["schemas"]["SupportedLocalesEntity"] | null;
@@ -395,7 +395,22 @@ export declare namespace API {
395
395
  currency_id?: string;
396
396
  user_data_id: string;
397
397
  }
398
- type StandAloneRequest = CommonRequest;
398
+ /** `POST /issuing/cards/create`. */
399
+ interface StandAloneRequest extends CommonRequest {
400
+ /**
401
+ * TOTAL wallet debit (fee + top-up), in `currency_id` — charged only on a tariff with an
402
+ * issuing fee; on a tariff without one nothing is charged unless `is_reverse` is set. With
403
+ * `is_reverse`, the amount to land on the card instead.
404
+ */
405
+ initial_topup?: number;
406
+ /**
407
+ * `initial_topup` is the amount to land on the card, in the card's currency; the issuing fee
408
+ * and the top-up commission are charged on top, on every tariff. Its cost is the
409
+ * `from_amount` of a reverse `TRANSFER_CARD_SUBACCOUNT` calc for that amount. Needs
410
+ * `initial_topup` of at least 0.01. A backend without base_backend#1710 ignores the flag.
411
+ */
412
+ is_reverse?: boolean;
413
+ }
399
414
  interface SubAccountRequest extends CommonRequest {
400
415
  sub_account_id: string;
401
416
  }
@@ -968,15 +983,6 @@ export declare namespace API {
968
983
  cardholder_id?: string;
969
984
  /** Card assignee (`user_data.uuid`); their linked cardholder is used. */
970
985
  assigned_user_data_uuid?: string;
971
- /**
972
- * TOTAL wallet debit at issuance (fee + card top-up). Accepted only on group
973
- * tariffs that already mandate an initial top-up. Requires `currency_id`.
974
- */
975
- initial_topup?: number;
976
- /** Wallet currency to debit; required whenever the tariff has a fee or a top-up. */
977
- currency_id?: string;
978
- /** Client-generated id stored with the card (idempotency/tracing reference). */
979
- request_id?: string;
980
986
  };
981
987
  type Response = CardsRoot['post']['responses']['201']['content']['application/json'] & {
982
988
  /**
@@ -1937,6 +1943,11 @@ export declare namespace API {
1937
1943
  max_amount: number | null;
1938
1944
  /** Whether payouts for this order type are limited to the wallet owner's own account */
1939
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;
1940
1951
  }
1941
1952
  namespace List {
1942
1953
  type Response = OrderInfo[];
@@ -2270,6 +2281,11 @@ export declare namespace API {
2270
2281
  max_amount: number | null;
2271
2282
  /** Whether payouts for this order type are limited to the wallet owner's own account */
2272
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;
2273
2289
  order_types_kyc_rails: OrderTypeKycRail[];
2274
2290
  }
2275
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.72",
3
+ "version": "1.36.74",
4
4
  "description": "Squarefi BFF API client module",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",