@enfuce/nextgen-sdk 0.0.3 → 0.0.5

package/dist/esm/exchange-rate/api.d.ts

@@ -0,0 +1,409 @@
+/**
+ * Exchange Rates API
+ * Endpoint for querying FX rates of payment scheme (including benchmark to ECB FX rates). API enables the issuer to comply with regulation (EU) 2019/518) and provide the cardholder with a better user experience by providing real-time visibility to scheme FX rates that are used for card transactions.
+ *
+ * The version of the OpenAPI document: 1
+ * Contact: info@enfuce.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Configuration } from './configuration';
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import type { RequestArgs } from './base';
+import { BaseAPI } from './base';
+export interface ErrorResponse {
+    /**
+     * An error code indicating what kind of error. I.e. HTTP error code
+     */
+    'code'?: string;
+    /**
+     * Error message in human-readable format
+     */
+    'message'?: string;
+    /**
+     * Unique error identifier
+     */
+    'id'?: string;
+    /**
+     * Enfuce code for a specific error type
+     */
+    'errorCode'?: string;
+    /**
+     * Error type
+     */
+    'errorType'?: ErrorResponseErrorTypeEnum;
+    /**
+     * Free-form text explaining the error reason
+     */
+    'errorReason'?: string;
+    /**
+     * Datetime when error occurred
+     */
+    'timestamp'?: string;
+}
+export declare const ErrorResponseErrorTypeEnum: {
+    readonly StaticValidationError: "STATIC_VALIDATION_ERROR";
+    readonly DynamicValidationError: "DYNAMIC_VALIDATION_ERROR";
+    readonly IntegrationError: "INTEGRATION_ERROR";
+    readonly SecurityError: "SECURITY_ERROR";
+    readonly UnexpectedError: "UNEXPECTED_ERROR";
+};
+export type ErrorResponseErrorTypeEnum = typeof ErrorResponseErrorTypeEnum[keyof typeof ErrorResponseErrorTypeEnum];
+export interface GetEcbRateV1Response {
+    /**
+     * Returns the ECB exchange rate.
+     */
+    'rate'?: number;
+}
+export interface GetFxRatesV2Request {
+    /**
+     * The transaction amount in the foreign currency that the end user requests to convert
+     */
+    'fromAmount': number;
+    /**
+     * The foreign currency that the end user requests to convert. Currency is given with a ISO 4217 currency code and needs to be a European Central Bank (\"ECB\") supported currency.
+     */
+    'fromCurrency': string;
+    /**
+     * The card\'s settlement currency. Currency is given with a ISO 4217 currency code and needs to be a ECB supported currency.
+     */
+    'toCurrency': string;
+    /**
+     * The issuer\'s mark-up percentage that is applied to foreign currency purchases
+     */
+    'issuerMarkupPercentage': number;
+}
+export interface GetFxRatesV2Response {
+    /**
+     * The transaction amount in the foreign currency that the end user requests to convert
+     */
+    'fromAmount'?: number;
+    /**
+     * The foreign currency that the end user requests to convert. Currency is given with a ISO 4217 currency code and needs to be a European Central Bank (\"ECB\") supported currency.
+     */
+    'fromCurrency'?: string;
+    /**
+     * The card\'s settlement currency. Currency is given with a ISO 4217 currency code and needs to be a ECB supported currency.
+     */
+    'toCurrency'?: string;
+    /**
+     * The transaction amount in the card\'s settlement currency converted with the payment scheme\'s rate but not considering the issuer mark-up. Derived by converting the fromAmount using payment scheme rates between from and to currency pairs. Mark-up rate is not included in the calculations. Exchange rates used for conversion will be the latest rates available. The value is always rounded to two (2) decimal places.
+     */
+    'toAmountWithSchemeRate'?: number;
+    /**
+     * The transaction amount in the card\'s settlement currency converted with payment scheme\'s rate considering the issuer mark-up. Derived by converting the fromAmount using ECB rates between from and to currency pairs. Additional rate is not included in the calculations. Exchange rates used for conversion will be the latest rates available. The value is always rounded to two (2) decimal places.
+     */
+    'toAmountWithMarkup'?: number;
+    /**
+     * The transaction amount in the card\'s settlement currency converted with the ECB\'s rate but not considering the issuer mark-up. Derived by converting the fromAmount using ECB rates between from and to currency pairs. Mark-up rate is not included in the calculations. Exchange rates used for conversion will be the latest rates available. The value is always rounded to two (2) decimal places.
+     */
+    'toAmountWithEcbRate'?: number;
+    /**
+     * Payment scheme exchange rate for the fromCurrency and toCurrency currency pair. This rate will not include any issuer mark-up. The value is always rounded to four (4) decimal places. As of 12/2022, Visa and Mastercard update their exchange rates on business days at 1 AM (GMT) and at 6 PM (GMT) respectively. Please note that the times at which payment schemes update their rates is subject to change without advance notice. However, the exchange rate applied and provided by Enfuce is always the latest one at any given time.
+     */
+    'fxRatePaymentScheme'?: number;
+    /**
+     * Payment scheme exchange rate for the fromCurrency and toCurrency currency pair. This rate will not include any issuer mark-up. The value is always rounded to eight (8) decimal places. As of 12/2022, Visa and Mastercard update their exchange rates on business days at 1 AM (GMT) and at 6 PM (GMT) respectively. Please note that the times at which payment schemes update their rates is subject to change without advance notice. However, the exchange rate applied and provided by Enfuce is always the latest one at any given time.
+     */
+    'fxRatePaymentSchemeRaw'?: number;
+    /**
+     * Applicable exchange rate for the customer, i.e. payment scheme exchange rate between the fromCurrency and toCurrency currency pair including issuer mark-up. The value is always rounded to four (4) decimal places.
+     */
+    'fxRateWithMarkup'?: number;
+    /**
+     * Applicable exchange rate for the customer, i.e. payment scheme exchange rate between the fromCurrency and toCurrency currency pair including issuer mark-up. The value is always rounded to eight (8) decimal places.
+     */
+    'fxRateWithMarkupRaw'?: number;
+    /**
+     * ECB exchange rate between the fromCurrency and toCurrency currency pair including issuer mark-up. The value is always rounded to four (4) decimal places. As of 12/2022, the ECB updates exchange rates once per business day around 2 PM (GMT). Please note that the times at which the ECB updates its rates is subject to change without advance notice. However, the exchange rate applied and provided by Enfuce is always the latest one at any given time.
+     */
+    'fxRateEcb'?: number;
+    /**
+     * ECB exchange rate between the fromCurrency and toCurrency currency pair including issuer mark-up. The value is always rounded to decimal (8) decimal places. As of 12/2022, the ECB updates exchange rates once per business day around 2 PM (GMT). Please note that the times at which the ECB updates its rates is subject to change without advance notice. However, the exchange rate applied and provided by Enfuce is always the latest one at any given time.
+     */
+    'fxRateEcbRaw'?: number;
+    /**
+     * Comparison of the customer applicable rate (payment scheme rate plus issuer mark-up) versus the ECB rate expressed as a percentage. A positive value represents in percentages how much higher the customer applicable rate is compared to the ECB rate.
+     */
+    'markupPercentageOverEcb'?: number;
+}
+export interface GetVisaFxRatesV1Request {
+    /**
+     * From Amount also known as transaction amount that will be converted from the \"fromCurrency\" and to the \"toCurrency\"
+     */
+    'fromAmount': number;
+    /**
+     * Any ECB supported currency with valid ISO 4217 currency code
+     */
+    'fromCurrency': string;
+    /**
+     * Any ECB supported currency with valid ISO 4217 currency code
+     */
+    'toCurrency': string;
+}
+export interface GetVisaFxRatesV1Response {
+    /**
+     * From Amount also known as transaction amount that will be converted from the \"fromCurrency\" to the \"toCurrency\".
+     */
+    'fromAmount'?: number;
+    /**
+     * Any ECB supported currency with valid ISO 4217 currency code
+     */
+    'fromCurrency'?: string;
+    /**
+     * Any ECB supported currency with valid ISO 4217 currency code
+     */
+    'toCurrency'?: string;
+    /**
+     * To Amount also referred to as Cardholder Billing amount without additionalRate. Derived by converting the fromAmount using Visa Treasury Rates between from and to currency pairs. Additional rate is not included in the calculations. Visa treasury rates used for conversion will be as of the last rates available.
+     */
+    'toAmountWithVisaRate'?: number;
+    /**
+     * Also referred to as Cardholder Billing amount with additional rate. Derived by converting the fromAmount using Visa Treasury Rates between fromCurrency and toCurrency currency pairs. additionalRate is included in the calculations. Visa treasury rates used for conversion will be as of the last rates available.
+     */
+    'toAmountWithAdditionalFee'?: number;
+    /**
+     * Visa Treasury Exchange Rate for the fromCurrency and toCurrency currency pair. This rate will not include any additionalRate
+     */
+    'fxRateVisa'?: number;
+    /**
+     * Applicable Exchange Rate between the fromCurrency and toCurrency currency pair including additionalRate.
+     */
+    'fxRateWithAdditionalFee'?: number;
+    /**
+     * ISO-8601 date when the Visa Treasury rates were last updated for calculations.
+     */
+    'visaRateLastUpdatedTimestamp'?: string;
+    'benchmarks'?: Array<GetVisaFxRatesV1ResponseBenchmarksInner>;
+}
+/**
+ * Will return all the benchmark properties that apply to the fromCurrency and toCurrency pair in the Visa system. The API is built to support several benchmarks but ECB is the only available benchmark for now.
+ */
+export interface GetVisaFxRatesV1ResponseBenchmarksInner {
+    /**
+     * The benchmark system used for getting the benchmark properties. For example will be ECB for ECB benchmark rate system. All benchmark rates and any markups are calculated based on the last available benchmark rates (from the standard rate system - in this case ECB) and Visa treasury rates
+     */
+    'benchmarkSystem'?: string;
+    /**
+     * Derived by converting the fromAmount using Benchmark Rates between fromCurrency and toCurrency currency pairs. additionalRate is not included in the calculations. Benchmark rates used for conversion will be as of the last rates available on the benchmark system for example ECB.
+     */
+    'toAmountWithBenchmarkRate'?: number;
+    /**
+     * Markup calculated between the toAmountWithAdditionalFee and toAmountWithBenchmarkRate. Calculated as (toAmountWithAdditionalFee - toAmountWithBenchmarkRate)/toAmountWithBenchmarkRate.
+     */
+    'markupWithAdditionalFee'?: number;
+    /**
+     * Exchange rate between the \"from\" and \"to\" currency pair using the benchmark rates
+     */
+    'benchmarkFxRate'?: number;
+    /**
+     * ISO-8601 date when the benchmark rates were last updated for calculations.
+     */
+    'benchmarkRateLastUpdatedTimestamp'?: string;
+}
+/**
+ * Indicates the applicable payment scheme
+ */
+export declare const PaymentScheme: {
+    readonly Visa: "VISA";
+    readonly Mc: "MC";
+};
+export type PaymentScheme = typeof PaymentScheme[keyof typeof PaymentScheme];
+/**
+ * GetECBExchangeRateApi - axios parameter creator
+ */
+export declare const GetECBExchangeRateApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Send a request to this endpoint to get ECB rate for a given “from” and “to” currency pair.
+     * @summary ECB Exchange Rates
+     * @param {string} fromCurrency
+     * @param {string} toCurrency
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getEcbRateV1: (fromCurrency: string, toCurrency: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * GetECBExchangeRateApi - functional programming interface
+ */
+export declare const GetECBExchangeRateApiFp: (configuration?: Configuration) => {
+    /**
+     * Send a request to this endpoint to get ECB rate for a given “from” and “to” currency pair.
+     * @summary ECB Exchange Rates
+     * @param {string} fromCurrency
+     * @param {string} toCurrency
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getEcbRateV1(fromCurrency: string, toCurrency: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEcbRateV1Response>>;
+};
+/**
+ * GetECBExchangeRateApi - factory interface
+ */
+export declare const GetECBExchangeRateApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Send a request to this endpoint to get ECB rate for a given “from” and “to” currency pair.
+     * @summary ECB Exchange Rates
+     * @param {string} fromCurrency
+     * @param {string} toCurrency
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getEcbRateV1(fromCurrency: string, toCurrency: string, options?: RawAxiosRequestConfig): AxiosPromise<GetEcbRateV1Response>;
+};
+/**
+ * GetECBExchangeRateApi - object-oriented interface
+ */
+export declare class GetECBExchangeRateApi extends BaseAPI {
+    /**
+     * Send a request to this endpoint to get ECB rate for a given “from” and “to” currency pair.
+     * @summary ECB Exchange Rates
+     * @param {string} fromCurrency
+     * @param {string} toCurrency
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getEcbRateV1(fromCurrency: string, toCurrency: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetEcbRateV1Response, any, {}>>;
+}
+/**
+ * GetECBSupportedCurrenciesApi - axios parameter creator
+ */
+export declare const GetECBSupportedCurrenciesApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Send a request to this endpoint to retrieve the list of currencies that the ECB supports.
+     * @summary ECB Supported Currencies
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getEcbSupportedCurrenciesV1: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * GetECBSupportedCurrenciesApi - functional programming interface
+ */
+export declare const GetECBSupportedCurrenciesApiFp: (configuration?: Configuration) => {
+    /**
+     * Send a request to this endpoint to retrieve the list of currencies that the ECB supports.
+     * @summary ECB Supported Currencies
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getEcbSupportedCurrenciesV1(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
+};
+/**
+ * GetECBSupportedCurrenciesApi - factory interface
+ */
+export declare const GetECBSupportedCurrenciesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Send a request to this endpoint to retrieve the list of currencies that the ECB supports.
+     * @summary ECB Supported Currencies
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getEcbSupportedCurrenciesV1(options?: RawAxiosRequestConfig): AxiosPromise<Array<string>>;
+};
+/**
+ * GetECBSupportedCurrenciesApi - object-oriented interface
+ */
+export declare class GetECBSupportedCurrenciesApi extends BaseAPI {
+    /**
+     * Send a request to this endpoint to retrieve the list of currencies that the ECB supports.
+     * @summary ECB Supported Currencies
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getEcbSupportedCurrenciesV1(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string[], any, {}>>;
+}
+/**
+ * GetFXExchangeRatesApi - axios parameter creator
+ */
+export declare const GetFXExchangeRatesApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Send a request to this endpoint to retrieve the Visa/Mastercard treasury FX rates for a given “from” and “to” currency pair.
+     * @summary FX Exchange Rates for Visa and Mastercard
+     * @param {PaymentScheme} paymentScheme Payment scheme
+     * @param {GetFxRatesV2Request} getFxRatesV2Request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSchemeFxRatesV2: (paymentScheme: PaymentScheme, getFxRatesV2Request: GetFxRatesV2Request, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * This operation is to get the VISA treasury FX rates for a given “from” and “to” currency pair.
+     * @summary VISA FX Exchange Rates
+     * @param {GetVisaFxRatesV1Request} getVisaFxRatesV1Request
+     * @param {*} [options] Override http request option.
+     * @deprecated
+     * @throws {RequiredError}
+     */
+    getVisaFxRatesV1: (getVisaFxRatesV1Request: GetVisaFxRatesV1Request, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * GetFXExchangeRatesApi - functional programming interface
+ */
+export declare const GetFXExchangeRatesApiFp: (configuration?: Configuration) => {
+    /**
+     * Send a request to this endpoint to retrieve the Visa/Mastercard treasury FX rates for a given “from” and “to” currency pair.
+     * @summary FX Exchange Rates for Visa and Mastercard
+     * @param {PaymentScheme} paymentScheme Payment scheme
+     * @param {GetFxRatesV2Request} getFxRatesV2Request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSchemeFxRatesV2(paymentScheme: PaymentScheme, getFxRatesV2Request: GetFxRatesV2Request, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetFxRatesV2Response>>;
+    /**
+     * This operation is to get the VISA treasury FX rates for a given “from” and “to” currency pair.
+     * @summary VISA FX Exchange Rates
+     * @param {GetVisaFxRatesV1Request} getVisaFxRatesV1Request
+     * @param {*} [options] Override http request option.
+     * @deprecated
+     * @throws {RequiredError}
+     */
+    getVisaFxRatesV1(getVisaFxRatesV1Request: GetVisaFxRatesV1Request, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetVisaFxRatesV1Response>>;
+};
+/**
+ * GetFXExchangeRatesApi - factory interface
+ */
+export declare const GetFXExchangeRatesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Send a request to this endpoint to retrieve the Visa/Mastercard treasury FX rates for a given “from” and “to” currency pair.
+     * @summary FX Exchange Rates for Visa and Mastercard
+     * @param {PaymentScheme} paymentScheme Payment scheme
+     * @param {GetFxRatesV2Request} getFxRatesV2Request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSchemeFxRatesV2(paymentScheme: PaymentScheme, getFxRatesV2Request: GetFxRatesV2Request, options?: RawAxiosRequestConfig): AxiosPromise<GetFxRatesV2Response>;
+    /**
+     * This operation is to get the VISA treasury FX rates for a given “from” and “to” currency pair.
+     * @summary VISA FX Exchange Rates
+     * @param {GetVisaFxRatesV1Request} getVisaFxRatesV1Request
+     * @param {*} [options] Override http request option.
+     * @deprecated
+     * @throws {RequiredError}
+     */
+    getVisaFxRatesV1(getVisaFxRatesV1Request: GetVisaFxRatesV1Request, options?: RawAxiosRequestConfig): AxiosPromise<GetVisaFxRatesV1Response>;
+};
+/**
+ * GetFXExchangeRatesApi - object-oriented interface
+ */
+export declare class GetFXExchangeRatesApi extends BaseAPI {
+    /**
+     * Send a request to this endpoint to retrieve the Visa/Mastercard treasury FX rates for a given “from” and “to” currency pair.
+     * @summary FX Exchange Rates for Visa and Mastercard
+     * @param {PaymentScheme} paymentScheme Payment scheme
+     * @param {GetFxRatesV2Request} getFxRatesV2Request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSchemeFxRatesV2(paymentScheme: PaymentScheme, getFxRatesV2Request: GetFxRatesV2Request, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetFxRatesV2Response, any, {}>>;
+    /**
+     * This operation is to get the VISA treasury FX rates for a given “from” and “to” currency pair.
+     * @summary VISA FX Exchange Rates
+     * @param {GetVisaFxRatesV1Request} getVisaFxRatesV1Request
+     * @param {*} [options] Override http request option.
+     * @deprecated
+     * @throws {RequiredError}
+     */
+    getVisaFxRatesV1(getVisaFxRatesV1Request: GetVisaFxRatesV1Request, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetVisaFxRatesV1Response, any, {}>>;
+}