@finverse/sdk-typescript 0.0.17 → 0.0.20

package/dist/api.d.ts

@@ -431,6 +431,89 @@ export interface CurrencyAmount {
      */
     raw?: string;
 }
+/**
+ *
+ * @export
+ * @interface CustomerPaymentInstruction
+ */
+export interface CustomerPaymentInstruction {
+    /**
+     * A id of the user of this payment, need to equal to userId when creating link
+     * @type {string}
+     * @memberof CustomerPaymentInstruction
+     */
+    user_id: string;
+    /**
+     * Type of payment is being created, please check Documentation on which payment type is supported in each institution
+     * @type {string}
+     * @memberof CustomerPaymentInstruction
+     */
+    type: CustomerPaymentInstructionTypeEnum;
+    /**
+     * The recipient name
+     * @type {string}
+     * @memberof CustomerPaymentInstruction
+     */
+    recipient_name?: string;
+    /**
+     * The recipient account Id
+     * @type {string}
+     * @memberof CustomerPaymentInstruction
+     */
+    recipient_account_id?: string;
+    /**
+     * The sender name
+     * @type {string}
+     * @memberof CustomerPaymentInstruction
+     */
+    sender_name?: string;
+    /**
+     * The sender account Id
+     * @type {string}
+     * @memberof CustomerPaymentInstruction
+     */
+    sender_account_id?: string;
+    /**
+     * When the payment should start
+     * @type {string}
+     * @memberof CustomerPaymentInstruction
+     */
+    start_date?: string | null;
+    /**
+     * When the payment should stop
+     * @type {string}
+     * @memberof CustomerPaymentInstruction
+     */
+    end_date?: string | null;
+    /**
+     * The currency for the payment
+     * @type {string}
+     * @memberof CustomerPaymentInstruction
+     */
+    currency?: string;
+    /**
+     * The payment amount
+     * @type {number}
+     * @memberof CustomerPaymentInstruction
+     */
+    amount?: number;
+    /**
+     * How often the payment should be executed
+     * @type {string}
+     * @memberof CustomerPaymentInstruction
+     */
+    frequency?: string;
+    /**
+     * Related remarks about this instruction
+     * @type {string}
+     * @memberof CustomerPaymentInstruction
+     */
+    remarks?: string;
+}
+export declare const CustomerPaymentInstructionTypeEnum: {
+    readonly DebitAuthorization: "DEBIT_AUTHORIZATION";
+};
+export declare type CustomerPaymentInstructionTypeEnum = typeof CustomerPaymentInstructionTypeEnum[keyof typeof CustomerPaymentInstructionTypeEnum];
 /**
  *
  * @export
@@ -687,6 +770,31 @@ export interface GetLoginIdentityHistoryResponse {
      */
     status_history?: Array<LoginIdentityStatusDetails>;
 }
+/**
+ *
+ * @export
+ * @interface GetPaymentInstructionsResponse
+ */
+export interface GetPaymentInstructionsResponse {
+    /**
+     *
+     * @type {PaymentInstruction}
+     * @memberof GetPaymentInstructionsResponse
+     */
+    payment_instruction?: PaymentInstruction;
+    /**
+     *
+     * @type {LoginIdentityShort}
+     * @memberof GetPaymentInstructionsResponse
+     */
+    login_identity?: LoginIdentityShort;
+    /**
+     *
+     * @type {InstitutionShort}
+     * @memberof GetPaymentInstructionsResponse
+     */
+    institution?: InstitutionShort;
+}
 /**
  *
  * @export
@@ -1141,7 +1249,7 @@ export interface IncomeTotal {
      * @type {IncomeEstimate}
      * @memberof IncomeTotal
      */
-    estmated_monthly_income?: IncomeEstimate;
+    estimated_monthly_income?: IncomeEstimate;
     /**
      * Number of transactions counted towards income
      * @type {number}
@@ -1528,31 +1636,6 @@ export interface ListAccountsResponse {
      */
     institution?: InstitutionShort;
 }
