@finverse/sdk-typescript 0.0.180 → 0.0.182

package/dist/api.d.ts

@@ -5051,146 +5051,6 @@ export interface PayoutDetails {
      */
     scheduled_date: string;
 }
-/**
- *
- * @export
- * @interface PayoutDetailsResponse
- */
-export interface PayoutDetailsResponse {
-    /**
-     * The mandate used to execute payments for this payout instruction. Currency for the mandate must be supported by the recipient account
-     * @type {string}
-     * @memberof PayoutDetailsResponse
-     */
-    mandate_id?: string;
-    /**
-     * A description for the payment (that will appear as the transaction description on bank statements)
-     * @type {string}
-     * @memberof PayoutDetailsResponse
-     */
-    description?: string;
-    /**
-     * YYYY-MM-DD, date (in UTC) to execute the payment, must be 1 day later than current date
-     * @type {string}
-     * @memberof PayoutDetailsResponse
-     */
-    scheduled_date?: string;
-}
-/**
- *
- * @export
- * @interface PayoutInstructionResponse
- */
-export interface PayoutInstructionResponse {
-    /**
-     * 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.
-     * @type {number}
-     * @memberof PayoutInstructionResponse
-     */
-    amount?: number;
-    /**
-     * The currency code as defined in ISO 4217.
-     * @type {string}
-     * @memberof PayoutInstructionResponse
-     */
-    currency?: string;
-    /**
-     *
-     * @type {PayoutDetailsResponse}
-     * @memberof PayoutInstructionResponse
-     */
-    payment_details?: PayoutDetailsResponse;
-    /**
-     *
-     * @type {PayoutRecipient}
-     * @memberof PayoutInstructionResponse
-     */
-    recipient?: PayoutRecipient;
-    /**
-     *
-     * @type {PayoutSender}
-     * @memberof PayoutInstructionResponse
-     */
-    sender?: PayoutSender;
-    /**
-     * Finverse Payout Instruction ID
-     * @type {string}
-     * @memberof PayoutInstructionResponse
-     */
-    payout_instruction_id?: string;
-    /**
-     * Possible values - CREATED, PROCESSING, EXECUTED, CANCELLED, FAILED.
-     * @type {string}
-     * @memberof PayoutInstructionResponse
-     */
-    status?: PayoutInstructionResponseStatusEnum;
-    /**
-     * 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.
-     * @type {{ [key: string]: string; }}
-     * @memberof PayoutInstructionResponse
-     */
-    metadata?: {
-        [key: string]: string;
-    };
-    /**
-     * Timestamp of when the recipient was created in ISO format (YYYY-MM-DDTHH:MM:SS.SSSZ)
-     * @type {string}
-     * @memberof PayoutInstructionResponse
-     */
-    created_at?: string;
-    /**
-     * Timestamp of when the recipient was last updated in ISO format (YYYY-MM-DDTHH:MM:SS.SSSZ)
-     * @type {string}
-     * @memberof PayoutInstructionResponse
-     */
-    updated_at?: string;
-    /**
-     *
-     * @type {FvErrorModelV2}
-     * @memberof PayoutInstructionResponse
-     */
-    error?: FvErrorModelV2;
-}
-export declare const PayoutInstructionResponseStatusEnum: {
-    readonly Created: "CREATED";
-    readonly Processing: "PROCESSING";
-    readonly Executed: "EXECUTED";
-    readonly Cancelled: "CANCELLED";
-    readonly Failed: "FAILED";
-};
-export declare type PayoutInstructionResponseStatusEnum = (typeof PayoutInstructionResponseStatusEnum)[keyof typeof PayoutInstructionResponseStatusEnum];
-/**
- *
- * @export
- * @interface PayoutRecipient
- */
-export interface PayoutRecipient {
-    /**
-     * Merchant account name
-     * @type {string}
-     * @memberof PayoutRecipient
-     */
-    name?: string;
-    /**
-     * Merchant account ID assigned by Finverse
-     * @type {string}
-     * @memberof PayoutRecipient
-     */
-    account_id?: string;
-}
-/**
- *
- * @export
- * @interface PayoutSender
- */
-export interface PayoutSender {
-    /**
-     *
-     * @type {string}
-     * @memberof PayoutSender
-     */
-    name?: string;
-}
 /**
  *
  * @export
@@ -5259,12 +5119,6 @@ export interface PayoutSnapshotResponse {
      * @memberof PayoutSnapshotResponse
      */
     payout_id?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof PayoutSnapshotResponse
-     */
-    transaction_reference_id?: string;
     /**
      *
      * @type {string}
@@ -5319,12 +5173,6 @@ export interface PayoutSnapshotResponse {
      * @memberof PayoutSnapshotResponse
      */
     currency?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof PayoutSnapshotResponse
