@finverse/sdk-typescript 0.0.38 → 0.0.41

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/dist/api.d.ts +370 -198
  2. package/dist/api.js +255 -153
  3. package/package.json +1 -1
package/dist/api.d.ts CHANGED
@@ -412,6 +412,69 @@ export interface CreateCustomerResponse {
412
412
  */
413
413
  webhook_uris?: Array<string>;
414
414
  }
415
+ /**
416
+ *
417
+ * @export
418
+ * @interface CreateMandateRequest
419
+ */
420
+ export interface CreateMandateRequest {
421
+ /**
422
+ *
423
+ * @type {MandateRecipient}
424
+ * @memberof CreateMandateRequest
425
+ */
426
+ recipient: MandateRecipient;
427
+ /**
428
+ *
429
+ * @type {CreateMandateSender}
430
+ * @memberof CreateMandateRequest
431
+ */
432
+ sender: CreateMandateSender;
433
+ /**
434
+ *
435
+ * @type {MandateDetails}
436
+ * @memberof CreateMandateRequest
437
+ */
438
+ mandate_details: MandateDetails;
439
+ }
440
+ /**
441
+ *
442
+ * @export
443
+ * @interface CreateMandateResponse
444
+ */
445
+ export interface CreateMandateResponse {
446
+ /**
447
+ * Finverse Mandate ID
448
+ * @type {string}
449
+ * @memberof CreateMandateResponse
450
+ */
451
+ mandate_id?: string;
452
+ }
453
+ /**
454
+ *
455
+ * @export
456
+ * @interface CreateMandateSender
457
+ */
458
+ export interface CreateMandateSender {
459
+ /**
460
+ *
461
+ * @type {string}
462
+ * @memberof CreateMandateSender
463
+ */
464
+ name?: string;
465
+ /**
466
+ * Customer App\'s user ID, representing the end-user making the payment.
467
+ * @type {string}
468
+ * @memberof CreateMandateSender
469
+ */
470
+ user_id: string;
471
+ /**
472
+ * Customer App\'s reference ID, representing the sender\'s account or billing reference number.
473
+ * @type {string}
474
+ * @memberof CreateMandateSender
475
+ */
476
+ sender_reference_id?: string;
477
+ }
415
478
  /**
416
479
  *
417
480
  * @export
@@ -425,6 +488,49 @@ export interface CreatePaymentInstructionResponse {
425
488
  */
426
489
  payment_instruction_id?: string;
427
490
  }
491
+ /**
492
+ *
493
+ * @export
494
+ * @interface CreatePaymentRequest
495
+ */
496
+ export interface CreatePaymentRequest {
497
+ /**
498
+ * 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.
499
+ * @type {number}
500
+ * @memberof CreatePaymentRequest
501
+ */
502
+ amount: number;
503
+ /**
504
+ * Indicates whether this is a mandate-based payment or one-off direct payment to an account. Possible values - MANDATE, SINGLE
505
+ * @type {string}
506
+ * @memberof CreatePaymentRequest
507
+ */
508
+ type: CreatePaymentRequestTypeEnum;
509
+ /**
510
+ *
511
+ * @type {PaymentDetails2}
512
+ * @memberof CreatePaymentRequest
513
+ */
514
+ payment_details: PaymentDetails2;
515
+ }
516
+ export declare const CreatePaymentRequestTypeEnum: {
517
+ readonly Mandate: "MANDATE";
518
+ readonly Single: "SINGLE";
519
+ };
520
+ export declare type CreatePaymentRequestTypeEnum = typeof CreatePaymentRequestTypeEnum[keyof typeof CreatePaymentRequestTypeEnum];
521
+ /**
522
+ *
523
+ * @export
524
+ * @interface CreatePaymentResponse
525
+ */
526
+ export interface CreatePaymentResponse {
527
+ /**
528
+ * Finverse Payment ID
529
+ * @type {string}
530
+ * @memberof CreatePaymentResponse
531
+ */
532
+ payment_id?: string;
533
+ }
428
534
  /**
429
535
  *
430
536
  * @export
@@ -783,6 +889,56 @@ export interface GetLoginIdentityHistoryResponse {
783
889
  */
784
890
  status_history?: Array<LoginIdentityStatusDetails>;
785
891
  }
