@finverse/sdk-typescript 0.0.38 → 0.0.39

package/dist/api.d.ts

@@ -425,6 +425,49 @@ export interface CreatePaymentInstructionResponse {
      */
     payment_instruction_id?: string;
 }
+/**
+ *
+ * @export
+ * @interface CreatePaymentRequest
+ */
+export interface CreatePaymentRequest {
+    /**
+     * Amount to be paid, in currency’s smallest unit or “minor unit”, as defined in ISO 4217. For example, HKD 100.01 is represented as amount = 10001 (minor unit = cents). For currencies without minor units (e.g. VND, JPY), the amount is represented as is, without modification. For example, VND 15101 is represented as amount = 15101.
+     * @type {number}
+     * @memberof CreatePaymentRequest
+     */
+    amount: number;
+    /**
+     * Indicates whether this is a mandate-based payment or one-off direct payment to an account. Possible values - MANDATE, SINGLE
+     * @type {string}
+     * @memberof CreatePaymentRequest
+     */
+    type: CreatePaymentRequestTypeEnum;
+    /**
+     *
+     * @type {PaymentDetails2}
+     * @memberof CreatePaymentRequest
+     */
+    payment_details: PaymentDetails2;
+}
+export declare const CreatePaymentRequestTypeEnum: {
+    readonly Mandate: "MANDATE";
+    readonly Single: "SINGLE";
+};
+export declare type CreatePaymentRequestTypeEnum = typeof CreatePaymentRequestTypeEnum[keyof typeof CreatePaymentRequestTypeEnum];
+/**
+ *
+ * @export
+ * @interface CreatePaymentResponse
+ */
+export interface CreatePaymentResponse {
+    /**
+     * Finverse Payment ID
+     * @type {string}
+     * @memberof CreatePaymentResponse
+     */
+    payment_id?: string;
+}
 /**
  *
  * @export
@@ -877,6 +920,58 @@ export interface GetPaymentInstructionsResponse {
      */
     payment_instruction?: PaymentInstruction;
 }
+/**
+ *
+ * @export
+ * @interface GetPaymentResponse
+ */
+export interface GetPaymentResponse {
+    /**
+     * Finverse Payment ID
+     * @type {string}
+     * @memberof GetPaymentResponse
+     */
+    payment_id?: string;
+    /**
+     * Amount to be paid, in currency’s smallest unit or “minor unit”, as defined in ISO 4217. For example, HKD 100.01 is represented as amount = 10001 (minor unit = cents). For currencies without minor units (e.g. VND, JPY), the amount is represented as is, without modification. For example, VND 15101 is represented as amount = 15101.
+     * @type {number}
+     * @memberof GetPaymentResponse
+     */
+    amount?: number;
+    /**
+     * Indicates whether this is a mandate-based payment or one-off direct payment to an account. Possible values - MANDATE, SINGLE
+     * @type {string}
+     * @memberof GetPaymentResponse
+     */
+    type?: GetPaymentResponseTypeEnum;
+    /**
+     * Possible values - CREATED, AUTHORIZED, SUBMITTED, EXECUTED, FAILED, REJECTED, CANCELLED.
+     * @type {string}
+     * @memberof GetPaymentResponse
+     */
+    status?: GetPaymentResponseStatusEnum;
+    /**
+     *
+     * @type {PaymentDetails2}
+     * @memberof GetPaymentResponse
+     */
+    payment_details?: PaymentDetails2;
+}
+export declare const GetPaymentResponseTypeEnum: {
+    readonly Mandate: "MANDATE";
+    readonly Single: "SINGLE";
+};
+export declare type GetPaymentResponseTypeEnum = typeof GetPaymentResponseTypeEnum[keyof typeof GetPaymentResponseTypeEnum];
+export declare const GetPaymentResponseStatusEnum: {
+    readonly Created: "CREATED";
+    readonly Authorized: "AUTHORIZED";
+    readonly Submitted: "SUBMITTED";
+    readonly Executed: "EXECUTED";
+    readonly Failed: "FAILED";
+    readonly Rejected: "REJECTED";
+    readonly Cancelled: "CANCELLED";
+};
+export declare type GetPaymentResponseStatusEnum = typeof GetPaymentResponseStatusEnum[keyof typeof GetPaymentResponseStatusEnum];
 /**
  *
  * @export
@@ -2244,6 +2339,31 @@ export interface PaymentDetails {
      */
     other_info?: OtherInfo;
 }
