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