@finverse/sdk-typescript 0.0.21 → 0.0.24

package/README.md

@@ -6,8 +6,7 @@ This SDK enables a basic end-to-end backend integration with the Finverse API, i
 npm install @finverse/sdk-typescript
 ```
 
-
-## Getting started
+## Getting started (Linking flow)
 
 ### 1. Authenticate with Finverse API: Obtain Customer Access Token
 ```typescript
@@ -162,3 +161,134 @@ const statementId = statements.data.statements[0].id;
 // Can download statement from here 
 const satementLink = await new LoginIdentityApi(configuration).getStatementLink(statementId);
 ```
+
+## Getting started (Payment flow)
+
+### 1. Authenticate with Finverse API: Obtain Customer Access Token
+```typescript
+// Obtain these from https://dashboard.finverse.com
+const apiHost = "https://api.sandbox.finverse.net"
+const clientId = process.env.FINVERSE_CLIENTID
+const clientSecret = process.env.FINVERSE_SECRET
+const redirectUri = process.env.REDIRECT_URI
+
+const configuration = new Configuration({ basePath: apiHost });
+// Obtain customer access token
+const customerTokenResp = await new PublicApi(configuration).generateCustomerAccessToken({
+	client_id: clientId,
+	client_secret: clientSecret,
+	grant_type: 'client_credentials',
+});
+
+const customerAccessToken = customerTokenResp.access_token
+```
+
+### 2. Create payment instruction
+```typescript
+    const configuration = new Configuration({ basePath: config.apiHost, accessToken: customerToken.access_token });
+    const paymentInstruction: CustomerPaymentInstruction = {
+      type: "DEBIT_AUTHORIZATION",
+      user_id: "customer_user1",
+      frequency: "MONTHLY",
+      start_date: "2022-04-01",
+      end_date: "2022-12-01",
+      amount: 1000,
+      currency: "PHP",
+      recipient_name: "HOMECREDIT",
+      recipient_account_id: "Recipient Account Id",
+      sender_name: "Sender Name",
+      sender_account_id: "LOAN102345",
+      remarks: "HOME CREDIT REPAYMENT"
+    };
+    const createPaymentInstructionResponse = await new CustomerApi(configuration).createPaymentInstruction(paymentInstruction);
+
+    // createPaymentInstructionResponse.data.payment_instruction_id can be used to retrieve the status
+```
+
+### 3. Link with payment instruction: Obtain Link Token and Link URL to launch Finverse Link UI
+```typescript
+// generate a link token
+
+// reference back to your system userId, finverse does not use this
+const userId = "someUserId"     
+// this will be sent in the redirectUri callback, can be used to identify the state
+const state = "someUniqueState" 
+const configuration = new Configuration({ 
+  basePath: apiHost, 
+	accessToken: customerToken.access_token
+});
+const linkTokenResp = await new CustomerApi(configuration).generateLinkToken({
+	ClientId:     clientId,
+  UserId:       userId,
+  RedirectUri:  redirectUri,
+  State:        state,
+  ResponseMode: "form_post",
+  ResponseType: "code",
+	GrantType:    "client_credentials",
+  PaymentInstructionId: createPaymentInstructionResponse.data.payment_instruction_id,
+  ProductsRequested: "PAYMENTS",
+});
+
+// The linkUrl can be used to initiate Finverse Link
+console.log("linkUrl: " + linkTokenResp.link_url)
+```
+
+### 4. Finalize linking: Exchange code for Login Identity Access Token
+```typescript
+// when Finverse Link UI is successful, obtain the code from Finverse Link
+// exchange it for a Login Identity Access Token
+const code = "obtainAfterLink"
+const configuration = new Configuration({ 
+	basePath: apiHost, 
+	accessToken: customerToken.access_token 
+});
+const loginIdentityTokenResp = await new LinkApi(configuration).token(
+	"authorization_code",
+	code,
+	clientId,
+	redirectURI,
+);
+
+// The loginIdentityToken can be used to retrieve data
+const loginIdentityToken = loginIdentityTokenResp.access_token
+```
+
+### 5. Poll loginIdentityStatus until ready
+Alternatively you can use webhook to receive LoginIdentity event.
+
+```typescript
+enum FinalStatus {
+	ERROR = 'ERROR',
+	DATA_RETRIEVAL_PARTIALLY_SUCCESSFUL = 'DATA_RETRIEVAL_PARTIALLY_SUCCESSFUL',
+	DATA_RETRIEVAL_COMPLETE = 'DATA_RETRIEVAL_COMPLETE',
+}
+
+const configuration = new Configuration({
+	basePath: apiHost,
+	accessToken: loginIdentityToken.access_token 
+});
+let loginIdentity: AxiosResponse<GetLoginIdentityByIdResponse>;
+
+// Poll until loginIdentityStatus is ready
+for (let i = 0; i < 20; i++) {
+	loginIdentity = await new LoginIdentityApi(configuration).getLoginIdentity();
+	const loginIdentityStatus = loginIdentity.data.login_identity.status;
+	if ( 
+	  loginIdentityStatus === FinalStatus.ERROR ||
+	  loginIdentityStatus === FinalStatus.DATA_RETRIEVAL_COMPLETE ||
+	  loginIdentityStatus === FinalStatus.DATA_RETRIEVAL_PARTIALLY_SUCCESSFUL
+	) { break; }
+	
+	await new Promise((resolve) => setTimeout(resolve, 3000));
+}
+
+console.log("login identity: " + loginIdentityResp.login_identity)
+```
+
+### 6. Get payment instruction status
+```typescript
+    const configuration = new Configuration({ basePath: config.apiHost, accessToken: customerToken.access_token });
+    const getPaymentInstructionResponse = await new CustomerApi(configuration).getPaymentInstruction(createPaymentInstructionResponse.data.payment_instruction_id);
+
+    console.log("paymentInstruction status: " + getPaymentInstructionResponse.data.payment_instruction.status);
+```

package/dist/api.d.ts

@@ -1162,13 +1162,13 @@ export interface IncomeEstimate {
      * @type {number}
      * @memberof IncomeEstimate
      */
-    amount?: number;
+    amount: number;
     /**
      * Currency
      * @type {string}
      * @memberof IncomeEstimate
      */
-    currency?: string;
+    currency: string;
 }
 /**
  *
@@ -1181,19 +1181,19 @@ export interface IncomeResponse {
      * @type {Array<SingleSourceIncome>}
      * @memberof IncomeResponse
      */
-    income?: Array<SingleSourceIncome>;
+    income: Array<SingleSourceIncome>;
     /**
      *
      * @type {LoginIdentityShort}
      * @memberof IncomeResponse
      */
-    login_identity?: LoginIdentityShort;
+    login_identity: LoginIdentityShort;
     /**
      *
      * @type {InstitutionShort}
      * @memberof IncomeResponse
      */
-    institution?: InstitutionShort;
+    institution: InstitutionShort;
 }
 /**
  *
@@ -1206,7 +1206,7 @@ export interface IncomeStream {
      * @type {string}
      * @memberof IncomeStream
      */
-    account_id?: string;
+    account_id: string;
     /**
      *
      * @type {IncomeEstimate}
@@ -1218,13 +1218,13 @@ export interface IncomeStream {
      * @type {number}
      * @memberof IncomeStream
      */
-    transaction_count?: number;
+    transaction_count: number;
     /**
      *
      * @type {Array<MonthlyIncomeEstimate>}
      * @memberof IncomeStream
      */
-    monthly_history?: Array<MonthlyIncomeEstimate>;
+    monthly_history: Array<MonthlyIncomeEstimate>;
 }
 /**
  *
@@ -1243,13 +1243,13 @@ export interface IncomeTotal {
      * @type {number}
      * @memberof IncomeTotal
      */
-    transaction_count?: number;
+    transaction_count: number;
     /**
      *
      * @type {Array<MonthlyIncomeEstimate>}
      * @memberof IncomeTotal
      */
-    monthly_history?: Array<MonthlyIncomeEstimate>;
+    monthly_history: Array<MonthlyIncomeEstimate>;
 }
 /**
  *
@@ -1561,6 +1561,12 @@ export interface LinkTokenRequest {
      * @memberof LinkTokenRequest
      */
     payment_instruction_id?: string;
+    /**
+     * Controls the behavior of the automatic data refresh checkbox
+     * @type {string}
+     * @memberof LinkTokenRequest
+     */
+    automatic_data_refresh?: LinkTokenRequestAutomaticDataRefreshEnum;
 }
 export declare const LinkTokenRequestUiModeEnum: {
     readonly Iframe: "iframe";
@@ -1568,6 +1574,12 @@ export declare const LinkTokenRequestUiModeEnum: {
     readonly AutoRedirect: "auto_redirect";
 };
 export declare type LinkTokenRequestUiModeEnum = typeof LinkTokenRequestUiModeEnum[keyof typeof LinkTokenRequestUiModeEnum];
+export declare const LinkTokenRequestAutomaticDataRefreshEnum: {
+    readonly On: "ON";
+    readonly Off: "OFF";
+    readonly ForcedOn: "FORCED_ON";
+};
+export declare type LinkTokenRequestAutomaticDataRefreshEnum = typeof LinkTokenRequestAutomaticDataRefreshEnum[keyof typeof LinkTokenRequestAutomaticDataRefreshEnum];
 /**
  *
  * @export
@@ -1968,19 +1980,19 @@ export interface MonthlyIncomeEstimate {
      * @type {IncomeEstimate}
      * @memberof MonthlyIncomeEstimate
      */
-    estimated_income?: IncomeEstimate;
+    estimated_income: IncomeEstimate;
     /**
      * The numeric month
      * @type {number}
      * @memberof MonthlyIncomeEstimate
      */
-    month?: number;
+    month: number;
     /**
      * The year
      * @type {number}
      * @memberof MonthlyIncomeEstimate
      */
-    year?: number;
+    year: number;
 }
 /**
  *
@@ -2063,7 +2075,7 @@ export interface PaymentInstruction {
      */
     login_identity_id?: string;
     /**
-     * Type of payment is being created, please check Documentation on which payment type is supported in each institution
+     * Type of payment that was created, please check Documentation on which payment type is supported in each institution
      * @type {string}
      * @memberof PaymentInstruction
      */
@@ -2299,25 +2311,25 @@ export interface SingleSourceIncome {
      * @type {Array<IncomeStream>}
      * @memberof SingleSourceIncome
      */
-    income_streams?: Array<IncomeStream>;
+    income_streams: Array<IncomeStream>;
     /**
      *
      * @type {IncomeTotal}
      * @memberof SingleSourceIncome
      */
-    income_total?: IncomeTotal;
+    income_total: IncomeTotal;
     /**
      * Where the income estimate was sourced from
      * @type {string}
      * @memberof SingleSourceIncome
      */
-    source?: string;
+    source: string;
     /**
      * Unknown
      * @type {string}
      * @memberof SingleSourceIncome
      */
-    source_id?: string;
+    source_id: string;
 }
 /**
  *
@@ -2540,7 +2552,7 @@ export interface Transaction {
  */
 export declare const CustomerApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
-     * Create a new payment instruction to be used when linking to perform debit authorization
+     * Create a new payment instruction to be used when linking to perform new payment
      * @param {CustomerPaymentInstruction} paymentInstruction Request body for starting a new Link
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -2575,7 +2587,7 @@ export declare const CustomerApiAxiosParamCreator: (configuration?: Configuratio
      */
     getLoginIdentityHistory: (loginIdentityId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Get payment instructions to be used when linking to perform debit authorization by id
+     * Get payment instructions by payment_instruction_id
      * @param {string} paymentInstructionId The id of a payment instruction
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -2605,7 +2617,7 @@ 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
+     * Create a new payment instruction to be used when linking to perform new payment
      * @param {CustomerPaymentInstruction} paymentInstruction Request body for starting a new Link
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -2640,7 +2652,7 @@ export declare const CustomerApiFp: (configuration?: Configuration) => {
      */
     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
+     * Get payment instructions by payment_instruction_id
      * @param {string} paymentInstructionId The id of a payment instruction
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -2670,7 +2682,7 @@ 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
+     * Create a new payment instruction to be used when linking to perform new payment
      * @param {CustomerPaymentInstruction} paymentInstruction Request body for starting a new Link
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -2705,7 +2717,7 @@ export declare const CustomerApiFactory: (configuration?: Configuration, basePat
      */
     getLoginIdentityHistory(loginIdentityId: string, options?: any): AxiosPromise<GetLoginIdentityHistoryResponse>;
     /**
-     * Get payment instructions to be used when linking to perform debit authorization by id
+     * Get payment instructions by payment_instruction_id
      * @param {string} paymentInstructionId The id of a payment instruction
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -2736,7 +2748,7 @@ export declare const CustomerApiFactory: (configuration?: Configuration, basePat
  */
 export interface CustomerApiInterface {
     /**
-     * Create a new payment instruction to be used when linking to perform debit authorization
+     * Create a new payment instruction to be used when linking to perform new payment
      * @param {CustomerPaymentInstruction} paymentInstruction Request body for starting a new Link
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -2776,7 +2788,7 @@ export interface CustomerApiInterface {
      */
     getLoginIdentityHistory(loginIdentityId: string, options?: AxiosRequestConfig): AxiosPromise<GetLoginIdentityHistoryResponse>;
     /**
-     * Get payment instructions to be used when linking to perform debit authorization by id
+     * Get payment instructions by payment_instruction_id
      * @param {string} paymentInstructionId The id of a payment instruction
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -2811,7 +2823,7 @@ 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
+     * Create a new payment instruction to be used when linking to perform new payment
      * @param {CustomerPaymentInstruction} paymentInstruction Request body for starting a new Link
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -2851,7 +2863,7 @@ export declare class CustomerApi extends BaseAPI implements CustomerApiInterface
      */
     getLoginIdentityHistory(loginIdentityId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetLoginIdentityHistoryResponse>>;
     /**
-     * Get payment instructions to be used when linking to perform debit authorization by id
+     * Get payment instructions by payment_instruction_id
      * @param {string} paymentInstructionId The id of a payment instruction
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -3695,14 +3707,14 @@ export declare class LoginIdentityApi extends BaseAPI implements LoginIdentityAp
  */
 export declare const PaymentApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
-     * Create a new payment instruction to be used when linking to perform debit authorization
+     * Create a new payment instruction to be used when linking to perform new payment
      * @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
+     * Get payment instructions by payment_instruction_id
      * @param {string} paymentInstructionId The id of a payment instruction
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -3715,14 +3727,14 @@ export declare const PaymentApiAxiosParamCreator: (configuration?: Configuration
  */
 export declare const PaymentApiFp: (configuration?: Configuration) => {
     /**
-     * Create a new payment instruction to be used when linking to perform debit authorization
+     * Create a new payment instruction to be used when linking to perform new payment
      * @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
+     * Get payment instructions by payment_instruction_id
      * @param {string} paymentInstructionId The id of a payment instruction
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -3735,14 +3747,14 @@ export declare const PaymentApiFp: (configuration?: Configuration) => {
  */
 export declare const PaymentApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
-     * Create a new payment instruction to be used when linking to perform debit authorization
+     * Create a new payment instruction to be used when linking to perform new payment
      * @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
+     * Get payment instructions by payment_instruction_id
      * @param {string} paymentInstructionId The id of a payment instruction
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -3756,7 +3768,7 @@ export declare const PaymentApiFactory: (configuration?: Configuration, basePath
  */
 export interface PaymentApiInterface {
     /**
-     * Create a new payment instruction to be used when linking to perform debit authorization
+     * Create a new payment instruction to be used when linking to perform new payment
      * @param {CustomerPaymentInstruction} paymentInstruction Request body for starting a new Link
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -3764,7 +3776,7 @@ export interface PaymentApiInterface {
      */
     createPaymentInstruction(paymentInstruction: CustomerPaymentInstruction, options?: AxiosRequestConfig): AxiosPromise<CreatePaymentInstructionResponse>;
     /**
-     * Get payment instructions to be used when linking to perform debit authorization by id
+     * Get payment instructions by payment_instruction_id
      * @param {string} paymentInstructionId The id of a payment instruction
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -3780,7 +3792,7 @@ export interface PaymentApiInterface {
  */
 export declare class PaymentApi extends BaseAPI implements PaymentApiInterface {
     /**
-     * Create a new payment instruction to be used when linking to perform debit authorization
+     * Create a new payment instruction to be used when linking to perform new payment
      * @param {CustomerPaymentInstruction} paymentInstruction Request body for starting a new Link
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -3788,7 +3800,7 @@ export declare class PaymentApi extends BaseAPI implements PaymentApiInterface {
      */
     createPaymentInstruction(paymentInstruction: CustomerPaymentInstruction, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePaymentInstructionResponse>>;
     /**
-     * Get payment instructions to be used when linking to perform debit authorization by id
+     * Get payment instructions by payment_instruction_id
      * @param {string} paymentInstructionId The id of a payment instruction
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}

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.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;
+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.LinkTokenRequestAutomaticDataRefreshEnum = exports.LinkTokenRequestUiModeEnum = exports.CustomerPaymentInstructionTypeEnum = void 0;
 const axios_1 = require("axios");
 // Some imports not used depending on template conditions
 // @ts-ignore
@@ -37,6 +37,11 @@ exports.LinkTokenRequestUiModeEnum = {
     Redirect: 'redirect',
     AutoRedirect: 'auto_redirect',
 };
+exports.LinkTokenRequestAutomaticDataRefreshEnum = {
+    On: 'ON',
+    Off: 'OFF',
+    ForcedOn: 'FORCED_ON',
+};
 exports.PaymentInstructionTypeEnum = {
     DebitAuthorization: 'DEBIT_AUTHORIZATION',
 };
@@ -47,7 +52,7 @@ exports.PaymentInstructionTypeEnum = {
 exports.CustomerApiAxiosParamCreator = function (configuration) {
     return {
         /**
-         * Create a new payment instruction to be used when linking to perform debit authorization
+         * Create a new payment instruction to be used when linking to perform new payment
          * @param {CustomerPaymentInstruction} paymentInstruction Request body for starting a new Link
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -201,7 +206,7 @@ exports.CustomerApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * Get payment instructions to be used when linking to perform debit authorization by id
+         * Get payment instructions by payment_instruction_id
          * @param {string} paymentInstructionId The id of a payment instruction
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -315,7 +320,7 @@ exports.CustomerApiFp = function (configuration) {
     const localVarAxiosParamCreator = exports.CustomerApiAxiosParamCreator(configuration);
     return {
         /**
-         * Create a new payment instruction to be used when linking to perform debit authorization
+         * Create a new payment instruction to be used when linking to perform new payment
          * @param {CustomerPaymentInstruction} paymentInstruction Request body for starting a new Link
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -375,7 +380,7 @@ exports.CustomerApiFp = function (configuration) {
             });
         },
         /**
-         * Get payment instructions to be used when linking to perform debit authorization by id
+         * Get payment instructions by payment_instruction_id
          * @param {string} paymentInstructionId The id of a payment instruction
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -423,7 +428,7 @@ exports.CustomerApiFactory = function (configuration, basePath, axios) {
     const localVarFp = exports.CustomerApiFp(configuration);
     return {
         /**
-         * Create a new payment instruction to be used when linking to perform debit authorization
+         * Create a new payment instruction to be used when linking to perform new payment
          * @param {CustomerPaymentInstruction} paymentInstruction Request body for starting a new Link
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -470,7 +475,7 @@ exports.CustomerApiFactory = function (configuration, basePath, axios) {
             return localVarFp.getLoginIdentityHistory(loginIdentityId, options).then((request) => request(axios, basePath));
         },
         /**
-         * Get payment instructions to be used when linking to perform debit authorization by id
+         * Get payment instructions by payment_instruction_id
          * @param {string} paymentInstructionId The id of a payment instruction
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -513,7 +518,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
+     * Create a new payment instruction to be used when linking to perform new payment
      * @param {CustomerPaymentInstruction} paymentInstruction Request body for starting a new Link
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -573,7 +578,7 @@ class CustomerApi extends base_1.BaseAPI {
             .then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Get payment instructions to be used when linking to perform debit authorization by id
+     * Get payment instructions by payment_instruction_id
      * @param {string} paymentInstructionId The id of a payment instruction
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -1993,7 +1998,7 @@ exports.LoginIdentityApi = LoginIdentityApi;
 exports.PaymentApiAxiosParamCreator = function (configuration) {
     return {
         /**
-         * Create a new payment instruction to be used when linking to perform debit authorization
+         * Create a new payment instruction to be used when linking to perform new payment
          * @param {CustomerPaymentInstruction} paymentInstruction Request body for starting a new Link
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -2025,7 +2030,7 @@ exports.PaymentApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * Get payment instructions to be used when linking to perform debit authorization by id
+         * Get payment instructions by payment_instruction_id
          * @param {string} paymentInstructionId The id of a payment instruction
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -2064,7 +2069,7 @@ exports.PaymentApiFp = function (configuration) {
     const localVarAxiosParamCreator = exports.PaymentApiAxiosParamCreator(configuration);
     return {
         /**
-         * Create a new payment instruction to be used when linking to perform debit authorization
+         * Create a new payment instruction to be used when linking to perform new payment
          * @param {CustomerPaymentInstruction} paymentInstruction Request body for starting a new Link
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -2076,7 +2081,7 @@ exports.PaymentApiFp = function (configuration) {
             });
         },
         /**
-         * Get payment instructions to be used when linking to perform debit authorization by id
+         * Get payment instructions by payment_instruction_id
          * @param {string} paymentInstructionId The id of a payment instruction
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -2097,7 +2102,7 @@ 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
+         * Create a new payment instruction to be used when linking to perform new payment
          * @param {CustomerPaymentInstruction} paymentInstruction Request body for starting a new Link
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -2108,7 +2113,7 @@ exports.PaymentApiFactory = function (configuration, basePath, axios) {
                 .then((request) => request(axios, basePath));
         },
         /**
-         * Get payment instructions to be used when linking to perform debit authorization by id
+         * Get payment instructions by payment_instruction_id
          * @param {string} paymentInstructionId The id of a payment instruction
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -2128,7 +2133,7 @@ exports.PaymentApiFactory = function (configuration, basePath, axios) {
  */
 class PaymentApi extends base_1.BaseAPI {
     /**
-     * Create a new payment instruction to be used when linking to perform debit authorization
+     * Create a new payment instruction to be used when linking to perform new payment
      * @param {CustomerPaymentInstruction} paymentInstruction Request body for starting a new Link
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -2140,7 +2145,7 @@ class PaymentApi extends base_1.BaseAPI {
             .then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Get payment instructions to be used when linking to perform debit authorization by id
+     * Get payment instructions by payment_instruction_id
      * @param {string} paymentInstructionId The id of a payment instruction
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}

package/dist/test/paymentInstruction.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/test/paymentInstruction.spec.js

@@ -0,0 +1,58 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const axios_mock_adapter_1 = require("axios-mock-adapter");
+const axios_1 = require("axios");
+const config_1 = require("./config");
+const __1 = require("..");
+const api_1 = require("../api");
+const customerToken_1 = require("./responses/customerToken");
+const paymentInstruction_1 = require("./responses/paymentInstruction");
+const chai_1 = require("chai");
+describe('PaymentInstruction', function () {
+    let mock;
+    before(() => {
+        mock = new axios_mock_adapter_1.default(axios_1.default);
+    });
+    it('Create paymentInstruction', function () {
+        return __awaiter(this, void 0, void 0, function* () {
+            mock.onPost(`${config_1.config.apiHost}/payments/instruction`).reply(200, paymentInstruction_1.createPaymentInstruction());
+            const configuration = new __1.Configuration({ basePath: config_1.config.apiHost, accessToken: customerToken_1.customerToken.access_token });
+            const paymentInstruction = {
+                type: "DEBIT_AUTHORIZATION",
+                user_id: "customer_user1",
+                frequency: "MONTHLY",
+                start_date: "2022-04-01",
+                end_date: "2022-12-01",
+                amount: 1000,
+                currency: "PHP",
+                recipient_name: "HOMECREDIT",
+                recipient_account_id: "Recipient Account Id",
+                sender_name: "Sender Name",
+                sender_account_id: "LOAN102345",
+                remarks: "HOME CREDIT REPAYMENT"
+            };
+            const createPaymentInstructionResponse = yield new api_1.CustomerApi(configuration).createPaymentInstruction(paymentInstruction);
+            chai_1.expect(createPaymentInstructionResponse.data.payment_instruction_id).to.be.ok;
+        });
+    });
+    it('Get paymentInstruction', function () {
+        return __awaiter(this, void 0, void 0, function* () {
+            mock.onGet(`${config_1.config.apiHost}/payments/instruction/stub_payment_instruction_id`).reply(200, paymentInstruction_1.getPaymentInstruction());
+            const configuration = new __1.Configuration({ basePath: config_1.config.apiHost, accessToken: customerToken_1.customerToken.access_token });
+            const getPaymentInstructionResponse = yield new api_1.CustomerApi(configuration).getPaymentInstruction("stub_payment_instruction_id");
+            chai_1.expect(getPaymentInstructionResponse.data.payment_instruction).to.be.ok;
+        });
+    });
+    after(() => {
+        mock.restore();
+    });
+});

package/dist/test/responses/paymentInstruction.d.ts

@@ -0,0 +1,3 @@
+import { GetPaymentInstructionsResponse, CreatePaymentInstructionResponse } from '../../api';
+export declare function createPaymentInstruction(): CreatePaymentInstructionResponse;
+export declare function getPaymentInstruction(): GetPaymentInstructionsResponse;

package/dist/test/responses/paymentInstruction.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPaymentInstruction = exports.createPaymentInstruction = void 0;
+function createPaymentInstruction() {
+    return {
+        payment_instruction_id: "01FYRK0Q1DVFTJRG50J5QT424Y",
+    };
+}
+exports.createPaymentInstruction = createPaymentInstruction;
+function getPaymentInstruction() {
+    return {
+        payment_instruction: {
+            amount: 1000,
+            currency: "PHP",
+            end_date: "2022-12-01",
+            frequency: "MONTHLY",
+            info: {},
+            recipient_account_id: "HOMECREDIT",
+            recipient_name: "HOMECREDIT",
+            reference_id: "01G0KD6Z8P06W4536X4BHEQYAX",
+            remarks: "HOME CREDIT REPAYMENT",
+            sender_account_id: "LOAN102345",
+            sender_name: "Sender Name",
+            start_date: "2022-04-01",
+            status: "SUBMITTED",
+            type: "DEBIT_AUTHORIZATION",
+        }
+    };
+}
+exports.getPaymentInstruction = getPaymentInstruction;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@finverse/sdk-typescript",
-  "version": "0.0.21",
+  "version": "0.0.24",
   "description": "OpenAPI client for @finverse/sdk-typescript",
   "author": "OpenAPI-Generator Contributors",
   "keywords": [
@@ -22,7 +22,7 @@
   },
   "devDependencies": {
     "@types/chai": "^4.3.1",
-    "@types/mocha": "^9.1.0",
+    "@types/mocha": "^9.1.1",
     "@types/node": "^12.11.5",
     "axios-mock-adapter": "^1.20.0",
     "chai": "^4.3.6",