@finverse/sdk-typescript 0.0.63 → 0.0.64

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.
Files changed (3) hide show
  1. package/dist/api.d.ts +1469 -232
  2. package/dist/api.js +1043 -61
  3. package/package.json +5 -5
package/dist/api.d.ts CHANGED
@@ -48,6 +48,12 @@ export interface AccessTokenResponse {
48
48
  * @memberof AccessTokenResponse
49
49
  */
50
50
  refresh_token: string;
51
+ /**
52
+ *
53
+ * @type {string}
54
+ * @memberof AccessTokenResponse
55
+ */
56
+ issued_at: string;
51
57
  }
52
58
  /**
53
59
  *
@@ -85,12 +91,6 @@ export interface Account {
85
91
  * @memberof Account
86
92
  */
87
93
  account_nickname?: string;
88
- /**
89
- *
90
- * @type {string}
91
- * @memberof Account
92
- */
93
- account_type?: string;
94
94
  /**
95
95
  *
96
96
  * @type {string}
@@ -157,6 +157,12 @@ export interface Account {
157
157
  * @memberof Account
158
158
  */
159
159
  is_excluded: boolean;
160
+ /**
161
+ *
162
+ * @type {AccountType}
163
+ * @memberof Account
164
+ */
165
+ account_type?: AccountType;
160
166
  }
161
167
  /**
162
168
  *
@@ -183,6 +189,69 @@ export interface AccountNumber {
183
189
  */
184
190
  raw: string;
185
191
  }
192
+ /**
193
+ *
194
+ * @export
195
+ * @interface AccountType
196
+ */
197
+ export interface AccountType {
198
+ /**
199
+ *
200
+ * @type {string}
201
+ * @memberof AccountType
202
+ */
203
+ type?: AccountTypeTypeEnum;
204
+ /**
205
+ *
206
+ * @type {string}
207
+ * @memberof AccountType
208
+ */
209
+ subtype?: AccountTypeSubtypeEnum;
210
+ }
211
+ export declare const AccountTypeTypeEnum: {
212
+ readonly Deposit: "DEPOSIT";
213
+ readonly Card: "CARD";
214
+ readonly Investment: "INVESTMENT";
215
+ readonly Loan: "LOAN";
216
+ readonly Unknown: "UNKNOWN";
217
+ };
218
+ export declare type AccountTypeTypeEnum = typeof AccountTypeTypeEnum[keyof typeof AccountTypeTypeEnum];
219
+ export declare const AccountTypeSubtypeEnum: {
220
+ readonly Checking: "CHECKING";
221
+ readonly Savings: "SAVINGS";
222
+ readonly TimeDeposit: "TIME_DEPOSIT";
223
+ readonly Other: "OTHER";
224
+ readonly CreditCard: "CREDIT_CARD";
225
+ readonly DebitCard: "DEBIT_CARD";
226
+ readonly Securities: "SECURITIES";
227
+ readonly Funds: "FUNDS";
228
+ readonly Stocks: "STOCKS";
229
+ readonly Bonds: "BONDS";
230
+ readonly Mortgage: "MORTGAGE";
231
+ readonly PersonalLoan: "PERSONAL_LOAN";
232
+ readonly RevolvingLoan: "REVOLVING_LOAN";
233
+ readonly Unknown: "UNKNOWN";
234
+ };
235
+ export declare type AccountTypeSubtypeEnum = typeof AccountTypeSubtypeEnum[keyof typeof AccountTypeSubtypeEnum];
236
+ /**
237
+ *
238
+ * @export
239
+ * @interface ActionRequest
240
+ */
241
+ export interface ActionRequest {
242
+ /**
243
+ *
244
+ * @type {EncryptedPayload}
245
+ * @memberof ActionRequest
246
+ */
247
+ encrypted_credentials: EncryptedPayload;
248
+ /**
249
+ * The action id
250
+ * @type {string}
251
+ * @memberof ActionRequest
252
+ */
253
+ action_id: string;
254
+ }
186
255
  /**
187
256
  *
188
257
  * @export
@@ -244,6 +313,80 @@ export interface AllProductStatus {
244
313
  */
245
314
  income_estimation?: ProductStatus;
246
315
  }
316
+ /**
317
+ *
318
+ * @export
319
+ * @interface ApiLinkRequest
320
+ */
321
+ export interface ApiLinkRequest {
322
+ /**
323
+ *
324
+ * @type {string}
325
+ * @memberof ApiLinkRequest
326
+ */
327
+ institution_id: string;
328
+ /**
329
+ * Identifier for end user
330
+ * @type {string}
331
+ * @memberof ApiLinkRequest
332
+ */
333
+ user_id: string;
334
+ /**
335
+ * this is a mandatory field
336
+ * @type {boolean}
337
+ * @memberof ApiLinkRequest
338
+ */
339
+ consent: boolean | null;
340
+ /**
341
+ * products that are requested
342
+ * @type {Array<string>}
343
+ * @memberof ApiLinkRequest
344
+ */
345
+ products_requested: Array<string>;
346
+ /**
347
+ *
348
+ * @type {boolean}
349
+ * @memberof ApiLinkRequest
350
+ */
351
+ store_credentials: boolean;
352
+ /**
353
+ *
354
+ * @type {EncryptedPayload}
355
+ * @memberof ApiLinkRequest
356
+ */
357
+ encrypted_credentials: EncryptedPayload;
358
+ /**
359
+ *
360
+ * @type {string}
361
+ * @memberof ApiLinkRequest
362
+ */
363
+ payment_instruction_id?: string;
364
+ }
365
+ /**
366
+ *
367
+ * @export
368
+ * @interface ApiRelinkRequest
369
+ */
370
+ export interface ApiRelinkRequest {
371
+ /**
372
+ *
373
+ * @type {boolean}
374
+ * @memberof ApiRelinkRequest
375
+ */
376
+ store_credential?: boolean;
377
+ /**
378
+ *
379
+ * @type {boolean}
380
+ * @memberof ApiRelinkRequest
381
+ */
382
+ consent: boolean;
383
+ /**
384
+ *
385
+ * @type {EncryptedPayload}
386
+ * @memberof ApiRelinkRequest
387
+ */
388
+ encrypted_credentials: EncryptedPayload;
389
+ }
247
390
  /**
248
391
  *
249
392
  * @export
@@ -370,132 +513,132 @@ export interface BadRequestModelError {
370
513
  /**
371
514
  *
372
515
  * @export
373
- * @interface BalanceHistory
516
+ * @interface BadRequestModelV2
374
517
  */
