@finverse/sdk-typescript 0.0.100 → 0.0.102
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 +114 -38
- package/package.json +1 -1
package/dist/api.d.ts
CHANGED
|
@@ -821,18 +821,6 @@ export declare type CreatePaymentRequestTypeEnum = typeof CreatePaymentRequestTy
|
|
|
821
821
|
* @interface CreatePayoutInstructionRequest
|
|
822
822
|
*/
|
|
823
823
|
export interface CreatePayoutInstructionRequest {
|
|
824
|
-
/**
|
|
825
|
-
* The mandate used to execute payments for this payout instruction. Currency for the mandate must be supported by the recipient account
|
|
826
|
-
* @type {string}
|
|
827
|
-
* @memberof CreatePayoutInstructionRequest
|
|
828
|
-
*/
|
|
829
|
-
mandate_id: string;
|
|
830
|
-
/**
|
|
831
|
-
* The recipient account to receive the payment
|
|
832
|
-
* @type {string}
|
|
833
|
-
* @memberof CreatePayoutInstructionRequest
|
|
834
|
-
*/
|
|
835
|
-
recipient_account_id: string;
|
|
836
824
|
/**
|
|
837
825
|
* 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.
|
|
838
826
|
* @type {number}
|
|
@@ -840,23 +828,23 @@ export interface CreatePayoutInstructionRequest {
|
|
|
840
828
|
*/
|
|
841
829
|
amount: number;
|
|
842
830
|
/**
|
|
843
|
-
*
|
|
831
|
+
* The currency code as defined in ISO 4217.
|
|
844
832
|
* @type {string}
|
|
845
833
|
* @memberof CreatePayoutInstructionRequest
|
|
846
834
|
*/
|
|
847
|
-
|
|
835
|
+
currency: string;
|
|
848
836
|
/**
|
|
849
|
-
*
|
|
850
|
-
* @type {
|
|
837
|
+
*
|
|
838
|
+
* @type {PayoutDetails}
|
|
851
839
|
* @memberof CreatePayoutInstructionRequest
|
|
852
840
|
*/
|
|
853
|
-
|
|
841
|
+
payment_details: PayoutDetails;
|
|
854
842
|
/**
|
|
855
|
-
*
|
|
856
|
-
* @type {
|
|
843
|
+
*
|
|
844
|
+
* @type {MandateRecipientRequest}
|
|
857
845
|
* @memberof CreatePayoutInstructionRequest
|
|
858
846
|
*/
|
|
859
|
-
|
|
847
|
+
recipient: MandateRecipientRequest;
|
|
860
848
|
}
|
|
861
849
|
/**
|
|
862
850
|
*
|
|
@@ -3859,33 +3847,59 @@ export declare type PaymentScheduleFrequencyEnum = typeof PaymentScheduleFrequen
|
|
|
3859
3847
|
/**
|
|
3860
3848
|
*
|
|
3861
3849
|
* @export
|
|
3862
|
-
* @interface
|
|
3850
|
+
* @interface PayoutDetails
|
|
3863
3851
|
*/
|
|
3864
|
-
export interface
|
|
3852
|
+
export interface PayoutDetails {
|
|
3865
3853
|
/**
|
|
3866
|
-
*
|
|
3854
|
+
* The mandate used to execute payments for this payout instruction. Currency for the mandate must be supported by the recipient account
|
|
3867
3855
|
* @type {string}
|
|
3868
|
-
* @memberof
|
|
3856
|
+
* @memberof PayoutDetails
|
|
3869
3857
|
*/
|
|
3870
|
-
|
|
3858
|
+
mandate_id: string;
|
|
3871
3859
|
/**
|
|
3872
|
-
*
|
|
3860
|
+
* A description for the payment (that will appear as the transaction description on bank statements)
|
|
3873
3861
|
* @type {string}
|
|
3874
|
-
* @memberof
|
|
3862
|
+
* @memberof PayoutDetails
|
|
3875
3863
|
*/
|
|
3876
|
-
|
|
3864
|
+
description?: string;
|
|
3865
|
+
/**
|
|
3866
|
+
* YYYY-MM-DD, date (in UTC) to execute the payment, must be 1 day later than current date
|
|
3867
|
+
* @type {string}
|
|
3868
|
+
* @memberof PayoutDetails
|
|
3869
|
+
*/
|
|
3870
|
+
scheduled_date: string;
|
|
3871
|
+
}
|
|
3872
|
+
/**
|
|
3873
|
+
*
|
|
3874
|
+
* @export
|
|
3875
|
+
* @interface PayoutDetailsResponse
|
|
3876
|
+
*/
|
|
3877
|
+
export interface PayoutDetailsResponse {
|
|
3877
3878
|
/**
|
|
3878
3879
|
* The mandate used to execute payments for this payout instruction. Currency for the mandate must be supported by the recipient account
|
|
3879
3880
|
* @type {string}
|
|
3880
|
-
* @memberof
|
|
3881
|
+
* @memberof PayoutDetailsResponse
|
|
3881
3882
|
*/
|
|
3882
3883
|
mandate_id?: string;
|
|
3883
3884
|
/**
|
|
3884
|
-
*
|
|
3885
|
+
* A description for the payment (that will appear as the transaction description on bank statements)
|
|
3885
3886
|
* @type {string}
|
|
3886
|
-
* @memberof
|
|
3887
|
+
* @memberof PayoutDetailsResponse
|
|
3887
3888
|
*/
|
|
3888
|
-
|
|
3889
|
+
description?: string;
|
|
3890
|
+
/**
|
|
3891
|
+
* YYYY-MM-DD, date (in UTC) to execute the payment, must be 1 day later than current date
|
|
3892
|
+
* @type {string}
|
|
3893
|
+
* @memberof PayoutDetailsResponse
|
|
3894
|
+
*/
|
|
3895
|
+
scheduled_date?: string;
|
|
3896
|
+
}
|
|
3897
|
+
/**
|
|
3898
|
+
*
|
|
3899
|
+
* @export
|
|
3900
|
+
* @interface PayoutInstructionResponse
|
|
3901
|
+
*/
|
|
3902
|
+
export interface PayoutInstructionResponse {
|
|
3889
3903
|
/**
|
|
3890
3904
|
* 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.
|
|
3891
3905
|
* @type {number}
|
|
@@ -3893,23 +3907,53 @@ export interface PayoutInstructionResponse {
|
|
|
3893
3907
|
*/
|
|
3894
3908
|
amount?: number;
|
|
3895
3909
|
/**
|
|
3896
|
-
*
|
|
3910
|
+
* The currency code as defined in ISO 4217.
|
|
3897
3911
|
* @type {string}
|
|
3898
3912
|
* @memberof PayoutInstructionResponse
|
|
3899
3913
|
*/
|
|
3900
|
-
|
|
3914
|
+
currency?: string;
|
|
3901
3915
|
/**
|
|
3902
|
-
*
|
|
3916
|
+
*
|
|
3917
|
+
* @type {PayoutDetailsResponse}
|
|
3918
|
+
* @memberof PayoutInstructionResponse
|
|
3919
|
+
*/
|
|
3920
|
+
payment_details?: PayoutDetailsResponse;
|
|
3921
|
+
/**
|
|
3922
|
+
*
|
|
3923
|
+
* @type {PayoutRecipient}
|
|
3924
|
+
* @memberof PayoutInstructionResponse
|
|
3925
|
+
*/
|
|
3926
|
+
recipient?: PayoutRecipient;
|
|
3927
|
+
/**
|
|
3928
|
+
*
|
|
3929
|
+
* @type {PayoutSender}
|
|
3930
|
+
* @memberof PayoutInstructionResponse
|
|
3931
|
+
*/
|
|
3932
|
+
sender?: PayoutSender;
|
|
3933
|
+
/**
|
|
3934
|
+
* Finverse Payout Instruction ID
|
|
3903
3935
|
* @type {string}
|
|
3904
3936
|
* @memberof PayoutInstructionResponse
|
|
3905
3937
|
*/
|
|
3906
|
-
|
|
3938
|
+
payout_instruction_id?: string;
|
|
3907
3939
|
/**
|
|
3908
|
-
*
|
|
3940
|
+
* Possible values - CREATED, PROCESSING, EXECUTED, CANCELLED, FAILED.
|
|
3909
3941
|
* @type {string}
|
|
3910
3942
|
* @memberof PayoutInstructionResponse
|
|
3911
3943
|
*/
|
|
3912
|
-
|
|
3944
|
+
status?: PayoutInstructionResponseStatusEnum;
|
|
3945
|
+
/**
|
|
3946
|
+
* Timestamp of when the recipient was created in ISO format (YYYY-MM-DDTHH:MM:SS.SSSZ)
|
|
3947
|
+
* @type {string}
|
|
3948
|
+
* @memberof PayoutInstructionResponse
|
|
3949
|
+
*/
|
|
3950
|
+
created_at?: string;
|
|
3951
|
+
/**
|
|
3952
|
+
* Timestamp of when the recipient was last updated in ISO format (YYYY-MM-DDTHH:MM:SS.SSSZ)
|
|
3953
|
+
* @type {string}
|
|
3954
|
+
* @memberof PayoutInstructionResponse
|
|
3955
|
+
*/
|
|
3956
|
+
updated_at?: string;
|
|
3913
3957
|
/**
|
|
3914
3958
|
*
|
|
3915
3959
|
* @type {FvErrorModelV2}
|
|
@@ -3925,6 +3969,38 @@ export declare const PayoutInstructionResponseStatusEnum: {
|
|
|
3925
3969
|
readonly Failed: "FAILED";
|
|
3926
3970
|
};
|
|
3927
3971
|
export declare type PayoutInstructionResponseStatusEnum = typeof PayoutInstructionResponseStatusEnum[keyof typeof PayoutInstructionResponseStatusEnum];
|
|
3972
|
+
/**
|
|
3973
|
+
*
|
|
3974
|
+
* @export
|
|
3975
|
+
* @interface PayoutRecipient
|
|
3976
|
+
*/
|
|
3977
|
+
export interface PayoutRecipient {
|
|
3978
|
+
/**
|
|
3979
|
+
* Merchant account name
|
|
3980
|
+
* @type {string}
|
|
3981
|
+
* @memberof PayoutRecipient
|
|
3982
|
+
*/
|
|
3983
|
+
name?: string;
|
|
3984
|
+
/**
|
|
3985
|
+
* Merchant account ID assigned by Finverse
|
|
3986
|
+
* @type {string}
|
|
3987
|
+
* @memberof PayoutRecipient
|
|
3988
|
+
*/
|
|
3989
|
+
recipient_account_id?: string;
|
|
3990
|
+
}
|
|
3991
|
+
/**
|
|
3992
|
+
*
|
|
3993
|
+
* @export
|
|
3994
|
+
* @interface PayoutSender
|
|
3995
|
+
*/
|
|
3996
|
+
export interface PayoutSender {
|
|
3997
|
+
/**
|
|
3998
|
+
*
|
|
3999
|
+
* @type {string}
|
|
4000
|
+
* @memberof PayoutSender
|
|
4001
|
+
*/
|
|
4002
|
+
name?: string;
|
|
4003
|
+
}
|
|
3928
4004
|
/**
|
|
3929
4005
|
*
|
|
3930
4006
|
* @export
|