892
+ /**
893
+ *
894
+ * @export
895
+ * @interface GetMandateResponse
896
+ */
897
+ export interface GetMandateResponse {
898
+ /**
899
+ * Timestamp in ISO format (YYYY-MM-DDTHH:MM:SS.SSSZ)
900
+ * @type {string}
901
+ * @memberof GetMandateResponse
902
+ */
903
+ last_update: string;
904
+ /**
905
+ * Finverse Mandate ID (ULID)
906
+ * @type {string}
907
+ * @memberof GetMandateResponse
908
+ */
909
+ mandate_id: string;
910
+ /**
911
+ * Mandate status
912
+ * @type {string}
913
+ * @memberof GetMandateResponse
914
+ */
915
+ mandate_status: GetMandateResponseMandateStatusEnum;
916
+ /**
917
+ *
918
+ * @type {MandateRecipient}
919
+ * @memberof GetMandateResponse
920
+ */
921
+ recipient: MandateRecipient;
922
+ /**
923
+ *
924
+ * @type {GetMandateSender}
925
+ * @memberof GetMandateResponse
926
+ */
927
+ sender: GetMandateSender;
928
+ /**
929
+ *
930
+ * @type {MandateDetails}
931
+ * @memberof GetMandateResponse
932
+ */
933
+ mandate_details: MandateDetails;
934
+ }
935
+ export declare const GetMandateResponseMandateStatusEnum: {
936
+ readonly Created: "CREATED";
937
+ readonly Used: "USED";
938
+ readonly Submitted: "SUBMITTED";
939
+ readonly Error: "ERROR";
940
+ };
941
+ export declare type GetMandateResponseMandateStatusEnum = typeof GetMandateResponseMandateStatusEnum[keyof typeof GetMandateResponseMandateStatusEnum];
786
942
  /**
787
943
  *
788
944
  * @export
@@ -817,66 +973,68 @@ export interface GetMandateSender {
817
973
  /**
818
974
  *
819
975
  * @export
820
- * @interface GetMandatesResponse
976
+ * @interface GetPaymentInstructionsResponse
821
977
  */
