squarefi-bff-api-module 1.26.14 → 1.27.0

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.
@@ -1,20 +1,20 @@
1
- import { APIKeyRole, CardFormFactor, CardTransactionType, CardType, CounterpartyDestinationType, CounterpartyType, CurrencyType, IssuingProgramStatus, OrderStatuses, OrderType, SortingDirection, SubAccountType, WalletTransactionMethod, WalletTransactionRecordType, WalletTransactionStatus, WalletTransactionType } from "../../constants";
2
- import { WalletType } from "../..";
3
- import { components, operations } from "./autogen/apiV2.types";
1
+ import { APIKeyRole, CardFormFactor, CardTransactionType, CardType, CounterpartyDestinationType, CounterpartyType, CurrencyType, IssuingProgramStatus, OrderStatuses, OrderType, SortingDirection, SubAccountType, WalletTransactionMethod, WalletTransactionRecordType, WalletTransactionStatus, WalletTransactionType } from '../../constants';
2
+ import { WalletType } from '../..';
3
+ import { components, operations } from './autogen/apiV2.types';
4
4
  export declare namespace API {
5
5
  namespace Auth {
6
6
  namespace RefreshToken {
7
- type Request = operations["AuthController_refreshToken"]["requestBody"]["content"]["application/json"];
8
- type Response = operations["AuthController_refreshToken"]["responses"]["200"]["content"]["application/json"];
7
+ type Request = operations['AuthController_refreshToken']['requestBody']['content']['application/json'];
8
+ type Response = operations['AuthController_refreshToken']['responses']['200']['content']['application/json'];
9
9
  }
10
10
  namespace Telegram {
11
11
  namespace Signin {
12
- type Request = operations["AuthTelegramController_signIn"]["requestBody"]["content"]["application/json"];
13
- type Response = operations["AuthTelegramController_signIn"]["responses"]["200"]["content"]["application/json"];
12
+ type Request = operations['AuthTelegramController_signIn']['requestBody']['content']['application/json'];
13
+ type Response = operations['AuthTelegramController_signIn']['responses']['200']['content']['application/json'];
14
14
  }
15
15
  namespace Signup {
16
- type Request = operations["AuthTelegramController_signUp"]["requestBody"]["content"]["application/json"];
17
- type Response = operations["AuthTelegramController_signUp"]["responses"]["200"]["content"]["application/json"];
16
+ type Request = operations['AuthTelegramController_signUp']['requestBody']['content']['application/json'];
17
+ type Response = operations['AuthTelegramController_signUp']['responses']['200']['content']['application/json'];
18
18
  }
19
19
  }
20
20
  interface Tokens {
@@ -30,7 +30,7 @@ export declare namespace API {
30
30
  }
31
31
  namespace SignIn {
32
32
  namespace ByType {
33
- type Request = operations["AuthController_signIn"]["requestBody"]["content"]["application/json"];
33
+ type Request = operations['AuthController_signIn']['requestBody']['content']['application/json'];
34
34
  }
35
35
  namespace Omni {
36
36
  namespace Email {
@@ -56,7 +56,7 @@ export declare namespace API {
56
56
  }
57
57
  namespace SignUp {
58
58
  namespace ByType {
59
- type Request = operations["AuthController_signUp"]["requestBody"]["content"]["application/json"];
59
+ type Request = operations['AuthController_signUp']['requestBody']['content']['application/json'];
60
60
  }
61
61
  namespace Password {
62
62
  interface Request {
@@ -77,8 +77,8 @@ export declare namespace API {
77
77
  }
78
78
  namespace BankData {
79
79
  namespace GetBankDataByAccountNumber {
80
- type Request = operations["BankDataController_getBankDataByCode"]["parameters"]["query"];
81
- type Response = operations["BankDataController_getBankDataByCode"]["responses"]["200"]["content"]["application/json"];
80
+ type Request = operations['BankDataController_getBankDataByCode']['parameters']['query'];
81
+ type Response = operations['BankDataController_getBankDataByCode']['responses']['200']['content']['application/json'];
82
82
  }
83
83
  }
84
84
  namespace Cards {
@@ -226,14 +226,14 @@ export declare namespace API {
226
226
  }
227
227
  namespace CardsList {
228
228
  namespace Request {
229
- type CardsListSortingFields = Partial<Pick<IssuingCardListItem, "created_at" | "card_status" | "last4" | "nick_name" | "name_on_card" | "card_id">>;
229
+ type CardsListSortingFields = Partial<Pick<IssuingCardListItem, 'created_at' | 'card_status' | 'last4' | 'nick_name' | 'name_on_card' | 'card_id'>>;
230
230
  type CardsListFilteringFields = Partial<IssuingCardListItem>;
231
231
  type CardsListRequestCommonParams = API.Common.Pagination.Request & API.Common.Sorting.Request<CardsListSortingFields> & API.Common.Filtering.Request<CardsListFilteringFields>;
232
232
  interface ByWalletUuid extends CardsListRequestCommonParams {
233
233
  wallet_uuid: string;
234
234
  }
235
235
  interface BySubaccountAndWalletUuid extends ByWalletUuid {
236
- filter?: Record<"fiat_account", Record<"type", SubAccountType>>;
236
+ filter?: Record<'fiat_account', Record<'type', SubAccountType>>;
237
237
  }
238
238
  type BySubAccountAndWalletId = ByWalletUuid & {
239
239
  fiat_account_id: string;
@@ -419,7 +419,7 @@ export declare namespace API {
419
419
  offset?: number;
420
420
  search?: string;
421
421
  type?: CounterpartyDestinationType | string;
422
- sort_by?: "created_at" | "nickname" | "type";
422
+ sort_by?: 'created_at' | 'nickname' | 'type';
423
423
  sort_order?: SortingDirection;
424
424
  filter?: {
425
425
  type?: CounterpartyDestinationType;
@@ -434,15 +434,13 @@ export declare namespace API {
434
434
  }
435
435
  namespace Detail {
436
436
  type DestinationDetailItemCommonFields = API.Counterparties.Destination.List.DestinationListItemCommonFields;
437
- interface DestinationDetailItemExternalBankingData extends API.Counterparties.Destination.List
438
- .DestinationListItemExternalBankingData {
439
- address: API.Counterparties.Destination.List.DestinationListItemExternalBankingData["address"] & {
437
+ interface DestinationDetailItemExternalBankingData extends API.Counterparties.Destination.List.DestinationListItemExternalBankingData {
438
+ address: API.Counterparties.Destination.List.DestinationListItemExternalBankingData['address'] & {
440
439
  country?: API.Location.Countries.Country;
441
440
  state?: API.Location.States.State;
442
441
  };
443
442
  }
444
- interface DestinationDetailItemExternalCryptoData extends API.Counterparties.Destination.List
445
- .DestinationListItemExternalCryptoData {
443
+ interface DestinationDetailItemExternalCryptoData extends API.Counterparties.Destination.List.DestinationListItemExternalCryptoData {
446
444
  currency: API.Currencies.Currency;
447
445
  }
448
446
  interface DestinationDetailItemWithExternalBankingData extends DestinationDetailItemCommonFields {
@@ -477,7 +475,7 @@ export declare namespace API {
477
475
  type: CounterpartyDestinationType;
478
476
  nickname: string;
479
477
  external_banking_data?: API.Counterparties.Destination.Detail.DestinationDetailItemExternalBankingData;
480
- external_crypto_data?: Pick<API.Counterparties.Destination.Detail.DestinationDetailItemExternalCryptoData, "currency_id" | "address" | "memo">;
478
+ external_crypto_data?: Pick<API.Counterparties.Destination.Detail.DestinationDetailItemExternalCryptoData, 'currency_id' | 'address' | 'memo'>;
481
479
  }
482
480
  type Response = API.Counterparties.Destination.Detail.DestinationDetailItem;
483
481
  }
@@ -510,7 +508,7 @@ export declare namespace API {
510
508
  wallet_id: string;
511
509
  offset?: number;
512
510
  limit?: number;
513
- sort_by?: "created_at" | "nickname" | "type" | "email" | "phone";
511
+ sort_by?: 'created_at' | 'nickname' | 'type' | 'email' | 'phone';
514
512
  sort_order?: SortingDirection;
515
513
  filter?: {
516
514
  type?: CounterpartyDestinationType;
@@ -525,13 +523,13 @@ export declare namespace API {
525
523
  };
526
524
  }
527
525
  namespace Create {
528
- type Request = Omit<Counterparty, "id" | "created_at"> & {
526
+ type Request = Omit<Counterparty, 'id' | 'created_at'> & {
529
527
  wallet_id: string;
530
528
  };
531
529
  type Response = Counterparty;
532
530
  }
533
531
  namespace Update {
534
- type Request = Partial<Omit<Counterparty, "id" | "created_at">> & {
532
+ type Request = Partial<Omit<Counterparty, 'id' | 'created_at'>> & {
535
533
  wallet_id: string;
536
534
  counterparty_account_id: string;
537
535
  };
@@ -556,7 +554,7 @@ export declare namespace API {
556
554
  }
557
555
  export interface CryptoCurrency extends CommonCurrencyFields {
558
556
  is_crypto: true;
559
- meta: CommonCurrencyFields["meta"] & {
557
+ meta: CommonCurrencyFields['meta'] & {
560
558
  chain_id: number;
561
559
  contract: string;
562
560
  chain_name: string;
@@ -564,7 +562,7 @@ export declare namespace API {
564
562
  }
565
563
  export interface FiatCurrency extends CommonCurrencyFields {
566
564
  is_crypto: false;
567
- meta: CommonCurrencyFields["meta"] & {
565
+ meta: CommonCurrencyFields['meta'] & {
568
566
  code: string;
569
567
  iso_code: number;
570
568
  sign: string;
@@ -792,15 +790,15 @@ export declare namespace API {
792
790
  }
793
791
  }
794
792
  namespace Entity {
795
- type Entity = components["schemas"]["KycEntityDto"];
793
+ type Entity = components['schemas']['KycEntityDto'];
796
794
  namespace Get {
797
- type Request = operations["KycEntitiesController_findOne"]["parameters"]["path"];
798
- type Response = operations["KycEntitiesController_findOne"]["responses"]["200"]["content"]["application/json"];
795
+ type Request = operations['KycEntitiesController_findOne']['parameters']['path'];
796
+ type Response = operations['KycEntitiesController_findOne']['responses']['200']['content']['application/json'];
799
797
  }
800
798
  }
801
799
  namespace Forms {
802
800
  namespace FormField {
803
- type FormFieldType = "text" | "email" | "password" | "radio" | "select" | "checkbox" | "textarea" | "number" | "date" | "switch" | "file";
801
+ type FormFieldType = 'text' | 'email' | 'password' | 'radio' | 'select' | 'checkbox' | 'textarea' | 'number' | 'date' | 'switch' | 'file';
804
802
  interface FormFieldValidation {
805
803
  pattern?: string;
806
804
  min?: number;
@@ -828,13 +826,13 @@ export declare namespace API {
828
826
  }
829
827
  }
830
828
  namespace FormGroup {
831
- type FormGroupFieldType = "group" | "field";
829
+ type FormGroupFieldType = 'group' | 'field';
832
830
  interface FormGroupFieldGroup {
833
- type: "group";
831
+ type: 'group';
834
832
  fields: API.KYC.Forms.FormGroup.FormGroup[];
835
833
  }
836
834
  interface FormGroupFieldField {
837
- type: "field";
835
+ type: 'field';
838
836
  field: API.KYC.Forms.FormField.FormField;
839
837
  }
840
838
  interface FormGroup {
@@ -846,33 +844,33 @@ export declare namespace API {
846
844
  }
847
845
  }
848
846
  namespace Rails {
849
- type RailStatus = components["schemas"]["WalletKycRailDto"]["status"];
850
- type WalletRail = components["schemas"]["WalletKycRailDto"];
851
- type WalletRailExtraActions = components["schemas"]["WalletKycRailExtraActionDto"];
852
- type WalletRailTermsAndConditions = components["schemas"]["WalletKycRailTermsAndConditionsDto"];
847
+ type RailStatus = components['schemas']['WalletKycRailDto']['status'];
848
+ type WalletRail = components['schemas']['WalletKycRailDto'];
849
+ type WalletRailExtraActions = components['schemas']['WalletKycRailExtraActionDto'];
850
+ type WalletRailTermsAndConditions = components['schemas']['WalletKycRailTermsAndConditionsDto'];
853
851
  namespace RailInfo {
854
- type RailInfo = components["schemas"]["WalletKycRailTypeDto"];
852
+ type RailInfo = components['schemas']['WalletKycRailTypeDto'];
855
853
  namespace SingleRail {
856
- type Request = operations["WalletKycRailsController_findOne"]["parameters"]["path"];
854
+ type Request = operations['WalletKycRailsController_findOne']['parameters']['path'];
857
855
  type Response = RailInfo;
858
856
  }
859
857
  namespace List {
860
858
  type Request = {
861
859
  wallet_id: string;
862
860
  };
863
- type Response = components["schemas"]["GetWalletKycRailsResponseDto"];
861
+ type Response = components['schemas']['GetWalletKycRailsResponseDto'];
864
862
  }
865
863
  }
866
864
  namespace Submit {
867
865
  namespace Single {
868
- type Request = operations["WalletKycRailsController_findOne"]["parameters"]["path"];
869
- type Response = components["schemas"]["WalletKycRailTypeDto"];
866
+ type Request = operations['WalletKycRailsController_findOne']['parameters']['path'];
867
+ type Response = components['schemas']['WalletKycRailTypeDto'];
870
868
  }
871
869
  }
872
870
  namespace Terms {
873
871
  namespace Confirm {
874
- type Request = operations["WalletKycRailsController_confirmTermsAndConditions"]["parameters"]["path"];
875
- type Response = components["schemas"]["WalletKycRailTypeDto"];
872
+ type Request = operations['WalletKycRailsController_confirmTermsAndConditions']['parameters']['path'];
873
+ type Response = components['schemas']['WalletKycRailTypeDto'];
876
874
  }
877
875
  }
878
876
  }
@@ -914,10 +912,10 @@ export declare namespace API {
914
912
  }
915
913
  }
916
914
  namespace States {
917
- type State = components["schemas"]["StateDto"];
915
+ type State = components['schemas']['StateDto'];
918
916
  namespace List {
919
- type Request = operations["SystemController_states"]["parameters"]["path"];
920
- type Response = operations["SystemController_states"]["responses"]["200"]["content"]["application/json"];
917
+ type Request = operations['SystemController_states']['parameters']['path'];
918
+ type Response = operations['SystemController_states']['responses']['200']['content']['application/json'];
921
919
  }
922
920
  }
923
921
  }
@@ -938,7 +936,7 @@ export declare namespace API {
938
936
  from_uuid: string;
939
937
  to_uuid: string;
940
938
  amount_from: number;
941
- order_type: "EXCHANGE_CRYPTO_INTERNAL";
939
+ order_type: 'EXCHANGE_CRYPTO_INTERNAL';
942
940
  status: OrderStatuses;
943
941
  amount_to: number;
944
942
  info: string;
@@ -969,7 +967,7 @@ export declare namespace API {
969
967
  from_uuid: string;
970
968
  to_uuid: string;
971
969
  amount_from: number;
972
- order_type: "TRANSFER_CARD_PREPAID";
970
+ order_type: 'TRANSFER_CARD_PREPAID';
973
971
  status: OrderStatuses;
974
972
  amount_to: number;
975
973
  info: string;
@@ -1003,7 +1001,7 @@ export declare namespace API {
1003
1001
  to_uuid: string;
1004
1002
  amount_from: number;
1005
1003
  amount_to: number;
1006
- order_type: "HIFI_WIRE_ONRAMP";
1004
+ order_type: 'HIFI_WIRE_ONRAMP';
1007
1005
  status: OrderStatuses;
1008
1006
  created_at: string;
1009
1007
  info: string;
@@ -1036,7 +1034,7 @@ export declare namespace API {
1036
1034
  to_uuid: string;
1037
1035
  amount_from: number;
1038
1036
  amount_to: number;
1039
- order_type: "HIFI_ACH_ONRAMP";
1037
+ order_type: 'HIFI_ACH_ONRAMP';
1040
1038
  status: OrderStatuses;
1041
1039
  created_at: string;
1042
1040
  info: string;
@@ -1069,7 +1067,7 @@ export declare namespace API {
1069
1067
  to_uuid: string;
1070
1068
  amount_from: number;
1071
1069
  amount_to: number;
1072
- order_type: "HIFI_SEPA_ONRAMP";
1070
+ order_type: 'HIFI_SEPA_ONRAMP';
1073
1071
  status: OrderStatuses;
1074
1072
  created_at: string;
1075
1073
  info: string;
@@ -1102,7 +1100,7 @@ export declare namespace API {
1102
1100
  to_uuid: string;
1103
1101
  amount_from: number;
1104
1102
  amount_to: number;
1105
- order_type: "HIFI_WIRE_OFFRAMP";
1103
+ order_type: 'HIFI_WIRE_OFFRAMP';
1106
1104
  status: OrderStatuses;
1107
1105
  created_at: string;
1108
1106
  info: string;
@@ -1135,7 +1133,7 @@ export declare namespace API {
1135
1133
  to_uuid: string;
1136
1134
  amount_from: number;
1137
1135
  amount_to: number;
1138
- order_type: "HIFI_ACH_OFFRAMP";
1136
+ order_type: 'HIFI_ACH_OFFRAMP';
1139
1137
  status: OrderStatuses;
1140
1138
  created_at: string;
1141
1139
  info: string;
@@ -1188,7 +1186,7 @@ export declare namespace API {
1188
1186
  from_uuid: string;
1189
1187
  to_uuid: string;
1190
1188
  amount_from: number;
1191
- order_type: "OMNIBUS_CRYPTO_WITHDRAWAL";
1189
+ order_type: 'OMNIBUS_CRYPTO_WITHDRAWAL';
1192
1190
  status: OrderStatuses;
1193
1191
  amount_to: number;
1194
1192
  info: string;
@@ -1312,7 +1310,7 @@ export declare namespace API {
1312
1310
  network_fee: number;
1313
1311
  transaction_fee: number;
1314
1312
  rate: number;
1315
- direction: "c2f" | "f2c" | "c2c";
1313
+ direction: 'c2f' | 'f2c' | 'c2c';
1316
1314
  }
1317
1315
  export {};
1318
1316
  }
@@ -1325,7 +1323,7 @@ export declare namespace API {
1325
1323
  id: string;
1326
1324
  transaction_type: string;
1327
1325
  description: string | null;
1328
- direction: "deposit" | "withdrawal";
1326
+ direction: 'deposit' | 'withdrawal';
1329
1327
  is_internal: boolean;
1330
1328
  order_types_kyc_rails: OrderTypeKycRail[];
1331
1329
  payment_method: OrderType | string;
@@ -1381,269 +1379,52 @@ export declare namespace API {
1381
1379
  network_fee: number;
1382
1380
  transaction_fee: number;
1383
1381
  rate: number;
1384
- direction: "c2f" | "f2c" | "c2c";
1382
+ direction: 'c2f' | 'f2c' | 'c2c';
1385
1383
  }
1386
1384
  export {};
1387
1385
  }
1388
1386
  namespace Create {
1389
- namespace ByOrderType {
1390
- namespace INTERNAL_TRANSFER {
1391
- interface Request {
1392
- wallet_id: string;
1393
- from_crypto_uuid: string;
1394
- to_wallet_id: string;
1395
- to_wallet_uuid: string;
1396
- amount: number;
1397
- request_id: string;
1398
- is_subtract: boolean;
1399
- is_reverse: boolean;
1400
- }
1401
- type Response = null;
1402
- }
1403
- namespace HIFI_WIRE_ONRAMP {
1404
- interface Request {
1405
- request_id: string;
1406
- counterparty_account_id: string;
1407
- amount: number;
1408
- wallet_id: string;
1409
- from_currency_id: string;
1410
- to_currency_id: string;
1411
- is_subtract: boolean;
1412
- is_reverse: boolean;
1413
- }
1414
- interface Response {
1415
- order_uuid: string;
1416
- wallet_uuid: string;
1417
- from_uuid: string;
1418
- to_uuid: string;
1419
- amount_from: number;
1420
- amount_to: number;
1421
- order_type: "HIFI_WIRE_ONRAMP";
1422
- status: OrderStatuses;
1423
- created_at: string;
1424
- info: string;
1425
- meta: {
1426
- request_id: string;
1427
- counterparty_account_id: string;
1428
- fee: number;
1429
- fee_currency: string;
1430
- billing_amount: number;
1431
- billing_currency: string;
1432
- transaction_amount: number;
1433
- transaction_currency: string;
1434
- order_uuid: string;
1435
- };
1436
- id: string;
1437
- }
1438
- }
1439
- namespace HIFI_ACH_ONRAMP {
1440
- interface Request {
1441
- request_id: string;
1442
- counterparty_account_id: string;
1443
- amount: number;
1444
- wallet_id: string;
1445
- from_currency_id: string;
1446
- to_currency_id: string;
1447
- is_subtract: boolean;
1448
- is_reverse: boolean;
1449
- }
1450
- interface Response {
1451
- order_uuid: string;
1452
- wallet_uuid: string;
1453
- from_uuid: string;
1454
- to_uuid: string;
1455
- amount_from: number;
1456
- amount_to: number;
1457
- order_type: "HIFI_ACH_ONRAMP";
1458
- status: OrderStatuses;
1459
- created_at: string;
1460
- info: string;
1461
- meta: {
1462
- request_id: string;
1463
- counterparty_account_id: string;
1464
- fee: number;
1465
- fee_currency: string;
1466
- billing_amount: number;
1467
- billing_currency: string;
1468
- transaction_amount: number;
1469
- transaction_currency: string;
1470
- order_uuid: string;
1471
- };
1472
- id: string;
1473
- }
1474
- }
1475
- namespace HIFI_SEPA_ONRAMP {
1476
- interface Request {
1387
+ namespace Common {
1388
+ namespace Request {
1389
+ interface BaseOrderParams {
1477
1390
  request_id: string;
1478
- counterparty_account_id: string;
1479
1391
  amount: number;
1480
1392
  wallet_id: string;
1481
1393
  from_currency_id: string;
1482
1394
  to_currency_id: string;
1483
1395
  is_subtract: boolean;
1484
- is_reverse: boolean;
1485
- }
1486
- interface Response {
1487
- order_uuid: string;
1488
- wallet_uuid: string;
1489
- from_uuid: string;
1490
- to_uuid: string;
1491
- amount_from: number;
1492
- amount_to: number;
1493
- order_type: "HIFI_SEPA_ONRAMP";
1494
- status: OrderStatuses;
1495
- created_at: string;
1496
- info: string;
1497
- meta: {
1498
- request_id: string;
1499
- counterparty_account_id: string;
1500
- fee: number;
1501
- fee_currency: string;
1502
- billing_amount: number;
1503
- billing_currency: string;
1504
- transaction_amount: number;
1505
- transaction_currency: string;
1506
- order_uuid: string;
1507
- };
1508
- id: string;
1509
- }
1510
- }
1511
- namespace HIFI_WIRE_OFFRAMP {
1512
- interface Request {
1513
- request_id: string;
1514
- counterparty_account_id: string;
1515
- amount: number;
1516
- wallet_id: string;
1517
- from_currency_id: string;
1518
- to_currency_id: string;
1519
- refference?: string;
1396
+ reference?: string;
1520
1397
  note?: string;
1521
- is_subtract: boolean;
1522
- is_reverse: boolean;
1523
1398
  }
1524
- interface Response {
1525
- order_uuid: string;
1526
- wallet_uuid: string;
1527
- from_uuid: string;
1528
- to_uuid: string;
1529
- amount_from: number;
1530
- amount_to: number;
1531
- order_type: "HIFI_WIRE_OFFRAMP";
1532
- status: OrderStatuses;
1533
- created_at: string;
1534
- info: string;
1535
- meta: {
1536
- request_id: string;
1537
- counterparty_account_id: string;
1538
- fee: number;
1539
- fee_currency: string;
1540
- billing_amount: number;
1541
- billing_currency: string;
1542
- transaction_amount: number;
1543
- transaction_currency: string;
1544
- order_uuid: string;
1545
- };
1546
- id: string;
1399
+ interface OrderWithCounterpartyParams extends BaseOrderParams {
1400
+ counterparty_destination_id: string;
1547
1401
  }
1548
- }
1549
- namespace HIFI_ACH_OFFRAMP {
1550
- interface Request {
1551
- request_id: string;
1552
- counterparty_account_id: string;
1553
- amount: number;
1554
- wallet_id: string;
1555
- from_currency_id: string;
1556
- to_currency_id: string;
1557
- refference?: string;
1402
+ interface CryptoTransferOrderParams extends BaseOrderParams {
1403
+ wallet_account_id: string;
1558
1404
  note?: string;
1559
- is_subtract: boolean;
1560
- is_reverse: boolean;
1561
1405
  }
1562
- interface Response {
1563
- order_uuid: string;
1564
- wallet_uuid: string;
1565
- from_uuid: string;
1566
- to_uuid: string;
1567
- amount_from: number;
1568
- amount_to: number;
1569
- order_type: "HIFI_ACH_OFFRAMP";
1570
- status: OrderStatuses;
1571
- created_at: string;
1572
- info: string;
1573
- meta: {
1574
- request_id: string;
1575
- counterparty_account_id: string;
1576
- fee: number;
1577
- fee_currency: string;
1578
- billing_amount: number;
1579
- billing_currency: string;
1580
- transaction_amount: number;
1581
- transaction_currency: string;
1582
- order_uuid: string;
1583
- };
1584
- id: string;
1406
+ interface OrderWithVirtualAccountParams extends BaseOrderParams {
1407
+ virtual_account_id: string;
1585
1408
  }
1586
- }
1587
- namespace HIFI_SEPA_OFFRAMP {
1588
- interface Request {
1589
- request_id: string;
1590
- counterparty_account_id: string;
1591
- amount: number;
1592
- wallet_id: string;
1593
- from_currency_id: string;
1594
- to_currency_id: string;
1595
- refference?: string;
1596
- note?: string;
1597
- is_subtract: boolean;
1598
- is_reverse: boolean;
1409
+ interface OrderWithSubAccountParams extends BaseOrderParams {
1410
+ sub_account_id: string;
1599
1411
  }
1600
- interface Response {
1412
+ }
1413
+ namespace Response {
1414
+ interface BaseOrderResponse {
1601
1415
  order_uuid: string;
1602
1416
  wallet_uuid: string;
1603
1417
  from_uuid: string;
1604
1418
  to_uuid: string;
1605
1419
  amount_from: number;
1606
1420
  amount_to: number;
1607
- order_type: "HIFI_SEPA_OFFRAMP";
1608
1421
  status: OrderStatuses;
1609
1422
  created_at: string;
1610
1423
  info: string;
1611
- meta: {
1612
- request_id: string;
1613
- counterparty_account_id: string;
1614
- fee: number;
1615
- fee_currency: string;
1616
- billing_amount: number;
1617
- billing_currency: string;
1618
- transaction_amount: number;
1619
- transaction_currency: string;
1620
- order_uuid: string;
1621
- };
1622
1424
  id: string;
1623
1425
  }
1624
- }
1625
- namespace TBD_SWIFT_WITHDRAWAL {
1626
- interface Request {
1627
- request_id: string;
1628
- counterparty_account_id: string;
1629
- amount: number;
1630
- wallet_id: string;
1631
- from_currency_id: string;
1632
- to_currency_id: string;
1633
- is_subtract: boolean;
1634
- is_reverse: boolean;
1635
- }
1636
- interface Response {
1637
- order_uuid: string;
1638
- wallet_uuid: string;
1639
- from_uuid: string;
1640
- to_uuid: string;
1641
- amount_from: number;
1642
- amount_to: number;
1643
- order_type: "HIFI_SEPA_OFFRAMP";
1644
- status: OrderStatuses;
1645
- created_at: string;
1646
- info: string;
1426
+ interface HifiOrderResponse extends BaseOrderResponse {
1427
+ order_type: string;
1647
1428
  meta: {
1648
1429
  request_id: string;
1649
1430
  counterparty_account_id: string;
@@ -1655,32 +1436,9 @@ export declare namespace API {
1655
1436
  transaction_currency: string;
1656
1437
  order_uuid: string;
1657
1438
  };
1658
- id: string;
1659
- }
1660
- }
1661
- namespace OMNIBUS_CRYPTO_TRANSFER {
1662
- interface Request {
1663
- request_id: string;
1664
- counterparty_account_id: string;
1665
- amount: number;
1666
- wallet_id: string;
1667
- wallet_account_id: string;
1668
- from_currency_id: string;
1669
- note?: string;
1670
- is_subtract: boolean;
1671
- is_reverse: boolean;
1672
1439
  }
1673
- interface Response {
1674
- created_at: string;
1675
- order_uuid: string;
1676
- wallet_uuid: string;
1677
- from_uuid: string;
1678
- to_uuid: string;
1679
- amount_from: number;
1680
- order_type: "OMNIBUS_CRYPTO_WITHDRAWAL";
1681
- status: OrderStatuses;
1682
- amount_to: number;
1683
- info: string;
1440
+ interface CryptoTransferResponse extends BaseOrderResponse {
1441
+ order_type: 'OMNIBUS_CRYPTO_WITHDRAWAL';
1684
1442
  meta: {
1685
1443
  fee: number;
1686
1444
  order_uuid: string;
@@ -1694,124 +1452,123 @@ export declare namespace API {
1694
1452
  transaction_currency: string;
1695
1453
  network_fee: number;
1696
1454
  };
1697
- id: string;
1698
- }
1699
- }
1700
- namespace SEGREGATED_CRYPTO_TRANSFER {
1701
- interface Request {
1702
- request_id: string;
1703
- counterparty_account_id: string;
1704
- amount: number;
1705
- wallet_id: string;
1706
- wallet_account_id: string;
1707
- from_currency_id: string;
1708
- note?: string;
1709
- is_subtract: boolean;
1710
- is_reverse: boolean;
1711
1455
  }
1712
- interface Response {
1713
- created_at: string;
1714
- order_uuid: string;
1715
- wallet_uuid: string;
1716
- from_uuid: string;
1717
- to_uuid: string;
1718
- amount_from: number;
1719
- order_type: "OMNIBUS_CRYPTO_WITHDRAWAL";
1720
- status: OrderStatuses;
1721
- amount_to: number;
1722
- info: string;
1456
+ interface RnCardsResponse extends BaseOrderResponse {
1457
+ order_type: 'RN_CARDS_OFFRAMP';
1723
1458
  meta: {
1724
- fee: number;
1725
- order_uuid: string;
1459
+ request_id: string;
1460
+ sub_account_id: string;
1726
1461
  to_address: string;
1462
+ deposit_chain_id: number;
1463
+ fee: number;
1727
1464
  fee_currency: string;
1728
- request_id: string;
1729
- counterparty_account_id: string;
1730
1465
  billing_amount: number;
1731
1466
  billing_currency: string;
1732
1467
  transaction_amount: number;
1733
1468
  transaction_currency: string;
1734
- network_fee: number;
1469
+ order_uuid: string;
1735
1470
  };
1736
- id: string;
1737
1471
  }
1738
- }
1739
- namespace HIFI_CRYPTO_TRANSFER {
1740
- interface Request {
1741
- request_id: string;
1742
- counterparty_account_id: string;
1743
- amount: number;
1744
- wallet_id: string;
1745
- wallet_account_id: string;
1746
- from_currency_id: string;
1747
- note?: string;
1748
- is_subtract: boolean;
1749
- is_reverse: boolean;
1750
- }
1751
- interface Response {
1752
- created_at: string;
1753
- order_uuid: string;
1754
- wallet_uuid: string;
1755
- from_uuid: string;
1756
- to_uuid: string;
1757
- amount_from: number;
1758
- order_type: "OMNIBUS_CRYPTO_WITHDRAWAL";
1759
- status: OrderStatuses;
1760
- amount_to: number;
1761
- info: string;
1472
+ interface L2FResponse extends BaseOrderResponse {
1473
+ order_type: string;
1762
1474
  meta: {
1763
- fee: number;
1764
- order_uuid: string;
1765
- to_address: string;
1766
- fee_currency: string;
1767
1475
  request_id: string;
1768
- counterparty_account_id: string;
1769
- billing_amount: number;
1770
- billing_currency: string;
1771
- transaction_amount: number;
1772
- transaction_currency: string;
1773
- network_fee: number;
1476
+ virtual_account_id: string;
1774
1477
  };
1775
- id: string;
1776
1478
  }
1777
1479
  }
1778
- namespace RN_CARDS_OFFRAMP {
1480
+ }
1481
+ namespace ByOrderType {
1482
+ namespace INTERNAL_TRANSFER {
1779
1483
  interface Request {
1780
- request_id: string;
1781
- sub_account_id: string;
1782
- amount: number;
1783
1484
  wallet_id: string;
1784
- from_currency_id: string;
1785
- to_currency_id: string;
1485
+ from_crypto_uuid: string;
1486
+ to_wallet_id: string;
1487
+ to_wallet_uuid: string;
1488
+ amount: number;
1489
+ request_id: string;
1786
1490
  is_subtract: boolean;
1787
1491
  is_reverse: boolean;
1788
1492
  }
1789
- interface Response {
1790
- order_uuid: string;
1791
- wallet_uuid: string;
1792
- from_uuid: string;
1793
- to_uuid: string;
1794
- amount_from: number;
1795
- amount_to: number;
1796
- order_type: "RN_CARDS_OFFRAMP";
1797
- status: OrderStatuses;
1798
- created_at: string;
1799
- info: string;
1800
- meta: {
1801
- request_id: string;
1802
- sub_account_id: string;
1803
- to_address: string;
1804
- deposit_chain_id: number;
1805
- fee: number;
1806
- fee_currency: string;
1807
- billing_amount: number;
1808
- billing_currency: string;
1809
- transaction_amount: number;
1810
- transaction_currency: string;
1811
- order_uuid: string;
1812
- };
1813
- id: string;
1814
- }
1493
+ type Response = null;
1494
+ }
1495
+ namespace HIFI_WIRE_ONRAMP {
1496
+ type Request = Common.Request.OrderWithCounterpartyParams;
1497
+ type Response = Common.Response.HifiOrderResponse & {
1498
+ order_type: 'HIFI_WIRE_ONRAMP';
1499
+ };
1500
+ }
1501
+ namespace HIFI_ACH_ONRAMP {
1502
+ type Request = Common.Request.OrderWithCounterpartyParams;
1503
+ type Response = Common.Response.HifiOrderResponse & {
1504
+ order_type: 'HIFI_ACH_ONRAMP';
1505
+ };
1506
+ }
1507
+ namespace HIFI_SEPA_ONRAMP {
1508
+ type Request = Common.Request.OrderWithCounterpartyParams;
1509
+ type Response = Common.Response.HifiOrderResponse & {
1510
+ order_type: 'HIFI_SEPA_ONRAMP';
1511
+ };
1512
+ }
1513
+ namespace HIFI_WIRE_OFFRAMP {
1514
+ type Request = Common.Request.OrderWithCounterpartyParams;
1515
+ type Response = Common.Response.HifiOrderResponse & {
1516
+ order_type: 'HIFI_WIRE_OFFRAMP';
1517
+ };
1518
+ }
1519
+ namespace HIFI_ACH_OFFRAMP {
1520
+ type Request = Common.Request.OrderWithCounterpartyParams;
1521
+ type Response = Common.Response.HifiOrderResponse & {
1522
+ order_type: 'HIFI_ACH_OFFRAMP';
1523
+ };
1524
+ }
1525
+ namespace HIFI_SEPA_OFFRAMP {
1526
+ type Request = Common.Request.OrderWithCounterpartyParams;
1527
+ type Response = Common.Response.HifiOrderResponse & {
1528
+ order_type: 'HIFI_SEPA_OFFRAMP';
1529
+ };
1530
+ }
1531
+ namespace TBD_SWIFT_WITHDRAWAL {
1532
+ type Request = Common.Request.OrderWithCounterpartyParams;
1533
+ type Response = Common.Response.HifiOrderResponse & {
1534
+ order_type: 'HIFI_SEPA_OFFRAMP';
1535
+ };
1536
+ }
1537
+ namespace OMNIBUS_CRYPTO_TRANSFER {
1538
+ type Request = Common.Request.OrderWithCounterpartyParams;
1539
+ type Response = Common.Response.CryptoTransferResponse;
1540
+ }
1541
+ namespace SEGREGATED_CRYPTO_TRANSFER {
1542
+ type Request = Common.Request.OrderWithCounterpartyParams;
1543
+ type Response = Common.Response.CryptoTransferResponse;
1544
+ }
1545
+ namespace RN_CARDS_OFFRAMP {
1546
+ type Request = Common.Request.OrderWithSubAccountParams;
1547
+ type Response = Common.Response.RnCardsResponse;
1548
+ }
1549
+ namespace L2F_SEPA_OFFRAMP {
1550
+ type Request = Common.Request.OrderWithVirtualAccountParams & Common.Request.OrderWithCounterpartyParams;
1551
+ type Response = Common.Response.L2FResponse & {
1552
+ order_type: 'L2F_SEPA_OFFRAMP';
1553
+ };
1554
+ }
1555
+ namespace L2F_SWIFT_OFFRAMP {
1556
+ type Request = Common.Request.OrderWithVirtualAccountParams & Common.Request.OrderWithCounterpartyParams;
1557
+ type Response = Common.Response.L2FResponse & {
1558
+ order_type: 'L2F_SWIFT_OFFRAMP';
1559
+ };
1560
+ }
1561
+ namespace L2F_ACH_OFFRAMP {
1562
+ type Request = Common.Request.OrderWithVirtualAccountParams & Common.Request.OrderWithCounterpartyParams;
1563
+ type Response = Common.Response.L2FResponse & {
1564
+ order_type: 'L2F_ACH_OFFRAMP';
1565
+ };
1566
+ }
1567
+ namespace L2F_WIRE_OFFRAMP {
1568
+ type Request = Common.Request.OrderWithVirtualAccountParams & Common.Request.OrderWithCounterpartyParams;
1569
+ type Response = Common.Response.L2FResponse & {
1570
+ order_type: 'L2F_WIRE_OFFRAMP';
1571
+ };
1815
1572
  }
1816
1573
  }
1817
1574
  }
@@ -1820,7 +1577,7 @@ export declare namespace API {
1820
1577
  id: string;
1821
1578
  transaction_type: string;
1822
1579
  description: string | null;
1823
- direction: "deposit" | "withdrawal";
1580
+ direction: 'deposit' | 'withdrawal';
1824
1581
  is_internal: boolean;
1825
1582
  kyc_rails_id: string | null;
1826
1583
  payment_method: OrderType | string;
@@ -1833,21 +1590,21 @@ export declare namespace API {
1833
1590
  }
1834
1591
  namespace Persona {
1835
1592
  namespace Inquiries {
1836
- type InquiryType = operations["PersonaController_initInquiry"]["parameters"]["path"]["type"];
1593
+ type InquiryType = operations['PersonaController_initInquiry']['parameters']['path']['type'];
1837
1594
  namespace Init {
1838
- type Request = operations["PersonaController_initInquiry"]["parameters"]["path"];
1839
- type Response = operations["PersonaController_initInquiry"]["responses"]["200"]["content"]["application/json"];
1595
+ type Request = operations['PersonaController_initInquiry']['parameters']['path'];
1596
+ type Response = operations['PersonaController_initInquiry']['responses']['200']['content']['application/json'];
1840
1597
  }
1841
1598
  namespace Resume {
1842
- type Request = operations["PersonaController_resumeInquiry"]["parameters"]["path"];
1843
- type Response = operations["PersonaController_resumeInquiry"]["responses"]["200"]["content"]["application/json"];
1599
+ type Request = operations['PersonaController_resumeInquiry']['parameters']['path'];
1600
+ type Response = operations['PersonaController_resumeInquiry']['responses']['200']['content']['application/json'];
1844
1601
  }
1845
1602
  }
1846
1603
  }
1847
1604
  namespace TOTP {
1848
1605
  namespace OTPVerification {
1849
- type OTPVerificationChannelType = "EMAIL" | "SMS" | "TOTP" | "APP" | "TG_TEST";
1850
- type OTPVerificationStatus = "PENDING" | "APPROVED" | "DENIED";
1606
+ type OTPVerificationChannelType = 'EMAIL' | 'SMS' | 'TOTP' | 'APP' | 'TG_TEST';
1607
+ type OTPVerificationStatus = 'PENDING' | 'APPROVED' | 'DENIED';
1851
1608
  type OTPVerificationChannelInfo = {
1852
1609
  channel: OTPVerificationChannelType;
1853
1610
  validity: number;
@@ -2052,7 +1809,7 @@ export declare namespace API {
2052
1809
  walletAddress: string;
2053
1810
  }
2054
1811
  namespace DepositInstruction {
2055
- type InstructionType = "ACH" | "FEDWIRE" | "SWIFT";
1812
+ type InstructionType = 'ACH' | 'FEDWIRE' | 'SWIFT';
2056
1813
  interface Address {
2057
1814
  city: string;
2058
1815
  state: string;
@@ -2074,17 +1831,17 @@ export declare namespace API {
2074
1831
  swift_bic?: string;
2075
1832
  }
2076
1833
  interface ACH extends Common {
2077
- instruction_type: "ACH";
1834
+ instruction_type: 'ACH';
2078
1835
  }
2079
1836
  interface FEDWIRE extends Common {
2080
- instruction_type: "FEDWIRE";
1837
+ instruction_type: 'FEDWIRE';
2081
1838
  account_holder_name: string;
2082
1839
  account_routing_number: string;
2083
1840
  institution_address: Address;
2084
1841
  account_holder_address: Address;
2085
1842
  }
2086
1843
  interface SWIFT extends Common {
2087
- instruction_type: "SWIFT";
1844
+ instruction_type: 'SWIFT';
2088
1845
  swift_bic: string;
2089
1846
  institution_address: Address;
2090
1847
  account_holder_address: Address;
@@ -2192,38 +1949,38 @@ export declare namespace API {
2192
1949
  }
2193
1950
  }
2194
1951
  namespace User {
2195
- type User = components["schemas"]["UserEntity"];
1952
+ type User = components['schemas']['UserEntity'];
2196
1953
  namespace Get {
2197
- type Request = operations["UserController_getMe"]["parameters"]["query"];
2198
- type Response = operations["UserController_getMe"]["responses"]["200"]["content"]["application/json"];
1954
+ type Request = operations['UserController_getMe']['parameters']['query'];
1955
+ type Response = operations['UserController_getMe']['responses']['200']['content']['application/json'];
2199
1956
  }
2200
1957
  namespace UpdateUser {
2201
1958
  namespace Phone {
2202
1959
  namespace RequestOTP {
2203
- type Request = operations["AuthenticatedUserController_changePhone"]["requestBody"]["content"]["application/json"];
1960
+ type Request = operations['AuthenticatedUserController_changePhone']['requestBody']['content']['application/json'];
2204
1961
  }
2205
1962
  namespace Confirm {
2206
- type Request = operations["AuthenticatedUserController_changePhoneNumberConfirm"]["requestBody"]["content"]["application/json"];
1963
+ type Request = operations['AuthenticatedUserController_changePhoneNumberConfirm']['requestBody']['content']['application/json'];
2207
1964
  }
2208
1965
  }
2209
1966
  namespace Email {
2210
1967
  namespace RequestOTP {
2211
- type Request = operations["AuthenticatedUserController_changeEmail"]["requestBody"]["content"]["application/json"];
1968
+ type Request = operations['AuthenticatedUserController_changeEmail']['requestBody']['content']['application/json'];
2212
1969
  }
2213
1970
  namespace Confirm {
2214
- type Request = operations["AuthenticatedUserController_changeEmailConfirm"]["requestBody"]["content"]["application/json"];
1971
+ type Request = operations['AuthenticatedUserController_changeEmailConfirm']['requestBody']['content']['application/json'];
2215
1972
  }
2216
1973
  }
2217
1974
  }
2218
1975
  namespace UserData {
2219
- type UserData = components["schemas"]["UserDataEntity"];
1976
+ type UserData = components['schemas']['UserDataEntity'];
2220
1977
  namespace Get {
2221
- type Request = operations["UserController_getMyUserData"]["parameters"]["query"];
2222
- type Response = operations["UserController_getMyUserData"]["responses"]["200"]["content"]["application/json"];
1978
+ type Request = operations['UserController_getMyUserData']['parameters']['query'];
1979
+ type Response = operations['UserController_getMyUserData']['responses']['200']['content']['application/json'];
2223
1980
  }
2224
1981
  namespace Update {
2225
- type Request = operations["UserController_updateMyUserData"]["requestBody"]["content"]["application/json"];
2226
- type Response = operations["UserController_updateMyUserData"]["responses"]["200"]["content"]["application/json"];
1982
+ type Request = operations['UserController_updateMyUserData']['requestBody']['content']['application/json'];
1983
+ type Response = operations['UserController_updateMyUserData']['responses']['200']['content']['application/json'];
2227
1984
  }
2228
1985
  }
2229
1986
  }
@@ -2353,7 +2110,7 @@ export declare namespace API {
2353
2110
  wallet_uuid: string;
2354
2111
  limit: number;
2355
2112
  offset: number;
2356
- filter?: Partial<components["schemas"]["TransactionsFilter"]>;
2113
+ filter?: Partial<components['schemas']['TransactionsFilter']>;
2357
2114
  };
2358
2115
  type Response = {
2359
2116
  total: number;
@@ -2362,7 +2119,7 @@ export declare namespace API {
2362
2119
  namespace ExportCsv {
2363
2120
  type Request = {
2364
2121
  wallet_uuid: string;
2365
- filter?: Partial<components["schemas"]["TransactionsFilter"]>;
2122
+ filter?: Partial<components['schemas']['TransactionsFilter']>;
2366
2123
  };
2367
2124
  type Response = string;
2368
2125
  }