-/**
- *
- * @export
- * @interface ListPaymentInstructionsResponse
- */
-export interface ListPaymentInstructionsResponse {
-    /**
-     *
-     * @type {Array<PaymentInstruction>}
-     * @memberof ListPaymentInstructionsResponse
-     */
-    payment_instructions?: Array<PaymentInstruction>;
-    /**
-     *
-     * @type {LoginIdentityShort}
-     * @memberof ListPaymentInstructionsResponse
-     */
-    login_identity?: LoginIdentityShort;
-    /**
-     *
-     * @type {InstitutionShort}
-     * @memberof ListPaymentInstructionsResponse
-     */
-    institution?: InstitutionShort;
-}
 /**
  *
  * @export
@@ -1980,17 +2063,17 @@ export interface PaymentDetails {
  */
 export interface PaymentInstruction {
     /**
-     * The user id to which the payment instruction will refer
+     * A id of the user of this payment, need to equal to userId when creating link
      * @type {string}
      * @memberof PaymentInstruction
      */
-    user_id: string;
+    user_id?: string;
     /**
-     * What type of payment is being created
+     * Type of payment is being created, please check Documentation on which payment type is supported in each institution
      * @type {string}
      * @memberof PaymentInstruction
      */
-    payment_type: PaymentInstructionPaymentTypeEnum;
+    type?: PaymentInstructionTypeEnum;
     /**
      * The recipient name
      * @type {string}
@@ -2040,40 +2123,40 @@ export interface PaymentInstruction {
      */
     amount?: number;
     /**
-     * How often the payment is executed
+     * How often the payment should be executed
      * @type {string}
      * @memberof PaymentInstruction
      */
     frequency?: string;
     /**
-     * Related remarks
+     * Related remarks about this instruction
      * @type {string}
      * @memberof PaymentInstruction
      */
     remarks?: string;
-    /**
-     * A customer provided key to ensure ideompotency
-     * @type {string}
-     * @memberof PaymentInstruction
-     */
-    idempotence_key?: string;
     /**
      * Status of the payment
      * @type {string}
      * @memberof PaymentInstruction
      */
-    payment_status?: string;
+    status?: string;
     /**
      * Reference identification returned by institution
      * @type {string}
      * @memberof PaymentInstruction
      */
     reference_id?: string;
+    /**
+     * Extra information collected for this payment instruction
+     * @type {object}
+     * @memberof PaymentInstruction
+     */
+    info?: object;
 }