375
- export interface BalanceHistory {
376
- /**
377
- * The date the balance was recorded
378
- * @type {string}
379
- * @memberof BalanceHistory
380
- */
381
- date: string;
518
+ export interface BadRequestModelV2 {
382
519
  /**
383
- * The end of day balance for this account on this specific date
384
- * @type {number}
385
- * @memberof BalanceHistory
386
- */
387
- amount: number;
388
- /**
389
- * The currency the balance
390
- * @type {string}
391
- * @memberof BalanceHistory
520
+ *
521
+ * @type {BadRequestModelV2Error}
522
+ * @memberof BadRequestModelV2
392
523
  */
393
- currency: string;
524
+ error?: BadRequestModelV2Error;
394
525
  }
395
526
  /**
396
527
  *
397
528
  * @export
398
- * @interface CompositeStatementLink
529
+ * @interface BadRequestModelV2Error
399
530
  */
400
- export interface CompositeStatementLink {
531
+ export interface BadRequestModelV2Error {
401
532
  /**
402
- * signedURL to download statement
533
+ * The error type
403
534
  * @type {string}
404
- * @memberof CompositeStatementLink
535
+ * @memberof BadRequestModelV2Error
405
536
  */
406
- url: string;
537
+ type: BadRequestModelV2ErrorTypeEnum;
407
538
  /**
408
- * expiry of the signedURL
539
+ *
409
540
  * @type {string}
410
- * @memberof CompositeStatementLink
541
+ * @memberof BadRequestModelV2Error
411
542
  */
412
- expiry: string;
413
- }
414
- /**
415
- *
416
- * @export
417
- * @interface CreateCustomerRequest
418
- */
419
- export interface CreateCustomerRequest {
543
+ error_code: string;
420
544
  /**
421
- * The email of the customer. This has to be unique.
422
- * @type {string}
423
- * @memberof CreateCustomerRequest
545
+ *
546
+ * @type {number}
547
+ * @memberof BadRequestModelV2Error
424
548
  */
425
- name: string;
549
+ code: number;
426
550
  /**
427
- * The email of the customer. This has to be unique.
551
+ *
428
552
  * @type {string}
429
- * @memberof CreateCustomerRequest
553
+ * @memberof BadRequestModelV2Error
430
554
  */
431
- email: string;
555
+ message: string;
432
556
  /**
433
- * Primary key to identity the customer
557
+ *
434
558
  * @type {string}
435
- * @memberof CreateCustomerRequest
436
- */
437
- customer_app_id: string;
438
- /**
439
- * The redirect callback
440
- * @type {Array<string>}
441
- * @memberof CreateCustomerRequest
559
+ * @memberof BadRequestModelV2Error
442
560
  */
443
- redirect_uris: Array<string>;
561
+ details?: string;
444
562
  /**
445
- * The webhook uris
446
- * @type {Array<string>}
447
- * @memberof CreateCustomerRequest
563
+ * The request_id provided in the request header
564
+ * @type {string}
565
+ * @memberof BadRequestModelV2Error
448
566
  */
449
- webhook_uris?: Array<string>;
567
+ request_id: string;
450
568
  }
569
+ export declare const BadRequestModelV2ErrorTypeEnum: {
570
+ readonly LinkError: "LINK_ERROR";
571
+ readonly ApiError: "API_ERROR";
572
+ };
573
+ export declare type BadRequestModelV2ErrorTypeEnum = typeof BadRequestModelV2ErrorTypeEnum[keyof typeof BadRequestModelV2ErrorTypeEnum];
451
574
  /**
452
575
  *
453
576
  * @export
454
- * @interface CreateCustomerResponse
577
+ * @interface BalanceHistory
455
578
  */
456
- export interface CreateCustomerResponse {
579
+ export interface BalanceHistory {
457
580
  /**
458
- * The email of the customer. This has to be unique.
581
+ * The date the balance was recorded
459
582
  * @type {string}
460
- * @memberof CreateCustomerResponse
583
+ * @memberof BalanceHistory
461
584
  */
462
- name: string;
585
+ date: string;
463
586
  /**
464
- * The email of the customer. This has to be unique.
465
- * @type {string}
466
- * @memberof CreateCustomerResponse
587
+ * The end of day balance for this account on this specific date
588
+ * @type {number}
589
+ * @memberof BalanceHistory
467
590
  */
468
- email: string;
591
+ amount: number;
469
592
  /**
470
- * Primary key to identity the customer
593
+ * The currency the balance
471
594
  * @type {string}
472
- * @memberof CreateCustomerResponse
595
+ * @memberof BalanceHistory
473
596
  */
474
- customer_app_id: string;
597
+ currency: string;
598
+ }
599
+ /**
600
+ *
601
+ * @export
602
+ * @interface CategoryDetails
603
+ */
604
+ export interface CategoryDetails {
475
605
  /**
476
- * The redirect callback
606
+ *
477
607
  * @type {Array<string>}
478
- * @memberof CreateCustomerResponse
608
+ * @memberof CategoryDetails
479
609
  */
480
- redirect_uris: Array<string>;
610
+ categories?: Array<string>;
481
611
  /**
482
612
  *
483
613
  * @type {string}
484
- * @memberof CreateCustomerResponse
614
+ * @memberof CategoryDetails
485
615
  */
486
- client_id: string;
616
+ source?: string;
487
617
  /**
488
618
  *
489
619
  * @type {string}
490
- * @memberof CreateCustomerResponse
620
+ * @memberof CategoryDetails
491
621
  */
492
- client_secret: string;
622
+ source_id?: string;
623
+ }
624
+ /**
625
+ *
626
+ * @export
627
+ * @interface CompositeStatementLink
628
+ */
629
+ export interface CompositeStatementLink {
493
630
  /**
494
- * The webhook uris
495
- * @type {Array<string>}
496
- * @memberof CreateCustomerResponse
631
+ * signedURL to download statement
632
+ * @type {string}
633
+ * @memberof CompositeStatementLink
497
634
  */
498
- webhook_uris?: Array<string>;
635
+ url: string;
636
+ /**
637
+ * expiry of the signedURL
638
+ * @type {string}
639
+ * @memberof CompositeStatementLink
640
+ */
641
+ expiry: string;
499
642
  }
500
643
  /**
501
644
  *
@@ -505,10 +648,10 @@ export interface CreateCustomerResponse {
505
648
  export interface CreateMandateRequest {
506
649
  /**
507
650
  *
508
- * @type {MandateRecipient}
651
+ * @type {MandateRecipientRequest}
509
652
  * @memberof CreateMandateRequest
510
653
  */
511
- recipient: MandateRecipient;
654
+ recipient: MandateRecipientRequest;
512
655
  /**
513
656
  *
514
657
  * @type {CreateMandateSender}
@@ -529,12 +672,58 @@ export interface CreateMandateRequest {
529
672
  */
530
673
  export interface CreateMandateResponse {
531
674
  /**
532
- * Finverse Mandate ID
675
+ * Timestamp in ISO format (YYYY-MM-DDTHH:MM:SS.SSSZ)
533
676
  * @type {string}
534
677
  * @memberof CreateMandateResponse
535
678
  */
536
- mandate_id?: string;
679
+ last_update: string;
680
+ /**
681
+ * Finverse Mandate ID (ULID)
682
+ * @type {string}
683
+ * @memberof CreateMandateResponse
684
+ */
685
+ mandate_id: string;
686
+ /**
687
+ * Mandate status
688
+ * @type {string}
689
+ * @memberof CreateMandateResponse
690
+ */
691
+ mandate_status: CreateMandateResponseMandateStatusEnum;
692
+ /**
693
+ *
694
+ * @type {MandateRecipient}
695
+ * @memberof CreateMandateResponse
696
+ */
697
+ recipient: MandateRecipient;
698
+ /**
699
+ *
700
+ * @type {GetMandateSender}
701
+ * @memberof CreateMandateResponse
702
+ */
703
+ sender: GetMandateSender;
704
+ /**
705
+ *
706
+ * @type {MandateDetails}
707
+ * @memberof CreateMandateResponse
708
+ */
709
+ mandate_details: MandateDetails;
710
+ /**
711
+ *
712
+ * @type {FvErrorModel}
713
+ * @memberof CreateMandateResponse
714
+ */
715
+ error?: FvErrorModel;
537
716
  }
717
+ export declare const CreateMandateResponseMandateStatusEnum: {
718
+ readonly AuthorizationRequired: "AUTHORIZATION_REQUIRED";
719
+ readonly Authorizing: "AUTHORIZING";
720
+ readonly Processing: "PROCESSING";
721
+ readonly Submitted: "SUBMITTED";
722
+ readonly Succeeded: "SUCCEEDED";
723
+ readonly Failed: "FAILED";
724
+ readonly Revoked: "REVOKED";
725
+ };
726
+ export declare type CreateMandateResponseMandateStatusEnum = typeof CreateMandateResponseMandateStatusEnum[keyof typeof CreateMandateResponseMandateStatusEnum];
538
727
  /**
539
728
  *
540
729
  * @export
@@ -580,11 +769,17 @@ export interface CreatePaymentInstructionResponse {
580
769
  */
581
770
  export interface CreatePaymentRequest {
582
771
  /**
583
- * Amount to be paid, in currencys smallest unit or “minor unit”, as defined in ISO 4217. For example, HKD 100.01 is represented as amount = 10001 (minor unit = cents). For currencies without minor units (e.g. VND, JPY), the amount is represented as is, without modification. For example, VND 15101 is represented as amount = 15101.
772
+ * Amount to be paid, in currency\'s smallest unit or “minor unit”, as defined in ISO 4217. For example, HKD 100.01 is represented as amount = 10001 (minor unit = cents). For currencies without minor units (e.g. VND, JPY), the amount is represented as is, without modification. For example, VND 15101 is represented as amount = 15101.
584
773
  * @type {number}
585
774
  * @memberof CreatePaymentRequest
586
775
  */
587
776
  amount: number;
777
+ /**
778
+ * The currency code as defined in ISO 4217.
779
+ * @type {string}
780
+ * @memberof CreatePaymentRequest
781
+ */
782
+ currency: string;
588
783
  /**
589
784
  * Indicates whether this is a mandate-based payment or one-off direct payment to an account. Possible values - MANDATE, SINGLE
590
785
  * @type {string}
@@ -603,19 +798,6 @@ export declare const CreatePaymentRequestTypeEnum: {
603
798
  readonly Single: "SINGLE";
604
799
  };
605
800
  export declare type CreatePaymentRequestTypeEnum = typeof CreatePaymentRequestTypeEnum[keyof typeof CreatePaymentRequestTypeEnum];
606
- /**
607
- *
608
- * @export
609
- * @interface CreatePaymentResponse
610
- */
611
- export interface CreatePaymentResponse {
612
- /**
613
- * Finverse Payment ID
614
- * @type {string}
615
- * @memberof CreatePaymentResponse
616
- */
617
- payment_id?: string;
618
- }
619
801
  /**
620
802
  *
621
803
  * @export
@@ -727,34 +909,65 @@ export declare type CustomerPaymentInstructionTypeEnum = typeof CustomerPaymentI
727
909
  /**
728
910
  *
729
911
  * @export
730
- * @interface CustomizationDetails
912
+ * @interface DeleteLoginIdentityResponse
913
+ */
914
+ export interface DeleteLoginIdentityResponse {
915
+ /**
916
+ *
917
+ * @type {boolean}
918
+ * @memberof DeleteLoginIdentityResponse
919
+ */
920
+ success?: boolean;
921
+ }
922
+ /**
923
+ *
924
+ * @export
925
+ * @interface EncryptedPayload
731
926
  */
732
- export interface CustomizationDetails {
927
+ export interface EncryptedPayload {
928
+ /**
929
+ * The credential payload encrypted with AES (base64)
930
+ * @type {string}
931
+ * @memberof EncryptedPayload
932
+ */
933
+ ciphertext: string;
934
+ /**
935
+ * The 16 byte IV used w/ AES (base64)
936
+ * @type {string}
937
+ * @memberof EncryptedPayload
938
+ */
939
+ initializationVector: string;
940
+ /**
941
+ * The MAC to verify AES decryption validity
942
+ * @type {string}
943
+ * @memberof EncryptedPayload
944
+ */
945
+ messageAuthenticationCode: string;
733
946
  /**
734
- *
947
+ * The AES key encrypted with an RSA pubkey (base64)
735
948
  * @type {string}
736
- * @memberof CustomizationDetails
949
+ * @memberof EncryptedPayload
737
950
  */
738
- logo_id?: string;
951
+ envelopeEncryptionKey: string;
739
952
  /**
740
- *
953
+ * The identifier of the public key used to encrypt the AES key
741
954
  * @type {string}
742
- * @memberof CustomizationDetails
955
+ * @memberof EncryptedPayload
743
956
  */
744
- display_name?: string;
957
+ keyId: string;
745
958
  }
746
959
  /**
747
960
  *
748
961
  * @export
749
- * @interface DeleteLoginIdentityResponse
962
+ * @interface ErrBodyModel
750
963
  */
751
- export interface DeleteLoginIdentityResponse {
964
+ export interface ErrBodyModel {
752
965
  /**
753
966
  *
754
- * @type {boolean}
755
- * @memberof DeleteLoginIdentityResponse
967
+ * @type {FvErrorModel}
968
+ * @memberof ErrBodyModel
756
969
  */
757
- success?: boolean;
970
+ error?: FvErrorModel;
758
971
  }
759
972
  /**
760
973
  *
@@ -805,6 +1018,54 @@ export interface ErrorResponse {
805
1018
  */
806
1019
  request_id?: string;
807
1020
  }
1021
+ /**
1022
+ *
1023
+ * @export
1024
+ * @interface FvErrorModel
1025
+ */
1026
+ export interface FvErrorModel {
1027
+ /**
1028
+ * The error type
1029
+ * @type {string}
1030
+ * @memberof FvErrorModel
1031
+ */
1032
+ type: FvErrorModelTypeEnum;
1033
+ /**
1034
+ *
1035
+ * @type {string}
1036
+ * @memberof FvErrorModel
1037
+ */
1038
+ error_code: string;
1039
+ /**
1040
+ *
1041
+ * @type {string}
1042
+ * @memberof FvErrorModel
1043
+ */
1044
+ code: string;
1045
+ /**
1046
+ *
1047
+ * @type {string}
1048
+ * @memberof FvErrorModel
1049
+ */
1050
+ message: string;
1051
+ /**
1052
+ *
1053
+ * @type {string}
1054
+ * @memberof FvErrorModel
1055
+ */
1056
+ details: string;
1057
+ /**
1058
+ * The request_id provided in the request header
1059
+ * @type {string}
1060
+ * @memberof FvErrorModel
1061
+ */
1062
+ request_id: string;
1063
+ }
1064
+ export declare const FvErrorModelTypeEnum: {
1065
+ readonly LinkError: "LINK_ERROR";
1066
+ readonly ApiError: "API_ERROR";
1067
+ };
1068
+ export declare type FvErrorModelTypeEnum = typeof FvErrorModelTypeEnum[keyof typeof FvErrorModelTypeEnum];
808
1069
  /**
809
1070
  *
810
1071
  * @export
@@ -897,7 +1158,18 @@ export interface GetBalanceHistoryResponse {
897
1158
  * @memberof GetBalanceHistoryResponse
898
1159
  */
899
1160
  balance_history?: Array<BalanceHistory>;
1161
+ /**
1162
+ *
1163
+ * @type {string}
1164
+ * @memberof GetBalanceHistoryResponse
1165
+ */
1166
+ source?: GetBalanceHistoryResponseSourceEnum;
900
1167
  }
1168
+ export declare const GetBalanceHistoryResponseSourceEnum: {
1169
+ readonly Institution: "INSTITUTION";
1170
+ readonly Computed: "COMPUTED";
1171
+ };
1172
+ export declare type GetBalanceHistoryResponseSourceEnum = typeof GetBalanceHistoryResponseSourceEnum[keyof typeof GetBalanceHistoryResponseSourceEnum];
901
1173
  /**
902
1174
  *
903
1175
  * @export
@@ -1063,7 +1335,7 @@ export interface GetMandateAuthResponse {
1063
1335
  * @type {string}
1064
1336
  * @memberof GetMandateAuthResponse
1065
1337
  */
1066
- sender_type: GetMandateAuthResponseSenderTypeEnum;
1338
+ sender_type?: GetMandateAuthResponseSenderTypeEnum;
1067
1339
  /**
1068
1340
  * Checklist of the authorization factors needed to complete Mandate authorization
1069
1341
  * @type {Array<AuthChecklistFactor>}
@@ -1082,6 +1354,12 @@ export interface GetMandateAuthResponse {
1082
1354
  * @memberof GetMandateAuthResponse
1083
1355
  */
1084
1356
  last_update: string;
1357
+ /**
1358
+ *
1359
+ * @type {FvErrorModel}
1360
+ * @memberof GetMandateAuthResponse
1361
+ */
1362
+ error?: FvErrorModel;
1085
1363
  }
1086
1364
  export declare const GetMandateAuthResponseMandateStatusEnum: {
1087
1365
  readonly Created: "CREATED";
@@ -1137,12 +1415,21 @@ export interface GetMandateResponse {
1137
1415
  * @memberof GetMandateResponse
1138
1416
  */
1139
1417
  mandate_details: MandateDetails;
1418
+ /**
1419
+ *
1420
+ * @type {FvErrorModel}
1421
+ * @memberof GetMandateResponse
1422
+ */
1423
+ error?: FvErrorModel;
1140
1424
  }
1141
1425
  export declare const GetMandateResponseMandateStatusEnum: {
1142
- readonly Created: "CREATED";
1426
+ readonly AuthorizationRequired: "AUTHORIZATION_REQUIRED";
1427
+ readonly Authorizing: "AUTHORIZING";
1143
1428
  readonly Processing: "PROCESSING";
1144
1429
  readonly Submitted: "SUBMITTED";
1145
- readonly Error: "ERROR";
1430
+ readonly Succeeded: "SUCCEEDED";
1431
+ readonly Failed: "FAILED";
1432
+ readonly Revoked: "REVOKED";
1146
1433
  };
1147
1434
  export declare type GetMandateResponseMandateStatusEnum = typeof GetMandateResponseMandateStatusEnum[keyof typeof GetMandateResponseMandateStatusEnum];
1148
1435
  /**
@@ -1189,64 +1476,6 @@ export interface GetPaymentInstructionsResponse {
1189
1476
  */
1190
1477
  payment_instruction?: PaymentInstruction;
1191
1478
  }
1192
- /**
1193
- *
1194
- * @export
1195
- * @interface GetPaymentResponse
1196
- */
1197
- export interface GetPaymentResponse {
1198
- /**
1199
- * Finverse Payment ID
1200
- * @type {string}
1201
- * @memberof GetPaymentResponse
1202
- */
1203
- payment_id?: string;
1204
- /**
1205
- * Amount to be paid, in currency’s smallest unit or “minor unit”, as defined in ISO 4217. For example, HKD 100.01 is represented as amount = 10001 (minor unit = cents). For currencies without minor units (e.g. VND, JPY), the amount is represented as is, without modification. For example, VND 15101 is represented as amount = 15101.
1206
- * @type {number}
1207
- * @memberof GetPaymentResponse
1208
- */
1209
- amount?: number;
1210
- /**
1211
- * Indicates whether this is a mandate-based payment or one-off direct payment to an account. Possible values - MANDATE, SINGLE
1212
- * @type {string}
1213
- * @memberof GetPaymentResponse
1214
- */
1215
- type?: GetPaymentResponseTypeEnum;
1216
- /**
1217
- * Timestamp in ISO format (YYYY-MM-DDTHH:MM:SS.SSSZ)
1218
- * @type {string}
1219
- * @memberof GetPaymentResponse
1220
- */
1221
- last_update?: string;
1222
- /**
1223
- * Possible values - CREATED, AUTHORIZED, SUBMITTED, EXECUTED, FAILED, REJECTED, CANCELLED.
1224
- * @type {string}
1225
- * @memberof GetPaymentResponse
1226
- */
1227
- status?: GetPaymentResponseStatusEnum;
1228
- /**
1229
- *
1230
- * @type {PaymentDetails2}
1231
- * @memberof GetPaymentResponse
1232
- */
1233
- payment_details?: PaymentDetails2;
1234
- }
1235
- export declare const GetPaymentResponseTypeEnum: {
1236
- readonly Mandate: "MANDATE";
1237
- readonly Single: "SINGLE";
1238
- };
1239
- export declare type GetPaymentResponseTypeEnum = typeof GetPaymentResponseTypeEnum[keyof typeof GetPaymentResponseTypeEnum];
1240
- export declare const GetPaymentResponseStatusEnum: {
1241
- readonly Created: "CREATED";
1242
- readonly Authorized: "AUTHORIZED";
1243
- readonly Submitted: "SUBMITTED";
1244
- readonly Executed: "EXECUTED";
1245
- readonly Failed: "FAILED";
1246
- readonly Rejected: "REJECTED";
1247
- readonly Cancelled: "CANCELLED";
1248
- };
1249
- export declare type GetPaymentResponseStatusEnum = typeof GetPaymentResponseStatusEnum[keyof typeof GetPaymentResponseStatusEnum];
1250
1479
  /**
1251
1480
  *
1252
1481
  * @export
@@ -1777,10 +2006,10 @@ export interface Institution {
1777
2006
  portal_name?: string;
1778
2007
  /**
1779
2008
  *
1780
- * @type {string}
2009
+ * @type {Array<string>}
1781
2010
  * @memberof Institution
1782
2011
  */
1783
- user_type: InstitutionUserTypeEnum;
2012
+ user_type: Array<InstitutionUserTypeEnum>;
1784
2013
  /**
1785
2014
  *
1786
2015
  * @type {string}
@@ -1804,13 +2033,19 @@ export interface Institution {
1804
2033
  * @type {object}
1805
2034
  * @memberof Institution
1806
2035
  */
1807
- login_details?: object;
2036
+ login_details: object;
1808
2037
  /**
1809
2038
  *
1810
2039
  * @type {Array<LoginMethod>}
1811
2040
  * @memberof Institution
1812
2041
  */
1813
2042
  login_methods?: Array<LoginMethod>;
2043
+ /**
2044
+ *
2045
+ * @type {PaymentInfo}
2046
+ * @memberof Institution
2047
+ */
2048
+ payment_info?: PaymentInfo;
1814
2049
  /**
1815
2050
  *
1816
2051
  * @type {string}
@@ -1823,6 +2058,12 @@ export interface Institution {
1823
2058
  * @memberof Institution
1824
2059
  */
1825
2060
  updated_at?: string;
2061
+ /**
2062
+ *
2063
+ * @type {Array<LoginAction>}
2064
+ * @memberof Institution
2065
+ */
2066
+ login_actions?: Array<LoginAction>;
1826
2067
  }
1827
2068
  export declare const InstitutionTagsEnum: {
1828
2069
  readonly Real: "real";
@@ -1845,6 +2086,7 @@ export declare const InstitutionProductsSupportedEnum: {
1845
2086
  export declare type InstitutionProductsSupportedEnum = typeof InstitutionProductsSupportedEnum[keyof typeof InstitutionProductsSupportedEnum];
1846
2087
  export declare const InstitutionUserTypeEnum: {
1847
2088
  readonly Personal: "PERSONAL";
2089
+ readonly Individual: "INDIVIDUAL";
1848
2090
  readonly Business: "BUSINESS";
1849
2091
  };
1850
2092
  export declare type InstitutionUserTypeEnum = typeof InstitutionUserTypeEnum[keyof typeof InstitutionUserTypeEnum];
@@ -1978,6 +2220,99 @@ export interface LinkResponse {
1978
2220
  */
1979
2221
  auth_url?: string;
1980
2222
  }
2223
+ /**
2224
+ *
2225
+ * @export
2226
+ * @interface LinkStatusActionModel
2227
+ */
2228
+ export interface LinkStatusActionModel {
2229
+ /**
2230
+ * Unique identifier
2231
+ * @type {string}
2232
+ * @memberof LinkStatusActionModel
2233
+ */
2234
+ action_id: string;
2235
+ /**
2236
+ * The type of user screen the UI is to render
2237
+ * @type {string}
2238
+ * @memberof LinkStatusActionModel
2239
+ */
2240
+ type: string;
2241
+ /**
2242
+ * The name of the user screen the UI is to render
2243
+ * @type {string}
2244
+ * @memberof LinkStatusActionModel
2245
+ */
2246
+ name: string;
2247
+ /**
2248
+ *
2249
+ * @type {Array<UserMessage>}
2250
+ * @memberof LinkStatusActionModel
2251
+ */
2252
+ messages: Array<UserMessage>;
2253
+ /**
2254
+ *
2255
+ * @type {Array<UserField>}
2256
+ * @memberof LinkStatusActionModel
2257
+ */
2258
+ fields: Array<UserField>;
2259
+ /**
2260
+ *
2261
+ * @type {Array<UserButton>}
2262
+ * @memberof LinkStatusActionModel
2263
+ */
2264
+ buttons?: Array<UserButton>;
2265
+ }
2266
+ /**
2267
+ *
2268
+ * @export
2269
+ * @interface LinkStatusPendingModel
2270
+ */
2271
+ export interface LinkStatusPendingModel {
2272
+ /**
2273
+ *
2274
+ * @type {string}
2275
+ * @memberof LinkStatusPendingModel
2276
+ */
2277
+ code?: string;
2278
+ /**
2279
+ *
2280
+ * @type {string}
2281
+ * @memberof LinkStatusPendingModel
2282
+ */
2283
+ message?: string;
2284
+ /**
2285
+ *
2286
+ * @type {string}
2287
+ * @memberof LinkStatusPendingModel
2288
+ */
2289
+ details?: string;
2290
+ }
2291
+ /**
2292
+ *
2293
+ * @export
2294
+ * @interface LinkStatusResponse
2295
+ */
2296
+ export interface LinkStatusResponse {
2297
+ /**
2298
+ *
2299
+ * @type {AccessTokenResponse}
2300
+ * @memberof LinkStatusResponse
2301
+ */
2302
+ success?: AccessTokenResponse;
2303
+ /**
2304
+ *
2305
+ * @type {LinkStatusPendingModel}
2306
+ * @memberof LinkStatusResponse
2307
+ */
2308
+ pending?: LinkStatusPendingModel;
2309
+ /**
2310
+ *
2311
+ * @type {LinkStatusActionModel}
2312
+ * @memberof LinkStatusResponse
2313
+ */
2314
+ action?: LinkStatusActionModel;
2315
+ }
1981
2316
  /**
1982
2317
  *
1983
2318
  * @export
@@ -2160,6 +2495,12 @@ export interface LinkTokenResponse {
2160
2495
  * @memberof LinkTokenResponse
2161
2496
  */
2162
2497
  expires_in: number;
2498
+ /**
2499
+ *
2500
+ * @type {string}
2501
+ * @memberof LinkTokenResponse
2502
+ */
2503
+ issued_at: string;
2163
2504
  /**
2164
2505
  *
2165
2506
  * @type {string}
@@ -2229,6 +2570,43 @@ export interface ListTransactionsResponse {
2229
2570
  */
2230
2571
  total_transactions: number;
2231
2572
  }
2573
+ /**
2574
+ *
2575
+ * @export
2576
+ * @interface LoginAction
2577
+ */
2578
+ export interface LoginAction {
2579
+ /**
2580
+ *
2581
+ * @type {string}
2582
+ * @memberof LoginAction
2583
+ */
2584
+ type?: string;
2585
+ /**
2586
+ *
2587
+ * @type {string}
2588
+ * @memberof LoginAction
2589
+ */
2590
+ name?: string;
2591
+ /**
2592
+ *
2593
+ * @type {Array<UserMessage>}
2594
+ * @memberof LoginAction
2595
+ */
2596
+ messages?: Array<UserMessage>;
2597
+ /**
2598
+ *
2599
+ * @type {Array<UserField>}
2600
+ * @memberof LoginAction
2601
+ */
2602
+ fields?: Array<UserField>;
2603
+ /**
2604
+ *
2605
+ * @type {Array<UserButton>}
2606
+ * @memberof LoginAction
2607
+ */
2608
+ buttons?: Array<UserButton>;
2609
+ }
2232
2610
  /**
2233
2611
  *
2234
2612
  * @export
@@ -2530,6 +2908,18 @@ export interface LoginMethod {
2530
2908
  * @memberof LoginMethod
2531
2909
  */
2532
2910
  name?: string;
2911
+ /**
2912
+ *
2913
+ * @type {boolean}
2914
+ * @memberof LoginMethod
2915
+ */
2916
+ is_default_method?: boolean | null;
2917
+ /**
2918
+ *
2919
+ * @type {string}
2920
+ * @memberof LoginMethod
2921
+ */
2922
+ status?: LoginMethodStatusEnum;
2533
2923
  /**
2534
2924
  *
2535
2925
  * @type {Array<LoginField>}
@@ -2537,6 +2927,12 @@ export interface LoginMethod {
2537
2927
  */
2538
2928
  login_fields?: Array<LoginField>;
2539
2929
  }
2930
+ export declare const LoginMethodStatusEnum: {
2931
+ readonly Supported: "SUPPORTED";
2932
+ readonly Alpha: "ALPHA";
2933
+ readonly Beta: "BETA";
2934
+ };
2935
+ export declare type LoginMethodStatusEnum = typeof LoginMethodStatusEnum[keyof typeof LoginMethodStatusEnum];
2540
2936
  /**
2541
2937
  *
2542
2938
  * @export
@@ -2635,13 +3031,13 @@ export interface MandateDetails {
2635
3031
  * @type {string}
2636
3032
  * @memberof MandateDetails
2637
3033
  */
2638
- start_date?: string;
3034
+ start_date?: string | null;
2639
3035
  /**
2640
3036
  * YYYY-MM-DD, must be later than the date of creation.
2641
3037
  * @type {string}
2642
3038
  * @memberof MandateDetails
2643
3039
  */
2644
- end_date?: string;
3040
+ end_date?: string | null;
2645
3041
  /**
2646
3042
  *
2647
3043
  * @type {PaymentSchedule}
@@ -2660,13 +3056,30 @@ export interface MandateDetails {
2660
3056
  * @memberof MandateDetails
2661
3057
  */
2662
3058
  description?: string;
3059
+ /**
3060
+ * Type of account held by the Sender at the Institution. Possible values are INDIVIDUAL, BUSINESS
3061
+ * @type {string}
3062
+ * @memberof MandateDetails
3063
+ */
3064
+ sender_type: MandateDetailsSenderTypeEnum;
2663
3065
  }
3066
+ export declare const MandateDetailsSenderTypeEnum: {
3067
+ readonly Individual: "INDIVIDUAL";
3068
+ readonly Business: "BUSINESS";
3069
+ };
3070
+ export declare type MandateDetailsSenderTypeEnum = typeof MandateDetailsSenderTypeEnum[keyof typeof MandateDetailsSenderTypeEnum];
2664
3071
  /**
2665
3072
  *
2666
3073
  * @export
2667
3074
  * @interface MandateRecipient
2668
3075
  */
2669
3076
  export interface MandateRecipient {
3077
+ /**
3078
+ * Merchant account name
3079
+ * @type {string}
3080
+ * @memberof MandateRecipient
3081
+ */
3082
+ name: string;
2670
3083
  /**
2671
3084
  * Merchant account ID assigned by Finverse
2672
3085
  * @type {string}
@@ -2674,6 +3087,19 @@ export interface MandateRecipient {
2674
3087
  */
2675
3088
  recipient_account_id: string;
2676
3089
  }
3090
+ /**
3091
+ *
3092
+ * @export
3093
+ * @interface MandateRecipientRequest
3094
+ */
3095
+ export interface MandateRecipientRequest {
3096
+ /**
3097
+ * Merchant account ID assigned by Finverse
3098
+ * @type {string}
3099
+ * @memberof MandateRecipientRequest
3100
+ */
3101
+ recipient_account_id: string;
3102
+ }
2677
3103
  /**
2678
3104
  *
2679
3105
  * @export
@@ -2699,6 +3125,25 @@ export interface MonthlyIncomeEstimate {
2699
3125
  */
2700
3126
  year: number;
2701
3127
  }