822
- export interface GetMandatesResponse {
978
+ export interface GetPaymentInstructionsResponse {
823
979
  /**
824
- * Timestamp in ISO format (YYYY-MM-DDTHH:MM:SS.SSSZ)
825
- * @type {string}
826
- * @memberof GetMandatesResponse
980
+ *
981
+ * @type {PaymentInstruction}
982
+ * @memberof GetPaymentInstructionsResponse
827
983
  */
828
- last_update: string;
984
+ payment_instruction?: PaymentInstruction;
985
+ }
986
+ /**
987
+ *
988
+ * @export
989
+ * @interface GetPaymentResponse
990
+ */
991
+ export interface GetPaymentResponse {
829
992
  /**
830
- * Finverse Mandate ID (ULID)
993
+ * Finverse Payment ID
831
994
  * @type {string}
832
- * @memberof GetMandatesResponse
995
+ * @memberof GetPaymentResponse
833
996
  */
834
- mandate_id: string;
997
+ payment_id?: string;
835
998
  /**
836
- * Mandate status
837
- * @type {string}
838
- * @memberof GetMandatesResponse
999
+ * 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.
1000
+ * @type {number}
1001
+ * @memberof GetPaymentResponse
839
1002
  */
840
- mandate_status: GetMandatesResponseMandateStatusEnum;
1003
+ amount?: number;
841
1004
  /**
842
- *
843
- * @type {MandateRecipient}
844
- * @memberof GetMandatesResponse
1005
+ * Indicates whether this is a mandate-based payment or one-off direct payment to an account. Possible values - MANDATE, SINGLE
1006
+ * @type {string}
1007
+ * @memberof GetPaymentResponse
845
1008
  */
846
- recipient: MandateRecipient;
1009
+ type?: GetPaymentResponseTypeEnum;
847
1010
  /**
848
- *
849
- * @type {GetMandateSender}
850
- * @memberof GetMandatesResponse
1011
+ * Possible values - CREATED, AUTHORIZED, SUBMITTED, EXECUTED, FAILED, REJECTED, CANCELLED.
1012
+ * @type {string}
1013
+ * @memberof GetPaymentResponse
851
1014
  */
852
- sender: GetMandateSender;
1015
+ status?: GetPaymentResponseStatusEnum;
853
1016
  /**
854
1017
  *
855
- * @type {MandateDetails}
856
- * @memberof GetMandatesResponse
1018
+ * @type {PaymentDetails2}
1019
+ * @memberof GetPaymentResponse
857
1020
  */
858
- mandate_details: MandateDetails;
1021
+ payment_details?: PaymentDetails2;
859
1022
  }
860
- export declare const GetMandatesResponseMandateStatusEnum: {
1023
+ export declare const GetPaymentResponseTypeEnum: {
1024
+ readonly Mandate: "MANDATE";
1025
+ readonly Single: "SINGLE";
1026
+ };
1027
+ export declare type GetPaymentResponseTypeEnum = typeof GetPaymentResponseTypeEnum[keyof typeof GetPaymentResponseTypeEnum];
1028
+ export declare const GetPaymentResponseStatusEnum: {
861
1029
  readonly Created: "CREATED";
862
- readonly Used: "USED";
1030
+ readonly Authorized: "AUTHORIZED";
863
1031
  readonly Submitted: "SUBMITTED";
864
- readonly Error: "ERROR";
1032
+ readonly Executed: "EXECUTED";
1033
+ readonly Failed: "FAILED";
1034
+ readonly Rejected: "REJECTED";
1035
+ readonly Cancelled: "CANCELLED";
865
1036
  };
866
- export declare type GetMandatesResponseMandateStatusEnum = typeof GetMandatesResponseMandateStatusEnum[keyof typeof GetMandatesResponseMandateStatusEnum];
867
- /**
868
- *
869
- * @export
870
- * @interface GetPaymentInstructionsResponse
871
- */
872
- export interface GetPaymentInstructionsResponse {
873
- /**
874
- *
875
- * @type {PaymentInstruction}
876
- * @memberof GetPaymentInstructionsResponse
877
- */
878
- payment_instruction?: PaymentInstruction;
879
- }
1037
+ export declare type GetPaymentResponseStatusEnum = typeof GetPaymentResponseStatusEnum[keyof typeof GetPaymentResponseStatusEnum];
880
1038
  /**
881
1039
  *
882
1040
  * @export
@@ -2244,6 +2402,31 @@ export interface PaymentDetails {
2244
2402
  */
2245
2403
  other_info?: OtherInfo;
2246
2404
  }
2405
+ /**
2406
+ *
2407
+ * @export
2408
+ * @interface PaymentDetails2
2409
+ */
2410
+ export interface PaymentDetails2 {
2411
+ /**
2412
+ * The transaction description provided to banks, which banks will show to their customers.
2413
+ * @type {string}
2414
+ * @memberof PaymentDetails2
2415
+ */
2416
+ description?: string;
2417
+ /**
2418
+ * ID of the mandate this pament is referring to.
2419
+ * @type {string}
2420
+ * @memberof PaymentDetails2
2421
+ */
2422
+ mandate_id: string;
2423
+ /**
2424
+ * Customer\'s ID for this transaction
2425
+ * @type {string}
2426
+ * @memberof PaymentDetails2
2427
+ */
2428
+ transaction_reference_id?: string;
2429
+ }
2247
2430
  /**
2248
2431
  *
2249
2432
  * @export
@@ -2396,69 +2579,6 @@ export declare const PaymentScheduleFrequencyEnum: {
2396
2579
  readonly Yearly: "YEARLY";
2397
2580
  };
2398
2581
  export declare type PaymentScheduleFrequencyEnum = typeof PaymentScheduleFrequencyEnum[keyof typeof PaymentScheduleFrequencyEnum];
2399
- /**
2400
- *
2401
- * @export
2402
- * @interface PostMandateSender
2403
- */
2404
- export interface PostMandateSender {
2405
- /**
2406
- *
2407
- * @type {string}
2408
- * @memberof PostMandateSender
2409
- */
2410
- name?: string;
2411
- /**
2412
- * Customer App\'s user ID, representing the end-user making the payment.
2413
- * @type {string}
2414
- * @memberof PostMandateSender
2415
- */
2416
- user_id: string;
2417
- /**
2418
- * Customer App\'s reference ID, representing the sender\'s account or billing reference number.
2419
- * @type {string}
2420
- * @memberof PostMandateSender
2421
- */
2422
- sender_reference_id?: string;
2423
- }
2424
- /**
2425
- *
2426
- * @export
2427
- * @interface PostMandatesRequest
2428
- */
2429
- export interface PostMandatesRequest {
2430
- /**
2431
- *
2432
- * @type {MandateRecipient}
2433
- * @memberof PostMandatesRequest
2434
- */
2435
- recipient: MandateRecipient;
2436
- /**
2437
- *
2438
- * @type {PostMandateSender}
2439
- * @memberof PostMandatesRequest
2440
- */
2441
- sender: PostMandateSender;
2442
- /**
2443
- *
2444
- * @type {MandateDetails}
2445
- * @memberof PostMandatesRequest
2446
- */
2447
- mandate_details: MandateDetails;
2448
- }
2449
- /**
2450
- *
2451
- * @export
2452
- * @interface PostMandatesResponse
2453
- */
2454
- export interface PostMandatesResponse {
2455
- /**
2456
- * Finverse Mandate ID
2457
- * @type {string}
2458
- * @memberof PostMandatesResponse
2459
- */
2460
- mandate_id?: string;
2461
- }
2462
2582
  /**
2463
2583
  *
2464
2584
  * @export
@@ -2905,6 +3025,20 @@ export declare type TransactionLimitsPeriodEnum = typeof TransactionLimitsPeriod
2905
3025
  * @export
2906
3026
  */
2907
3027
  export declare const CustomerApiAxiosParamCreator: (configuration?: Configuration) => {
3028
+ /**
3029
+ * CREATE Mandate
3030
+ * @param {CreateMandateRequest} createMandateRequest request body for creating mandate
3031
+ * @param {*} [options] Override http request option.
3032
+ * @throws {RequiredError}
3033
+ */
3034
+ createMandate: (createMandateRequest: CreateMandateRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3035
+ /**
3036
+ * Create new Payment
3037
+ * @param {CreatePaymentRequest} createPaymentRequest request body for creating payment
3038
+ * @param {*} [options] Override http request option.
3039
+ * @throws {RequiredError}
3040
+ */
3041
+ createPayment: (createPaymentRequest: CreatePaymentRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
2908
3042
  /**
2909
3043
  * Create a new payment instruction to be used when linking to perform new payment
2910
3044
  * @param {CustomerPaymentInstruction} paymentInstruction Request body for starting a new Link
@@ -2941,12 +3075,19 @@ export declare const CustomerApiAxiosParamCreator: (configuration?: Configuratio
2941
3075
  */
2942
3076
  getLoginIdentityHistory: (loginIdentityId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
2943
3077
  /**
2944
- * Get Mandates details by mandate_id
3078
+ * Get Mandate details by mandate_id
2945
3079
  * @param {string} mandateId mandate id
2946
3080
  * @param {*} [options] Override http request option.
2947
3081
  * @throws {RequiredError}
2948
3082
  */
2949
- getMandates: (mandateId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3083
+ getMandate: (mandateId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3084
+ /**
3085
+ * Get Payment details by payment_id
3086
+ * @param {string} paymentId payment id
3087
+ * @param {*} [options] Override http request option.
3088
+ * @throws {RequiredError}
3089
+ */
3090
+ getPayment: (paymentId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
2950
3091
  /**
2951
3092
  * Get payment instructions by payment_instruction_id
2952
3093
  * @param {string} paymentInstructionId The id of a payment instruction
@@ -2964,13 +3105,6 @@ export declare const CustomerApiAxiosParamCreator: (configuration?: Configuratio
2964
3105
  * @throws {RequiredError}
2965
3106
  */
2966
3107
  listInstitutions: (country?: string, countries?: Array<string>, productsSupported?: string, institutionType?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
2967
- /**
2968
- * CREATE Mandates
2969
- * @param {PostMandatesRequest} postMandatesRequest request body for creating mandate
2970
- * @param {*} [options] Override http request option.
2971
- * @throws {RequiredError}
2972
- */
2973
- postMandates: (postMandatesRequest: PostMandatesRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
2974
3108
  /**
2975
3109
  * Refresh an access token
2976
3110
  * @param {RefreshRequest} refreshRequest The refresh token
@@ -2984,6 +3118,20 @@ export declare const CustomerApiAxiosParamCreator: (configuration?: Configuratio
2984
3118
  * @export
2985
3119
  */
2986
3120
  export declare const CustomerApiFp: (configuration?: Configuration) => {
3121
+ /**
3122
+ * CREATE Mandate
3123
+ * @param {CreateMandateRequest} createMandateRequest request body for creating mandate
3124
+ * @param {*} [options] Override http request option.
3125
+ * @throws {RequiredError}
3126
+ */
3127
+ createMandate(createMandateRequest: CreateMandateRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateMandateResponse>>;
3128
+ /**
3129
+ * Create new Payment
3130
+ * @param {CreatePaymentRequest} createPaymentRequest request body for creating payment
3131
+ * @param {*} [options] Override http request option.
3132
+ * @throws {RequiredError}
3133
+ */
3134
+ createPayment(createPaymentRequest: CreatePaymentRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePaymentResponse>>;
2987
3135
  /**
2988
3136
  * Create a new payment instruction to be used when linking to perform new payment
2989
3137
  * @param {CustomerPaymentInstruction} paymentInstruction Request body for starting a new Link
@@ -3020,12 +3168,19 @@ export declare const CustomerApiFp: (configuration?: Configuration) => {
3020
3168
  */
3021
3169
  getLoginIdentityHistory(loginIdentityId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetLoginIdentityHistoryResponse>>;
3022
3170
  /**
3023
- * Get Mandates details by mandate_id
3171
+ * Get Mandate details by mandate_id
3024
3172
  * @param {string} mandateId mandate id
3025
3173
  * @param {*} [options] Override http request option.
3026
3174
  * @throws {RequiredError}
3027
3175
  */
3028
- getMandates(mandateId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetMandatesResponse>>;
3176
+ getMandate(mandateId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetMandateResponse>>;
3177
+ /**
3178
+ * Get Payment details by payment_id
3179
+ * @param {string} paymentId payment id
3180
+ * @param {*} [options] Override http request option.
3181
+ * @throws {RequiredError}
3182
+ */
3183
+ getPayment(paymentId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPaymentResponse>>;
3029
3184
  /**
3030
3185
  * Get payment instructions by payment_instruction_id
3031
3186
  * @param {string} paymentInstructionId The id of a payment instruction
@@ -3043,13 +3198,6 @@ export declare const CustomerApiFp: (configuration?: Configuration) => {
3043
3198
  * @throws {RequiredError}
3044
3199
  */
3045
3200
  listInstitutions(country?: string, countries?: Array<string>, productsSupported?: string, institutionType?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Institution>>>;
3046
- /**
3047
- * CREATE Mandates
3048
- * @param {PostMandatesRequest} postMandatesRequest request body for creating mandate
3049
- * @param {*} [options] Override http request option.
3050
- * @throws {RequiredError}
3051
- */
3052
- postMandates(postMandatesRequest: PostMandatesRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostMandatesResponse>>;
3053
3201
  /**
3054
3202
  * Refresh an access token
3055
3203
  * @param {RefreshRequest} refreshRequest The refresh token
@@ -3063,6 +3211,20 @@ export declare const CustomerApiFp: (configuration?: Configuration) => {
3063
3211
  * @export
3064
3212
  */
3065
3213
  export declare const CustomerApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
3214
+ /**
3215
+ * CREATE Mandate
3216
+ * @param {CreateMandateRequest} createMandateRequest request body for creating mandate
3217
+ * @param {*} [options] Override http request option.
3218
+ * @throws {RequiredError}
3219
+ */
3220
+ createMandate(createMandateRequest: CreateMandateRequest, options?: any): AxiosPromise<CreateMandateResponse>;
3221
+ /**
3222
+ * Create new Payment
3223
+ * @param {CreatePaymentRequest} createPaymentRequest request body for creating payment
3224
+ * @param {*} [options] Override http request option.
3225
+ * @throws {RequiredError}
3226
+ */
3227
+ createPayment(createPaymentRequest: CreatePaymentRequest, options?: any): AxiosPromise<CreatePaymentResponse>;
3066
3228
  /**
3067
3229
  * Create a new payment instruction to be used when linking to perform new payment
3068
3230
  * @param {CustomerPaymentInstruction} paymentInstruction Request body for starting a new Link
@@ -3099,12 +3261,19 @@ export declare const CustomerApiFactory: (configuration?: Configuration, basePat
3099
3261
  */
3100
3262
  getLoginIdentityHistory(loginIdentityId: string, options?: any): AxiosPromise<GetLoginIdentityHistoryResponse>;
3101
3263
  /**
3102
- * Get Mandates details by mandate_id
3264
+ * Get Mandate details by mandate_id
3103
3265
  * @param {string} mandateId mandate id
3104
3266
  * @param {*} [options] Override http request option.
3105
3267
  * @throws {RequiredError}
3106
3268
  */
3107
- getMandates(mandateId: string, options?: any): AxiosPromise<GetMandatesResponse>;
3269
+ getMandate(mandateId: string, options?: any): AxiosPromise<GetMandateResponse>;
3270
+ /**
3271
+ * Get Payment details by payment_id
3272
+ * @param {string} paymentId payment id
3273
+ * @param {*} [options] Override http request option.
3274
+ * @throws {RequiredError}
3275
+ */
3276
+ getPayment(paymentId: string, options?: any): AxiosPromise<GetPaymentResponse>;
3108
3277
  /**
3109
3278
  * Get payment instructions by payment_instruction_id
3110
3279
  * @param {string} paymentInstructionId The id of a payment instruction
@@ -3122,13 +3291,6 @@ export declare const CustomerApiFactory: (configuration?: Configuration, basePat
3122
3291
  * @throws {RequiredError}
3123
3292
  */
3124
3293
  listInstitutions(country?: string, countries?: Array<string>, productsSupported?: string, institutionType?: string, options?: any): AxiosPromise<Array<Institution>>;
3125
- /**
3126
- * CREATE Mandates
3127
- * @param {PostMandatesRequest} postMandatesRequest request body for creating mandate
3128
- * @param {*} [options] Override http request option.
3129
- * @throws {RequiredError}
3130
- */
3131
- postMandates(postMandatesRequest: PostMandatesRequest, options?: any): AxiosPromise<PostMandatesResponse>;
3132
3294
  /**
3133
3295
  * Refresh an access token
3134
3296
  * @param {RefreshRequest} refreshRequest The refresh token
@@ -3143,6 +3305,22 @@ export declare const CustomerApiFactory: (configuration?: Configuration, basePat
3143
3305
  * @interface CustomerApi
3144
3306
  */
3145
3307
  export interface CustomerApiInterface {
3308
+ /**
3309
+ * CREATE Mandate
3310
+ * @param {CreateMandateRequest} createMandateRequest request body for creating mandate
3311
+ * @param {*} [options] Override http request option.
3312
+ * @throws {RequiredError}
3313
+ * @memberof CustomerApiInterface
3314
+ */
3315
+ createMandate(createMandateRequest: CreateMandateRequest, options?: AxiosRequestConfig): AxiosPromise<CreateMandateResponse>;
3316
+ /**
3317
+ * Create new Payment
3318
+ * @param {CreatePaymentRequest} createPaymentRequest request body for creating payment
3319
+ * @param {*} [options] Override http request option.
3320
+ * @throws {RequiredError}
3321
+ * @memberof CustomerApiInterface
3322
+ */
3323
+ createPayment(createPaymentRequest: CreatePaymentRequest, options?: AxiosRequestConfig): AxiosPromise<CreatePaymentResponse>;
3146
3324
  /**
3147
3325
  * Create a new payment instruction to be used when linking to perform new payment
3148
3326
  * @param {CustomerPaymentInstruction} paymentInstruction Request body for starting a new Link
@@ -3184,13 +3362,21 @@ export interface CustomerApiInterface {
3184
3362
  */
3185
3363
  getLoginIdentityHistory(loginIdentityId: string, options?: AxiosRequestConfig): AxiosPromise<GetLoginIdentityHistoryResponse>;
3186
3364
  /**
3187
- * Get Mandates details by mandate_id
3365
+ * Get Mandate details by mandate_id
3188
3366
  * @param {string} mandateId mandate id
3189
3367
  * @param {*} [options] Override http request option.
3190
3368
  * @throws {RequiredError}
3191
3369
  * @memberof CustomerApiInterface
3192
3370
  */
3193
- getMandates(mandateId: string, options?: AxiosRequestConfig): AxiosPromise<GetMandatesResponse>;
3371
+ getMandate(mandateId: string, options?: AxiosRequestConfig): AxiosPromise<GetMandateResponse>;
3372
+ /**
3373
+ * Get Payment details by payment_id
3374
+ * @param {string} paymentId payment id
3375
+ * @param {*} [options] Override http request option.
3376
+ * @throws {RequiredError}
3377
+ * @memberof CustomerApiInterface
3378
+ */
3379
+ getPayment(paymentId: string, options?: AxiosRequestConfig): AxiosPromise<GetPaymentResponse>;
3194
3380
  /**
3195
3381
  * Get payment instructions by payment_instruction_id
3196
3382
  * @param {string} paymentInstructionId The id of a payment instruction
@@ -3210,14 +3396,6 @@ export interface CustomerApiInterface {
3210
3396
  * @memberof CustomerApiInterface
3211
3397
  */
3212
3398
  listInstitutions(country?: string, countries?: Array<string>, productsSupported?: string, institutionType?: string, options?: AxiosRequestConfig): AxiosPromise<Array<Institution>>;
3213
- /**
3214
- * CREATE Mandates
3215
- * @param {PostMandatesRequest} postMandatesRequest request body for creating mandate
3216
- * @param {*} [options] Override http request option.
3217
- * @throws {RequiredError}
3218
- * @memberof CustomerApiInterface
3219
- */
3220
- postMandates(postMandatesRequest: PostMandatesRequest, options?: AxiosRequestConfig): AxiosPromise<PostMandatesResponse>;
3221
3399
  /**
3222
3400
  * Refresh an access token
3223
3401
  * @param {RefreshRequest} refreshRequest The refresh token
@@ -3234,6 +3412,22 @@ export interface CustomerApiInterface {
3234
3412
  * @extends {BaseAPI}
3235
3413
  */
3236
3414
  export declare class CustomerApi extends BaseAPI implements CustomerApiInterface {
3415
+ /**
3416
+ * CREATE Mandate
3417
+ * @param {CreateMandateRequest} createMandateRequest request body for creating mandate
3418
+ * @param {*} [options] Override http request option.
3419
+ * @throws {RequiredError}
3420
+ * @memberof CustomerApi
3421
+ */
3422
+ createMandate(createMandateRequest: CreateMandateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateMandateResponse>>;
3423
+ /**
3424
+ * Create new Payment
3425
+ * @param {CreatePaymentRequest} createPaymentRequest request body for creating payment
3426
+ * @param {*} [options] Override http request option.
3427
+ * @throws {RequiredError}
3428
+ * @memberof CustomerApi
3429
+ */
3430
+ createPayment(createPaymentRequest: CreatePaymentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePaymentResponse>>;
3237
3431
  /**
3238
3432
  * Create a new payment instruction to be used when linking to perform new payment
3239
3433
  * @param {CustomerPaymentInstruction} paymentInstruction Request body for starting a new Link
@@ -3275,13 +3469,21 @@ export declare class CustomerApi extends BaseAPI implements CustomerApiInterface
3275
3469
  */
3276
3470
  getLoginIdentityHistory(loginIdentityId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetLoginIdentityHistoryResponse>>;
3277
3471
  /**
3278
- * Get Mandates details by mandate_id
3472
+ * Get Mandate details by mandate_id
3279
3473
  * @param {string} mandateId mandate id
3280
3474
  * @param {*} [options] Override http request option.
3281
3475
  * @throws {RequiredError}
3282
3476
  * @memberof CustomerApi
3283
3477
  */
3284
- getMandates(mandateId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMandatesResponse>>;
3478
+ getMandate(mandateId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMandateResponse>>;
3479
+ /**
3480
+ * Get Payment details by payment_id
3481
+ * @param {string} paymentId payment id
3482
+ * @param {*} [options] Override http request option.
3483
+ * @throws {RequiredError}
3484
+ * @memberof CustomerApi
3485
+ */
3486
+ getPayment(paymentId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPaymentResponse>>;
3285
3487
  /**
3286
3488
  * Get payment instructions by payment_instruction_id
3287
3489
  * @param {string} paymentInstructionId The id of a payment instruction
@@ -3301,14 +3503,6 @@ export declare class CustomerApi extends BaseAPI implements CustomerApiInterface
3301
3503
  * @memberof CustomerApi
3302
3504
  */
3303
3505
  listInstitutions(country?: string, countries?: Array<string>, productsSupported?: string, institutionType?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Institution[]>>;
3304
- /**
3305
- * CREATE Mandates
3306
- * @param {PostMandatesRequest} postMandatesRequest request body for creating mandate
3307
- * @param {*} [options] Override http request option.
3308
- * @throws {RequiredError}
3309
- * @memberof CustomerApi
3310
- */
3311
- postMandates(postMandatesRequest: PostMandatesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PostMandatesResponse>>;
3312
3506
  /**
3313
3507
  * Refresh an access token
3314
3508
  * @param {RefreshRequest} refreshRequest The refresh token
@@ -3602,16 +3796,11 @@ export declare const LoginIdentityApiAxiosParamCreator: (configuration?: Configu
3602
3796
  getBalanceHistory: (accountId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3603
3797
  /**
3604
3798
  * Download composite statement
3799
+ * @param {boolean} [redirect] when true, response will be http redirect; otherwise it will be json response with the download link
3605
3800
  * @param {*} [options] Override http request option.
3606
3801
  * @throws {RequiredError}
3607
3802
  */
3608
- getCompositeStatement: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
3609
- /**
3610
- * Get composite statement link for download
3611
- * @param {*} [options] Override http request option.
3612
- * @throws {RequiredError}
3613
- */
3614
- getCompositeStatementLink: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
3803
+ getCompositeStatement: (redirect?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3615
3804
  /**
3616
3805
  * \\[BETA] Get a list of identity data for a given login identity
3617
3806
  * @param {*} [options] Override http request option.
@@ -3633,12 +3822,13 @@ export declare const LoginIdentityApiAxiosParamCreator: (configuration?: Configu
3633
3822
  /**
3634
3823
  * Download statement
3635
3824
  * @param {string} statementId The statement id
3825
+ * @param {boolean} [redirect] when true, response will be http redirect; otherwise it will be json response with the download link
3636
3826
  * @param {*} [options] Override http request option.
3637
3827
  * @throws {RequiredError}
3638
3828
  */
3639
- getStatement: (statementId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3829
+ getStatement: (statementId: string, redirect?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3640
3830
  /**
3641
- * Get statement link for download
3831
+ * (Deprecated) Get statement link for download
3642
3832
  * @param {string} statementId The statement id
3643
3833
  * @param {*} [options] Override http request option.
3644
3834
  * @throws {RequiredError}
@@ -3721,16 +3911,11 @@ export declare const LoginIdentityApiFp: (configuration?: Configuration) => {
3721
3911
  getBalanceHistory(accountId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetBalanceHistoryResponse>>;
3722
3912
  /**
3723
3913
  * Download composite statement
3914
+ * @param {boolean} [redirect] when true, response will be http redirect; otherwise it will be json response with the download link
3724
3915
  * @param {*} [options] Override http request option.
3725
3916
  * @throws {RequiredError}
3726
3917
  */
3727
- getCompositeStatement(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
3728
- /**
3729
- * Get composite statement link for download
3730
- * @param {*} [options] Override http request option.
3731
- * @throws {RequiredError}
3732
- */
3733
- getCompositeStatementLink(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CompositeStatementLink>>;
3918
+ getCompositeStatement(redirect?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CompositeStatementLink>>;
3734
3919
  /**
3735
3920
  * \\[BETA] Get a list of identity data for a given login identity
3736
3921
  * @param {*} [options] Override http request option.
@@ -3752,12 +3937,13 @@ export declare const LoginIdentityApiFp: (configuration?: Configuration) => {
3752
3937
  /**
3753
3938
  * Download statement
3754
3939
  * @param {string} statementId The statement id
3940
+ * @param {boolean} [redirect] when true, response will be http redirect; otherwise it will be json response with the download link
3755
3941
  * @param {*} [options] Override http request option.
3756
3942
  * @throws {RequiredError}
3757
3943
  */
3758
- getStatement(statementId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
3944
+ getStatement(statementId: string, redirect?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStatementLinkResponse>>;
3759
3945
  /**
3760
- * Get statement link for download
3946
+ * (Deprecated) Get statement link for download
3761
3947
  * @param {string} statementId The statement id
3762
3948
  * @param {*} [options] Override http request option.
3763
3949
  * @throws {RequiredError}
@@ -3840,16 +4026,11 @@ export declare const LoginIdentityApiFactory: (configuration?: Configuration, ba
3840
4026
  getBalanceHistory(accountId: string, options?: any): AxiosPromise<GetBalanceHistoryResponse>;
3841
4027
  /**
3842
4028
  * Download composite statement
4029
+ * @param {boolean} [redirect] when true, response will be http redirect; otherwise it will be json response with the download link
3843
4030
  * @param {*} [options] Override http request option.
3844
4031
  * @throws {RequiredError}
3845
4032
  */
3846
- getCompositeStatement(options?: any): AxiosPromise<void>;
3847
- /**
3848
- * Get composite statement link for download
3849
- * @param {*} [options] Override http request option.
3850
- * @throws {RequiredError}
3851
- */
3852
- getCompositeStatementLink(options?: any): AxiosPromise<CompositeStatementLink>;
4033
+ getCompositeStatement(redirect?: boolean, options?: any): AxiosPromise<CompositeStatementLink>;
3853
4034
  /**
3854
4035
  * \\[BETA] Get a list of identity data for a given login identity
3855
4036
  * @param {*} [options] Override http request option.
@@ -3871,12 +4052,13 @@ export declare const LoginIdentityApiFactory: (configuration?: Configuration, ba
3871
4052
  /**
3872
4053
  * Download statement
3873
4054
  * @param {string} statementId The statement id
4055
+ * @param {boolean} [redirect] when true, response will be http redirect; otherwise it will be json response with the download link
3874
4056
  * @param {*} [options] Override http request option.
3875
4057
  * @throws {RequiredError}
3876
4058
  */
3877
- getStatement(statementId: string, options?: any): AxiosPromise<void>;
4059
+ getStatement(statementId: string, redirect?: boolean, options?: any): AxiosPromise<GetStatementLinkResponse>;
3878
4060
  /**
3879
- * Get statement link for download
4061
+ * (Deprecated) Get statement link for download
3880
4062
  * @param {string} statementId The statement id
3881
4063
  * @param {*} [options] Override http request option.
3882
4064
  * @throws {RequiredError}
@@ -3965,18 +4147,12 @@ export interface LoginIdentityApiInterface {
3965
4147
  getBalanceHistory(accountId: string, options?: AxiosRequestConfig): AxiosPromise<GetBalanceHistoryResponse>;
3966
4148
  /**
3967
4149
  * Download composite statement
4150
+ * @param {boolean} [redirect] when true, response will be http redirect; otherwise it will be json response with the download link
3968
4151
  * @param {*} [options] Override http request option.
3969
4152
  * @throws {RequiredError}
3970
4153
  * @memberof LoginIdentityApiInterface
3971
4154
  */
3972
- getCompositeStatement(options?: AxiosRequestConfig): AxiosPromise<void>;
3973
- /**
3974
- * Get composite statement link for download
3975
- * @param {*} [options] Override http request option.
3976
- * @throws {RequiredError}
3977
- * @memberof LoginIdentityApiInterface
3978
- */
3979
- getCompositeStatementLink(options?: AxiosRequestConfig): AxiosPromise<CompositeStatementLink>;
4155
+ getCompositeStatement(redirect?: boolean, options?: AxiosRequestConfig): AxiosPromise<CompositeStatementLink>;
3980
4156
  /**
3981
4157
  * \\[BETA] Get a list of identity data for a given login identity
3982
4158
  * @param {*} [options] Override http request option.
@@ -4001,13 +4177,14 @@ export interface LoginIdentityApiInterface {
4001
4177
  /**
4002
4178
  * Download statement
4003
4179
  * @param {string} statementId The statement id
4180
+ * @param {boolean} [redirect] when true, response will be http redirect; otherwise it will be json response with the download link
4004
4181
  * @param {*} [options] Override http request option.
4005
4182
  * @throws {RequiredError}
4006
4183
  * @memberof LoginIdentityApiInterface
4007
4184
  */
4008
- getStatement(statementId: string, options?: AxiosRequestConfig): AxiosPromise<void>;
4185
+ getStatement(statementId: string, redirect?: boolean, options?: AxiosRequestConfig): AxiosPromise<GetStatementLinkResponse>;
4009
4186
  /**
4010
- * Get statement link for download
4187
+ * (Deprecated) Get statement link for download
4011
4188
  * @param {string} statementId The statement id
4012
4189
  * @param {*} [options] Override http request option.
4013
4190
  * @throws {RequiredError}
@@ -4103,18 +4280,12 @@ export declare class LoginIdentityApi extends BaseAPI implements LoginIdentityAp
4103
4280
  getBalanceHistory(accountId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetBalanceHistoryResponse>>;
4104
4281
  /**
4105
4282
  * Download composite statement
4283
+ * @param {boolean} [redirect] when true, response will be http redirect; otherwise it will be json response with the download link
4106
4284
  * @param {*} [options] Override http request option.
4107
4285
  * @throws {RequiredError}
4108
4286
  * @memberof LoginIdentityApi
4109
4287
  */
4110
- getCompositeStatement(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void>>;
4111
- /**
4112
- * Get composite statement link for download
4113
- * @param {*} [options] Override http request option.
4114
- * @throws {RequiredError}
4115
- * @memberof LoginIdentityApi
4116
- */
4117
- getCompositeStatementLink(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CompositeStatementLink>>;
4288
+ getCompositeStatement(redirect?: boolean, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CompositeStatementLink>>;
4118
4289
  /**
4119
4290
  * \\[BETA] Get a list of identity data for a given login identity
4120
4291
  * @param {*} [options] Override http request option.
@@ -4139,13 +4310,14 @@ export declare class LoginIdentityApi extends BaseAPI implements LoginIdentityAp
4139
4310
  /**
4140
4311
  * Download statement
4141
4312
  * @param {string} statementId The statement id
4313
+ * @param {boolean} [redirect] when true, response will be http redirect; otherwise it will be json response with the download link
4142
4314
  * @param {*} [options] Override http request option.
4143
4315
  * @throws {RequiredError}
4144
4316
  * @memberof LoginIdentityApi
4145
4317
  */
4146
- getStatement(statementId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void>>;
4318
+ getStatement(statementId: string, redirect?: boolean, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetStatementLinkResponse>>;
4147
4319
  /**
4148
- * Get statement link for download
4320
+ * (Deprecated) Get statement link for download
4149
4321
  * @param {string} statementId The statement id
4150
4322
  * @param {*} [options] Override http request option.
4151
4323
  * @throws {RequiredError}