-export declare const PaymentInstructionPaymentTypeEnum: {
+export declare const PaymentInstructionTypeEnum: {
     readonly DebitAuthorization: "DEBIT_AUTHORIZATION";
 };
-export declare type PaymentInstructionPaymentTypeEnum = typeof PaymentInstructionPaymentTypeEnum[keyof typeof PaymentInstructionPaymentTypeEnum];
+export declare type PaymentInstructionTypeEnum = typeof PaymentInstructionTypeEnum[keyof typeof PaymentInstructionTypeEnum];
 /**
  *
  * @export
@@ -2458,11 +2541,11 @@ export interface Transaction {
 export declare const CustomerApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
      * Create a new payment instruction to be used when linking to perform debit authorization
-     * @param {PaymentInstruction} paymentInstruction Request body for starting a new Link
+     * @param {CustomerPaymentInstruction} paymentInstruction Request body for starting a new Link
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    createPaymentInstruction: (paymentInstruction: PaymentInstruction, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    createPaymentInstruction: (paymentInstruction: CustomerPaymentInstruction, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * generate a link token that can be used to create link
      * @param {LinkTokenRequest} linkTokenRequest token request
@@ -2491,6 +2574,13 @@ export declare const CustomerApiAxiosParamCreator: (configuration?: Configuratio
      * @throws {RequiredError}
      */
     getLoginIdentityHistory: (loginIdentityId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get payment instructions to be used when linking to perform debit authorization by id
+     * @param {string} paymentInstructionId The id of a payment instruction
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPaymentInstruction: (paymentInstructionId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Get a list of institutions
      * @param {string} [country] The country the institution belongs to
@@ -2516,11 +2606,11 @@ export declare const CustomerApiAxiosParamCreator: (configuration?: Configuratio
 export declare const CustomerApiFp: (configuration?: Configuration) => {
     /**
      * Create a new payment instruction to be used when linking to perform debit authorization
-     * @param {PaymentInstruction} paymentInstruction Request body for starting a new Link
+     * @param {CustomerPaymentInstruction} paymentInstruction Request body for starting a new Link
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    createPaymentInstruction(paymentInstruction: PaymentInstruction, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePaymentInstructionResponse>>;
+    createPaymentInstruction(paymentInstruction: CustomerPaymentInstruction, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePaymentInstructionResponse>>;
     /**
      * generate a link token that can be used to create link
      * @param {LinkTokenRequest} linkTokenRequest token request
@@ -2549,6 +2639,13 @@ export declare const CustomerApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getLoginIdentityHistory(loginIdentityId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetLoginIdentityHistoryResponse>>;
+    /**
+     * Get payment instructions to be used when linking to perform debit authorization by id
+     * @param {string} paymentInstructionId The id of a payment instruction
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPaymentInstruction(paymentInstructionId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPaymentInstructionsResponse>>;
     /**
      * Get a list of institutions
      * @param {string} [country] The country the institution belongs to
@@ -2574,11 +2671,11 @@ export declare const CustomerApiFp: (configuration?: Configuration) => {
 export declare const CustomerApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
      * Create a new payment instruction to be used when linking to perform debit authorization
-     * @param {PaymentInstruction} paymentInstruction Request body for starting a new Link
+     * @param {CustomerPaymentInstruction} paymentInstruction Request body for starting a new Link
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    createPaymentInstruction(paymentInstruction: PaymentInstruction, options?: any): AxiosPromise<CreatePaymentInstructionResponse>;
+    createPaymentInstruction(paymentInstruction: CustomerPaymentInstruction, options?: any): AxiosPromise<CreatePaymentInstructionResponse>;
     /**
      * generate a link token that can be used to create link
      * @param {LinkTokenRequest} linkTokenRequest token request
@@ -2607,6 +2704,13 @@ export declare const CustomerApiFactory: (configuration?: Configuration, basePat
      * @throws {RequiredError}
      */
     getLoginIdentityHistory(loginIdentityId: string, options?: any): AxiosPromise<GetLoginIdentityHistoryResponse>;
+    /**
+     * Get payment instructions to be used when linking to perform debit authorization by id
+     * @param {string} paymentInstructionId The id of a payment instruction
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPaymentInstruction(paymentInstructionId: string, options?: any): AxiosPromise<GetPaymentInstructionsResponse>;
     /**
      * Get a list of institutions
      * @param {string} [country] The country the institution belongs to
@@ -2633,12 +2737,12 @@ export declare const CustomerApiFactory: (configuration?: Configuration, basePat
 export interface CustomerApiInterface {
     /**
      * Create a new payment instruction to be used when linking to perform debit authorization
-     * @param {PaymentInstruction} paymentInstruction Request body for starting a new Link
+     * @param {CustomerPaymentInstruction} paymentInstruction Request body for starting a new Link
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof CustomerApiInterface
      */
-    createPaymentInstruction(paymentInstruction: PaymentInstruction, options?: AxiosRequestConfig): AxiosPromise<CreatePaymentInstructionResponse>;
+    createPaymentInstruction(paymentInstruction: CustomerPaymentInstruction, options?: AxiosRequestConfig): AxiosPromise<CreatePaymentInstructionResponse>;
     /**
      * generate a link token that can be used to create link
      * @param {LinkTokenRequest} linkTokenRequest token request
@@ -2671,6 +2775,14 @@ export interface CustomerApiInterface {
      * @memberof CustomerApiInterface
      */
     getLoginIdentityHistory(loginIdentityId: string, options?: AxiosRequestConfig): AxiosPromise<GetLoginIdentityHistoryResponse>;
+    /**
+     * Get payment instructions to be used when linking to perform debit authorization by id
+     * @param {string} paymentInstructionId The id of a payment instruction
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomerApiInterface
+     */
+    getPaymentInstruction(paymentInstructionId: string, options?: AxiosRequestConfig): AxiosPromise<GetPaymentInstructionsResponse>;
     /**
      * Get a list of institutions
      * @param {string} [country] The country the institution belongs to
@@ -2700,12 +2812,12 @@ export interface CustomerApiInterface {
 export declare class CustomerApi extends BaseAPI implements CustomerApiInterface {
     /**
      * Create a new payment instruction to be used when linking to perform debit authorization
-     * @param {PaymentInstruction} paymentInstruction Request body for starting a new Link
+     * @param {CustomerPaymentInstruction} paymentInstruction Request body for starting a new Link
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof CustomerApi
      */
-    createPaymentInstruction(paymentInstruction: PaymentInstruction, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePaymentInstructionResponse>>;
+    createPaymentInstruction(paymentInstruction: CustomerPaymentInstruction, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePaymentInstructionResponse>>;
     /**
      * generate a link token that can be used to create link
      * @param {LinkTokenRequest} linkTokenRequest token request
@@ -2738,6 +2850,14 @@ export declare class CustomerApi extends BaseAPI implements CustomerApiInterface
      * @memberof CustomerApi
      */
     getLoginIdentityHistory(loginIdentityId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetLoginIdentityHistoryResponse>>;
+    /**
+     * Get payment instructions to be used when linking to perform debit authorization by id
+     * @param {string} paymentInstructionId The id of a payment instruction
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomerApi
+     */
+    getPaymentInstruction(paymentInstructionId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPaymentInstructionsResponse>>;
     /**
      * Get a list of institutions
      * @param {string} [country] The country the institution belongs to
@@ -3084,12 +3204,6 @@ export declare const LoginIdentityApiAxiosParamCreator: (configuration?: Configu
      * @throws {RequiredError}
      */
     listAccounts: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     * Get list of payment instructions to be used when linking to perfom debit authorization
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    listPaymentInstructions: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Get a list of transactions for a particular account. The transactions are returned in sorted order, with the most recent one appearing first.
      * @param {string} accountId The account id (ULID, example - 01EP4A1MZDHKETZFRPF0K62S6S)
@@ -3197,12 +3311,6 @@ export declare const LoginIdentityApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     listAccounts(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListAccountsResponse>>;
-    /**
-     * Get list of payment instructions to be used when linking to perfom debit authorization
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    listPaymentInstructions(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPaymentInstructionsResponse>>;
     /**
      * Get a list of transactions for a particular account. The transactions are returned in sorted order, with the most recent one appearing first.
      * @param {string} accountId The account id (ULID, example - 01EP4A1MZDHKETZFRPF0K62S6S)
@@ -3310,12 +3418,6 @@ export declare const LoginIdentityApiFactory: (configuration?: Configuration, ba
      * @throws {RequiredError}
      */
     listAccounts(options?: any): AxiosPromise<ListAccountsResponse>;
-    /**
-     * Get list of payment instructions to be used when linking to perfom debit authorization
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    listPaymentInstructions(options?: any): AxiosPromise<ListPaymentInstructionsResponse>;
     /**
      * Get a list of transactions for a particular account. The transactions are returned in sorted order, with the most recent one appearing first.
      * @param {string} accountId The account id (ULID, example - 01EP4A1MZDHKETZFRPF0K62S6S)
@@ -3436,13 +3538,6 @@ export interface LoginIdentityApiInterface {
      * @memberof LoginIdentityApiInterface
      */
     listAccounts(options?: AxiosRequestConfig): AxiosPromise<ListAccountsResponse>;
-    /**
-     * Get list of payment instructions to be used when linking to perfom debit authorization
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof LoginIdentityApiInterface
-     */
-    listPaymentInstructions(options?: AxiosRequestConfig): AxiosPromise<ListPaymentInstructionsResponse>;
     /**
      * Get a list of transactions for a particular account. The transactions are returned in sorted order, with the most recent one appearing first.
      * @param {string} accountId The account id (ULID, example - 01EP4A1MZDHKETZFRPF0K62S6S)
@@ -3567,13 +3662,6 @@ export declare class LoginIdentityApi extends BaseAPI implements LoginIdentityAp
      * @memberof LoginIdentityApi
      */
     listAccounts(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListAccountsResponse>>;
-    /**
-     * Get list of payment instructions to be used when linking to perfom debit authorization
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof LoginIdentityApi
-     */
-    listPaymentInstructions(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPaymentInstructionsResponse>>;
     /**
      * Get a list of transactions for a particular account. The transactions are returned in sorted order, with the most recent one appearing first.
      * @param {string} accountId The account id (ULID, example - 01EP4A1MZDHKETZFRPF0K62S6S)
@@ -3601,6 +3689,113 @@ export declare class LoginIdentityApi extends BaseAPI implements LoginIdentityAp
      */
     refreshLoginIdentity(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void>>;
 }
+/**
+ * PaymentApi - axios parameter creator
+ * @export
+ */
+export declare const PaymentApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Create a new payment instruction to be used when linking to perform debit authorization
+     * @param {CustomerPaymentInstruction} paymentInstruction Request body for starting a new Link
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createPaymentInstruction: (paymentInstruction: CustomerPaymentInstruction, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get payment instructions to be used when linking to perform debit authorization by id
+     * @param {string} paymentInstructionId The id of a payment instruction
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPaymentInstruction: (paymentInstructionId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * PaymentApi - functional programming interface
+ * @export
+ */
+export declare const PaymentApiFp: (configuration?: Configuration) => {
+    /**
+     * Create a new payment instruction to be used when linking to perform debit authorization
+     * @param {CustomerPaymentInstruction} paymentInstruction Request body for starting a new Link
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createPaymentInstruction(paymentInstruction: CustomerPaymentInstruction, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePaymentInstructionResponse>>;
+    /**
+     * Get payment instructions to be used when linking to perform debit authorization by id
+     * @param {string} paymentInstructionId The id of a payment instruction
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPaymentInstruction(paymentInstructionId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPaymentInstructionsResponse>>;
+};
+/**
+ * PaymentApi - factory interface
+ * @export
+ */
+export declare const PaymentApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Create a new payment instruction to be used when linking to perform debit authorization
+     * @param {CustomerPaymentInstruction} paymentInstruction Request body for starting a new Link
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createPaymentInstruction(paymentInstruction: CustomerPaymentInstruction, options?: any): AxiosPromise<CreatePaymentInstructionResponse>;
+    /**
+     * Get payment instructions to be used when linking to perform debit authorization by id
+     * @param {string} paymentInstructionId The id of a payment instruction
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPaymentInstruction(paymentInstructionId: string, options?: any): AxiosPromise<GetPaymentInstructionsResponse>;
+};
+/**
+ * PaymentApi - interface
+ * @export
+ * @interface PaymentApi
+ */
+export interface PaymentApiInterface {
+    /**
+     * Create a new payment instruction to be used when linking to perform debit authorization
+     * @param {CustomerPaymentInstruction} paymentInstruction Request body for starting a new Link
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PaymentApiInterface
+     */
+    createPaymentInstruction(paymentInstruction: CustomerPaymentInstruction, options?: AxiosRequestConfig): AxiosPromise<CreatePaymentInstructionResponse>;
+    /**
+     * Get payment instructions to be used when linking to perform debit authorization by id
+     * @param {string} paymentInstructionId The id of a payment instruction
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PaymentApiInterface
+     */
+    getPaymentInstruction(paymentInstructionId: string, options?: AxiosRequestConfig): AxiosPromise<GetPaymentInstructionsResponse>;
+}
+/**
+ * PaymentApi - object-oriented interface
+ * @export
+ * @class PaymentApi
+ * @extends {BaseAPI}
+ */
+export declare class PaymentApi extends BaseAPI implements PaymentApiInterface {
+    /**
+     * Create a new payment instruction to be used when linking to perform debit authorization
+     * @param {CustomerPaymentInstruction} paymentInstruction Request body for starting a new Link
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PaymentApi
+     */
+    createPaymentInstruction(paymentInstruction: CustomerPaymentInstruction, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePaymentInstructionResponse>>;
+    /**
+     * Get payment instructions to be used when linking to perform debit authorization by id
+     * @param {string} paymentInstructionId The id of a payment instruction
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PaymentApi
+     */
+    getPaymentInstruction(paymentInstructionId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPaymentInstructionsResponse>>;
+}
 /**
  * PublicApi - axios parameter creator
  * @export

package/dist/api.js

@@ -22,19 +22,22 @@ 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.CustomerApi = exports.CustomerApiFactory = exports.CustomerApiFp = exports.CustomerApiAxiosParamCreator = exports.PaymentInstructionPaymentTypeEnum = exports.LinkTokenRequestUiModeEnum = void 0;
+exports.PublicApi = exports.PublicApiFactory = exports.PublicApiFp = exports.PublicApiAxiosParamCreator = exports.PaymentApi = exports.PaymentApiFactory = exports.PaymentApiFp = exports.PaymentApiAxiosParamCreator = exports.LoginIdentityApi = exports.LoginIdentityApiFactory = exports.LoginIdentityApiFp = exports.LoginIdentityApiAxiosParamCreator = exports.LinkApi = exports.LinkApiFactory = exports.LinkApiFp = exports.LinkApiAxiosParamCreator = exports.CustomerApi = exports.CustomerApiFactory = exports.CustomerApiFp = exports.CustomerApiAxiosParamCreator = exports.PaymentInstructionTypeEnum = exports.LinkTokenRequestUiModeEnum = exports.CustomerPaymentInstructionTypeEnum = void 0;
 const axios_1 = require("axios");
 // Some imports not used depending on template conditions
 // @ts-ignore
 const common_1 = require("./common");
 // @ts-ignore
 const base_1 = require("./base");
+exports.CustomerPaymentInstructionTypeEnum = {
+    DebitAuthorization: 'DEBIT_AUTHORIZATION',
+};
 exports.LinkTokenRequestUiModeEnum = {
     Iframe: 'iframe',
     Redirect: 'redirect',
     AutoRedirect: 'auto_redirect',
 };
-exports.PaymentInstructionPaymentTypeEnum = {
+exports.PaymentInstructionTypeEnum = {
     DebitAuthorization: 'DEBIT_AUTHORIZATION',
 };
 /**
@@ -45,7 +48,7 @@ exports.CustomerApiAxiosParamCreator = function (configuration) {
     return {
         /**
          * Create a new payment instruction to be used when linking to perform debit authorization
-         * @param {PaymentInstruction} paymentInstruction Request body for starting a new Link
+         * @param {CustomerPaymentInstruction} paymentInstruction Request body for starting a new Link
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -197,6 +200,36 @@ exports.CustomerApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * Get payment instructions to be used when linking to perform debit authorization by id
+         * @param {string} paymentInstructionId The id of a payment instruction
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getPaymentInstruction: (paymentInstructionId, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'paymentInstructionId' is not null or undefined
+            common_1.assertParamExists('getPaymentInstruction', 'paymentInstructionId', paymentInstructionId);
+            const localVarPath = `/payments/instruction/{paymentInstructionId}`.replace(`{${'paymentInstructionId'}}`, encodeURIComponent(String(paymentInstructionId)));
+            // 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] The country the institution belongs to
@@ -283,7 +316,7 @@ exports.CustomerApiFp = function (configuration) {
     return {
         /**
          * Create a new payment instruction to be used when linking to perform debit authorization
-         * @param {PaymentInstruction} paymentInstruction Request body for starting a new Link
+         * @param {CustomerPaymentInstruction} paymentInstruction Request body for starting a new Link
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -341,6 +374,18 @@ exports.CustomerApiFp = function (configuration) {
                 return common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
             });
         },
+        /**
+         * Get payment instructions to be used when linking to perform debit authorization by id
+         * @param {string} paymentInstructionId The id of a payment instruction
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getPaymentInstruction(paymentInstructionId, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getPaymentInstruction(paymentInstructionId, options);
+                return common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
+            });
+        },
         /**
          * Get a list of institutions
          * @param {string} [country] The country the institution belongs to
@@ -379,7 +424,7 @@ exports.CustomerApiFactory = function (configuration, basePath, axios) {
     return {
         /**
          * Create a new payment instruction to be used when linking to perform debit authorization
-         * @param {PaymentInstruction} paymentInstruction Request body for starting a new Link
+         * @param {CustomerPaymentInstruction} paymentInstruction Request body for starting a new Link
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -424,6 +469,17 @@ exports.CustomerApiFactory = function (configuration, basePath, axios) {
         getLoginIdentityHistory(loginIdentityId, options) {
             return localVarFp.getLoginIdentityHistory(loginIdentityId, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Get payment instructions to be used when linking to perform debit authorization by id
+         * @param {string} paymentInstructionId The id of a payment instruction
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getPaymentInstruction(paymentInstructionId, options) {
+            return localVarFp
+                .getPaymentInstruction(paymentInstructionId, options)
+                .then((request) => request(axios, basePath));
+        },
         /**
          * Get a list of institutions
          * @param {string} [country] The country the institution belongs to
@@ -458,7 +514,7 @@ exports.CustomerApiFactory = function (configuration, basePath, axios) {
 class CustomerApi extends base_1.BaseAPI {
     /**
      * Create a new payment instruction to be used when linking to perform debit authorization
-     * @param {PaymentInstruction} paymentInstruction Request body for starting a new Link
+     * @param {CustomerPaymentInstruction} paymentInstruction Request body for starting a new Link
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof CustomerApi
@@ -516,6 +572,18 @@ class CustomerApi extends base_1.BaseAPI {
             .getLoginIdentityHistory(loginIdentityId, options)
             .then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Get payment instructions to be used when linking to perform debit authorization by id
+     * @param {string} paymentInstructionId The id of a payment instruction
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomerApi
+     */
+    getPaymentInstruction(paymentInstructionId, options) {
+        return exports.CustomerApiFp(this.configuration)
+            .getPaymentInstruction(paymentInstructionId, options)
+            .then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Get a list of institutions
      * @param {string} [country] The country the institution belongs to
@@ -1302,33 +1370,6 @@ exports.LoginIdentityApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
-        /**
-         * Get list of payment instructions to be used when linking to perfom debit authorization
-         * @param {*} [options] Override http request option.
-         * @throws {RequiredError}
-         */
-        listPaymentInstructions: (options = {}) => __awaiter(this, void 0, void 0, function* () {
-            const localVarPath = `/payments/instruction`;
-            // 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 transactions for a particular account. The transactions are returned in sorted order, with the most recent one appearing first.
          * @param {string} accountId The account id (ULID, example - 01EP4A1MZDHKETZFRPF0K62S6S)
@@ -1576,17 +1617,6 @@ exports.LoginIdentityApiFp = function (configuration) {
                 return common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
             });
         },
-        /**
-         * Get list of payment instructions to be used when linking to perfom debit authorization
-         * @param {*} [options] Override http request option.
-         * @throws {RequiredError}
-         */
-        listPaymentInstructions(options) {
-            return __awaiter(this, void 0, void 0, function* () {
-                const localVarAxiosArgs = yield localVarAxiosParamCreator.listPaymentInstructions(options);
-                return common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
-            });
-        },
         /**
          * Get a list of transactions for a particular account. The transactions are returned in sorted order, with the most recent one appearing first.
          * @param {string} accountId The account id (ULID, example - 01EP4A1MZDHKETZFRPF0K62S6S)
@@ -1736,14 +1766,6 @@ exports.LoginIdentityApiFactory = function (configuration, basePath, axios) {
         listAccounts(options) {
             return localVarFp.listAccounts(options).then((request) => request(axios, basePath));
         },
-        /**
-         * Get list of payment instructions to be used when linking to perfom debit authorization
-         * @param {*} [options] Override http request option.
-         * @throws {RequiredError}
-         */
-        listPaymentInstructions(options) {
-            return localVarFp.listPaymentInstructions(options).then((request) => request(axios, basePath));
-        },
         /**
          * Get a list of transactions for a particular account. The transactions are returned in sorted order, with the most recent one appearing first.
          * @param {string} accountId The account id (ULID, example - 01EP4A1MZDHKETZFRPF0K62S6S)
@@ -1924,17 +1946,6 @@ class LoginIdentityApi extends base_1.BaseAPI {
             .listAccounts(options)
             .then((request) => request(this.axios, this.basePath));
     }
-    /**
-     * Get list of payment instructions to be used when linking to perfom debit authorization
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof LoginIdentityApi
-     */
-    listPaymentInstructions(options) {
-        return exports.LoginIdentityApiFp(this.configuration)
-            .listPaymentInstructions(options)
-            .then((request) => request(this.axios, this.basePath));
-    }
     /**
      * Get a list of transactions for a particular account. The transactions are returned in sorted order, with the most recent one appearing first.
      * @param {string} accountId The account id (ULID, example - 01EP4A1MZDHKETZFRPF0K62S6S)
@@ -1975,6 +1986,173 @@ class LoginIdentityApi extends base_1.BaseAPI {
     }
 }
 exports.LoginIdentityApi = LoginIdentityApi;
+/**
+ * PaymentApi - axios parameter creator
+ * @export
+ */
+exports.PaymentApiAxiosParamCreator = function (configuration) {
+    return {
+        /**
+         * Create a new payment instruction to be used when linking to perform debit authorization
+         * @param {CustomerPaymentInstruction} paymentInstruction Request body for starting a new Link
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createPaymentInstruction: (paymentInstruction, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'paymentInstruction' is not null or undefined
+            common_1.assertParamExists('createPaymentInstruction', 'paymentInstruction', paymentInstruction);
+            const localVarPath = `/payments/instruction`;
+            // 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);
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            common_1.setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            localVarRequestOptions.data = common_1.serializeDataIfNeeded(paymentInstruction, localVarRequestOptions, configuration);
+            return {
+                url: common_1.toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         * Get payment instructions to be used when linking to perform debit authorization by id
+         * @param {string} paymentInstructionId The id of a payment instruction
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getPaymentInstruction: (paymentInstructionId, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'paymentInstructionId' is not null or undefined
+            common_1.assertParamExists('getPaymentInstruction', 'paymentInstructionId', paymentInstructionId);
+            const localVarPath = `/payments/instruction/{paymentInstructionId}`.replace(`{${'paymentInstructionId'}}`, encodeURIComponent(String(paymentInstructionId)));
+            // 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,
+            };
+        }),
+    };
+};
+/**
+ * PaymentApi - functional programming interface
+ * @export
+ */
+exports.PaymentApiFp = function (configuration) {
+    const localVarAxiosParamCreator = exports.PaymentApiAxiosParamCreator(configuration);
+    return {
+        /**
+         * Create a new payment instruction to be used when linking to perform debit authorization
+         * @param {CustomerPaymentInstruction} paymentInstruction Request body for starting a new Link
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createPaymentInstruction(paymentInstruction, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.createPaymentInstruction(paymentInstruction, options);
+                return common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
+            });
+        },
+        /**
+         * Get payment instructions to be used when linking to perform debit authorization by id
+         * @param {string} paymentInstructionId The id of a payment instruction
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getPaymentInstruction(paymentInstructionId, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getPaymentInstruction(paymentInstructionId, options);
+                return common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
+            });
+        },
+    };
+};
+/**
+ * PaymentApi - factory interface
+ * @export
+ */
+exports.PaymentApiFactory = function (configuration, basePath, axios) {
+    const localVarFp = exports.PaymentApiFp(configuration);
+    return {
+        /**
+         * Create a new payment instruction to be used when linking to perform debit authorization
+         * @param {CustomerPaymentInstruction} paymentInstruction Request body for starting a new Link
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createPaymentInstruction(paymentInstruction, options) {
+            return localVarFp
+                .createPaymentInstruction(paymentInstruction, options)
+                .then((request) => request(axios, basePath));
+        },
+        /**
+         * Get payment instructions to be used when linking to perform debit authorization by id
+         * @param {string} paymentInstructionId The id of a payment instruction
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getPaymentInstruction(paymentInstructionId, options) {
+            return localVarFp
+                .getPaymentInstruction(paymentInstructionId, options)
+                .then((request) => request(axios, basePath));
+        },
+    };
+};
+/**
+ * PaymentApi - object-oriented interface
+ * @export
+ * @class PaymentApi
+ * @extends {BaseAPI}
+ */
+class PaymentApi extends base_1.BaseAPI {
+    /**
+     * Create a new payment instruction to be used when linking to perform debit authorization
+     * @param {CustomerPaymentInstruction} paymentInstruction Request body for starting a new Link
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PaymentApi
+     */
+    createPaymentInstruction(paymentInstruction, options) {
+        return exports.PaymentApiFp(this.configuration)
+            .createPaymentInstruction(paymentInstruction, options)
+            .then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Get payment instructions to be used when linking to perform debit authorization by id
+     * @param {string} paymentInstructionId The id of a payment instruction
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PaymentApi
+     */
+    getPaymentInstruction(paymentInstructionId, options) {
+        return exports.PaymentApiFp(this.configuration)
+            .getPaymentInstruction(paymentInstructionId, options)
+            .then((request) => request(this.axios, this.basePath));
+    }
+}
+exports.PaymentApi = PaymentApi;
 /**
  * PublicApi - axios parameter creator
  * @export

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@finverse/sdk-typescript",
-  "version": "0.0.17",
+  "version": "0.0.20",
   "description": "OpenAPI client for @finverse/sdk-typescript",
   "author": "OpenAPI-Generator Contributors",
   "keywords": [
@@ -11,11 +11,11 @@
     "@finverse/sdk-typescript"
   ],
   "license": "MIT",
-  "main": "index",
-  "typings": "index",
+  "main": "dist/index.js",
+  "typings": "dist/index.js",
   "scripts": {
-    "build": "tsc --outDir dist/",
-    "prepare": "npm run build"
+    "build": "tsc --outDir dist",
+    "test": "mocha --require ts-node/register test/**/*.spec.ts"
   },
   "dependencies": {
     "axios": "^0.21.4"