3128
+ /**
3129
+ *
3130
+ * @export
3131
+ * @interface NonSensitiveLinkStatusResponse
3132
+ */
3133
+ export interface NonSensitiveLinkStatusResponse {
3134
+ /**
3135
+ *
3136
+ * @type {LinkStatusActionModel}
3137
+ * @memberof NonSensitiveLinkStatusResponse
3138
+ */
3139
+ action?: LinkStatusActionModel;
3140
+ /**
3141
+ *
3142
+ * @type {string}
3143
+ * @memberof NonSensitiveLinkStatusResponse
3144
+ */
3145
+ redirect_uri?: string;
3146
+ }
2702
3147
  /**
2703
3148
  *
2704
3149
  * @export
@@ -2799,6 +3244,25 @@ export interface PaymentDetails2 {
2799
3244
  */
2800
3245
  transaction_reference_id?: string;
2801
3246
  }
3247
+ /**
3248
+ *
3249
+ * @export
3250
+ * @interface PaymentInfo
3251
+ */
3252
+ export interface PaymentInfo {
3253
+ /**
3254
+ *
3255
+ * @type {Array<string>}
3256
+ * @memberof PaymentInfo
3257
+ */
3258
+ currencies_supported?: Array<string>;
3259
+ /**
3260
+ *
3261
+ * @type {OtherInfo}
3262
+ * @memberof PaymentInfo
3263
+ */
3264
+ other_info?: OtherInfo;
3265
+ }
2802
3266
  /**
2803
3267
  *
2804
3268
  * @export
@@ -2924,6 +3388,88 @@ export declare const PaymentInstructionTypeEnum: {
2924
3388
  readonly DebitAuthorization: "DEBIT_AUTHORIZATION";
2925
3389
  };
2926
3390
  export declare type PaymentInstructionTypeEnum = typeof PaymentInstructionTypeEnum[keyof typeof PaymentInstructionTypeEnum];
3391
+ /**
3392
+ *
3393
+ * @export
3394
+ * @interface PaymentResponse
3395
+ */
3396
+ export interface PaymentResponse {
3397
+ /**
3398
+ * Finverse Payment ID
3399
+ * @type {string}
3400
+ * @memberof PaymentResponse
3401
+ */
3402
+ payment_id?: string;
3403
+ /**
3404
+ * Amount to be paid, in currency\'s smallest unit or “minor unit”, as defined in ISO 4217. For example, HKD 100.01 is represented as amount = 10001 (minor unit = cents). For currencies without minor units (e.g. VND, JPY), the amount is represented as is, without modification. For example, VND 15101 is represented as amount = 15101.
3405
+ * @type {number}
3406
+ * @memberof PaymentResponse
3407
+ */
3408
+ amount?: number;
3409
+ /**
3410
+ * The currency code as defined in ISO 4217.
3411
+ * @type {string}
3412
+ * @memberof PaymentResponse
3413
+ */
3414
+ currency?: string;
3415
+ /**
3416
+ * Indicates whether this is a mandate-based payment or one-off direct payment to an account. Possible values - MANDATE, SINGLE
3417
+ * @type {string}
3418
+ * @memberof PaymentResponse
3419
+ */
3420
+ type?: PaymentResponseTypeEnum;
3421
+ /**
3422
+ * Timestamp in ISO format (YYYY-MM-DDTHH:MM:SS.SSSZ)
3423
+ * @type {string}
3424
+ * @memberof PaymentResponse
3425
+ */
3426
+ last_update?: string;
3427
+ /**
3428
+ * Possible values - CREATED, AUTHORIZED, SUBMITTED, EXECUTED, FAILED, REJECTED, CANCELLED.
3429
+ * @type {string}
3430
+ * @memberof PaymentResponse
3431
+ */
3432
+ status?: PaymentResponseStatusEnum;
3433
+ /**
3434
+ *
3435
+ * @type {PaymentDetails2}
3436
+ * @memberof PaymentResponse
3437
+ */
3438
+ payment_details?: PaymentDetails2;
3439
+ /**
3440
+ *
3441
+ * @type {MandateRecipient}
3442
+ * @memberof PaymentResponse
3443
+ */
3444
+ recipient?: MandateRecipient;
3445
+ /**
3446
+ *
3447
+ * @type {GetMandateSender}
3448
+ * @memberof PaymentResponse
3449
+ */
3450
+ sender?: GetMandateSender;
3451
+ /**
3452
+ *
3453
+ * @type {FvErrorModel}
3454
+ * @memberof PaymentResponse
3455
+ */
3456
+ error?: FvErrorModel;
3457
+ }
3458
+ export declare const PaymentResponseTypeEnum: {
3459
+ readonly Mandate: "MANDATE";
3460
+ readonly Single: "SINGLE";
3461
+ };
3462
+ export declare type PaymentResponseTypeEnum = typeof PaymentResponseTypeEnum[keyof typeof PaymentResponseTypeEnum];
3463
+ export declare const PaymentResponseStatusEnum: {
3464
+ readonly AuthorizationRequired: "AUTHORIZATION_REQUIRED";
3465
+ readonly Authorizing: "AUTHORIZING";
3466
+ readonly Processing: "PROCESSING";
3467
+ readonly Submitted: "SUBMITTED";
3468
+ readonly Executed: "EXECUTED";
3469
+ readonly Failed: "FAILED";
3470
+ readonly Revoked: "REVOKED";
3471
+ };
3472
+ export declare type PaymentResponseStatusEnum = typeof PaymentResponseStatusEnum[keyof typeof PaymentResponseStatusEnum];
2927
3473
  /**
2928
3474
  *
2929
3475
  * @export
@@ -3113,6 +3659,32 @@ export interface RelinkRequest {
3113
3659
  */
