@finverse/sdk-typescript 0.0.100 → 0.0.101
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 +72 -40
- 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
|
*
|
|
@@ -3856,6 +3844,31 @@ export declare const PaymentScheduleFrequencyEnum: {
|
|
|
3856
3844
|
readonly Yearly: "YEARLY";
|
|
3857
3845
|
};
|
|
3858
3846
|
export declare type PaymentScheduleFrequencyEnum = typeof PaymentScheduleFrequencyEnum[keyof typeof PaymentScheduleFrequencyEnum];
|
|
3847
|
+
/**
|
|
3848
|
+
*
|
|
3849
|
+
* @export
|
|
3850
|
+
* @interface PayoutDetails
|
|
3851
|
+
*/
|
|
3852
|
+
export interface PayoutDetails {
|
|
3853
|
+
/**
|
|
3854
|
+
* The mandate used to execute payments for this payout instruction. Currency for the mandate must be supported by the recipient account
|
|
3855
|
+
* @type {string}
|
|
3856
|
+
* @memberof PayoutDetails
|
|
3857
|
+
*/
|
|
3858
|
+
mandate_id: string;
|
|
3859
|
+
/**
|
|
3860
|
+
* A description for the payment (that will appear as the transaction description on bank statements)
|
|
3861
|
+
* @type {string}
|
|
3862
|
+
* @memberof PayoutDetails
|
|
3863
|
+
*/
|
|
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
|
+
}
|
|
3859
3872
|
/**
|
|
3860
3873
|
*
|
|
3861
3874
|
* @export
|
|
@@ -3863,53 +3876,59 @@ export declare type PaymentScheduleFrequencyEnum = typeof PaymentScheduleFrequen
|
|
|
3863
3876
|
*/
|
|
3864
3877
|
export interface PayoutInstructionResponse {
|
|
3865
3878
|
/**
|
|
3866
|
-
*
|
|
3867
|
-
* @type {
|
|
3879
|
+
* 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.
|
|
3880
|
+
* @type {number}
|
|
3868
3881
|
* @memberof PayoutInstructionResponse
|
|
3869
3882
|
*/
|
|
3870
|
-
|
|
3883
|
+
amount?: number;
|
|
3871
3884
|
/**
|
|
3872
|
-
*
|
|
3885
|
+
* The currency code as defined in ISO 4217.
|
|
3873
3886
|
* @type {string}
|
|
3874
3887
|
* @memberof PayoutInstructionResponse
|
|
3875
3888
|
*/
|
|
3876
|
-
|
|
3889
|
+
currency?: string;
|
|
3877
3890
|
/**
|
|
3878
|
-
*
|
|
3879
|
-
* @type {
|
|
3891
|
+
*
|
|
3892
|
+
* @type {PayoutDetails}
|
|
3880
3893
|
* @memberof PayoutInstructionResponse
|
|
3881
3894
|
*/
|
|
3882
|
-
|
|
3895
|
+
payment_details?: PayoutDetails;
|
|
3883
3896
|
/**
|
|
3884
|
-
*
|
|
3885
|
-
* @type {
|
|
3897
|
+
*
|
|
3898
|
+
* @type {MandateRecipient}
|
|
3886
3899
|
* @memberof PayoutInstructionResponse
|
|
3887
3900
|
*/
|
|
3888
|
-
|
|
3901
|
+
recipient?: MandateRecipient;
|
|
3889
3902
|
/**
|
|
3890
|
-
*
|
|
3891
|
-
* @type {
|
|
3903
|
+
*
|
|
3904
|
+
* @type {PayoutSender}
|
|
3892
3905
|
* @memberof PayoutInstructionResponse
|
|
3893
3906
|
*/
|
|
3894
|
-
|
|
3907
|
+
sender?: PayoutSender;
|
|
3895
3908
|
/**
|
|
3896
|
-
*
|
|
3909
|
+
* Finverse Payout Instruction ID
|
|
3897
3910
|
* @type {string}
|
|
3898
3911
|
* @memberof PayoutInstructionResponse
|
|
3899
3912
|
*/
|
|
3900
|
-
|
|
3913
|
+
payout_instruction_id: string;
|
|
3901
3914
|
/**
|
|
3902
|
-
*
|
|
3915
|
+
* Possible values - CREATED, PROCESSING, EXECUTED, CANCELLED, FAILED.
|
|
3903
3916
|
* @type {string}
|
|
3904
3917
|
* @memberof PayoutInstructionResponse
|
|
3905
3918
|
*/
|
|
3906
|
-
|
|
3919
|
+
status: PayoutInstructionResponseStatusEnum;
|
|
3907
3920
|
/**
|
|
3908
|
-
*
|
|
3921
|
+
* Timestamp of when the recipient was created in ISO format (YYYY-MM-DDTHH:MM:SS.SSSZ)
|
|
3909
3922
|
* @type {string}
|
|
3910
3923
|
* @memberof PayoutInstructionResponse
|
|
3911
3924
|
*/
|
|
3912
|
-
|
|
3925
|
+
created_at?: string;
|
|
3926
|
+
/**
|
|
3927
|
+
* Timestamp of when the recipient was last updated in ISO format (YYYY-MM-DDTHH:MM:SS.SSSZ)
|
|
3928
|
+
* @type {string}
|
|
3929
|
+
* @memberof PayoutInstructionResponse
|
|
3930
|
+
*/
|
|
3931
|
+
updated_at?: string;
|
|
3913
3932
|
/**
|
|
3914
3933
|
*
|
|
3915
3934
|
* @type {FvErrorModelV2}
|
|
@@ -3925,6 +3944,19 @@ export declare const PayoutInstructionResponseStatusEnum: {
|
|
|
3925
3944
|
readonly Failed: "FAILED";
|
|
3926
3945
|
};
|
|
3927
3946
|
export declare type PayoutInstructionResponseStatusEnum = typeof PayoutInstructionResponseStatusEnum[keyof typeof PayoutInstructionResponseStatusEnum];
|
|
3947
|
+
/**
|
|
3948
|
+
*
|
|
3949
|
+
* @export
|
|
3950
|
+
* @interface PayoutSender
|
|
3951
|
+
*/
|
|
3952
|
+
export interface PayoutSender {
|
|
3953
|
+
/**
|
|
3954
|
+
*
|
|
3955
|
+
* @type {string}
|
|
3956
|
+
* @memberof PayoutSender
|
|
3957
|
+
*/
|
|
3958
|
+
name?: string;
|
|
3959
|
+
}
|
|
3928
3960
|
/**
|
|
3929
3961
|
*
|
|
3930
3962
|
* @export
|