-     */
-    description?: string;
     /**
      *
      * @type {PayoutSnapshotPaymentAccount}
@@ -6207,13 +6055,6 @@ export declare const CustomerApiAxiosParamCreator: (configuration?: Configuratio
      * @throws {RequiredError}
      */
     authorizeMandate: (mandateId: string, authorizeMandateRequest: AuthorizeMandateRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     * Cancel Payout Instruction by payout_instruction_id
-     * @param {string} payoutInstructionId payout instruction id
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    cancelPayoutInstruction: (payoutInstructionId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * CREATE Mandate
      * @param {CreateMandateRequest} createMandateRequest request body for creating mandate
@@ -6334,13 +6175,6 @@ export declare const CustomerApiAxiosParamCreator: (configuration?: Configuratio
      * @throws {RequiredError}
      */
     getPaymentUser: (paymentUserId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     * Get Payout Instruction details by payout_instruction_id
-     * @param {string} payoutInstructionId payout instruction id
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getPayoutInstruction: (payoutInstructionId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Get a list of institutions
      * @param {string} [country] (Deprecated) The country the institution belongs to
@@ -6393,13 +6227,6 @@ export declare const CustomerApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     authorizeMandate(mandateId: string, authorizeMandateRequest: AuthorizeMandateRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetMandateResponse>>;
-    /**
-     * Cancel Payout Instruction by payout_instruction_id
-     * @param {string} payoutInstructionId payout instruction id
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    cancelPayoutInstruction(payoutInstructionId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PayoutInstructionResponse>>;
     /**
      * CREATE Mandate
      * @param {CreateMandateRequest} createMandateRequest request body for creating mandate
@@ -6520,13 +6347,6 @@ export declare const CustomerApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getPaymentUser(paymentUserId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentUser>>;
-    /**
-     * Get Payout Instruction details by payout_instruction_id
-     * @param {string} payoutInstructionId payout instruction id
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getPayoutInstruction(payoutInstructionId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PayoutInstructionResponse>>;
     /**
      * Get a list of institutions
      * @param {string} [country] (Deprecated) The country the institution belongs to
@@ -6579,13 +6399,6 @@ export declare const CustomerApiFactory: (configuration?: Configuration, basePat
      * @throws {RequiredError}
      */
     authorizeMandate(mandateId: string, authorizeMandateRequest: AuthorizeMandateRequest, options?: any): AxiosPromise<GetMandateResponse>;
-    /**
-     * Cancel Payout Instruction by payout_instruction_id
-     * @param {string} payoutInstructionId payout instruction id
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    cancelPayoutInstruction(payoutInstructionId: string, options?: any): AxiosPromise<PayoutInstructionResponse>;
     /**
      * CREATE Mandate
      * @param {CreateMandateRequest} createMandateRequest request body for creating mandate
@@ -6706,13 +6519,6 @@ export declare const CustomerApiFactory: (configuration?: Configuration, basePat
      * @throws {RequiredError}
      */
     getPaymentUser(paymentUserId: string, options?: any): AxiosPromise<PaymentUser>;
-    /**
-     * Get Payout Instruction details by payout_instruction_id
-     * @param {string} payoutInstructionId payout instruction id
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getPayoutInstruction(payoutInstructionId: string, options?: any): AxiosPromise<PayoutInstructionResponse>;
     /**
      * Get a list of institutions
      * @param {string} [country] (Deprecated) The country the institution belongs to
@@ -6767,14 +6573,6 @@ export interface CustomerApiInterface {
      * @memberof CustomerApiInterface
      */
     authorizeMandate(mandateId: string, authorizeMandateRequest: AuthorizeMandateRequest, options?: AxiosRequestConfig): AxiosPromise<GetMandateResponse>;
-    /**
-     * Cancel Payout Instruction by payout_instruction_id
-     * @param {string} payoutInstructionId payout instruction id
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof CustomerApiInterface
-     */
-    cancelPayoutInstruction(payoutInstructionId: string, options?: AxiosRequestConfig): AxiosPromise<PayoutInstructionResponse>;
     /**
      * CREATE Mandate
      * @param {CreateMandateRequest} createMandateRequest request body for creating mandate
@@ -6912,14 +6710,6 @@ export interface CustomerApiInterface {
      * @memberof CustomerApiInterface
      */
     getPaymentUser(paymentUserId: string, options?: AxiosRequestConfig): AxiosPromise<PaymentUser>;
-    /**
-     * Get Payout Instruction details by payout_instruction_id
-     * @param {string} payoutInstructionId payout instruction id
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof CustomerApiInterface
-     */
-    getPayoutInstruction(payoutInstructionId: string, options?: AxiosRequestConfig): AxiosPromise<PayoutInstructionResponse>;
     /**
      * Get a list of institutions
      * @param {string} [country] (Deprecated) The country the institution belongs to
@@ -6980,14 +6770,6 @@ export declare class CustomerApi extends BaseAPI implements CustomerApiInterface
      * @memberof CustomerApi
      */
     authorizeMandate(mandateId: string, authorizeMandateRequest: AuthorizeMandateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMandateResponse>>;
-    /**
-     * Cancel Payout Instruction by payout_instruction_id
-     * @param {string} payoutInstructionId payout instruction id
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof CustomerApi
-     */
-    cancelPayoutInstruction(payoutInstructionId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PayoutInstructionResponse>>;
     /**
      * CREATE Mandate
      * @param {CreateMandateRequest} createMandateRequest request body for creating mandate
@@ -7125,14 +6907,6 @@ export declare class CustomerApi extends BaseAPI implements CustomerApiInterface
      * @memberof CustomerApi
      */
     getPaymentUser(paymentUserId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentUser>>;
-    /**
-     * Get Payout Instruction details by payout_instruction_id
-     * @param {string} payoutInstructionId payout instruction id
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof CustomerApi
-     */
-    getPayoutInstruction(payoutInstructionId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PayoutInstructionResponse>>;
     /**
      * Get a list of institutions
      * @param {string} [country] (Deprecated) The country the institution belongs to
@@ -7189,6 +6963,13 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
      * @throws {RequiredError}
      */
     cancelPaymentLink: (paymentLinkId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Cancel Payout by payout_id
+     * @param {string} payoutId payout id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    cancelPayout: (payoutId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Submit manual payment confirmation
      * @param {ManualPaymentConfirmationRequest} manualPaymentIdentifiers Request body containing information to identify manual payment
@@ -7238,11 +7019,12 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
     createPaymentLinkMandate: (createPaymentLinkMandateRequest: CreatePaymentLinkMandateRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Create a scheduled payout
+     * @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.
      * @param {CreateScheduledPayoutRequest} createScheduledPayoutRequest Request body containing information to create scheduled payout
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    createScheduledPayout: (createScheduledPayoutRequest: CreateScheduledPayoutRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    createScheduledPayout: (idempotencyKey: string, createScheduledPayoutRequest: CreateScheduledPayoutRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Get a customer-specific list of institutions for Finverse Link
      * @param {*} [options] Override http request option.
@@ -7313,6 +7095,13 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     cancelPaymentLink(paymentLinkId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentLinkResponse>>;
+    /**
+     * Cancel Payout by payout_id
+     * @param {string} payoutId payout id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    cancelPayout(payoutId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PayoutSnapshotResponse>>;
     /**
      * Submit manual payment confirmation
      * @param {ManualPaymentConfirmationRequest} manualPaymentIdentifiers Request body containing information to identify manual payment
@@ -7362,11 +7151,12 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
     createPaymentLinkMandate(createPaymentLinkMandateRequest: CreatePaymentLinkMandateRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePaymentLinkMandateResponse>>;
     /**
      * Create a scheduled payout
+     * @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.
      * @param {CreateScheduledPayoutRequest} createScheduledPayoutRequest Request body containing information to create scheduled payout
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    createScheduledPayout(createScheduledPayoutRequest: CreateScheduledPayoutRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PayoutSnapshotResponse>>;
+    createScheduledPayout(idempotencyKey: string, createScheduledPayoutRequest: CreateScheduledPayoutRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PayoutSnapshotResponse>>;
     /**
      * Get a customer-specific list of institutions for Finverse Link
      * @param {*} [options] Override http request option.
@@ -7437,6 +7227,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
      * @throws {RequiredError}
      */
     cancelPaymentLink(paymentLinkId: string, options?: any): AxiosPromise<PaymentLinkResponse>;
+    /**
+     * Cancel Payout by payout_id
+     * @param {string} payoutId payout id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    cancelPayout(payoutId: string, options?: any): AxiosPromise<PayoutSnapshotResponse>;
     /**
      * Submit manual payment confirmation
      * @param {ManualPaymentConfirmationRequest} manualPaymentIdentifiers Request body containing information to identify manual payment
@@ -7486,11 +7283,12 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
     createPaymentLinkMandate(createPaymentLinkMandateRequest: CreatePaymentLinkMandateRequest, options?: any): AxiosPromise<CreatePaymentLinkMandateResponse>;
     /**
      * Create a scheduled payout
+     * @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.
      * @param {CreateScheduledPayoutRequest} createScheduledPayoutRequest Request body containing information to create scheduled payout
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    createScheduledPayout(createScheduledPayoutRequest: CreateScheduledPayoutRequest, options?: any): AxiosPromise<PayoutSnapshotResponse>;
+    createScheduledPayout(idempotencyKey: string, createScheduledPayoutRequest: CreateScheduledPayoutRequest, options?: any): AxiosPromise<PayoutSnapshotResponse>;
     /**
      * Get a customer-specific list of institutions for Finverse Link
      * @param {*} [options] Override http request option.
@@ -7563,6 +7361,14 @@ export interface DefaultApiInterface {
      * @memberof DefaultApiInterface
      */
     cancelPaymentLink(paymentLinkId: string, options?: AxiosRequestConfig): AxiosPromise<PaymentLinkResponse>;
+    /**
+     * Cancel Payout by payout_id
+     * @param {string} payoutId payout id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DefaultApiInterface
+     */
+    cancelPayout(payoutId: string, options?: AxiosRequestConfig): AxiosPromise<PayoutSnapshotResponse>;
     /**
      * Submit manual payment confirmation
      * @param {ManualPaymentConfirmationRequest} manualPaymentIdentifiers Request body containing information to identify manual payment
@@ -7619,12 +7425,13 @@ export interface DefaultApiInterface {
     createPaymentLinkMandate(createPaymentLinkMandateRequest: CreatePaymentLinkMandateRequest, options?: AxiosRequestConfig): AxiosPromise<CreatePaymentLinkMandateResponse>;
     /**
      * Create a scheduled payout
+     * @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.
      * @param {CreateScheduledPayoutRequest} createScheduledPayoutRequest Request body containing information to create scheduled payout
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof DefaultApiInterface
      */
-    createScheduledPayout(createScheduledPayoutRequest: CreateScheduledPayoutRequest, options?: AxiosRequestConfig): AxiosPromise<PayoutSnapshotResponse>;
+    createScheduledPayout(idempotencyKey: string, createScheduledPayoutRequest: CreateScheduledPayoutRequest, options?: AxiosRequestConfig): AxiosPromise<PayoutSnapshotResponse>;
     /**
      * Get a customer-specific list of institutions for Finverse Link
      * @param {*} [options] Override http request option.
@@ -7704,6 +7511,14 @@ export declare class DefaultApi extends BaseAPI implements DefaultApiInterface {
      * @memberof DefaultApi
      */
     cancelPaymentLink(paymentLinkId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentLinkResponse>>;
+    /**
+     * Cancel Payout by payout_id
+     * @param {string} payoutId payout id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DefaultApi
+     */
+    cancelPayout(payoutId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PayoutSnapshotResponse>>;
     /**
      * Submit manual payment confirmation
      * @param {ManualPaymentConfirmationRequest} manualPaymentIdentifiers Request body containing information to identify manual payment
@@ -7760,12 +7575,13 @@ export declare class DefaultApi extends BaseAPI implements DefaultApiInterface {
     createPaymentLinkMandate(createPaymentLinkMandateRequest: CreatePaymentLinkMandateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePaymentLinkMandateResponse>>;
     /**
      * Create a scheduled payout
+     * @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.
      * @param {CreateScheduledPayoutRequest} createScheduledPayoutRequest Request body containing information to create scheduled payout
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof DefaultApi
      */
-    createScheduledPayout(createScheduledPayoutRequest: CreateScheduledPayoutRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PayoutSnapshotResponse>>;
+    createScheduledPayout(idempotencyKey: string, createScheduledPayoutRequest: CreateScheduledPayoutRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PayoutSnapshotResponse>>;
     /**
      * Get a customer-specific list of institutions for Finverse Link
      * @param {*} [options] Override http request option.

package/dist/api.js

@@ -22,7 +22,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PublicApi = exports.PublicApiFactory = exports.PublicApiFp = exports.PublicApiAxiosParamCreator = exports.LoginIdentityApi = exports.LoginIdentityApiFactory = exports.LoginIdentityApiFp = exports.LoginIdentityApiAxiosParamCreator = exports.LinkApi = exports.LinkApiFactory = exports.LinkApiFp = exports.LinkApiAxiosParamCreator = exports.DefaultApi = exports.DefaultApiFactory = exports.DefaultApiFp = exports.DefaultApiAxiosParamCreator = exports.CustomerApi = exports.CustomerApiFactory = exports.CustomerApiFp = exports.CustomerApiAxiosParamCreator = exports.TransactionLimitsPeriodEnum = exports.SubmitAuthChecklistResponseMandateStatusEnum = exports.SenderDetailDetailsTypeEnum = exports.RecipientAccountResponseAccountTypeEnum = exports.RecipientAccountNumberTypeEnum = exports.PayoutInstructionResponseStatusEnum = exports.PaymentUserUserTypeEnum = exports.PaymentScheduleFrequencyEnum = exports.PaymentResponseStatusEnum = exports.PaymentResponseTypeEnum = exports.PaymentLinkTokenResponseTokenTypeEnum = exports.PaymentLinkResponseStatusEnum = exports.PaymentLinkResponseModeEnum = exports.PaymentLinkCustomizationsUiModeEnum = exports.PaymentInstructionTypeEnum = exports.PaymentInfoPaymentsSupportedEnum = exports.PaymentAccountDetailsAccountTypeEnum = exports.MandateSenderAccountAccountTypeEnum = exports.MandateRecipientAccountAccountTypeEnum = exports.MandateAuthLinkCustomizationsUiModeEnum = exports.LoginMethodStatusEnum = exports.LinkTokenRequestAutomaticDataRefreshEnum = exports.LinkTokenRequestUiModeEnum = exports.LineItemItemTypeEnum = exports.InstitutionStatusEnum = exports.InstitutionUserTypeEnum = exports.InstitutionProductsSupportedEnum = exports.InstitutionInstitutionTypeEnum = exports.InstitutionTagsEnum = exports.GetMandateSenderUserTypeEnum = exports.GetMandateResponseStatusEnum = exports.GetMandateAuthResponseSenderTypeEnum = exports.GetMandateAuthResponseMandateStatusEnum = exports.GetMandateAuthLinkResponseTokenTypeEnum = exports.GetBalanceHistoryResponseSourceEnum = exports.FvErrorModelV2TypeEnum = exports.FvErrorModelTypeEnum = exports.FeePaidByEnum = exports.CustomerPaymentInstructionTypeEnum = exports.CreateRecipientAccountAccountTypeEnum = exports.CreatePaymentUserRequestUserTypeEnum = exports.CreatePaymentRequestTypeEnum = exports.CreatePaymentLinkRequestModeEnum = exports.CreatePaymentLinkMandateRequestSenderTypeEnum = exports.CreatePaymentAccountRequestAccountTypeEnum = exports.CreateMandateSenderUserTypeEnum = exports.CreateMandateResponseStatusEnum = exports.BadRequestModelV2ErrorTypeEnum = exports.AuthChecklistOptionsSubmittedByEnum = exports.AuthChecklistOptionsNameEnum = exports.AuthChecklistFactorRequiredEnum = exports.AuthChecklistFactorTypeEnum = exports.AccountTypeSubtypeEnum = exports.AccountTypeTypeEnum = void 0;
+exports.PublicApi = exports.PublicApiFactory = exports.PublicApiFp = exports.PublicApiAxiosParamCreator = exports.LoginIdentityApi = exports.LoginIdentityApiFactory = exports.LoginIdentityApiFp = exports.LoginIdentityApiAxiosParamCreator = exports.LinkApi = exports.LinkApiFactory = exports.LinkApiFp = exports.LinkApiAxiosParamCreator = exports.DefaultApi = exports.DefaultApiFactory = exports.DefaultApiFp = exports.DefaultApiAxiosParamCreator = exports.CustomerApi = exports.CustomerApiFactory = exports.CustomerApiFp = exports.CustomerApiAxiosParamCreator = exports.TransactionLimitsPeriodEnum = exports.SubmitAuthChecklistResponseMandateStatusEnum = exports.SenderDetailDetailsTypeEnum = exports.RecipientAccountResponseAccountTypeEnum = exports.RecipientAccountNumberTypeEnum = exports.PaymentUserUserTypeEnum = exports.PaymentScheduleFrequencyEnum = exports.PaymentResponseStatusEnum = exports.PaymentResponseTypeEnum = exports.PaymentLinkTokenResponseTokenTypeEnum = exports.PaymentLinkResponseStatusEnum = exports.PaymentLinkResponseModeEnum = exports.PaymentLinkCustomizationsUiModeEnum = exports.PaymentInstructionTypeEnum = exports.PaymentInfoPaymentsSupportedEnum = exports.PaymentAccountDetailsAccountTypeEnum = exports.MandateSenderAccountAccountTypeEnum = exports.MandateRecipientAccountAccountTypeEnum = exports.MandateAuthLinkCustomizationsUiModeEnum = exports.LoginMethodStatusEnum = exports.LinkTokenRequestAutomaticDataRefreshEnum = exports.LinkTokenRequestUiModeEnum = exports.LineItemItemTypeEnum = exports.InstitutionStatusEnum = exports.InstitutionUserTypeEnum = exports.InstitutionProductsSupportedEnum = exports.InstitutionInstitutionTypeEnum = exports.InstitutionTagsEnum = exports.GetMandateSenderUserTypeEnum = exports.GetMandateResponseStatusEnum = exports.GetMandateAuthResponseSenderTypeEnum = exports.GetMandateAuthResponseMandateStatusEnum = exports.GetMandateAuthLinkResponseTokenTypeEnum = exports.GetBalanceHistoryResponseSourceEnum = exports.FvErrorModelV2TypeEnum = exports.FvErrorModelTypeEnum = exports.FeePaidByEnum = exports.CustomerPaymentInstructionTypeEnum = exports.CreateRecipientAccountAccountTypeEnum = exports.CreatePaymentUserRequestUserTypeEnum = exports.CreatePaymentRequestTypeEnum = exports.CreatePaymentLinkRequestModeEnum = exports.CreatePaymentLinkMandateRequestSenderTypeEnum = exports.CreatePaymentAccountRequestAccountTypeEnum = exports.CreateMandateSenderUserTypeEnum = exports.CreateMandateResponseStatusEnum = exports.BadRequestModelV2ErrorTypeEnum = exports.AuthChecklistOptionsSubmittedByEnum = exports.AuthChecklistOptionsNameEnum = exports.AuthChecklistFactorRequiredEnum = exports.AuthChecklistFactorTypeEnum = exports.AccountTypeSubtypeEnum = exports.AccountTypeTypeEnum = void 0;
 const axios_1 = require("axios");
 // Some imports not used depending on template conditions
 // @ts-ignore
@@ -266,13 +266,6 @@ exports.PaymentUserUserTypeEnum = {
     Individual: 'INDIVIDUAL',
     Business: 'BUSINESS',
 };
-exports.PayoutInstructionResponseStatusEnum = {
-    Created: 'CREATED',
-    Processing: 'PROCESSING',
-    Executed: 'EXECUTED',
-    Cancelled: 'CANCELLED',
-    Failed: 'FAILED',
-};
 exports.RecipientAccountNumberTypeEnum = {
     Local: 'LOCAL',
     Iban: 'IBAN',
@@ -341,36 +334,6 @@ exports.CustomerApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
-        /**
-         * Cancel Payout Instruction by payout_instruction_id
-         * @param {string} payoutInstructionId payout instruction id
-         * @param {*} [options] Override http request option.
-         * @throws {RequiredError}
-         */
-        cancelPayoutInstruction: (payoutInstructionId, options = {}) => __awaiter(this, void 0, void 0, function* () {
-            // verify required parameter 'payoutInstructionId' is not null or undefined
-            common_1.assertParamExists('cancelPayoutInstruction', 'payoutInstructionId', payoutInstructionId);
-            const localVarPath = `/payout_instructions/{payoutInstructionId}/cancel`.replace(`{${'payoutInstructionId'}}`, encodeURIComponent(String(payoutInstructionId)));
-            // use dummy base URL string because the URL constructor only accepts absolute URLs.
-            const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
-            let baseOptions;
-            if (configuration) {
-                baseOptions = configuration.baseOptions;
-            }
-            const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
-            const localVarHeaderParameter = {};
-            const localVarQueryParameter = {};
-            // authentication Oauth2 required
-            // oauth required
-            yield common_1.setOAuthToObject(localVarHeaderParameter, 'Oauth2', [], configuration);
-            common_1.setSearchParams(localVarUrlObj, localVarQueryParameter);
-            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
-            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
-            return {
-                url: common_1.toPathString(localVarUrlObj),
-                options: localVarRequestOptions,
-            };
-        }),
         /**
          * CREATE Mandate
          * @param {CreateMandateRequest} createMandateRequest request body for creating mandate
@@ -900,36 +863,6 @@ exports.CustomerApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
-        /**
-         * Get Payout Instruction details by payout_instruction_id
-         * @param {string} payoutInstructionId payout instruction id
-         * @param {*} [options] Override http request option.
-         * @throws {RequiredError}
-         */
-        getPayoutInstruction: (payoutInstructionId, options = {}) => __awaiter(this, void 0, void 0, function* () {
-            // verify required parameter 'payoutInstructionId' is not null or undefined
-            common_1.assertParamExists('getPayoutInstruction', 'payoutInstructionId', payoutInstructionId);
-            const localVarPath = `/payout_instructions/{payoutInstructionId}`.replace(`{${'payoutInstructionId'}}`, encodeURIComponent(String(payoutInstructionId)));
-            // use dummy base URL string because the URL constructor only accepts absolute URLs.
-            const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
-            let baseOptions;
-            if (configuration) {
-                baseOptions = configuration.baseOptions;
-            }
-            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
-            const localVarHeaderParameter = {};
-            const localVarQueryParameter = {};
-            // authentication Oauth2 required
-            // oauth required
-            yield common_1.setOAuthToObject(localVarHeaderParameter, 'Oauth2', [], configuration);
-            common_1.setSearchParams(localVarUrlObj, localVarQueryParameter);
-            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
-            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
-            return {
-                url: common_1.toPathString(localVarUrlObj),
-                options: localVarRequestOptions,
-            };
-        }),
         /**
          * Get a list of institutions
          * @param {string} [country] (Deprecated) The country the institution belongs to
@@ -1121,18 +1054,6 @@ exports.CustomerApiFp = function (configuration) {
                 return common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
             });
         },
-        /**
-         * Cancel Payout Instruction by payout_instruction_id
-         * @param {string} payoutInstructionId payout instruction id
-         * @param {*} [options] Override http request option.
-         * @throws {RequiredError}
-         */
-        cancelPayoutInstruction(payoutInstructionId, options) {
-            return __awaiter(this, void 0, void 0, function* () {
-                const localVarAxiosArgs = yield localVarAxiosParamCreator.cancelPayoutInstruction(payoutInstructionId, options);
-                return common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
-            });
-        },
         /**
          * CREATE Mandate
          * @param {CreateMandateRequest} createMandateRequest request body for creating mandate
@@ -1338,18 +1259,6 @@ exports.CustomerApiFp = function (configuration) {
                 return common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
             });
         },
-        /**
-         * Get Payout Instruction details by payout_instruction_id
-         * @param {string} payoutInstructionId payout instruction id
-         * @param {*} [options] Override http request option.
-         * @throws {RequiredError}
-         */
-        getPayoutInstruction(payoutInstructionId, options) {
-            return __awaiter(this, void 0, void 0, function* () {
-                const localVarAxiosArgs = yield localVarAxiosParamCreator.getPayoutInstruction(payoutInstructionId, options);
-                return common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
-            });
-        },
         /**
          * Get a list of institutions
          * @param {string} [country] (Deprecated) The country the institution belongs to
@@ -1434,17 +1343,6 @@ exports.CustomerApiFactory = function (configuration, basePath, axios) {
                 .authorizeMandate(mandateId, authorizeMandateRequest, options)
                 .then((request) => request(axios, basePath));
         },
-        /**
-         * Cancel Payout Instruction by payout_instruction_id
-         * @param {string} payoutInstructionId payout instruction id
-         * @param {*} [options] Override http request option.
-         * @throws {RequiredError}
-         */
-        cancelPayoutInstruction(payoutInstructionId, options) {
-            return localVarFp
-                .cancelPayoutInstruction(payoutInstructionId, options)
-                .then((request) => request(axios, basePath));
-        },
         /**
          * CREATE Mandate
          * @param {CreateMandateRequest} createMandateRequest request body for creating mandate
@@ -1613,15 +1511,6 @@ exports.CustomerApiFactory = function (configuration, basePath, axios) {
         getPaymentUser(paymentUserId, options) {
             return localVarFp.getPaymentUser(paymentUserId, options).then((request) => request(axios, basePath));
         },
-        /**
-         * Get Payout Instruction details by payout_instruction_id
-         * @param {string} payoutInstructionId payout instruction id
-         * @param {*} [options] Override http request option.
-         * @throws {RequiredError}
-         */
-        getPayoutInstruction(payoutInstructionId, options) {
-            return localVarFp.getPayoutInstruction(payoutInstructionId, options).then((request) => request(axios, basePath));
-        },
         /**
          * Get a list of institutions
          * @param {string} [country] (Deprecated) The country the institution belongs to
@@ -1696,18 +1585,6 @@ class CustomerApi extends base_1.BaseAPI {
             .authorizeMandate(mandateId, authorizeMandateRequest, options)
             .then((request) => request(this.axios, this.basePath));
     }
-    /**
-     * Cancel Payout Instruction by payout_instruction_id
-     * @param {string} payoutInstructionId payout instruction id
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof CustomerApi
-     */
-    cancelPayoutInstruction(payoutInstructionId, options) {
-        return exports.CustomerApiFp(this.configuration)
-            .cancelPayoutInstruction(payoutInstructionId, options)
-            .then((request) => request(this.axios, this.basePath));
-    }
     /**
      * CREATE Mandate
      * @param {CreateMandateRequest} createMandateRequest request body for creating mandate
@@ -1913,18 +1790,6 @@ class CustomerApi extends base_1.BaseAPI {
             .getPaymentUser(paymentUserId, options)
             .then((request) => request(this.axios, this.basePath));
     }
-    /**
-     * Get Payout Instruction details by payout_instruction_id
-     * @param {string} payoutInstructionId payout instruction id
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof CustomerApi
-     */
-    getPayoutInstruction(payoutInstructionId, options) {
-        return exports.CustomerApiFp(this.configuration)
-            .getPayoutInstruction(payoutInstructionId, options)
-            .then((request) => request(this.axios, this.basePath));
-    }
     /**
      * Get a list of institutions
      * @param {string} [country] (Deprecated) The country the institution belongs to
@@ -2026,6 +1891,36 @@ exports.DefaultApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * Cancel Payout by payout_id
+         * @param {string} payoutId payout id
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        cancelPayout: (payoutId, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'payoutId' is not null or undefined
+            common_1.assertParamExists('cancelPayout', 'payoutId', payoutId);
+            const localVarPath = `/payouts/{payoutId}/cancel`.replace(`{${'payoutId'}}`, encodeURIComponent(String(payoutId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication Oauth2 required
+            // oauth required
+            yield common_1.setOAuthToObject(localVarHeaderParameter, 'Oauth2', [], configuration);
+            common_1.setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: common_1.toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
         /**
          * Submit manual payment confirmation
          * @param {ManualPaymentConfirmationRequest} manualPaymentIdentifiers Request body containing information to identify manual payment
@@ -2243,11 +2138,14 @@ exports.DefaultApiAxiosParamCreator = function (configuration) {
         }),
         /**
          * Create a scheduled payout
+         * @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.
          * @param {CreateScheduledPayoutRequest} createScheduledPayoutRequest Request body containing information to create scheduled payout
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        createScheduledPayout: (createScheduledPayoutRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
+        createScheduledPayout: (idempotencyKey, createScheduledPayoutRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'idempotencyKey' is not null or undefined
+            common_1.assertParamExists('createScheduledPayout', 'idempotencyKey', idempotencyKey);
             // verify required parameter 'createScheduledPayoutRequest' is not null or undefined
             common_1.assertParamExists('createScheduledPayout', 'createScheduledPayoutRequest', createScheduledPayoutRequest);
             const localVarPath = `/payouts/scheduled`;
@@ -2263,6 +2161,9 @@ exports.DefaultApiAxiosParamCreator = function (configuration) {
             // authentication Oauth2 required
             // oauth required
             yield common_1.setOAuthToObject(localVarHeaderParameter, 'Oauth2', [], configuration);
+            if (idempotencyKey !== undefined && idempotencyKey !== null) {
+                localVarHeaderParameter['Idempotency-Key'] = String(idempotencyKey);
+            }
             localVarHeaderParameter['Content-Type'] = 'application/json';
             common_1.setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
@@ -2544,6 +2445,18 @@ exports.DefaultApiFp = function (configuration) {
                 return common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
             });
         },
+        /**
+         * Cancel Payout by payout_id
+         * @param {string} payoutId payout id
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        cancelPayout(payoutId, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.cancelPayout(payoutId, options);
+                return common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
+            });
+        },
         /**
          * Submit manual payment confirmation
          * @param {ManualPaymentConfirmationRequest} manualPaymentIdentifiers Request body containing information to identify manual payment
@@ -2628,13 +2541,14 @@ exports.DefaultApiFp = function (configuration) {
         },
         /**
          * Create a scheduled payout
+         * @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.
          * @param {CreateScheduledPayoutRequest} createScheduledPayoutRequest Request body containing information to create scheduled payout
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        createScheduledPayout(createScheduledPayoutRequest, options) {
+        createScheduledPayout(idempotencyKey, createScheduledPayoutRequest, options) {
             return __awaiter(this, void 0, void 0, function* () {
-                const localVarAxiosArgs = yield localVarAxiosParamCreator.createScheduledPayout(createScheduledPayoutRequest, options);
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.createScheduledPayout(idempotencyKey, createScheduledPayoutRequest, options);
                 return common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
             });
         },
@@ -2743,6 +2657,15 @@ exports.DefaultApiFactory = function (configuration, basePath, axios) {
         cancelPaymentLink(paymentLinkId, options) {
             return localVarFp.cancelPaymentLink(paymentLinkId, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Cancel Payout by payout_id
+         * @param {string} payoutId payout id
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        cancelPayout(payoutId, options) {
+            return localVarFp.cancelPayout(payoutId, options).then((request) => request(axios, basePath));
+        },
         /**
          * Submit manual payment confirmation
          * @param {ManualPaymentConfirmationRequest} manualPaymentIdentifiers Request body containing information to identify manual payment
@@ -2814,13 +2737,14 @@ exports.DefaultApiFactory = function (configuration, basePath, axios) {
         },
         /**
          * Create a scheduled payout
+         * @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.
          * @param {CreateScheduledPayoutRequest} createScheduledPayoutRequest Request body containing information to create scheduled payout
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        createScheduledPayout(createScheduledPayoutRequest, options) {
+        createScheduledPayout(idempotencyKey, createScheduledPayoutRequest, options) {
             return localVarFp
-                .createScheduledPayout(createScheduledPayoutRequest, options)
+                .createScheduledPayout(idempotencyKey, createScheduledPayoutRequest, options)
                 .then((request) => request(axios, basePath));
         },
         /**
@@ -2919,6 +2843,18 @@ class DefaultApi extends base_1.BaseAPI {
             .cancelPaymentLink(paymentLinkId, options)
             .then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Cancel Payout by payout_id
+     * @param {string} payoutId payout id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DefaultApi
+     */
+    cancelPayout(payoutId, options) {
+        return exports.DefaultApiFp(this.configuration)
+            .cancelPayout(payoutId, options)
+            .then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Submit manual payment confirmation
      * @param {ManualPaymentConfirmationRequest} manualPaymentIdentifiers Request body containing information to identify manual payment
@@ -3003,14 +2939,15 @@ class DefaultApi extends base_1.BaseAPI {
     }
     /**
      * Create a scheduled payout
+     * @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.
      * @param {CreateScheduledPayoutRequest} createScheduledPayoutRequest Request body containing information to create scheduled payout
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof DefaultApi
      */
-    createScheduledPayout(createScheduledPayoutRequest, options) {
+    createScheduledPayout(idempotencyKey, createScheduledPayoutRequest, options) {
         return exports.DefaultApiFp(this.configuration)
-            .createScheduledPayout(createScheduledPayoutRequest, options)
+            .createScheduledPayout(idempotencyKey, createScheduledPayoutRequest, options)
             .then((request) => request(this.axios, this.basePath));
     }
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@finverse/sdk-typescript",
-  "version": "0.0.180",
+  "version": "0.0.182",
   "description": "OpenAPI client for @finverse/sdk-typescript",
   "author": "OpenAPI-Generator Contributors",
   "keywords": [