3114
3660
  consent?: boolean | null;
3115
3661
  }
3662
+ /**
3663
+ *
3664
+ * @export
3665
+ * @interface SetMandateInstitutionRequest
3666
+ */
3667
+ export interface SetMandateInstitutionRequest {
3668
+ /**
3669
+ * Finverse Institution ID
3670
+ * @type {string}
3671
+ * @memberof SetMandateInstitutionRequest
3672
+ */
3673
+ institution_id: string;
3674
+ }
3675
+ /**
3676
+ *
3677
+ * @export
3678
+ * @interface SetMandateInstitutionResponse
3679
+ */
3680
+ export interface SetMandateInstitutionResponse {
3681
+ /**
3682
+ * Finverse Mandate ID
3683
+ * @type {string}
3684
+ * @memberof SetMandateInstitutionResponse
3685
+ */
3686
+ mandate_id: string;
3687
+ }
3116
3688
  /**
3117
3689
  *
3118
3690
  * @export
@@ -3212,18 +3784,6 @@ export interface SubmitAuthChecklistRequest {
3212
3784
  * @memberof SubmitAuthChecklistRequest
3213
3785
  */
3214
3786
  key_id: string;
3215
- /**
3216
- * Finverse Institution ID
3217
- * @type {string}
3218
- * @memberof SubmitAuthChecklistRequest
3219
- */
3220
- institution_id: string;
3221
- /**
3222
- * Type of account held by the Sender at the Institution. Possible values are INDIVIDUAL, BUSINESS
3223
- * @type {string}
3224
- * @memberof SubmitAuthChecklistRequest
3225
- */
3226
- sender_type?: SubmitAuthChecklistRequestSenderTypeEnum;
3227
3787
  /**
3228
3788
  * The encrypted envelope key
3229
3789
  * @type {string}
@@ -3249,11 +3809,6 @@ export interface SubmitAuthChecklistRequest {
3249
3809
  */
3250
3810
  ciphertext: string;
3251
3811
  }
3252
- export declare const SubmitAuthChecklistRequestSenderTypeEnum: {
3253
- readonly Individual: "INDIVIDUAL";
3254
- readonly Business: "BUSINESS";
3255
- };
3256
- export declare type SubmitAuthChecklistRequestSenderTypeEnum = typeof SubmitAuthChecklistRequestSenderTypeEnum[keyof typeof SubmitAuthChecklistRequestSenderTypeEnum];
3257
3812
  /**
3258
3813
  *
3259
3814
  * @export
@@ -3292,6 +3847,31 @@ export declare const SubmitAuthChecklistResponseMandateStatusEnum: {
3292
3847
  readonly Error: "ERROR";
3293
3848
  };
3294
3849
  export declare type SubmitAuthChecklistResponseMandateStatusEnum = typeof SubmitAuthChecklistResponseMandateStatusEnum[keyof typeof SubmitAuthChecklistResponseMandateStatusEnum];
3850
+ /**
3851
+ *
3852
+ * @export
3853
+ * @interface SwaggerErrBodyModel
3854
+ */
3855
+ export interface SwaggerErrBodyModel {
3856
+ /**
3857
+ *
3858
+ * @type {number}
3859
+ * @memberof SwaggerErrBodyModel
3860
+ */
3861
+ code?: number;
3862
+ /**
3863
+ *
3864
+ * @type {string}
3865
+ * @memberof SwaggerErrBodyModel
3866
+ */
3867
+ message?: string;
3868
+ /**
3869
+ *
3870
+ * @type {FvErrorModel}
3871
+ * @memberof SwaggerErrBodyModel
3872
+ */
3873
+ error?: FvErrorModel;
3874
+ }
3295
3875
  /**
3296
3876
  *
3297
3877
  * @export
@@ -3341,6 +3921,12 @@ export interface TokenResponse {
3341
3921
  * @memberof TokenResponse
3342
3922
  */
3343
3923
  expires_in: number;
3924
+ /**
3925
+ *
3926
+ * @type {string}
3927
+ * @memberof TokenResponse
3928
+ */
3929
+ issued_at: string;
3344
3930
  }
3345
3931
  /**
3346
3932
  *
@@ -3373,13 +3959,13 @@ export interface Transaction {
3373
3959
  */
3374
3960
  transaction_type?: string;
3375
3961
  /**
3376
- *
3962
+ * (Deprecated)
3377
3963
  * @type {string}
3378
3964
  * @memberof Transaction
3379
3965
  */
3380
3966
  category?: string;
3381
3967
  /**
3382
- *
3968
+ * (Deprecated)
3383
3969
  * @type {string}
3384
3970
  * @memberof Transaction
3385
3971
  */
