@finverse/sdk-typescript 0.0.101 → 0.0.103
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 +106 -6
- package/package.json +1 -1
package/dist/api.d.ts
CHANGED
|
@@ -664,6 +664,14 @@ export interface CreateMandateRequest {
|
|
|
664
664
|
* @memberof CreateMandateRequest
|
|
665
665
|
*/
|
|
666
666
|
mandate_details: MandateDetails;
|
|
667
|
+
/**
|
|
668
|
+
* Additional attributes of the mandate in key:value format (e.g. mandate_internal_id: 1234). It supports up to 10 key:value pairs, whereas the key and value supports up to 50 and 500 characters respectively.
|
|
669
|
+
* @type {{ [key: string]: string; }}
|
|
670
|
+
* @memberof CreateMandateRequest
|
|
671
|
+
*/
|
|
672
|
+
metadata?: {
|
|
673
|
+
[key: string]: string;
|
|
674
|
+
};
|
|
667
675
|
}
|
|
668
676
|
/**
|
|
669
677
|
*
|
|
@@ -707,6 +715,14 @@ export interface CreateMandateResponse {
|
|
|
707
715
|
* @memberof CreateMandateResponse
|
|
708
716
|
*/
|
|
709
717
|
mandate_details: MandateDetails;
|
|
718
|
+
/**
|
|
719
|
+
* Additional attributes of the mandate in key:value format (e.g. mandate_internal_id: 1234). It supports up to 10 key:value pairs, whereas the key and value supports up to 50 and 500 characters respectively.
|
|
720
|
+
* @type {{ [key: string]: string; }}
|
|
721
|
+
* @memberof CreateMandateResponse
|
|
722
|
+
*/
|
|
723
|
+
metadata?: {
|
|
724
|
+
[key: string]: string;
|
|
725
|
+
};
|
|
710
726
|
/**
|
|
711
727
|
*
|
|
712
728
|
* @type {FvErrorModelV2}
|
|
@@ -809,6 +825,14 @@ export interface CreatePaymentRequest {
|
|
|
809
825
|
* @memberof CreatePaymentRequest
|
|
810
826
|
*/
|
|
811
827
|
payment_details: PaymentDetails2;
|
|
828
|
+
/**
|
|
829
|
+
* Additional attributes of the payment in key:value format (e.g. payment_internal_id: 1234). It supports up to 10 key:value pairs, whereas the key and value supports up to 50 and 500 characters respectively.
|
|
830
|
+
* @type {{ [key: string]: string; }}
|
|
831
|
+
* @memberof CreatePaymentRequest
|
|
832
|
+
*/
|
|
833
|
+
metadata?: {
|
|
834
|
+
[key: string]: string;
|
|
835
|
+
};
|
|
812
836
|
}
|
|
813
837
|
export declare const CreatePaymentRequestTypeEnum: {
|
|
814
838
|
readonly Mandate: "MANDATE";
|
|
@@ -845,6 +869,14 @@ export interface CreatePayoutInstructionRequest {
|
|
|
845
869
|
* @memberof CreatePayoutInstructionRequest
|
|
846
870
|
*/
|
|
847
871
|
recipient: MandateRecipientRequest;
|
|
872
|
+
/**
|
|
873
|
+
* Additional attributes of the payout instruction in key:value format (e.g. payout_instruction_internal_id: 1234). It supports up to 10 key:value pairs, whereas the key and value supports up to 50 and 500 characters respectively.
|
|
874
|
+
* @type {{ [key: string]: string; }}
|
|
875
|
+
* @memberof CreatePayoutInstructionRequest
|
|
876
|
+
*/
|
|
877
|
+
metadata?: {
|
|
878
|
+
[key: string]: string;
|
|
879
|
+
};
|
|
848
880
|
}
|
|
849
881
|
/**
|
|
850
882
|
*
|
|
@@ -1689,6 +1721,14 @@ export interface GetMandateResponse {
|
|
|
1689
1721
|
* @memberof GetMandateResponse
|
|
1690
1722
|
*/
|
|
1691
1723
|
error?: FvErrorModelV2;
|
|
1724
|
+
/**
|
|
1725
|
+
* Additional attributes of the mandate in key:value format (e.g. mandate_internal_id: 1234). It supports up to 10 key:value pairs, whereas the key and value supports up to 50 and 500 characters respectively.
|
|
1726
|
+
* @type {{ [key: string]: string; }}
|
|
1727
|
+
* @memberof GetMandateResponse
|
|
1728
|
+
*/
|
|
1729
|
+
metadata?: {
|
|
1730
|
+
[key: string]: string;
|
|
1731
|
+
};
|
|
1692
1732
|
}
|
|
1693
1733
|
export declare const GetMandateResponseStatusEnum: {
|
|
1694
1734
|
readonly AuthorizationRequired: "AUTHORIZATION_REQUIRED";
|
|
@@ -3795,6 +3835,14 @@ export interface PaymentResponse {
|
|
|
3795
3835
|
* @memberof PaymentResponse
|
|
3796
3836
|
*/
|
|
3797
3837
|
transaction_date?: string | null;
|
|
3838
|
+
/**
|
|
3839
|
+
* Additional attributes of the payment in key:value format (e.g. payment_internal_id: 1234). It supports up to 10 key:value pairs, whereas the key and value supports up to 50 and 500 characters respectively.
|
|
3840
|
+
* @type {{ [key: string]: string; }}
|
|
3841
|
+
* @memberof PaymentResponse
|
|
3842
|
+
*/
|
|
3843
|
+
metadata?: {
|
|
3844
|
+
[key: string]: string;
|
|
3845
|
+
};
|
|
3798
3846
|
/**
|
|
3799
3847
|
*
|
|
3800
3848
|
* @type {FvErrorModelV2}
|
|
@@ -3869,6 +3917,31 @@ export interface PayoutDetails {
|
|
|
3869
3917
|
*/
|
|
3870
3918
|
scheduled_date: string;
|
|
3871
3919
|
}
|
|
3920
|
+
/**
|
|
3921
|
+
*
|
|
3922
|
+
* @export
|
|
3923
|
+
* @interface PayoutDetailsResponse
|
|
3924
|
+
*/
|
|
3925
|
+
export interface PayoutDetailsResponse {
|
|
3926
|
+
/**
|
|
3927
|
+
* The mandate used to execute payments for this payout instruction. Currency for the mandate must be supported by the recipient account
|
|
3928
|
+
* @type {string}
|
|
3929
|
+
* @memberof PayoutDetailsResponse
|
|
3930
|
+
*/
|
|
3931
|
+
mandate_id?: string;
|
|
3932
|
+
/**
|
|
3933
|
+
* A description for the payment (that will appear as the transaction description on bank statements)
|
|
3934
|
+
* @type {string}
|
|
3935
|
+
* @memberof PayoutDetailsResponse
|
|
3936
|
+
*/
|
|
3937
|
+
description?: string;
|
|
3938
|
+
/**
|
|
3939
|
+
* YYYY-MM-DD, date (in UTC) to execute the payment, must be 1 day later than current date
|
|
3940
|
+
* @type {string}
|
|
3941
|
+
* @memberof PayoutDetailsResponse
|
|
3942
|
+
*/
|
|
3943
|
+
scheduled_date?: string;
|
|
3944
|
+
}
|
|
3872
3945
|
/**
|
|
3873
3946
|
*
|
|
3874
3947
|
* @export
|
|
@@ -3889,16 +3962,16 @@ export interface PayoutInstructionResponse {
|
|
|
3889
3962
|
currency?: string;
|
|
3890
3963
|
/**
|
|
3891
3964
|
*
|
|
3892
|
-
* @type {
|
|
3965
|
+
* @type {PayoutDetailsResponse}
|
|
3893
3966
|
* @memberof PayoutInstructionResponse
|
|
3894
3967
|
*/
|
|
3895
|
-
payment_details?:
|
|
3968
|
+
payment_details?: PayoutDetailsResponse;
|
|
3896
3969
|
/**
|
|
3897
3970
|
*
|
|
3898
|
-
* @type {
|
|
3971
|
+
* @type {PayoutRecipient}
|
|
3899
3972
|
* @memberof PayoutInstructionResponse
|
|
3900
3973
|
*/
|
|
3901
|
-
recipient?:
|
|
3974
|
+
recipient?: PayoutRecipient;
|
|
3902
3975
|
/**
|
|
3903
3976
|
*
|
|
3904
3977
|
* @type {PayoutSender}
|
|
@@ -3910,13 +3983,21 @@ export interface PayoutInstructionResponse {
|
|
|
3910
3983
|
* @type {string}
|
|
3911
3984
|
* @memberof PayoutInstructionResponse
|
|
3912
3985
|
*/
|
|
3913
|
-
payout_instruction_id
|
|
3986
|
+
payout_instruction_id?: string;
|
|
3914
3987
|
/**
|
|
3915
3988
|
* Possible values - CREATED, PROCESSING, EXECUTED, CANCELLED, FAILED.
|
|
3916
3989
|
* @type {string}
|
|
3917
3990
|
* @memberof PayoutInstructionResponse
|
|
3918
3991
|
*/
|
|
3919
|
-
status
|
|
3992
|
+
status?: PayoutInstructionResponseStatusEnum;
|
|
3993
|
+
/**
|
|
3994
|
+
* Additional attributes of the payout instruction in key:value format (e.g. payout_instruction_internal_id: 1234). It supports up to 10 key:value pairs, whereas the key and value supports up to 50 and 500 characters respectively.
|
|
3995
|
+
* @type {{ [key: string]: string; }}
|
|
3996
|
+
* @memberof PayoutInstructionResponse
|
|
3997
|
+
*/
|
|
3998
|
+
metadata?: {
|
|
3999
|
+
[key: string]: string;
|
|
4000
|
+
};
|
|
3920
4001
|
/**
|
|
3921
4002
|
* Timestamp of when the recipient was created in ISO format (YYYY-MM-DDTHH:MM:SS.SSSZ)
|
|
3922
4003
|
* @type {string}
|
|
@@ -3944,6 +4025,25 @@ export declare const PayoutInstructionResponseStatusEnum: {
|
|
|
3944
4025
|
readonly Failed: "FAILED";
|
|
3945
4026
|
};
|
|
3946
4027
|
export declare type PayoutInstructionResponseStatusEnum = typeof PayoutInstructionResponseStatusEnum[keyof typeof PayoutInstructionResponseStatusEnum];
|
|
4028
|
+
/**
|
|
4029
|
+
*
|
|
4030
|
+
* @export
|
|
4031
|
+
* @interface PayoutRecipient
|
|
4032
|
+
*/
|
|
4033
|
+
export interface PayoutRecipient {
|
|
4034
|
+
/**
|
|
4035
|
+
* Merchant account name
|
|
4036
|
+
* @type {string}
|
|
4037
|
+
* @memberof PayoutRecipient
|
|
4038
|
+
*/
|
|
4039
|
+
name?: string;
|
|
4040
|
+
/**
|
|
4041
|
+
* Merchant account ID assigned by Finverse
|
|
4042
|
+
* @type {string}
|
|
4043
|
+
* @memberof PayoutRecipient
|
|
4044
|
+
*/
|
|
4045
|
+
recipient_account_id?: string;
|
|
4046
|
+
}
|
|
3947
4047
|
/**
|
|
3948
4048
|
*
|
|
3949
4049
|
* @export
|