+/**
+ *
+ * @export
+ * @interface PaymentDetails2
+ */
+export interface PaymentDetails2 {
+    /**
+     * The transaction description provided to banks, which banks will show to their customers.
+     * @type {string}
+     * @memberof PaymentDetails2
+     */
+    description?: string;
+    /**
+     * ID of the mandate this pament is referring to.
+     * @type {string}
+     * @memberof PaymentDetails2
+     */
+    mandate_id: string;
+    /**
+     * Customer\'s ID for this transaction
+     * @type {string}
+     * @memberof PaymentDetails2
+     */
+    transaction_reference_id?: string;
+}
 /**
  *
  * @export
@@ -2905,6 +3025,13 @@ export declare type TransactionLimitsPeriodEnum = typeof TransactionLimitsPeriod
  * @export
  */
 export declare const CustomerApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Create new Payment
+     * @param {CreatePaymentRequest} createPaymentRequest request body for creating payment
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createPayment: (createPaymentRequest: CreatePaymentRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Create a new payment instruction to be used when linking to perform new payment
      * @param {CustomerPaymentInstruction} paymentInstruction Request body for starting a new Link
@@ -2947,6 +3074,13 @@ export declare const CustomerApiAxiosParamCreator: (configuration?: Configuratio
      * @throws {RequiredError}
      */
     getMandates: (mandateId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get Payment details by payment_id
+     * @param {string} paymentId payment id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPayment: (paymentId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Get payment instructions by payment_instruction_id
      * @param {string} paymentInstructionId The id of a payment instruction
@@ -2984,6 +3118,13 @@ export declare const CustomerApiAxiosParamCreator: (configuration?: Configuratio
  * @export
  */
 export declare const CustomerApiFp: (configuration?: Configuration) => {
+    /**
+     * Create new Payment
+     * @param {CreatePaymentRequest} createPaymentRequest request body for creating payment
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createPayment(createPaymentRequest: CreatePaymentRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePaymentResponse>>;
     /**
      * Create a new payment instruction to be used when linking to perform new payment
      * @param {CustomerPaymentInstruction} paymentInstruction Request body for starting a new Link
@@ -3026,6 +3167,13 @@ export declare const CustomerApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getMandates(mandateId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetMandatesResponse>>;
+    /**
+     * Get Payment details by payment_id
+     * @param {string} paymentId payment id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPayment(paymentId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPaymentResponse>>;
     /**
      * Get payment instructions by payment_instruction_id
      * @param {string} paymentInstructionId The id of a payment instruction
@@ -3063,6 +3211,13 @@ export declare const CustomerApiFp: (configuration?: Configuration) => {
  * @export
  */
 export declare const CustomerApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Create new Payment
+     * @param {CreatePaymentRequest} createPaymentRequest request body for creating payment
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createPayment(createPaymentRequest: CreatePaymentRequest, options?: any): AxiosPromise<CreatePaymentResponse>;
     /**
      * Create a new payment instruction to be used when linking to perform new payment
      * @param {CustomerPaymentInstruction} paymentInstruction Request body for starting a new Link
@@ -3105,6 +3260,13 @@ export declare const CustomerApiFactory: (configuration?: Configuration, basePat
      * @throws {RequiredError}
      */
     getMandates(mandateId: string, options?: any): AxiosPromise<GetMandatesResponse>;
+    /**
+     * Get Payment details by payment_id
+     * @param {string} paymentId payment id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPayment(paymentId: string, options?: any): AxiosPromise<GetPaymentResponse>;
     /**
      * Get payment instructions by payment_instruction_id
      * @param {string} paymentInstructionId The id of a payment instruction
@@ -3143,6 +3305,14 @@ export declare const CustomerApiFactory: (configuration?: Configuration, basePat
  * @interface CustomerApi
  */
 export interface CustomerApiInterface {
+    /**
+     * Create new Payment
+     * @param {CreatePaymentRequest} createPaymentRequest request body for creating payment
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomerApiInterface
+     */
+    createPayment(createPaymentRequest: CreatePaymentRequest, options?: AxiosRequestConfig): AxiosPromise<CreatePaymentResponse>;
     /**
      * Create a new payment instruction to be used when linking to perform new payment
      * @param {CustomerPaymentInstruction} paymentInstruction Request body for starting a new Link
@@ -3191,6 +3361,14 @@ export interface CustomerApiInterface {
      * @memberof CustomerApiInterface
      */
     getMandates(mandateId: string, options?: AxiosRequestConfig): AxiosPromise<GetMandatesResponse>;
+    /**
+     * Get Payment details by payment_id
+     * @param {string} paymentId payment id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomerApiInterface
+     */
+    getPayment(paymentId: string, options?: AxiosRequestConfig): AxiosPromise<GetPaymentResponse>;
     /**
      * Get payment instructions by payment_instruction_id
      * @param {string} paymentInstructionId The id of a payment instruction
@@ -3234,6 +3412,14 @@ export interface CustomerApiInterface {
  * @extends {BaseAPI}
  */
 export declare class CustomerApi extends BaseAPI implements CustomerApiInterface {
+    /**
+     * Create new Payment
+     * @param {CreatePaymentRequest} createPaymentRequest request body for creating payment
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomerApi
+     */
+    createPayment(createPaymentRequest: CreatePaymentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePaymentResponse>>;
     /**
      * Create a new payment instruction to be used when linking to perform new payment
      * @param {CustomerPaymentInstruction} paymentInstruction Request body for starting a new Link
@@ -3282,6 +3468,14 @@ export declare class CustomerApi extends BaseAPI implements CustomerApiInterface
      * @memberof CustomerApi
      */
     getMandates(mandateId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMandatesResponse>>;
+    /**
+     * Get Payment details by payment_id
+     * @param {string} paymentId payment id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomerApi
+     */
+    getPayment(paymentId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPaymentResponse>>;
     /**
      * Get payment instructions by payment_instruction_id
      * @param {string} paymentInstructionId The id of a payment instruction

package/dist/api.js

@@ -22,13 +22,17 @@ 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.TransactionLimitsPeriodEnum = exports.PaymentScheduleFrequencyEnum = exports.PaymentInstructionTypeEnum = exports.LinkTokenRequestAutomaticDataRefreshEnum = exports.LinkTokenRequestUiModeEnum = exports.GetMandatesResponseMandateStatusEnum = exports.CustomerPaymentInstructionTypeEnum = void 0;
+exports.PublicApi = exports.PublicApiFactory = exports.PublicApiFp = exports.PublicApiAxiosParamCreator = exports.LoginIdentityApi = exports.LoginIdentityApiFactory = exports.LoginIdentityApiFp = exports.LoginIdentityApiAxiosParamCreator = exports.LinkApi = exports.LinkApiFactory = exports.LinkApiFp = exports.LinkApiAxiosParamCreator = exports.CustomerApi = exports.CustomerApiFactory = exports.CustomerApiFp = exports.CustomerApiAxiosParamCreator = exports.TransactionLimitsPeriodEnum = exports.PaymentScheduleFrequencyEnum = exports.PaymentInstructionTypeEnum = exports.LinkTokenRequestAutomaticDataRefreshEnum = exports.LinkTokenRequestUiModeEnum = exports.GetPaymentResponseStatusEnum = exports.GetPaymentResponseTypeEnum = exports.GetMandatesResponseMandateStatusEnum = exports.CustomerPaymentInstructionTypeEnum = exports.CreatePaymentRequestTypeEnum = 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.CreatePaymentRequestTypeEnum = {
+    Mandate: 'MANDATE',
+    Single: 'SINGLE',
+};
 exports.CustomerPaymentInstructionTypeEnum = {
     DebitAuthorization: 'DEBIT_AUTHORIZATION',
 };
@@ -38,6 +42,19 @@ exports.GetMandatesResponseMandateStatusEnum = {
     Submitted: 'SUBMITTED',
     Error: 'ERROR',
 };
+exports.GetPaymentResponseTypeEnum = {
+    Mandate: 'MANDATE',
+    Single: 'SINGLE',
+};
+exports.GetPaymentResponseStatusEnum = {
+    Created: 'CREATED',
+    Authorized: 'AUTHORIZED',
+    Submitted: 'SUBMITTED',
+    Executed: 'EXECUTED',
+    Failed: 'FAILED',
+    Rejected: 'REJECTED',
+    Cancelled: 'CANCELLED',
+};
 exports.LinkTokenRequestUiModeEnum = {
     Iframe: 'iframe',
     Redirect: 'redirect',
@@ -72,6 +89,38 @@ exports.TransactionLimitsPeriodEnum = {
  */
 exports.CustomerApiAxiosParamCreator = function (configuration) {
     return {
+        /**
+         * Create new Payment
+         * @param {CreatePaymentRequest} createPaymentRequest request body for creating payment
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createPayment: (createPaymentRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'createPaymentRequest' is not null or undefined
+            common_1.assertParamExists('createPayment', 'createPaymentRequest', createPaymentRequest);
+            const localVarPath = `/payments`;
+            // 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(createPaymentRequest, localVarRequestOptions, configuration);
+            return {
+                url: common_1.toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
         /**
          * Create a new payment instruction to be used when linking to perform new payment
          * @param {CustomerPaymentInstruction} paymentInstruction Request body for starting a new Link
@@ -256,6 +305,36 @@ exports.CustomerApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * Get Payment details by payment_id
+         * @param {string} paymentId payment id
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getPayment: (paymentId, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'paymentId' is not null or undefined
+            common_1.assertParamExists('getPayment', 'paymentId', paymentId);
+            const localVarPath = `/payments/{paymentId}`.replace(`{${'paymentId'}}`, encodeURIComponent(String(paymentId)));
+            // 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 payment instructions by payment_instruction_id
          * @param {string} paymentInstructionId The id of a payment instruction
@@ -402,6 +481,18 @@ exports.CustomerApiAxiosParamCreator = function (configuration) {
 exports.CustomerApiFp = function (configuration) {
     const localVarAxiosParamCreator = exports.CustomerApiAxiosParamCreator(configuration);
     return {
+        /**
+         * Create new Payment
+         * @param {CreatePaymentRequest} createPaymentRequest request body for creating payment
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createPayment(createPaymentRequest, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.createPayment(createPaymentRequest, options);
+                return common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, 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
@@ -474,6 +565,18 @@ exports.CustomerApiFp = function (configuration) {
                 return common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
             });
         },
+        /**
+         * Get Payment details by payment_id
+         * @param {string} paymentId payment id
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getPayment(paymentId, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getPayment(paymentId, 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
@@ -534,6 +637,15 @@ exports.CustomerApiFp = function (configuration) {
 exports.CustomerApiFactory = function (configuration, basePath, axios) {
     const localVarFp = exports.CustomerApiFp(configuration);
     return {
+        /**
+         * Create new Payment
+         * @param {CreatePaymentRequest} createPaymentRequest request body for creating payment
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createPayment(createPaymentRequest, options) {
+            return localVarFp.createPayment(createPaymentRequest, options).then((request) => request(axios, basePath));
+        },
         /**
          * Create a new payment instruction to be used when linking to perform new payment
          * @param {CustomerPaymentInstruction} paymentInstruction Request body for starting a new Link
@@ -590,6 +702,15 @@ exports.CustomerApiFactory = function (configuration, basePath, axios) {
         getMandates(mandateId, options) {
             return localVarFp.getMandates(mandateId, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Get Payment details by payment_id
+         * @param {string} paymentId payment id
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getPayment(paymentId, options) {
+            return localVarFp.getPayment(paymentId, options).then((request) => request(axios, basePath));
+        },
         /**
          * Get payment instructions by payment_instruction_id
          * @param {string} paymentInstructionId The id of a payment instruction
@@ -642,6 +763,18 @@ exports.CustomerApiFactory = function (configuration, basePath, axios) {
  * @extends {BaseAPI}
  */
 class CustomerApi extends base_1.BaseAPI {
+    /**
+     * Create new Payment
+     * @param {CreatePaymentRequest} createPaymentRequest request body for creating payment
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomerApi
+     */
+    createPayment(createPaymentRequest, options) {
+        return exports.CustomerApiFp(this.configuration)
+            .createPayment(createPaymentRequest, options)
+            .then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Create a new payment instruction to be used when linking to perform new payment
      * @param {CustomerPaymentInstruction} paymentInstruction Request body for starting a new Link
@@ -714,6 +847,18 @@ class CustomerApi extends base_1.BaseAPI {
             .getMandates(mandateId, options)
             .then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Get Payment details by payment_id
+     * @param {string} paymentId payment id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomerApi
+     */
+    getPayment(paymentId, options) {
+        return exports.CustomerApiFp(this.configuration)
+            .getPayment(paymentId, options)
+            .then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Get payment instructions by payment_instruction_id
      * @param {string} paymentInstructionId The id of a payment instruction

package/package.json

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