@@ -3433,7 +4019,7 @@ export interface Transaction {
3433
4019
  */
3434
4020
  amount?: CurrencyAmount;
3435
4021
  /**
3436
- *
4022
+ * (Deprecated)
3437
4023
  * @type {object}
3438
4024
  * @memberof Transaction
3439
4025
  */
@@ -3450,6 +4036,18 @@ export interface Transaction {
3450
4036
  * @memberof Transaction
3451
4037
  */
3452
4038
  updated_at?: string;
4039
+ /**
4040
+ * Array of category labels
4041
+ * @type {Array<string>}
4042
+ * @memberof Transaction
4043
+ */
4044
+ categories?: Array<string>;
4045
+ /**
4046
+ *
4047
+ * @type {CategoryDetails}
4048
+ * @memberof Transaction
4049
+ */
4050
+ category_details?: CategoryDetails;
3453
4051
  }
3454
4052
  /**
3455
4053
  *
@@ -3458,7 +4056,7 @@ export interface Transaction {
3458
4056
  */
3459
4057
  export interface TransactionLimits {
3460
4058
  /**
3461
- * Maximum amount of money that can be paid during the reference period (across any number of transactions). Expressed in currencys smallest unit or “minor unit”, as defined in ISO 4217.
4059
+ * Maximum amount of money that can be paid during the reference period (across any number of transactions). Expressed in currency\'s smallest unit or “minor unit”, as defined in ISO 4217.
3462
4060
  * @type {number}
3463
4061
  * @memberof TransactionLimits
3464
4062
  */
@@ -3470,7 +4068,7 @@ export interface TransactionLimits {
3470
4068
  */
3471
4069
  max_period_count?: number;
3472
4070
  /**
3473
- * The maximum amount of money that can be transferred in a single transaction under this mandate. Expressed in currencys smallest unit or “minor unit”, as defined in ISO 4217.
4071
+ * The maximum amount of money that can be transferred in a single transaction under this mandate. Expressed in currency\'s smallest unit or “minor unit”, as defined in ISO 4217.
3474
4072
  * @type {number}
3475
4073
  * @memberof TransactionLimits
3476
4074
  */
@@ -3480,7 +4078,7 @@ export interface TransactionLimits {
3480
4078
  * @type {string}
3481
4079
  * @memberof TransactionLimits
3482
4080
  */
3483
- period: TransactionLimitsPeriodEnum;
4081
+ period?: TransactionLimitsPeriodEnum;
3484
4082
  }
3485
4083
  export declare const TransactionLimitsPeriodEnum: {
3486
4084
  readonly Daily: "DAILY";
@@ -3490,11 +4088,133 @@ export declare const TransactionLimitsPeriodEnum: {
3490
4088
  readonly Yearly: "YEARLY";
3491
4089
  };
3492
4090
  export declare type TransactionLimitsPeriodEnum = typeof TransactionLimitsPeriodEnum[keyof typeof TransactionLimitsPeriodEnum];
4091
+ /**
4092
+ *
4093
+ * @export
4094
+ * @interface UserButton
4095
+ */
4096
+ export interface UserButton {
4097
+ /**
4098
+ * The name of the button.
4099
+ * @type {string}
4100
+ * @memberof UserButton
4101
+ */
4102
+ name: string;
4103
+ /**
4104
+ * The text that will be displayed for this button
4105
+ * @type {string}
4106
+ * @memberof UserButton
4107
+ */
4108
+ value: string;
4109
+ /**
4110
+ * The type of button. Currently it can only be SUBMIT
4111
+ * @type {string}
4112
+ * @memberof UserButton
4113
+ */
4114
+ type: string;
4115
+ }
4116
+ /**
4117
+ *
4118
+ * @export
4119
+ * @interface UserField
4120
+ */
4121
+ export interface UserField {
4122
+ /**
4123
+ * The name of the field. This will be used as the key when submitting response.
4124
+ * @type {string}
4125
+ * @memberof UserField
4126
+ */
4127
+ name: string;
4128
+ /**
4129
+ * The label for this field.
4130
+ * @type {string}
4131
+ * @memberof UserField
4132
+ */
4133
+ label?: string;
4134
+ /**
4135
+ * The placeholder for this field.
4136
+ * @type {string}
4137
+ * @memberof UserField
4138
+ */
4139
+ placeholder?: string;
4140
+ /**
4141
+ * The type of field. Currently it can only be SELECT, INPUT or PASSWORD
4142
+ * @type {string}
4143
+ * @memberof UserField
4144
+ */
4145
+ type: string;
4146
+ /**
4147
+ * This is only applicable when the field type is SELECT
4148
+ * @type {Array<UserFieldOption>}
4149
+ * @memberof UserField
4150
+ */
4151
+ options?: Array<UserFieldOption>;
4152
+ }
4153
+ /**
4154
+ *
4155
+ * @export
4156
+ * @interface UserFieldOption
4157
+ */
4158
+ export interface UserFieldOption {
4159
+ /**
4160
+ * The value displayed in the select element.
4161
+ * @type {string}
4162
+ * @memberof UserFieldOption
4163
+ */
4164
+ label: string;
4165
+ /**
4166
+ * The value that will be submitted if this option was selected.
4167
+ * @type {string}
4168
+ * @memberof UserFieldOption
4169
+ */
4170
+ value: string;
4171
+ }
4172
+ /**
4173
+ *
4174
+ * @export
4175
+ * @interface UserMessage
4176
+ */
4177
+ export interface UserMessage {
4178
+ /**
4179
+ * The name of the message
4180
+ * @type {string}
4181
+ * @memberof UserMessage
4182
+ */
4183
+ name: string;
4184
+ /**
4185
+ * The type of the message. This will help how the UI renders this text.
4186
+ * @type {string}
4187
+ * @memberof UserMessage
4188
+ */
4189
+ type: string;
4190
+ /**
4191
+ * The actual text value.
4192
+ * @type {string}
4193
+ * @memberof UserMessage
4194
+ */
4195
+ value: string;
4196
+ }
3493
4197
  /**
3494
4198
  * CustomerApi - axios parameter creator
3495
4199
  * @export
3496
4200
  */
3497
4201
  export declare const CustomerApiAxiosParamCreator: (configuration?: Configuration) => {
4202
+ /**
4203
+ * CREATE Mandate
4204
+ * @param {CreateMandateRequest} createMandateRequest request body for creating mandate
4205
+ * @param {string} [idempotencyKey] A random key provided by the customer, per unique payment. The purpose for the Idempotency key is to allow safe retrying without the operation being performed multiple times.
4206
+ * @param {*} [options] Override http request option.
4207
+ * @throws {RequiredError}
4208
+ */
4209
+ createMandate: (createMandateRequest: CreateMandateRequest, idempotencyKey?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
4210
+ /**
4211
+ * Create new Payment
4212
+ * @param {CreatePaymentRequest} createPaymentRequest request body for creating payment
4213
+ * @param {string} [idempotencyKey] A random key provided by the customer, per unique payment. The purpose for the Idempotency key is to allow safe retrying without the operation being performed multiple times.
4214
+ * @param {*} [options] Override http request option.
4215
+ * @throws {RequiredError}
4216
+ */
4217
+ createPayment: (createPaymentRequest: CreatePaymentRequest, idempotencyKey?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3498
4218
  /**
3499
4219
  * Create a new payment instruction to be used when linking to perform new payment
3500
4220
  * @param {CustomerPaymentInstruction} paymentInstruction Request body for starting a new Link
@@ -3530,6 +4250,33 @@ export declare const CustomerApiAxiosParamCreator: (configuration?: Configuratio
3530
4250
  * @throws {RequiredError}
3531
4251
  */
3532
4252
  getLoginIdentityHistory: (loginIdentityId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
4253
+ /**
4254
+ * Get Mandate details by mandate_id
4255
+ * @param {string} mandateId mandate id
4256
+ * @param {*} [options] Override http request option.
4257
+ * @throws {RequiredError}
4258
+ */
4259
+ getMandate: (mandateId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
4260
+ /**
4261
+ * Get Mandate Authorization by mandate id
4262
+ * @param {*} [options] Override http request option.
4263
+ * @throws {RequiredError}
4264
+ */
4265
+ getMandateAuth: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
4266
+ /**
4267
+ * Get link to launch FV Link UI in mandate authorization mode
4268
+ * @param {GetMandateAuthLinkRequest} getMandateAuthLinkRequest request body for mandate authorization link
4269
+ * @param {*} [options] Override http request option.
4270
+ * @throws {RequiredError}
4271
+ */
4272
+ getMandateAuthLink: (getMandateAuthLinkRequest: GetMandateAuthLinkRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
4273
+ /**
4274
+ * Get Payment details by payment_id
4275
+ * @param {string} paymentId payment id
4276
+ * @param {*} [options] Override http request option.
4277
+ * @throws {RequiredError}
4278
+ */
4279
+ getPayment: (paymentId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3533
4280
  /**
3534
4281
  * Get payment instructions by payment_instruction_id
3535
4282
  * @param {string} paymentInstructionId The id of a payment instruction
@@ -3539,7 +4286,7 @@ export declare const CustomerApiAxiosParamCreator: (configuration?: Configuratio
3539
4286
  getPaymentInstruction: (paymentInstructionId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3540
4287
  /**
3541
4288
  * Get a list of institutions
3542
- * @param {string} [country] The country the institution belongs to
4289
+ * @param {string} [country] (Deprecated) The country the institution belongs to
3543
4290
  * @param {Array<string>} [countries] The countries the institution belongs to
3544
4291
  * @param {string} [productsSupported] The products that this institution supports
3545
4292
  * @param {'BANK' | 'WALLET' | 'TEST'} [institutionType] The type of institution
@@ -3554,12 +4301,42 @@ export declare const CustomerApiAxiosParamCreator: (configuration?: Configuratio
3554
4301
  * @throws {RequiredError}
3555
4302
  */
3556
4303
  refreshToken: (refreshRequest: RefreshRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
4304
+ /**
4305
+ * Update InstitutionID and SenderType for Mandate
4306
+ * @param {SetMandateInstitutionRequest} updateRequest request body for updating mandate institutionId and senderType
4307
+ * @param {*} [options] Override http request option.
4308
+ * @throws {RequiredError}
4309
+ */
4310
+ setMandateInstitution: (updateRequest: SetMandateInstitutionRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
4311
+ /**
4312
+ * Submit authorization checklist items
4313
+ * @param {SubmitAuthChecklistRequest} submitAuthChecklistRequest request body for submitting auth checklist
4314
+ * @param {*} [options] Override http request option.
4315
+ * @throws {RequiredError}
4316
+ */
4317
+ submitAuthChecklist: (submitAuthChecklistRequest: SubmitAuthChecklistRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3557
4318
  };
3558
4319
  /**
3559
4320
  * CustomerApi - functional programming interface
3560
4321
  * @export
3561
4322
  */
3562
4323
  export declare const CustomerApiFp: (configuration?: Configuration) => {
4324
+ /**
4325
+ * CREATE Mandate
4326
+ * @param {CreateMandateRequest} createMandateRequest request body for creating mandate
4327
+ * @param {string} [idempotencyKey] A random key provided by the customer, per unique payment. The purpose for the Idempotency key is to allow safe retrying without the operation being performed multiple times.
4328
+ * @param {*} [options] Override http request option.
4329
+ * @throws {RequiredError}
4330
+ */
4331
+ createMandate(createMandateRequest: CreateMandateRequest, idempotencyKey?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateMandateResponse>>;
4332
+ /**
4333
+ * Create new Payment
4334
+ * @param {CreatePaymentRequest} createPaymentRequest request body for creating payment
4335
+ * @param {string} [idempotencyKey] A random key provided by the customer, per unique payment. The purpose for the Idempotency key is to allow safe retrying without the operation being performed multiple times.
4336
+ * @param {*} [options] Override http request option.
4337
+ * @throws {RequiredError}
4338
+ */
4339
+ createPayment(createPaymentRequest: CreatePaymentRequest, idempotencyKey?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentResponse>>;
3563
4340
  /**
3564
4341
  * Create a new payment instruction to be used when linking to perform new payment
3565
4342
  * @param {CustomerPaymentInstruction} paymentInstruction Request body for starting a new Link
@@ -3595,6 +4372,33 @@ export declare const CustomerApiFp: (configuration?: Configuration) => {
3595
4372
  * @throws {RequiredError}
3596
4373
  */
3597
4374
  getLoginIdentityHistory(loginIdentityId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetLoginIdentityHistoryResponse>>;
4375
+ /**
4376
+ * Get Mandate details by mandate_id
4377
+ * @param {string} mandateId mandate id
4378
+ * @param {*} [options] Override http request option.
4379
+ * @throws {RequiredError}
4380
+ */
4381
+ getMandate(mandateId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetMandateResponse>>;
4382
+ /**
4383
+ * Get Mandate Authorization by mandate id
4384
+ * @param {*} [options] Override http request option.
4385
+ * @throws {RequiredError}
4386
+ */
4387
+ getMandateAuth(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetMandateAuthResponse>>;
4388
+ /**
4389
+ * Get link to launch FV Link UI in mandate authorization mode
4390
+ * @param {GetMandateAuthLinkRequest} getMandateAuthLinkRequest request body for mandate authorization link
4391
+ * @param {*} [options] Override http request option.
4392
+ * @throws {RequiredError}
4393
+ */
4394
+ getMandateAuthLink(getMandateAuthLinkRequest: GetMandateAuthLinkRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetMandateAuthLinkResponse>>;
4395
+ /**
4396
+ * Get Payment details by payment_id
4397
+ * @param {string} paymentId payment id
4398
+ * @param {*} [options] Override http request option.
4399
+ * @throws {RequiredError}
4400
+ */
4401
+ getPayment(paymentId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentResponse>>;
3598
4402
  /**
3599
4403
  * Get payment instructions by payment_instruction_id
3600
4404
  * @param {string} paymentInstructionId The id of a payment instruction
@@ -3604,7 +4408,7 @@ export declare const CustomerApiFp: (configuration?: Configuration) => {
3604
4408
  getPaymentInstruction(paymentInstructionId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPaymentInstructionsResponse>>;
3605
4409
  /**
3606
4410
  * Get a list of institutions
3607
- * @param {string} [country] The country the institution belongs to
4411
+ * @param {string} [country] (Deprecated) The country the institution belongs to
3608
4412
  * @param {Array<string>} [countries] The countries the institution belongs to
3609
4413
  * @param {string} [productsSupported] The products that this institution supports
3610
4414
  * @param {'BANK' | 'WALLET' | 'TEST'} [institutionType] The type of institution
@@ -3619,12 +4423,42 @@ export declare const CustomerApiFp: (configuration?: Configuration) => {
3619
4423
  * @throws {RequiredError}
3620
4424
  */
3621
4425
  refreshToken(refreshRequest: RefreshRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccessTokenResponse>>;
4426
+ /**
4427
+ * Update InstitutionID and SenderType for Mandate
4428
+ * @param {SetMandateInstitutionRequest} updateRequest request body for updating mandate institutionId and senderType
4429
+ * @param {*} [options] Override http request option.
4430
+ * @throws {RequiredError}
4431
+ */
4432
+ setMandateInstitution(updateRequest: SetMandateInstitutionRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SetMandateInstitutionResponse>>;
4433
+ /**
4434
+ * Submit authorization checklist items
4435
+ * @param {SubmitAuthChecklistRequest} submitAuthChecklistRequest request body for submitting auth checklist
4436
+ * @param {*} [options] Override http request option.
4437
+ * @throws {RequiredError}
4438
+ */
4439
+ submitAuthChecklist(submitAuthChecklistRequest: SubmitAuthChecklistRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SubmitAuthChecklistResponse>>;
3622
4440
  };
3623
4441
  /**
3624
4442
  * CustomerApi - factory interface
3625
4443
  * @export
3626
4444
  */
3627
4445
  export declare const CustomerApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
4446
+ /**
4447
+ * CREATE Mandate
4448
+ * @param {CreateMandateRequest} createMandateRequest request body for creating mandate
4449
+ * @param {string} [idempotencyKey] A random key provided by the customer, per unique payment. The purpose for the Idempotency key is to allow safe retrying without the operation being performed multiple times.
4450
+ * @param {*} [options] Override http request option.
4451
+ * @throws {RequiredError}
4452
+ */
4453
+ createMandate(createMandateRequest: CreateMandateRequest, idempotencyKey?: string, options?: any): AxiosPromise<CreateMandateResponse>;
4454
+ /**
4455
+ * Create new Payment
4456
+ * @param {CreatePaymentRequest} createPaymentRequest request body for creating payment
4457
+ * @param {string} [idempotencyKey] A random key provided by the customer, per unique payment. The purpose for the Idempotency key is to allow safe retrying without the operation being performed multiple times.
4458
+ * @param {*} [options] Override http request option.
4459
+ * @throws {RequiredError}
4460
+ */
4461
+ createPayment(createPaymentRequest: CreatePaymentRequest, idempotencyKey?: string, options?: any): AxiosPromise<PaymentResponse>;
3628
4462
  /**
3629
4463
  * Create a new payment instruction to be used when linking to perform new payment
3630
4464
  * @param {CustomerPaymentInstruction} paymentInstruction Request body for starting a new Link
@@ -3660,6 +4494,33 @@ export declare const CustomerApiFactory: (configuration?: Configuration, basePat
3660
4494
  * @throws {RequiredError}
3661
4495
  */
3662
4496
  getLoginIdentityHistory(loginIdentityId: string, options?: any): AxiosPromise<GetLoginIdentityHistoryResponse>;
4497
+ /**
4498
+ * Get Mandate details by mandate_id
4499
+ * @param {string} mandateId mandate id
4500
+ * @param {*} [options] Override http request option.
4501
+ * @throws {RequiredError}
4502
+ */
4503
+ getMandate(mandateId: string, options?: any): AxiosPromise<GetMandateResponse>;
4504
+ /**
4505
+ * Get Mandate Authorization by mandate id
4506
+ * @param {*} [options] Override http request option.
4507
+ * @throws {RequiredError}
4508
+ */
4509
+ getMandateAuth(options?: any): AxiosPromise<GetMandateAuthResponse>;
4510
+ /**
4511
+ * Get link to launch FV Link UI in mandate authorization mode
4512
+ * @param {GetMandateAuthLinkRequest} getMandateAuthLinkRequest request body for mandate authorization link
4513
+ * @param {*} [options] Override http request option.
4514
+ * @throws {RequiredError}
4515
+ */
4516
+ getMandateAuthLink(getMandateAuthLinkRequest: GetMandateAuthLinkRequest, options?: any): AxiosPromise<GetMandateAuthLinkResponse>;
4517
+ /**
4518
+ * Get Payment details by payment_id
4519
+ * @param {string} paymentId payment id
4520
+ * @param {*} [options] Override http request option.
4521
+ * @throws {RequiredError}
4522
+ */
4523
+ getPayment(paymentId: string, options?: any): AxiosPromise<PaymentResponse>;
3663
4524
  /**
3664
4525
  * Get payment instructions by payment_instruction_id
3665
4526
  * @param {string} paymentInstructionId The id of a payment instruction
@@ -3669,7 +4530,7 @@ export declare const CustomerApiFactory: (configuration?: Configuration, basePat
3669
4530
  getPaymentInstruction(paymentInstructionId: string, options?: any): AxiosPromise<GetPaymentInstructionsResponse>;
3670
4531
  /**
3671
4532
  * Get a list of institutions
3672
- * @param {string} [country] The country the institution belongs to
4533
+ * @param {string} [country] (Deprecated) The country the institution belongs to
3673
4534
  * @param {Array<string>} [countries] The countries the institution belongs to
3674
4535
  * @param {string} [productsSupported] The products that this institution supports
3675
4536
  * @param {'BANK' | 'WALLET' | 'TEST'} [institutionType] The type of institution
@@ -3684,6 +4545,20 @@ export declare const CustomerApiFactory: (configuration?: Configuration, basePat
3684
4545
  * @throws {RequiredError}
3685
4546
  */
3686
4547
  refreshToken(refreshRequest: RefreshRequest, options?: any): AxiosPromise<AccessTokenResponse>;
4548
+ /**
4549
+ * Update InstitutionID and SenderType for Mandate
4550
+ * @param {SetMandateInstitutionRequest} updateRequest request body for updating mandate institutionId and senderType
4551
+ * @param {*} [options] Override http request option.
4552
+ * @throws {RequiredError}
4553
+ */
4554
+ setMandateInstitution(updateRequest: SetMandateInstitutionRequest, options?: any): AxiosPromise<SetMandateInstitutionResponse>;
4555
+ /**
4556
+ * Submit authorization checklist items
4557
+ * @param {SubmitAuthChecklistRequest} submitAuthChecklistRequest request body for submitting auth checklist
4558
+ * @param {*} [options] Override http request option.
4559
+ * @throws {RequiredError}
4560
+ */
4561
+ submitAuthChecklist(submitAuthChecklistRequest: SubmitAuthChecklistRequest, options?: any): AxiosPromise<SubmitAuthChecklistResponse>;
3687
4562
  };
3688
4563
  /**
3689
4564
  * CustomerApi - interface
@@ -3691,6 +4566,24 @@ export declare const CustomerApiFactory: (configuration?: Configuration, basePat
3691
4566
  * @interface CustomerApi
3692
4567
  */
3693
4568
  export interface CustomerApiInterface {
4569
+ /**
4570
+ * CREATE Mandate
4571
+ * @param {CreateMandateRequest} createMandateRequest request body for creating mandate
4572
+ * @param {string} [idempotencyKey] A random key provided by the customer, per unique payment. The purpose for the Idempotency key is to allow safe retrying without the operation being performed multiple times.
4573
+ * @param {*} [options] Override http request option.
4574
+ * @throws {RequiredError}
4575
+ * @memberof CustomerApiInterface
4576
+ */
4577
+ createMandate(createMandateRequest: CreateMandateRequest, idempotencyKey?: string, options?: AxiosRequestConfig): AxiosPromise<CreateMandateResponse>;
4578
+ /**
4579
+ * Create new Payment
4580
+ * @param {CreatePaymentRequest} createPaymentRequest request body for creating payment
4581
+ * @param {string} [idempotencyKey] A random key provided by the customer, per unique payment. The purpose for the Idempotency key is to allow safe retrying without the operation being performed multiple times.
4582
+ * @param {*} [options] Override http request option.
4583
+ * @throws {RequiredError}
4584
+ * @memberof CustomerApiInterface
4585
+ */
4586
+ createPayment(createPaymentRequest: CreatePaymentRequest, idempotencyKey?: string, options?: AxiosRequestConfig): AxiosPromise<PaymentResponse>;
3694
4587
  /**
3695
4588
  * Create a new payment instruction to be used when linking to perform new payment
3696
4589
  * @param {CustomerPaymentInstruction} paymentInstruction Request body for starting a new Link
@@ -3731,6 +4624,37 @@ export interface CustomerApiInterface {
3731
4624
  * @memberof CustomerApiInterface
3732
4625
  */
3733
4626
  getLoginIdentityHistory(loginIdentityId: string, options?: AxiosRequestConfig): AxiosPromise<GetLoginIdentityHistoryResponse>;
4627
+ /**
4628
+ * Get Mandate details by mandate_id
4629
+ * @param {string} mandateId mandate id
4630
+ * @param {*} [options] Override http request option.
4631
+ * @throws {RequiredError}
4632
+ * @memberof CustomerApiInterface
4633
+ */
4634
+ getMandate(mandateId: string, options?: AxiosRequestConfig): AxiosPromise<GetMandateResponse>;
4635
+ /**
4636
+ * Get Mandate Authorization by mandate id
4637
+ * @param {*} [options] Override http request option.
4638
+ * @throws {RequiredError}
4639
+ * @memberof CustomerApiInterface
4640
+ */
4641
+ getMandateAuth(options?: AxiosRequestConfig): AxiosPromise<GetMandateAuthResponse>;
4642
+ /**
4643
+ * Get link to launch FV Link UI in mandate authorization mode
4644
+ * @param {GetMandateAuthLinkRequest} getMandateAuthLinkRequest request body for mandate authorization link
4645
+ * @param {*} [options] Override http request option.
4646
+ * @throws {RequiredError}
4647
+ * @memberof CustomerApiInterface
4648
+ */
4649
+ getMandateAuthLink(getMandateAuthLinkRequest: GetMandateAuthLinkRequest, options?: AxiosRequestConfig): AxiosPromise<GetMandateAuthLinkResponse>;
4650
+ /**
4651
+ * Get Payment details by payment_id
4652
+ * @param {string} paymentId payment id
4653
+ * @param {*} [options] Override http request option.
4654
+ * @throws {RequiredError}
4655
+ * @memberof CustomerApiInterface
4656
+ */
4657
+ getPayment(paymentId: string, options?: AxiosRequestConfig): AxiosPromise<PaymentResponse>;
3734
4658
  /**
3735
4659
  * Get payment instructions by payment_instruction_id
3736
4660
  * @param {string} paymentInstructionId The id of a payment instruction
@@ -3741,7 +4665,7 @@ export interface CustomerApiInterface {
3741
4665
  getPaymentInstruction(paymentInstructionId: string, options?: AxiosRequestConfig): AxiosPromise<GetPaymentInstructionsResponse>;
3742
4666
  /**
3743
4667
  * Get a list of institutions
3744
- * @param {string} [country] The country the institution belongs to
4668
+ * @param {string} [country] (Deprecated) The country the institution belongs to
3745
4669
  * @param {Array<string>} [countries] The countries the institution belongs to
3746
4670
  * @param {string} [productsSupported] The products that this institution supports
3747
4671
  * @param {'BANK' | 'WALLET' | 'TEST'} [institutionType] The type of institution
@@ -3758,6 +4682,22 @@ export interface CustomerApiInterface {
3758
4682
  * @memberof CustomerApiInterface
3759
4683
  */
3760
4684
  refreshToken(refreshRequest: RefreshRequest, options?: AxiosRequestConfig): AxiosPromise<AccessTokenResponse>;
4685
+ /**
4686
+ * Update InstitutionID and SenderType for Mandate
4687
+ * @param {SetMandateInstitutionRequest} updateRequest request body for updating mandate institutionId and senderType
4688
+ * @param {*} [options] Override http request option.
4689
+ * @throws {RequiredError}
4690
+ * @memberof CustomerApiInterface
4691
+ */
4692
+ setMandateInstitution(updateRequest: SetMandateInstitutionRequest, options?: AxiosRequestConfig): AxiosPromise<SetMandateInstitutionResponse>;
4693
+ /**
4694
+ * Submit authorization checklist items
4695
+ * @param {SubmitAuthChecklistRequest} submitAuthChecklistRequest request body for submitting auth checklist
4696
+ * @param {*} [options] Override http request option.
4697
+ * @throws {RequiredError}
4698
+ * @memberof CustomerApiInterface
4699
+ */
4700
+ submitAuthChecklist(submitAuthChecklistRequest: SubmitAuthChecklistRequest, options?: AxiosRequestConfig): AxiosPromise<SubmitAuthChecklistResponse>;
3761
4701
  }
3762
4702
  /**
3763
4703
  * CustomerApi - object-oriented interface
@@ -3766,6 +4706,24 @@ export interface CustomerApiInterface {
3766
4706
  * @extends {BaseAPI}
3767
4707
  */
3768
4708
  export declare class CustomerApi extends BaseAPI implements CustomerApiInterface {
4709
+ /**
4710
+ * CREATE Mandate
4711
+ * @param {CreateMandateRequest} createMandateRequest request body for creating mandate
4712
+ * @param {string} [idempotencyKey] A random key provided by the customer, per unique payment. The purpose for the Idempotency key is to allow safe retrying without the operation being performed multiple times.
4713
+ * @param {*} [options] Override http request option.
4714
+ * @throws {RequiredError}
4715
+ * @memberof CustomerApi
4716
+ */
4717
+ createMandate(createMandateRequest: CreateMandateRequest, idempotencyKey?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateMandateResponse>>;
4718
+ /**
4719
+ * Create new Payment
4720
+ * @param {CreatePaymentRequest} createPaymentRequest request body for creating payment
4721
+ * @param {string} [idempotencyKey] A random key provided by the customer, per unique payment. The purpose for the Idempotency key is to allow safe retrying without the operation being performed multiple times.
4722
+ * @param {*} [options] Override http request option.
4723
+ * @throws {RequiredError}
4724
+ * @memberof CustomerApi
4725
+ */
4726
+ createPayment(createPaymentRequest: CreatePaymentRequest, idempotencyKey?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentResponse>>;
3769
4727
  /**
3770
4728
  * Create a new payment instruction to be used when linking to perform new payment
3771
4729
  * @param {CustomerPaymentInstruction} paymentInstruction Request body for starting a new Link
@@ -3806,6 +4764,37 @@ export declare class CustomerApi extends BaseAPI implements CustomerApiInterface
3806
4764
  * @memberof CustomerApi
3807
4765
  */
3808
4766
  getLoginIdentityHistory(loginIdentityId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetLoginIdentityHistoryResponse>>;
4767
+ /**
4768
+ * Get Mandate details by mandate_id
4769
+ * @param {string} mandateId mandate id
4770
+ * @param {*} [options] Override http request option.
4771
+ * @throws {RequiredError}
4772
+ * @memberof CustomerApi
4773
+ */
4774
+ getMandate(mandateId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMandateResponse>>;
4775
+ /**
4776
+ * Get Mandate Authorization by mandate id
4777
+ * @param {*} [options] Override http request option.
4778
+ * @throws {RequiredError}
4779
+ * @memberof CustomerApi
4780
+ */
4781
+ getMandateAuth(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMandateAuthResponse>>;
4782
+ /**
4783
+ * Get link to launch FV Link UI in mandate authorization mode
4784
+ * @param {GetMandateAuthLinkRequest} getMandateAuthLinkRequest request body for mandate authorization link
4785
+ * @param {*} [options] Override http request option.
4786
+ * @throws {RequiredError}
4787
+ * @memberof CustomerApi
4788
+ */
4789
+ getMandateAuthLink(getMandateAuthLinkRequest: GetMandateAuthLinkRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMandateAuthLinkResponse>>;
4790
+ /**
4791
+ * Get Payment details by payment_id
4792
+ * @param {string} paymentId payment id
4793
+ * @param {*} [options] Override http request option.
4794
+ * @throws {RequiredError}
4795
+ * @memberof CustomerApi
4796
+ */
4797
+ getPayment(paymentId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentResponse>>;
3809
4798
  /**
3810
4799
  * Get payment instructions by payment_instruction_id
3811
4800
  * @param {string} paymentInstructionId The id of a payment instruction
@@ -3816,7 +4805,7 @@ export declare class CustomerApi extends BaseAPI implements CustomerApiInterface
3816
4805
  getPaymentInstruction(paymentInstructionId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPaymentInstructionsResponse>>;
3817
4806
  /**
3818
4807
  * Get a list of institutions
3819
- * @param {string} [country] The country the institution belongs to
4808
+ * @param {string} [country] (Deprecated) The country the institution belongs to
3820
4809
  * @param {Array<string>} [countries] The countries the institution belongs to
3821
4810
  * @param {string} [productsSupported] The products that this institution supports
3822
4811
  * @param {'BANK' | 'WALLET' | 'TEST'} [institutionType] The type of institution
@@ -3833,28 +4822,67 @@ export declare class CustomerApi extends BaseAPI implements CustomerApiInterface
3833
4822
  * @memberof CustomerApi
3834
4823
  */
3835
4824
  refreshToken(refreshRequest: RefreshRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccessTokenResponse>>;
4825
+ /**
4826
+ * Update InstitutionID and SenderType for Mandate
4827
+ * @param {SetMandateInstitutionRequest} updateRequest request body for updating mandate institutionId and senderType
4828
+ * @param {*} [options] Override http request option.
4829
+ * @throws {RequiredError}
4830
+ * @memberof CustomerApi
4831
+ */
4832
+ setMandateInstitution(updateRequest: SetMandateInstitutionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SetMandateInstitutionResponse>>;
4833
+ /**
4834
+ * Submit authorization checklist items
4835
+ * @param {SubmitAuthChecklistRequest} submitAuthChecklistRequest request body for submitting auth checklist
4836
+ * @param {*} [options] Override http request option.
4837
+ * @throws {RequiredError}
4838
+ * @memberof CustomerApi
4839
+ */
4840
+ submitAuthChecklist(submitAuthChecklistRequest: SubmitAuthChecklistRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SubmitAuthChecklistResponse>>;
3836
4841
  }
3837
4842
  /**
3838
4843
  * LinkApi - axios parameter creator
3839
4844
  * @export
3840
4845
  */
3841
4846
  export declare const LinkApiAxiosParamCreator: (configuration?: Configuration) => {
4847
+ /**
4848
+ * Create a new link and submit credentials
4849
+ * @param {ApiLinkRequest} apiLinkRequest Request body for creating a new link and submitting credentials
4850
+ * @param {*} [options] Override http request option.
4851
+ * @throws {RequiredError}
4852
+ */
4853
+ createLink: (apiLinkRequest: ApiLinkRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3842
4854
  /**
3843
4855
  * Creates a new link
3844
4856
  * @param {LinkRequest} linkRequest Request body for starting a new Link
3845
4857
  * @param {*} [options] Override http request option.
3846
4858
  * @throws {RequiredError}
3847
4859
  */
3848
- createLink: (linkRequest: LinkRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
4860
+ createLinkWoauth: (linkRequest: LinkRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
4861
+ /**
4862
+ * Post the user action value
4863
+ * @param {string} loginIdentityId The login identity id
4864
+ * @param {ActionRequest} actionRequest Request body for post link action
4865
+ * @param {*} [options] Override http request option.
4866
+ * @throws {RequiredError}
4867
+ */
4868
+ linkAction: (loginIdentityId: string, actionRequest: ActionRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
4869
+ /**
4870
+ * Check the status of a given loginIdentity
4871
+ * @param {string} loginIdentityId The login identity id
4872
+ * @param {*} [options] Override http request option.
4873
+ * @throws {RequiredError}
4874
+ */
4875
+ linkStatus: (loginIdentityId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3849
4876
  /**
3850
- * Get the customization details
4877
+ * Check the status of a given login identity via FVLink
4878
+ * @param {string} loginIdentityId The login identity id
3851
4879
  * @param {*} [options] Override http request option.
3852
4880
  * @throws {RequiredError}
3853
4881
  */
3854
- getCustomization: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
4882
+ linkStatusNonSensitive: (loginIdentityId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3855
4883
  /**
3856
4884
  * Get a list of institutions
3857
- * @param {string} [country] The country the institution belongs to
4885
+ * @param {string} [country] (Deprecated) The country the institution belongs to
3858
4886
  * @param {Array<string>} [countries] The countries the institution belongs to
3859
4887
  * @param {string} [productsSupported] The products that this institution supports
3860
4888
  * @param {'BANK' | 'WALLET' | 'TEST'} [institutionType] The type of institution
@@ -3869,6 +4897,14 @@ export declare const LinkApiAxiosParamCreator: (configuration?: Configuration) =
3869
4897
  * @throws {RequiredError}
3870
4898
  */
3871
4899
  relink: (relinkRequest: RelinkRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
4900
+ /**
4901
+ * Create a new link using an existing LIID
4902
+ * @param {string} loginIdentityId The login identity id
4903
+ * @param {ApiRelinkRequest} apiRelinkRequest Request body for relinking and submitting credentials
4904
+ * @param {*} [options] Override http request option.
4905
+ * @throws {RequiredError}
4906
+ */
4907
+ relinkV2: (loginIdentityId: string, apiRelinkRequest: ApiRelinkRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3872
4908
  /**
3873
4909
  * Exchange authorization code for token
3874
4910
  * @param {string} grantType
@@ -3885,22 +4921,45 @@ export declare const LinkApiAxiosParamCreator: (configuration?: Configuration) =
3885
4921
  * @export
3886
4922
  */
3887
4923
  export declare const LinkApiFp: (configuration?: Configuration) => {
4924
+ /**
4925
+ * Create a new link and submit credentials
4926
+ * @param {ApiLinkRequest} apiLinkRequest Request body for creating a new link and submitting credentials
4927
+ * @param {*} [options] Override http request option.
4928
+ * @throws {RequiredError}
4929
+ */
4930
+ createLink(apiLinkRequest: ApiLinkRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetLoginIdentityByIdResponse>>;
3888
4931
  /**
3889
4932
  * Creates a new link
3890
4933
  * @param {LinkRequest} linkRequest Request body for starting a new Link
3891
4934
  * @param {*} [options] Override http request option.
3892
4935
  * @throws {RequiredError}
3893
4936
  */
3894
- createLink(linkRequest: LinkRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LinkResponse>>;
4937
+ createLinkWoauth(linkRequest: LinkRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LinkResponse>>;
3895
4938
  /**
3896
- * Get the customization details
4939
+ * Post the user action value
4940
+ * @param {string} loginIdentityId The login identity id
4941
+ * @param {ActionRequest} actionRequest Request body for post link action
4942
+ * @param {*} [options] Override http request option.
4943
+ * @throws {RequiredError}
4944
+ */
4945
+ linkAction(loginIdentityId: string, actionRequest: ActionRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetLoginIdentityByIdResponse>>;
4946
+ /**
4947
+ * Check the status of a given loginIdentity
4948
+ * @param {string} loginIdentityId The login identity id
4949
+ * @param {*} [options] Override http request option.
4950
+ * @throws {RequiredError}
4951
+ */
4952
+ linkStatus(loginIdentityId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LinkStatusResponse>>;
4953
+ /**
4954
+ * Check the status of a given login identity via FVLink
4955
+ * @param {string} loginIdentityId The login identity id
3897
4956
  * @param {*} [options] Override http request option.
3898
4957
  * @throws {RequiredError}
3899
4958
  */
3900
- getCustomization(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CustomizationDetails>>;
4959
+ linkStatusNonSensitive(loginIdentityId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NonSensitiveLinkStatusResponse>>;
3901
4960
  /**
3902
4961
  * Get a list of institutions
3903
- * @param {string} [country] The country the institution belongs to
4962
+ * @param {string} [country] (Deprecated) The country the institution belongs to
3904
4963
  * @param {Array<string>} [countries] The countries the institution belongs to
3905
4964
  * @param {string} [productsSupported] The products that this institution supports
3906
4965
  * @param {'BANK' | 'WALLET' | 'TEST'} [institutionType] The type of institution
@@ -3915,6 +4974,14 @@ export declare const LinkApiFp: (configuration?: Configuration) => {
3915
4974
  * @throws {RequiredError}
3916
4975
  */
3917
4976
  relink(relinkRequest: RelinkRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LinkResponse>>;
4977
+ /**
4978
+ * Create a new link using an existing LIID
4979
+ * @param {string} loginIdentityId The login identity id
4980
+ * @param {ApiRelinkRequest} apiRelinkRequest Request body for relinking and submitting credentials
4981
+ * @param {*} [options] Override http request option.
4982
+ * @throws {RequiredError}
4983
+ */
4984
+ relinkV2(loginIdentityId: string, apiRelinkRequest: ApiRelinkRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetLoginIdentityByIdResponse>>;
3918
4985
  /**
3919
4986
  * Exchange authorization code for token
3920
4987
  * @param {string} grantType
@@ -3931,22 +4998,45 @@ export declare const LinkApiFp: (configuration?: Configuration) => {
3931
4998
  * @export
3932
4999
  */
3933
5000
  export declare const LinkApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
5001
+ /**
5002
+ * Create a new link and submit credentials
5003
+ * @param {ApiLinkRequest} apiLinkRequest Request body for creating a new link and submitting credentials
5004
+ * @param {*} [options] Override http request option.
5005
+ * @throws {RequiredError}
5006
+ */
5007
+ createLink(apiLinkRequest: ApiLinkRequest, options?: any): AxiosPromise<GetLoginIdentityByIdResponse>;
3934
5008
  /**
3935
5009
  * Creates a new link
3936
5010
  * @param {LinkRequest} linkRequest Request body for starting a new Link
3937
5011
  * @param {*} [options] Override http request option.
3938
5012
  * @throws {RequiredError}
3939
5013
  */
3940
- createLink(linkRequest: LinkRequest, options?: any): AxiosPromise<LinkResponse>;
5014
+ createLinkWoauth(linkRequest: LinkRequest, options?: any): AxiosPromise<LinkResponse>;
5015
+ /**
5016
+ * Post the user action value
5017
+ * @param {string} loginIdentityId The login identity id
5018
+ * @param {ActionRequest} actionRequest Request body for post link action
5019
+ * @param {*} [options] Override http request option.
5020
+ * @throws {RequiredError}
5021
+ */
5022
+ linkAction(loginIdentityId: string, actionRequest: ActionRequest, options?: any): AxiosPromise<GetLoginIdentityByIdResponse>;
5023
+ /**
5024
+ * Check the status of a given loginIdentity
5025
+ * @param {string} loginIdentityId The login identity id
5026
+ * @param {*} [options] Override http request option.
5027
+ * @throws {RequiredError}
5028
+ */
5029
+ linkStatus(loginIdentityId: string, options?: any): AxiosPromise<LinkStatusResponse>;
3941
5030
  /**
3942
- * Get the customization details
5031
+ * Check the status of a given login identity via FVLink
5032
+ * @param {string} loginIdentityId The login identity id
3943
5033
  * @param {*} [options] Override http request option.
3944
5034
  * @throws {RequiredError}
3945
5035
  */
3946
- getCustomization(options?: any): AxiosPromise<CustomizationDetails>;
5036
+ linkStatusNonSensitive(loginIdentityId: string, options?: any): AxiosPromise<NonSensitiveLinkStatusResponse>;
3947
5037
  /**
3948
5038
  * Get a list of institutions
3949
- * @param {string} [country] The country the institution belongs to
5039
+ * @param {string} [country] (Deprecated) The country the institution belongs to
3950
5040
  * @param {Array<string>} [countries] The countries the institution belongs to
3951
5041
  * @param {string} [productsSupported] The products that this institution supports
3952
5042
  * @param {'BANK' | 'WALLET' | 'TEST'} [institutionType] The type of institution
@@ -3961,6 +5051,14 @@ export declare const LinkApiFactory: (configuration?: Configuration, basePath?:
3961
5051
  * @throws {RequiredError}
3962
5052
  */
3963
5053
  relink(relinkRequest: RelinkRequest, options?: any): AxiosPromise<LinkResponse>;
5054
+ /**
5055
+ * Create a new link using an existing LIID
5056
+ * @param {string} loginIdentityId The login identity id
5057
+ * @param {ApiRelinkRequest} apiRelinkRequest Request body for relinking and submitting credentials
5058
+ * @param {*} [options] Override http request option.
5059
+ * @throws {RequiredError}
5060
+ */
5061
+ relinkV2(loginIdentityId: string, apiRelinkRequest: ApiRelinkRequest, options?: any): AxiosPromise<GetLoginIdentityByIdResponse>;
3964
5062
  /**
3965
5063
  * Exchange authorization code for token
3966
5064
  * @param {string} grantType
@@ -3978,6 +5076,14 @@ export declare const LinkApiFactory: (configuration?: Configuration, basePath?:
3978
5076
  * @interface LinkApi
3979
5077
  */
3980
5078
  export interface LinkApiInterface {
5079
+ /**
5080
+ * Create a new link and submit credentials
5081
+ * @param {ApiLinkRequest} apiLinkRequest Request body for creating a new link and submitting credentials
5082
+ * @param {*} [options] Override http request option.
5083
+ * @throws {RequiredError}
5084
+ * @memberof LinkApiInterface
5085
+ */
5086
+ createLink(apiLinkRequest: ApiLinkRequest, options?: AxiosRequestConfig): AxiosPromise<GetLoginIdentityByIdResponse>;
3981
5087
  /**
3982
5088
  * Creates a new link
3983
5089
  * @param {LinkRequest} linkRequest Request body for starting a new Link
@@ -3985,17 +5091,35 @@ export interface LinkApiInterface {
3985
5091
  * @throws {RequiredError}
3986
5092
  * @memberof LinkApiInterface
3987
5093
  */
3988
- createLink(linkRequest: LinkRequest, options?: AxiosRequestConfig): AxiosPromise<LinkResponse>;
5094
+ createLinkWoauth(linkRequest: LinkRequest, options?: AxiosRequestConfig): AxiosPromise<LinkResponse>;
5095
+ /**
5096
+ * Post the user action value
5097
+ * @param {string} loginIdentityId The login identity id
5098
+ * @param {ActionRequest} actionRequest Request body for post link action
5099
+ * @param {*} [options] Override http request option.
5100
+ * @throws {RequiredError}
5101
+ * @memberof LinkApiInterface
5102
+ */
5103
+ linkAction(loginIdentityId: string, actionRequest: ActionRequest, options?: AxiosRequestConfig): AxiosPromise<GetLoginIdentityByIdResponse>;
5104
+ /**
5105
+ * Check the status of a given loginIdentity
5106
+ * @param {string} loginIdentityId The login identity id
5107
+ * @param {*} [options] Override http request option.
5108
+ * @throws {RequiredError}
5109
+ * @memberof LinkApiInterface
5110
+ */
5111
+ linkStatus(loginIdentityId: string, options?: AxiosRequestConfig): AxiosPromise<LinkStatusResponse>;
3989
5112
  /**
3990
- * Get the customization details
5113
+ * Check the status of a given login identity via FVLink
5114
+ * @param {string} loginIdentityId The login identity id
3991
5115
  * @param {*} [options] Override http request option.
3992
5116
  * @throws {RequiredError}
3993
5117
  * @memberof LinkApiInterface
3994
5118
  */
3995
- getCustomization(options?: AxiosRequestConfig): AxiosPromise<CustomizationDetails>;
5119
+ linkStatusNonSensitive(loginIdentityId: string, options?: AxiosRequestConfig): AxiosPromise<NonSensitiveLinkStatusResponse>;
3996
5120
  /**
3997
5121
  * Get a list of institutions
3998
- * @param {string} [country] The country the institution belongs to
5122
+ * @param {string} [country] (Deprecated) The country the institution belongs to
3999
5123
  * @param {Array<string>} [countries] The countries the institution belongs to
4000
5124
  * @param {string} [productsSupported] The products that this institution supports
4001
5125
  * @param {'BANK' | 'WALLET' | 'TEST'} [institutionType] The type of institution
@@ -4012,6 +5136,15 @@ export interface LinkApiInterface {
4012
5136
  * @memberof LinkApiInterface
4013
5137
  */
4014
5138
  relink(relinkRequest: RelinkRequest, options?: AxiosRequestConfig): AxiosPromise<LinkResponse>;
5139
+ /**
5140
+ * Create a new link using an existing LIID
5141
+ * @param {string} loginIdentityId The login identity id
5142
+ * @param {ApiRelinkRequest} apiRelinkRequest Request body for relinking and submitting credentials
5143
+ * @param {*} [options] Override http request option.
5144
+ * @throws {RequiredError}
5145
+ * @memberof LinkApiInterface
5146
+ */
5147
+ relinkV2(loginIdentityId: string, apiRelinkRequest: ApiRelinkRequest, options?: AxiosRequestConfig): AxiosPromise<GetLoginIdentityByIdResponse>;
4015
5148
  /**
4016
5149
  * Exchange authorization code for token
4017
5150
  * @param {string} grantType
@@ -4031,6 +5164,14 @@ export interface LinkApiInterface {
4031
5164
  * @extends {BaseAPI}
4032
5165
  */
4033
5166
  export declare class LinkApi extends BaseAPI implements LinkApiInterface {
5167
+ /**
5168
+ * Create a new link and submit credentials
5169
+ * @param {ApiLinkRequest} apiLinkRequest Request body for creating a new link and submitting credentials
5170
+ * @param {*} [options] Override http request option.
5171
+ * @throws {RequiredError}
5172
+ * @memberof LinkApi
5173
+ */
5174
+ createLink(apiLinkRequest: ApiLinkRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetLoginIdentityByIdResponse>>;
4034
5175
  /**
4035
5176
  * Creates a new link
4036
5177
  * @param {LinkRequest} linkRequest Request body for starting a new Link
@@ -4038,17 +5179,35 @@ export declare class LinkApi extends BaseAPI implements LinkApiInterface {
4038
5179
  * @throws {RequiredError}
4039
5180
  * @memberof LinkApi
4040
5181
  */
4041
- createLink(linkRequest: LinkRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<LinkResponse>>;
5182
+ createLinkWoauth(linkRequest: LinkRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<LinkResponse>>;
5183
+ /**
5184
+ * Post the user action value
5185
+ * @param {string} loginIdentityId The login identity id
5186
+ * @param {ActionRequest} actionRequest Request body for post link action
5187
+ * @param {*} [options] Override http request option.
5188
+ * @throws {RequiredError}
5189
+ * @memberof LinkApi
5190
+ */
5191
+ linkAction(loginIdentityId: string, actionRequest: ActionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetLoginIdentityByIdResponse>>;
5192
+ /**
5193
+ * Check the status of a given loginIdentity
5194
+ * @param {string} loginIdentityId The login identity id
5195
+ * @param {*} [options] Override http request option.
5196
+ * @throws {RequiredError}
5197
+ * @memberof LinkApi
5198
+ */
5199
+ linkStatus(loginIdentityId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<LinkStatusResponse>>;
4042
5200
  /**
4043
- * Get the customization details
5201
+ * Check the status of a given login identity via FVLink
5202
+ * @param {string} loginIdentityId The login identity id
4044
5203
  * @param {*} [options] Override http request option.
4045
5204
  * @throws {RequiredError}
4046
5205
  * @memberof LinkApi
4047
5206
  */
4048
- getCustomization(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CustomizationDetails>>;
5207
+ linkStatusNonSensitive(loginIdentityId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<NonSensitiveLinkStatusResponse>>;
4049
5208
  /**
4050
5209
  * Get a list of institutions
4051
- * @param {string} [country] The country the institution belongs to
5210
+ * @param {string} [country] (Deprecated) The country the institution belongs to
4052
5211
  * @param {Array<string>} [countries] The countries the institution belongs to
4053
5212
  * @param {string} [productsSupported] The products that this institution supports
4054
5213
  * @param {'BANK' | 'WALLET' | 'TEST'} [institutionType] The type of institution
@@ -4065,6 +5224,15 @@ export declare class LinkApi extends BaseAPI implements LinkApiInterface {
4065
5224
  * @memberof LinkApi
4066
5225
  */
4067
5226
  relink(relinkRequest: RelinkRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<LinkResponse>>;
5227
+ /**
5228
+ * Create a new link using an existing LIID
5229
+ * @param {string} loginIdentityId The login identity id
5230
+ * @param {ApiRelinkRequest} apiRelinkRequest Request body for relinking and submitting credentials
5231
+ * @param {*} [options] Override http request option.
5232
+ * @throws {RequiredError}
5233
+ * @memberof LinkApi
5234
+ */
5235
+ relinkV2(loginIdentityId: string, apiRelinkRequest: ApiRelinkRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetLoginIdentityByIdResponse>>;
4068
5236
  /**
4069
5237
  * Exchange authorization code for token
4070
5238
  * @param {string} grantType
@@ -4112,10 +5280,11 @@ export declare const LoginIdentityApiAxiosParamCreator: (configuration?: Configu
4112
5280
  /**
4113
5281
  * Get the balance history for a specific account
4114
5282
  * @param {string} accountId The account id
5283
+ * @param {'INSTITUTION' | 'COMPUTED'} [source] The source will determine what type of balance history will be returned
4115
5284
  * @param {*} [options] Override http request option.
4116
5285
  * @throws {RequiredError}
4117
5286
  */
4118
- getBalanceHistory: (accountId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
5287
+ getBalanceHistory: (accountId: string, source?: 'INSTITUTION' | 'COMPUTED', options?: AxiosRequestConfig) => Promise<RequestArgs>;
4119
5288
  /**
4120
5289
  * Download composite statement
4121
5290
  * @param {boolean} [redirect] when true, response will be http redirect; otherwise it will be json response with the download link
@@ -4220,10 +5389,11 @@ export declare const LoginIdentityApiFp: (configuration?: Configuration) => {
4220
5389
  /**
4221
5390
  * Get the balance history for a specific account
4222
5391
  * @param {string} accountId The account id
5392
+ * @param {'INSTITUTION' | 'COMPUTED'} [source] The source will determine what type of balance history will be returned
4223
5393
  * @param {*} [options] Override http request option.
4224
5394
  * @throws {RequiredError}
4225
5395
  */
4226
- getBalanceHistory(accountId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetBalanceHistoryResponse>>;
5396
+ getBalanceHistory(accountId: string, source?: 'INSTITUTION' | 'COMPUTED', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetBalanceHistoryResponse>>;
4227
5397
  /**
4228
5398
  * Download composite statement
4229
5399
  * @param {boolean} [redirect] when true, response will be http redirect; otherwise it will be json response with the download link
@@ -4328,10 +5498,11 @@ export declare const LoginIdentityApiFactory: (configuration?: Configuration, ba
4328
5498
  /**
4329
5499
  * Get the balance history for a specific account
4330
5500
  * @param {string} accountId The account id
5501
+ * @param {'INSTITUTION' | 'COMPUTED'} [source] The source will determine what type of balance history will be returned
4331
5502
  * @param {*} [options] Override http request option.
4332
5503
  * @throws {RequiredError}
4333
5504
  */
4334
- getBalanceHistory(accountId: string, options?: any): AxiosPromise<GetBalanceHistoryResponse>;
5505
+ getBalanceHistory(accountId: string, source?: 'INSTITUTION' | 'COMPUTED', options?: any): AxiosPromise<GetBalanceHistoryResponse>;
4335
5506
  /**
4336
5507
  * Download composite statement
4337
5508
  * @param {boolean} [redirect] when true, response will be http redirect; otherwise it will be json response with the download link
@@ -4441,11 +5612,12 @@ export interface LoginIdentityApiInterface {
4441
5612
  /**
4442
5613
  * Get the balance history for a specific account
4443
5614
  * @param {string} accountId The account id
5615
+ * @param {'INSTITUTION' | 'COMPUTED'} [source] The source will determine what type of balance history will be returned
4444
5616
  * @param {*} [options] Override http request option.
4445
5617
  * @throws {RequiredError}
4446
5618
  * @memberof LoginIdentityApiInterface
4447
5619
  */
4448
- getBalanceHistory(accountId: string, options?: AxiosRequestConfig): AxiosPromise<GetBalanceHistoryResponse>;
5620
+ getBalanceHistory(accountId: string, source?: 'INSTITUTION' | 'COMPUTED', options?: AxiosRequestConfig): AxiosPromise<GetBalanceHistoryResponse>;
4449
5621
  /**
4450
5622
  * Download composite statement
4451
5623
  * @param {boolean} [redirect] when true, response will be http redirect; otherwise it will be json response with the download link
@@ -4566,11 +5738,12 @@ export declare class LoginIdentityApi extends BaseAPI implements LoginIdentityAp
4566
5738
  /**
4567
5739
  * Get the balance history for a specific account
4568
5740
  * @param {string} accountId The account id
5741
+ * @param {'INSTITUTION' | 'COMPUTED'} [source] The source will determine what type of balance history will be returned
4569
5742
  * @param {*} [options] Override http request option.
4570
5743
  * @throws {RequiredError}
4571
5744
  * @memberof LoginIdentityApi
4572
5745
  */
4573
- getBalanceHistory(accountId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetBalanceHistoryResponse>>;
5746
+ getBalanceHistory(accountId: string, source?: 'INSTITUTION' | 'COMPUTED', options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetBalanceHistoryResponse>>;
4574
5747
  /**
4575
5748
  * Download composite statement
4576
5749
  * @param {boolean} [redirect] when true, response will be http redirect; otherwise it will be json response with the download link
@@ -4673,6 +5846,18 @@ export declare const PublicApiAxiosParamCreator: (configuration?: Configuration)
4673
5846
  * @throws {RequiredError}
4674
5847
  */
4675
5848
  generateCustomerAccessToken: (tokenRequest?: TokenRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
5849
+ /**
5850
+ * get jwks
5851
+ * @param {*} [options] Override http request option.
5852
+ * @throws {RequiredError}
5853
+ */
5854
+ getCredSubmitJwks: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
5855
+ /**
5856
+ * get payment jwks
5857
+ * @param {*} [options] Override http request option.
5858
+ * @throws {RequiredError}
5859
+ */
5860
+ getPaymentsJwks: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
4676
5861
  };
4677
5862
  /**
4678
5863
  * PublicApi - functional programming interface
@@ -4697,6 +5882,18 @@ export declare const PublicApiFp: (configuration?: Configuration) => {
4697
5882
  * @throws {RequiredError}
4698
5883
  */
4699
5884
  generateCustomerAccessToken(tokenRequest?: TokenRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TokenResponse>>;
5885
+ /**
5886
+ * get jwks
5887
+ * @param {*} [options] Override http request option.
5888
+ * @throws {RequiredError}
5889
+ */
5890
+ getCredSubmitJwks(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
5891
+ /**
5892
+ * get payment jwks
5893
+ * @param {*} [options] Override http request option.
5894
+ * @throws {RequiredError}
5895
+ */
5896
+ getPaymentsJwks(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetJWKSResponse>>;
4700
5897
  };
4701
5898
  /**
4702
5899
  * PublicApi - factory interface
@@ -4721,6 +5918,18 @@ export declare const PublicApiFactory: (configuration?: Configuration, basePath?
4721
5918
  * @throws {RequiredError}
4722
5919
  */
4723
5920
  generateCustomerAccessToken(tokenRequest?: TokenRequest, options?: any): AxiosPromise<TokenResponse>;
5921
+ /**
5922
+ * get jwks
5923
+ * @param {*} [options] Override http request option.
5924
+ * @throws {RequiredError}
5925
+ */
5926
+ getCredSubmitJwks(options?: any): AxiosPromise<void>;
5927
+ /**
5928
+ * get payment jwks
5929
+ * @param {*} [options] Override http request option.
5930
+ * @throws {RequiredError}
5931
+ */
5932
+ getPaymentsJwks(options?: any): AxiosPromise<GetJWKSResponse>;
4724
5933
  };
4725
5934
  /**
4726
5935
  * PublicApi - interface
@@ -4748,6 +5957,20 @@ export interface PublicApiInterface {
4748
5957
  * @memberof PublicApiInterface
4749
5958
  */
4750
5959
  generateCustomerAccessToken(tokenRequest?: TokenRequest, options?: AxiosRequestConfig): AxiosPromise<TokenResponse>;
5960
+ /**
5961
+ * get jwks
5962
+ * @param {*} [options] Override http request option.
5963
+ * @throws {RequiredError}
5964
+ * @memberof PublicApiInterface
5965
+ */
5966
+ getCredSubmitJwks(options?: AxiosRequestConfig): AxiosPromise<void>;
5967
+ /**
5968
+ * get payment jwks
5969
+ * @param {*} [options] Override http request option.
5970
+ * @throws {RequiredError}
5971
+ * @memberof PublicApiInterface
5972
+ */
5973
+ getPaymentsJwks(options?: AxiosRequestConfig): AxiosPromise<GetJWKSResponse>;
4751
5974
  }
4752
5975
  /**
4753
5976
  * PublicApi - object-oriented interface
@@ -4776,4 +5999,18 @@ export declare class PublicApi extends BaseAPI implements PublicApiInterface {
4776
5999
  * @memberof PublicApi
4777
6000
  */
4778
6001
  generateCustomerAccessToken(tokenRequest?: TokenRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TokenResponse>>;
6002
+ /**
6003
+ * get jwks
6004
+ * @param {*} [options] Override http request option.
6005
+ * @throws {RequiredError}
6006
+ * @memberof PublicApi
6007
+ */
6008
+ getCredSubmitJwks(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void>>;
6009
+ /**
6010
+ * get payment jwks
6011
+ * @param {*} [options] Override http request option.
6012
+ * @throws {RequiredError}
6013
+ * @memberof PublicApi
6014
+ */
6015
+ getPaymentsJwks(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetJWKSResponse>>;
4779
6016
  }