@finverse/sdk-typescript 0.0.19 → 0.0.22

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

@@ -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,19 @@ export interface GetLoginIdentityHistoryResponse {
      */
     status_history?: Array<LoginIdentityStatusDetails>;
 }
+/**
+ *
+ * @export
+ * @interface GetPaymentInstructionsResponse
+ */
+export interface GetPaymentInstructionsResponse {
+    /**
+     *
+     * @type {PaymentInstruction}
+     * @memberof GetPaymentInstructionsResponse
+     */
+    payment_instruction?: PaymentInstruction;
+}
 /**
  *
  * @export
@@ -1141,7 +1237,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 +1624,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 +2051,23 @@ 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;
+    /**
+     * An id that links this payment to a specific Login Identity
+     * @type {string}
+     * @memberof PaymentInstruction
+     */
+    login_identity_id?: string;
     /**
-     * What type of payment is being created
+     * Type of payment that was 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 +2117,46 @@ 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
+     * Status of the payment
      * @type {string}
      * @memberof PaymentInstruction
      */
-    idempotence_key?: string;
+    status?: string;
     /**
-     * Status of the payment
+     * Reference identification returned by institution
      * @type {string}
      * @memberof PaymentInstruction
      */
-    payment_status?: string;
+    reference_id?: string;
     /**
-     * Reference identification returned by institution
+     *
      * @type {string}
      * @memberof PaymentInstruction
      */
-    reference_id?: string;
+    last_update?: 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
@@ -2457,12 +2540,12 @@ 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
+     * 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: 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 by payment_instruction_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
@@ -2515,12 +2605,12 @@ 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
+     * 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: 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 by payment_instruction_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
@@ -2573,12 +2670,12 @@ 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
+     * 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: 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 by payment_instruction_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
@@ -2632,13 +2736,13 @@ 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
+     * 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}
      * @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 by payment_instruction_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
@@ -2699,13 +2811,13 @@ 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
+     * 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}
      * @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 by payment_instruction_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 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 by payment_instruction_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 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 by payment_instruction_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 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 by payment_instruction_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 new payment
+     * @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 by payment_instruction_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 new payment
+     * @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 by payment_instruction_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',
 };
 /**
@@ -44,8 +47,8 @@ exports.PaymentInstructionPaymentTypeEnum = {
 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
+         * 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}
          */
@@ -197,6 +200,36 @@ exports.CustomerApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * Get payment instructions by payment_instruction_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
@@ -282,8 +315,8 @@ exports.CustomerApiFp = function (configuration) {
     const localVarAxiosParamCreator = exports.CustomerApiAxiosParamCreator(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
+         * 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}
          */
@@ -341,6 +374,18 @@ exports.CustomerApiFp = function (configuration) {
                 return common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
             });
         },
+        /**
+         * Get payment instructions by payment_instruction_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
@@ -378,8 +423,8 @@ 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
-         * @param {PaymentInstruction} paymentInstruction Request body for starting a new Link
+         * 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}
          */
@@ -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 by payment_instruction_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
@@ -457,8 +513,8 @@ 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
+     * 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}
      * @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 by payment_instruction_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 new payment
+         * @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 by payment_instruction_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 new payment
+         * @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 by payment_instruction_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 new payment
+         * @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 by payment_instruction_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 new payment
+     * @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 by payment_instruction_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/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.19",
+  "version": "0.0.22",
   "description": "OpenAPI client for @finverse/sdk-typescript",
   "author": "OpenAPI-Generator Contributors",
   "keywords": [
@@ -21,7 +21,7 @@
     "axios": "^0.21.4"
   },
   "devDependencies": {
-    "@types/chai": "^4.3.0",
+    "@types/chai": "^4.3.1",
     "@types/mocha": "^9.1.0",
     "@types/node": "^12.11.5",
     "axios-mock-adapter": "^1.20.0",