@channelpayments/node-sdk 1.182.0 → 1.183.0

package/dist/cjs/apis/ChannelPaymentsApi.d.ts

@@ -5,7 +5,10 @@
  *
  */
 import * as runtime from '../runtime';
-import type { BuyersEntity, BuyersSearchEntity, CaptureTransactionDto, ChangeNotificationEntity, ChangeNotificationsSearchEntity, CheckoutSessionEntity, ConnectorServiceTokenEntity, CreateBuyerDto, CreateCheckoutSessionDto, CreatePaymentMethodDto, CreateProvisionedCardTokenDto, CreateTransactionRefundDto, CreateTransactionRequestDto, MerchantEntity, PaymentMethodEntity, PaymentMethodsSearchEntity, ReturnNotificationEntity, ReturnNotificationsSearchEntity, TagDto, TransactionEntity, TransactionRefundEntity, TransactionRefundsSearchEntity, TransactionsSearchEntity, UpdateBuyerDto } from '../models';
+import type { BuyersEntity, BuyersSearchEntity, CaptureTransactionDto, ChangeNotificationEntity, ChangeNotificationsSearchEntity, CheckoutSessionEntity, ConnectorServiceTokenEntity, CreateBuyerDto, CreateCheckoutSessionDto, CreatePaymentMethodDto, CreateProvisionedCardTokenDto, CreateTransactionRefundDto, CreateTransactionRequestDto, MerchantEntity, MerchantFeeDetailsEntity, PaymentMethodEntity, PaymentMethodsSearchEntity, ReturnNotificationEntity, ReturnNotificationsSearchEntity, TagDto, TransactionEntity, TransactionRefundEntity, TransactionRefundsSearchEntity, TransactionsSearchEntity, UpdateBuyerDto } from '../models';
+export interface GetFeeDetailsRequest {
+    amount: string;
+}
 export interface SearchBuyersRequest {
     merchantId: string;
     buyerId?: string;
@@ -168,6 +171,11 @@ export declare class ChannelPaymentsApi extends runtime.BaseAPI {
      * Find connector service tokens.
     */
     getConnectorServiceTokens(paymentMethodId: string): Promise<Array<ConnectorServiceTokenEntity>>;
+    /**
+     * Get fee details by amount
+     * Get fee details
+    */
+    getFeeDetails(requestParameters: GetFeeDetailsRequest): Promise<MerchantFeeDetailsEntity>;
     /**
      * Retrieve the merchant associated with the user making the request.
      * Find merchant

package/dist/cjs/apis/ChannelPaymentsApi.js

@@ -1045,6 +1045,76 @@ class ChannelPaymentsApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Get fee details by amount
+     * Get fee details
+    */
+    getFeeDetails(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters.amount === null || requestParameters.amount === undefined) {
+                throw new runtime.RequiredError('amount', 'Required parameter \'amount\' was null or undefined when calling getFeeDetails.');
+            }
+            const queryParameters = {};
+            if (requestParameters.amount !== undefined) {
+                queryParameters['amount'] = requestParameters.amount;
+            }
+            const headerParameters = {};
+            const rawResponse = yield this.request({
+                path: `/transactions/fee-details`,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            });
+            let response;
+            if (rawResponse.status === 200) {
+                response = new runtime.JSONApiResponse(rawResponse, (jsonValue) => (0, models_1.MerchantFeeDetailsEntityFromJSON)(jsonValue));
+            }
+            if (rawResponse.status === 400) {
+                const errorResponse = new runtime.JSONApiResponse(rawResponse, (jsonValue) => (0, models_1.ErrorEntityFromJSON)(jsonValue));
+                const error = yield errorResponse.value();
+                throw error;
+            }
+            if (rawResponse.status === 401) {
+                const errorResponse = new runtime.JSONApiResponse(rawResponse, (jsonValue) => (0, models_1.ErrorEntityFromJSON)(jsonValue));
+                const error = yield errorResponse.value();
+                throw error;
+            }
+            if (rawResponse.status === 403) {
+                const errorResponse = new runtime.JSONApiResponse(rawResponse, (jsonValue) => (0, models_1.ErrorEntityFromJSON)(jsonValue));
+                const error = yield errorResponse.value();
+                throw error;
+            }
+            if (rawResponse.status === 404) {
+                const errorResponse = new runtime.JSONApiResponse(rawResponse, (jsonValue) => (0, models_1.ErrorEntityFromJSON)(jsonValue));
+                const error = yield errorResponse.value();
+                throw error;
+            }
+            if (rawResponse.status === 500) {
+                const errorResponse = new runtime.JSONApiResponse(rawResponse, (jsonValue) => (0, models_1.ErrorEntityFromJSON)(jsonValue));
+                const error = yield errorResponse.value();
+                throw error;
+            }
+            if (rawResponse.status === 502) {
+                const errorResponse = new runtime.JSONApiResponse(rawResponse, (jsonValue) => (0, models_1.ErrorEntityFromJSON)(jsonValue));
+                const error = yield errorResponse.value();
+                throw error;
+            }
+            if (rawResponse.status === 503) {
+                const errorResponse = new runtime.JSONApiResponse(rawResponse, (jsonValue) => (0, models_1.ErrorEntityFromJSON)(jsonValue));
+                const error = yield errorResponse.value();
+                throw error;
+            }
+            if (rawResponse.status === 504) {
+                const errorResponse = new runtime.JSONApiResponse(rawResponse, (jsonValue) => (0, models_1.ErrorEntityFromJSON)(jsonValue));
+                const error = yield errorResponse.value();
+                throw error;
+            }
+            if (!response) {
+                response = new runtime.TextApiResponse(rawResponse);
+            }
+            return yield response.value();
+        });
+    }
     /**
      * Retrieve the merchant associated with the user making the request.
      * Find merchant

package/dist/cjs/models/FeeDetailsEntity.d.ts

@@ -0,0 +1,53 @@
+/**
+ * Channel Payments API
+ *
+ * NOTE: This class is auto generated. Do not edit the class manually.
+ *
+ */
+/**
+ *
+ * @export
+ * @interface FeeDetailsEntity
+ */
+export interface FeeDetailsEntity {
+    /**
+     * The type of the transaction fee.
+     * @type {string}
+     * @memberof FeeDetailsEntity
+     */
+    type: FeeDetailsEntityTypeEnum;
+    /**
+     * The type of charge for the transaction fee.
+     * @type {string}
+     * @memberof FeeDetailsEntity
+     */
+    chargeType: FeeDetailsEntityChargeTypeEnum;
+    /**
+     * The amount of the transaction fee.
+     * @type {number}
+     * @memberof FeeDetailsEntity
+     */
+    amount: number;
+}
+/**
+ * @export
+ */
+export declare const FeeDetailsEntityTypeEnum: {
+    readonly ConvenienceFee: "CONVENIENCE_FEE";
+};
+export type FeeDetailsEntityTypeEnum = typeof FeeDetailsEntityTypeEnum[keyof typeof FeeDetailsEntityTypeEnum];
+/**
+ * @export
+ */
+export declare const FeeDetailsEntityChargeTypeEnum: {
+    readonly IncludedInAmount: "INCLUDED_IN_AMOUNT";
+    readonly ChargedSeparately: "CHARGED_SEPARATELY";
+};
+export type FeeDetailsEntityChargeTypeEnum = typeof FeeDetailsEntityChargeTypeEnum[keyof typeof FeeDetailsEntityChargeTypeEnum];
+/**
+ * Check if a given object implements the FeeDetailsEntity interface.
+ */
+export declare function instanceOfFeeDetailsEntity(value: object): boolean;
+export declare function FeeDetailsEntityFromJSON(json: any): FeeDetailsEntity;
+export declare function FeeDetailsEntityFromJSONTyped(json: any, ignoreDiscriminator: boolean): FeeDetailsEntity;
+export declare function FeeDetailsEntityToJSON(value?: FeeDetailsEntity | null): any;

package/dist/cjs/models/FeeDetailsEntity.js

@@ -0,0 +1,66 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Channel Payments API
+ *
+ * NOTE: This class is auto generated. Do not edit the class manually.
+ *
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FeeDetailsEntityChargeTypeEnum = exports.FeeDetailsEntityTypeEnum = void 0;
+exports.instanceOfFeeDetailsEntity = instanceOfFeeDetailsEntity;
+exports.FeeDetailsEntityFromJSON = FeeDetailsEntityFromJSON;
+exports.FeeDetailsEntityFromJSONTyped = FeeDetailsEntityFromJSONTyped;
+exports.FeeDetailsEntityToJSON = FeeDetailsEntityToJSON;
+const runtime_1 = require("../runtime");
+/**
+ * @export
+ */
+exports.FeeDetailsEntityTypeEnum = {
+    ConvenienceFee: 'CONVENIENCE_FEE'
+};
+/**
+ * @export
+ */
+exports.FeeDetailsEntityChargeTypeEnum = {
+    IncludedInAmount: 'INCLUDED_IN_AMOUNT',
+    ChargedSeparately: 'CHARGED_SEPARATELY'
+};
+/**
+ * Check if a given object implements the FeeDetailsEntity interface.
+ */
+function instanceOfFeeDetailsEntity(value) {
+    let isInstance = true;
+    isInstance = isInstance && "type" in value;
+    isInstance = isInstance && "chargeType" in value;
+    isInstance = isInstance && "amount" in value;
+    return isInstance;
+}
+function FeeDetailsEntityFromJSON(json) {
+    return FeeDetailsEntityFromJSONTyped(json, false);
+}
+function FeeDetailsEntityFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    const typed = {
+        'type': json['type'],
+        'chargeType': json['chargeType'],
+        'amount': json['amount'],
+    };
+    return (0, runtime_1.removeNullUndefined)(typed);
+}
+function FeeDetailsEntityToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'type': value.type,
+        'chargeType': value.chargeType,
+        'amount': value.amount,
+    };
+}

package/dist/cjs/models/MerchantFeeDetailsEntity.d.ts

@@ -0,0 +1,39 @@
+/**
+ * Channel Payments API
+ *
+ * NOTE: This class is auto generated. Do not edit the class manually.
+ *
+ */
+import type { PaymentMethodFeeDetailsEntity } from './PaymentMethodFeeDetailsEntity';
+/**
+ *
+ * @export
+ * @interface MerchantFeeDetailsEntity
+ */
+export interface MerchantFeeDetailsEntity {
+    /**
+     * The ID of the merchant.
+     * @type {string}
+     * @memberof MerchantFeeDetailsEntity
+     */
+    merchantId: string;
+    /**
+     * The merchant specified total of the transaction.
+     * @type {string}
+     * @memberof MerchantFeeDetailsEntity
+     */
+    subtotal: string;
+    /**
+     * The details of the payment method fees.
+     * @type {Array<PaymentMethodFeeDetailsEntity>}
+     * @memberof MerchantFeeDetailsEntity
+     */
+    feeDetails: Array<PaymentMethodFeeDetailsEntity>;
+}
+/**
+ * Check if a given object implements the MerchantFeeDetailsEntity interface.
+ */
+export declare function instanceOfMerchantFeeDetailsEntity(value: object): boolean;
+export declare function MerchantFeeDetailsEntityFromJSON(json: any): MerchantFeeDetailsEntity;
+export declare function MerchantFeeDetailsEntityFromJSONTyped(json: any, ignoreDiscriminator: boolean): MerchantFeeDetailsEntity;
+export declare function MerchantFeeDetailsEntityToJSON(value?: MerchantFeeDetailsEntity | null): any;

package/dist/cjs/models/MerchantFeeDetailsEntity.js

@@ -0,0 +1,53 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Channel Payments API
+ *
+ * NOTE: This class is auto generated. Do not edit the class manually.
+ *
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfMerchantFeeDetailsEntity = instanceOfMerchantFeeDetailsEntity;
+exports.MerchantFeeDetailsEntityFromJSON = MerchantFeeDetailsEntityFromJSON;
+exports.MerchantFeeDetailsEntityFromJSONTyped = MerchantFeeDetailsEntityFromJSONTyped;
+exports.MerchantFeeDetailsEntityToJSON = MerchantFeeDetailsEntityToJSON;
+const runtime_1 = require("../runtime");
+const PaymentMethodFeeDetailsEntity_1 = require("./PaymentMethodFeeDetailsEntity");
+/**
+ * Check if a given object implements the MerchantFeeDetailsEntity interface.
+ */
+function instanceOfMerchantFeeDetailsEntity(value) {
+    let isInstance = true;
+    isInstance = isInstance && "merchantId" in value;
+    isInstance = isInstance && "subtotal" in value;
+    isInstance = isInstance && "feeDetails" in value;
+    return isInstance;
+}
+function MerchantFeeDetailsEntityFromJSON(json) {
+    return MerchantFeeDetailsEntityFromJSONTyped(json, false);
+}
+function MerchantFeeDetailsEntityFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    const typed = {
+        'merchantId': json['merchantId'],
+        'subtotal': json['subtotal'],
+        'feeDetails': (json['feeDetails'].map(PaymentMethodFeeDetailsEntity_1.PaymentMethodFeeDetailsEntityFromJSON)),
+    };
+    return (0, runtime_1.removeNullUndefined)(typed);
+}
+function MerchantFeeDetailsEntityToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'merchantId': value.merchantId,
+        'subtotal': value.subtotal,
+        'feeDetails': (value.feeDetails.map(PaymentMethodFeeDetailsEntity_1.PaymentMethodFeeDetailsEntityToJSON)),
+    };
+}

package/dist/cjs/models/PaymentMethodFeeDetailsEntity.d.ts

@@ -0,0 +1,54 @@
+/**
+ * Channel Payments API
+ *
+ * NOTE: This class is auto generated. Do not edit the class manually.
+ *
+ */
+import type { FeeDetailsEntity } from './FeeDetailsEntity';
+/**
+ *
+ * @export
+ * @interface PaymentMethodFeeDetailsEntity
+ */
+export interface PaymentMethodFeeDetailsEntity {
+    /**
+     * The payment method used for the transaction fee calculation.
+     * @type {string}
+     * @memberof PaymentMethodFeeDetailsEntity
+     */
+    method: PaymentMethodFeeDetailsEntityMethodEnum;
+    /**
+     * The details of the transaction fees.
+     * @type {Array<FeeDetailsEntity>}
+     * @memberof PaymentMethodFeeDetailsEntity
+     */
+    fees: Array<FeeDetailsEntity>;
+    /**
+     * The total amount of fees applied.
+     * @type {number}
+     * @memberof PaymentMethodFeeDetailsEntity
+     */
+    feesTotal: number;
+    /**
+     * The adjusted total after applying the fees.
+     * @type {number}
+     * @memberof PaymentMethodFeeDetailsEntity
+     */
+    adjustedTotal: number;
+}
+/**
+ * @export
+ */
+export declare const PaymentMethodFeeDetailsEntityMethodEnum: {
+    readonly Ach: "ACH";
+    readonly Bank: "BANK";
+    readonly Card: "CARD";
+};
+export type PaymentMethodFeeDetailsEntityMethodEnum = typeof PaymentMethodFeeDetailsEntityMethodEnum[keyof typeof PaymentMethodFeeDetailsEntityMethodEnum];
+/**
+ * Check if a given object implements the PaymentMethodFeeDetailsEntity interface.
+ */
+export declare function instanceOfPaymentMethodFeeDetailsEntity(value: object): boolean;
+export declare function PaymentMethodFeeDetailsEntityFromJSON(json: any): PaymentMethodFeeDetailsEntity;
+export declare function PaymentMethodFeeDetailsEntityFromJSONTyped(json: any, ignoreDiscriminator: boolean): PaymentMethodFeeDetailsEntity;
+export declare function PaymentMethodFeeDetailsEntityToJSON(value?: PaymentMethodFeeDetailsEntity | null): any;

package/dist/cjs/models/PaymentMethodFeeDetailsEntity.js

@@ -0,0 +1,65 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Channel Payments API
+ *
+ * NOTE: This class is auto generated. Do not edit the class manually.
+ *
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PaymentMethodFeeDetailsEntityMethodEnum = void 0;
+exports.instanceOfPaymentMethodFeeDetailsEntity = instanceOfPaymentMethodFeeDetailsEntity;
+exports.PaymentMethodFeeDetailsEntityFromJSON = PaymentMethodFeeDetailsEntityFromJSON;
+exports.PaymentMethodFeeDetailsEntityFromJSONTyped = PaymentMethodFeeDetailsEntityFromJSONTyped;
+exports.PaymentMethodFeeDetailsEntityToJSON = PaymentMethodFeeDetailsEntityToJSON;
+const runtime_1 = require("../runtime");
+const FeeDetailsEntity_1 = require("./FeeDetailsEntity");
+/**
+ * @export
+ */
+exports.PaymentMethodFeeDetailsEntityMethodEnum = {
+    Ach: 'ACH',
+    Bank: 'BANK',
+    Card: 'CARD'
+};
+/**
+ * Check if a given object implements the PaymentMethodFeeDetailsEntity interface.
+ */
+function instanceOfPaymentMethodFeeDetailsEntity(value) {
+    let isInstance = true;
+    isInstance = isInstance && "method" in value;
+    isInstance = isInstance && "fees" in value;
+    isInstance = isInstance && "feesTotal" in value;
+    isInstance = isInstance && "adjustedTotal" in value;
+    return isInstance;
+}
+function PaymentMethodFeeDetailsEntityFromJSON(json) {
+    return PaymentMethodFeeDetailsEntityFromJSONTyped(json, false);
+}
+function PaymentMethodFeeDetailsEntityFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    const typed = {
+        'method': json['method'],
+        'fees': (json['fees'].map(FeeDetailsEntity_1.FeeDetailsEntityFromJSON)),
+        'feesTotal': json['feesTotal'],
+        'adjustedTotal': json['adjustedTotal'],
+    };
+    return (0, runtime_1.removeNullUndefined)(typed);
+}
+function PaymentMethodFeeDetailsEntityToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'method': value.method,
+        'fees': (value.fees.map(FeeDetailsEntity_1.FeeDetailsEntityToJSON)),
+        'feesTotal': value.feesTotal,
+        'adjustedTotal': value.adjustedTotal,
+    };
+}

package/dist/cjs/models/TransactionEntity.d.ts

@@ -247,12 +247,6 @@ export interface TransactionEntity {
      * @memberof TransactionEntity
      */
     tags?: Array<TagEntity>;
-    /**
-     *
-     * @type {string}
-     * @memberof TransactionEntity
-     */
-    declineReason?: string;
 }
 /**
  * @export

package/dist/cjs/models/TransactionEntity.js

@@ -125,7 +125,6 @@ function TransactionEntityFromJSONTyped(json, ignoreDiscriminator) {
         'settledAt': !(0, runtime_1.exists)(json, 'settledAt') ? undefined : (new Date(json['settledAt'])),
         'returnedAt': !(0, runtime_1.exists)(json, 'returnedAt') ? undefined : (new Date(json['returnedAt'])),
         'tags': !(0, runtime_1.exists)(json, 'tags') ? undefined : (json['tags'].map(TagEntity_1.TagEntityFromJSON)),
-        'declineReason': !(0, runtime_1.exists)(json, 'declineReason') ? undefined : json['declineReason'],
     };
     return (0, runtime_1.removeNullUndefined)(typed);
 }
@@ -176,6 +175,5 @@ function TransactionEntityToJSON(value) {
         'settledAt': value.settledAt === undefined ? undefined : (value.settledAt.toISOString()),
         'returnedAt': value.returnedAt === undefined ? undefined : (value.returnedAt.toISOString()),
         'tags': value.tags === undefined ? undefined : (value.tags.map(TagEntity_1.TagEntityToJSON)),
-        'declineReason': value.declineReason,
     };
 }

package/dist/cjs/models/index.d.ts

@@ -48,6 +48,7 @@ export * from './ErrorEntity';
 export * from './FeatureEntity';
 export * from './FeatureTargetEntity';
 export * from './FeaturesEntity';
+export * from './FeeDetailsEntity';
 export * from './LogoUploadEntity';
 export * from './MerchantAccountEntity';
 export * from './MerchantAccountServiceEntity';
@@ -59,6 +60,7 @@ export * from './MerchantConnectorCredentialsServiceEntity';
 export * from './MerchantConnectorServiceEntity';
 export * from './MerchantCredentialsEntity';
 export * from './MerchantEntity';
+export * from './MerchantFeeDetailsEntity';
 export * from './MerchantServiceEntity';
 export * from './MerchantSettingsDto';
 export * from './MerchantSettingsEntity';
@@ -69,6 +71,7 @@ export * from './MerchantThemeLogoEntity';
 export * from './PaymentMethodBaseEntity';
 export * from './PaymentMethodDto';
 export * from './PaymentMethodEntity';
+export * from './PaymentMethodFeeDetailsEntity';
 export * from './PaymentMethodServiceEntity';
 export * from './PaymentMethodsSearchEntity';
 export * from './ReturnNotificationEntity';

package/dist/cjs/models/index.js

@@ -66,6 +66,7 @@ __exportStar(require("./ErrorEntity"), exports);
 __exportStar(require("./FeatureEntity"), exports);
 __exportStar(require("./FeatureTargetEntity"), exports);
 __exportStar(require("./FeaturesEntity"), exports);
+__exportStar(require("./FeeDetailsEntity"), exports);
 __exportStar(require("./LogoUploadEntity"), exports);
 __exportStar(require("./MerchantAccountEntity"), exports);
 __exportStar(require("./MerchantAccountServiceEntity"), exports);
@@ -77,6 +78,7 @@ __exportStar(require("./MerchantConnectorCredentialsServiceEntity"), exports);
 __exportStar(require("./MerchantConnectorServiceEntity"), exports);
 __exportStar(require("./MerchantCredentialsEntity"), exports);
 __exportStar(require("./MerchantEntity"), exports);
+__exportStar(require("./MerchantFeeDetailsEntity"), exports);
 __exportStar(require("./MerchantServiceEntity"), exports);
 __exportStar(require("./MerchantSettingsDto"), exports);
 __exportStar(require("./MerchantSettingsEntity"), exports);
@@ -87,6 +89,7 @@ __exportStar(require("./MerchantThemeLogoEntity"), exports);
 __exportStar(require("./PaymentMethodBaseEntity"), exports);
 __exportStar(require("./PaymentMethodDto"), exports);
 __exportStar(require("./PaymentMethodEntity"), exports);
+__exportStar(require("./PaymentMethodFeeDetailsEntity"), exports);
 __exportStar(require("./PaymentMethodServiceEntity"), exports);
 __exportStar(require("./PaymentMethodsSearchEntity"), exports);
 __exportStar(require("./ReturnNotificationEntity"), exports);

package/dist/cjs/runtime.js

@@ -114,7 +114,7 @@ class BaseAPI {
     createFetchParams(context) {
         return __awaiter(this, void 0, void 0, function* () {
             Object.keys(context.headers).forEach(key => context.headers[key] === undefined ? delete context.headers[key] : {});
-            context.headers['user-agent'] = "@channelpayments/node-sdk/v1.182.0";
+            context.headers['user-agent'] = "@channelpayments/node-sdk/v1.183.0";
             const token = this.generateAuthToken();
             context.headers['Authorization'] = `Bearer ${token}`;
             let url = this.url + context.path;

package/dist/mjs/apis/ChannelPaymentsApi.d.ts

@@ -5,7 +5,10 @@
  *
  */
 import * as runtime from '../runtime';
-import type { BuyersEntity, BuyersSearchEntity, CaptureTransactionDto, ChangeNotificationEntity, ChangeNotificationsSearchEntity, CheckoutSessionEntity, ConnectorServiceTokenEntity, CreateBuyerDto, CreateCheckoutSessionDto, CreatePaymentMethodDto, CreateProvisionedCardTokenDto, CreateTransactionRefundDto, CreateTransactionRequestDto, MerchantEntity, PaymentMethodEntity, PaymentMethodsSearchEntity, ReturnNotificationEntity, ReturnNotificationsSearchEntity, TagDto, TransactionEntity, TransactionRefundEntity, TransactionRefundsSearchEntity, TransactionsSearchEntity, UpdateBuyerDto } from '../models';
+import type { BuyersEntity, BuyersSearchEntity, CaptureTransactionDto, ChangeNotificationEntity, ChangeNotificationsSearchEntity, CheckoutSessionEntity, ConnectorServiceTokenEntity, CreateBuyerDto, CreateCheckoutSessionDto, CreatePaymentMethodDto, CreateProvisionedCardTokenDto, CreateTransactionRefundDto, CreateTransactionRequestDto, MerchantEntity, MerchantFeeDetailsEntity, PaymentMethodEntity, PaymentMethodsSearchEntity, ReturnNotificationEntity, ReturnNotificationsSearchEntity, TagDto, TransactionEntity, TransactionRefundEntity, TransactionRefundsSearchEntity, TransactionsSearchEntity, UpdateBuyerDto } from '../models';
+export interface GetFeeDetailsRequest {
+    amount: string;
+}
 export interface SearchBuyersRequest {
     merchantId: string;
     buyerId?: string;
@@ -168,6 +171,11 @@ export declare class ChannelPaymentsApi extends runtime.BaseAPI {
      * Find connector service tokens.
     */
     getConnectorServiceTokens(paymentMethodId: string): Promise<Array<ConnectorServiceTokenEntity>>;
+    /**
+     * Get fee details by amount
+     * Get fee details
+    */
+    getFeeDetails(requestParameters: GetFeeDetailsRequest): Promise<MerchantFeeDetailsEntity>;
     /**
      * Retrieve the merchant associated with the user making the request.
      * Find merchant

package/dist/mjs/apis/ChannelPaymentsApi.js

@@ -7,7 +7,7 @@
  *
  */
 import * as runtime from '../runtime';
-import { BuyersEntityFromJSON, BuyersSearchEntityFromJSON, CaptureTransactionDtoToJSON, ChangeNotificationEntityFromJSON, ChangeNotificationsSearchEntityFromJSON, CheckoutSessionEntityFromJSON, ConnectorServiceTokenEntityFromJSON, CreateBuyerDtoToJSON, CreateCheckoutSessionDtoToJSON, CreatePaymentMethodDtoToJSON, CreateProvisionedCardTokenDtoToJSON, CreateTransactionRefundDtoToJSON, CreateTransactionRequestDtoToJSON, ErrorEntityFromJSON, MerchantEntityFromJSON, PaymentMethodEntityFromJSON, PaymentMethodsSearchEntityFromJSON, ReturnNotificationEntityFromJSON, ReturnNotificationsSearchEntityFromJSON, TransactionEntityFromJSON, TransactionRefundEntityFromJSON, TransactionRefundsSearchEntityFromJSON, TransactionsSearchEntityFromJSON, UpdateBuyerDtoToJSON, } from '../models';
+import { BuyersEntityFromJSON, BuyersSearchEntityFromJSON, CaptureTransactionDtoToJSON, ChangeNotificationEntityFromJSON, ChangeNotificationsSearchEntityFromJSON, CheckoutSessionEntityFromJSON, ConnectorServiceTokenEntityFromJSON, CreateBuyerDtoToJSON, CreateCheckoutSessionDtoToJSON, CreatePaymentMethodDtoToJSON, CreateProvisionedCardTokenDtoToJSON, CreateTransactionRefundDtoToJSON, CreateTransactionRequestDtoToJSON, ErrorEntityFromJSON, MerchantEntityFromJSON, MerchantFeeDetailsEntityFromJSON, PaymentMethodEntityFromJSON, PaymentMethodsSearchEntityFromJSON, ReturnNotificationEntityFromJSON, ReturnNotificationsSearchEntityFromJSON, TransactionEntityFromJSON, TransactionRefundEntityFromJSON, TransactionRefundsSearchEntityFromJSON, TransactionsSearchEntityFromJSON, UpdateBuyerDtoToJSON, } from '../models';
 /**
  *
  */
@@ -972,6 +972,74 @@ export class ChannelPaymentsApi extends runtime.BaseAPI {
         }
         return await response.value();
     }
+    /**
+     * Get fee details by amount
+     * Get fee details
+    */
+    async getFeeDetails(requestParameters) {
+        if (requestParameters.amount === null || requestParameters.amount === undefined) {
+            throw new runtime.RequiredError('amount', 'Required parameter \'amount\' was null or undefined when calling getFeeDetails.');
+        }
+        const queryParameters = {};
+        if (requestParameters.amount !== undefined) {
+            queryParameters['amount'] = requestParameters.amount;
+        }
+        const headerParameters = {};
+        const rawResponse = await this.request({
+            path: `/transactions/fee-details`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        });
+        let response;
+        if (rawResponse.status === 200) {
+            response = new runtime.JSONApiResponse(rawResponse, (jsonValue) => MerchantFeeDetailsEntityFromJSON(jsonValue));
+        }
+        if (rawResponse.status === 400) {
+            const errorResponse = new runtime.JSONApiResponse(rawResponse, (jsonValue) => ErrorEntityFromJSON(jsonValue));
+            const error = await errorResponse.value();
+            throw error;
+        }
+        if (rawResponse.status === 401) {
+            const errorResponse = new runtime.JSONApiResponse(rawResponse, (jsonValue) => ErrorEntityFromJSON(jsonValue));
+            const error = await errorResponse.value();
+            throw error;
+        }
+        if (rawResponse.status === 403) {
+            const errorResponse = new runtime.JSONApiResponse(rawResponse, (jsonValue) => ErrorEntityFromJSON(jsonValue));
+            const error = await errorResponse.value();
+            throw error;
+        }
+        if (rawResponse.status === 404) {
+            const errorResponse = new runtime.JSONApiResponse(rawResponse, (jsonValue) => ErrorEntityFromJSON(jsonValue));
+            const error = await errorResponse.value();
+            throw error;
+        }
+        if (rawResponse.status === 500) {
+            const errorResponse = new runtime.JSONApiResponse(rawResponse, (jsonValue) => ErrorEntityFromJSON(jsonValue));
+            const error = await errorResponse.value();
+            throw error;
+        }
+        if (rawResponse.status === 502) {
+            const errorResponse = new runtime.JSONApiResponse(rawResponse, (jsonValue) => ErrorEntityFromJSON(jsonValue));
+            const error = await errorResponse.value();
+            throw error;
+        }
+        if (rawResponse.status === 503) {
+            const errorResponse = new runtime.JSONApiResponse(rawResponse, (jsonValue) => ErrorEntityFromJSON(jsonValue));
+            const error = await errorResponse.value();
+            throw error;
+        }
+        if (rawResponse.status === 504) {
+            const errorResponse = new runtime.JSONApiResponse(rawResponse, (jsonValue) => ErrorEntityFromJSON(jsonValue));
+            const error = await errorResponse.value();
+            throw error;
+        }
+        if (!response) {
+            response = new runtime.TextApiResponse(rawResponse);
+        }
+        return await response.value();
+    }
     /**
      * Retrieve the merchant associated with the user making the request.
      * Find merchant

package/dist/mjs/models/FeeDetailsEntity.d.ts

@@ -0,0 +1,53 @@
+/**
+ * Channel Payments API
+ *
+ * NOTE: This class is auto generated. Do not edit the class manually.
+ *
+ */
+/**
+ *
+ * @export
+ * @interface FeeDetailsEntity
+ */
+export interface FeeDetailsEntity {
+    /**
+     * The type of the transaction fee.
+     * @type {string}
+     * @memberof FeeDetailsEntity
+     */
+    type: FeeDetailsEntityTypeEnum;
+    /**
+     * The type of charge for the transaction fee.
+     * @type {string}
+     * @memberof FeeDetailsEntity
+     */
+    chargeType: FeeDetailsEntityChargeTypeEnum;
+    /**
+     * The amount of the transaction fee.
+     * @type {number}
+     * @memberof FeeDetailsEntity
+     */
+    amount: number;
+}
+/**
+ * @export
+ */
+export declare const FeeDetailsEntityTypeEnum: {
+    readonly ConvenienceFee: "CONVENIENCE_FEE";
+};
+export type FeeDetailsEntityTypeEnum = typeof FeeDetailsEntityTypeEnum[keyof typeof FeeDetailsEntityTypeEnum];
+/**
+ * @export
+ */
+export declare const FeeDetailsEntityChargeTypeEnum: {
+    readonly IncludedInAmount: "INCLUDED_IN_AMOUNT";
+    readonly ChargedSeparately: "CHARGED_SEPARATELY";
+};
+export type FeeDetailsEntityChargeTypeEnum = typeof FeeDetailsEntityChargeTypeEnum[keyof typeof FeeDetailsEntityChargeTypeEnum];
+/**
+ * Check if a given object implements the FeeDetailsEntity interface.
+ */
+export declare function instanceOfFeeDetailsEntity(value: object): boolean;
+export declare function FeeDetailsEntityFromJSON(json: any): FeeDetailsEntity;
+export declare function FeeDetailsEntityFromJSONTyped(json: any, ignoreDiscriminator: boolean): FeeDetailsEntity;
+export declare function FeeDetailsEntityToJSON(value?: FeeDetailsEntity | null): any;

package/dist/mjs/models/FeeDetailsEntity.js

@@ -0,0 +1,59 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Channel Payments API
+ *
+ * NOTE: This class is auto generated. Do not edit the class manually.
+ *
+ */
+import { removeNullUndefined } from '../runtime';
+/**
+ * @export
+ */
+export const FeeDetailsEntityTypeEnum = {
+    ConvenienceFee: 'CONVENIENCE_FEE'
+};
+/**
+ * @export
+ */
+export const FeeDetailsEntityChargeTypeEnum = {
+    IncludedInAmount: 'INCLUDED_IN_AMOUNT',
+    ChargedSeparately: 'CHARGED_SEPARATELY'
+};
+/**
+ * Check if a given object implements the FeeDetailsEntity interface.
+ */
+export function instanceOfFeeDetailsEntity(value) {
+    let isInstance = true;
+    isInstance = isInstance && "type" in value;
+    isInstance = isInstance && "chargeType" in value;
+    isInstance = isInstance && "amount" in value;
+    return isInstance;
+}
+export function FeeDetailsEntityFromJSON(json) {
+    return FeeDetailsEntityFromJSONTyped(json, false);
+}
+export function FeeDetailsEntityFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    const typed = {
+        'type': json['type'],
+        'chargeType': json['chargeType'],
+        'amount': json['amount'],
+    };
+    return removeNullUndefined(typed);
+}
+export function FeeDetailsEntityToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'type': value.type,
+        'chargeType': value.chargeType,
+        'amount': value.amount,
+    };
+}

package/dist/mjs/models/MerchantFeeDetailsEntity.d.ts

@@ -0,0 +1,39 @@
+/**
+ * Channel Payments API
+ *
+ * NOTE: This class is auto generated. Do not edit the class manually.
+ *
+ */
+import type { PaymentMethodFeeDetailsEntity } from './PaymentMethodFeeDetailsEntity';
+/**
+ *
+ * @export
+ * @interface MerchantFeeDetailsEntity
+ */
+export interface MerchantFeeDetailsEntity {
+    /**
+     * The ID of the merchant.
+     * @type {string}
+     * @memberof MerchantFeeDetailsEntity
+     */
+    merchantId: string;
+    /**
+     * The merchant specified total of the transaction.
+     * @type {string}
+     * @memberof MerchantFeeDetailsEntity
+     */
+    subtotal: string;
+    /**
+     * The details of the payment method fees.
+     * @type {Array<PaymentMethodFeeDetailsEntity>}
+     * @memberof MerchantFeeDetailsEntity
+     */
+    feeDetails: Array<PaymentMethodFeeDetailsEntity>;
+}
+/**
+ * Check if a given object implements the MerchantFeeDetailsEntity interface.
+ */
+export declare function instanceOfMerchantFeeDetailsEntity(value: object): boolean;
+export declare function MerchantFeeDetailsEntityFromJSON(json: any): MerchantFeeDetailsEntity;
+export declare function MerchantFeeDetailsEntityFromJSONTyped(json: any, ignoreDiscriminator: boolean): MerchantFeeDetailsEntity;
+export declare function MerchantFeeDetailsEntityToJSON(value?: MerchantFeeDetailsEntity | null): any;

package/dist/mjs/models/MerchantFeeDetailsEntity.js

@@ -0,0 +1,47 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Channel Payments API
+ *
+ * NOTE: This class is auto generated. Do not edit the class manually.
+ *
+ */
+import { removeNullUndefined } from '../runtime';
+import { PaymentMethodFeeDetailsEntityFromJSON, PaymentMethodFeeDetailsEntityToJSON, } from './PaymentMethodFeeDetailsEntity';
+/**
+ * Check if a given object implements the MerchantFeeDetailsEntity interface.
+ */
+export function instanceOfMerchantFeeDetailsEntity(value) {
+    let isInstance = true;
+    isInstance = isInstance && "merchantId" in value;
+    isInstance = isInstance && "subtotal" in value;
+    isInstance = isInstance && "feeDetails" in value;
+    return isInstance;
+}
+export function MerchantFeeDetailsEntityFromJSON(json) {
+    return MerchantFeeDetailsEntityFromJSONTyped(json, false);
+}
+export function MerchantFeeDetailsEntityFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    const typed = {
+        'merchantId': json['merchantId'],
+        'subtotal': json['subtotal'],
+        'feeDetails': (json['feeDetails'].map(PaymentMethodFeeDetailsEntityFromJSON)),
+    };
+    return removeNullUndefined(typed);
+}
+export function MerchantFeeDetailsEntityToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'merchantId': value.merchantId,
+        'subtotal': value.subtotal,
+        'feeDetails': (value.feeDetails.map(PaymentMethodFeeDetailsEntityToJSON)),
+    };
+}

package/dist/mjs/models/PaymentMethodFeeDetailsEntity.d.ts

@@ -0,0 +1,54 @@
+/**
+ * Channel Payments API
+ *
+ * NOTE: This class is auto generated. Do not edit the class manually.
+ *
+ */
+import type { FeeDetailsEntity } from './FeeDetailsEntity';
+/**
+ *
+ * @export
+ * @interface PaymentMethodFeeDetailsEntity
+ */
+export interface PaymentMethodFeeDetailsEntity {
+    /**
+     * The payment method used for the transaction fee calculation.
+     * @type {string}
+     * @memberof PaymentMethodFeeDetailsEntity
+     */
+    method: PaymentMethodFeeDetailsEntityMethodEnum;
+    /**
+     * The details of the transaction fees.
+     * @type {Array<FeeDetailsEntity>}
+     * @memberof PaymentMethodFeeDetailsEntity
+     */
+    fees: Array<FeeDetailsEntity>;
+    /**
+     * The total amount of fees applied.
+     * @type {number}
+     * @memberof PaymentMethodFeeDetailsEntity
+     */
+    feesTotal: number;
+    /**
+     * The adjusted total after applying the fees.
+     * @type {number}
+     * @memberof PaymentMethodFeeDetailsEntity
+     */
+    adjustedTotal: number;
+}
+/**
+ * @export
+ */
+export declare const PaymentMethodFeeDetailsEntityMethodEnum: {
+    readonly Ach: "ACH";
+    readonly Bank: "BANK";
+    readonly Card: "CARD";
+};
+export type PaymentMethodFeeDetailsEntityMethodEnum = typeof PaymentMethodFeeDetailsEntityMethodEnum[keyof typeof PaymentMethodFeeDetailsEntityMethodEnum];
+/**
+ * Check if a given object implements the PaymentMethodFeeDetailsEntity interface.
+ */
+export declare function instanceOfPaymentMethodFeeDetailsEntity(value: object): boolean;
+export declare function PaymentMethodFeeDetailsEntityFromJSON(json: any): PaymentMethodFeeDetailsEntity;
+export declare function PaymentMethodFeeDetailsEntityFromJSONTyped(json: any, ignoreDiscriminator: boolean): PaymentMethodFeeDetailsEntity;
+export declare function PaymentMethodFeeDetailsEntityToJSON(value?: PaymentMethodFeeDetailsEntity | null): any;

package/dist/mjs/models/PaymentMethodFeeDetailsEntity.js

@@ -0,0 +1,58 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Channel Payments API
+ *
+ * NOTE: This class is auto generated. Do not edit the class manually.
+ *
+ */
+import { removeNullUndefined } from '../runtime';
+import { FeeDetailsEntityFromJSON, FeeDetailsEntityToJSON, } from './FeeDetailsEntity';
+/**
+ * @export
+ */
+export const PaymentMethodFeeDetailsEntityMethodEnum = {
+    Ach: 'ACH',
+    Bank: 'BANK',
+    Card: 'CARD'
+};
+/**
+ * Check if a given object implements the PaymentMethodFeeDetailsEntity interface.
+ */
+export function instanceOfPaymentMethodFeeDetailsEntity(value) {
+    let isInstance = true;
+    isInstance = isInstance && "method" in value;
+    isInstance = isInstance && "fees" in value;
+    isInstance = isInstance && "feesTotal" in value;
+    isInstance = isInstance && "adjustedTotal" in value;
+    return isInstance;
+}
+export function PaymentMethodFeeDetailsEntityFromJSON(json) {
+    return PaymentMethodFeeDetailsEntityFromJSONTyped(json, false);
+}
+export function PaymentMethodFeeDetailsEntityFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    const typed = {
+        'method': json['method'],
+        'fees': (json['fees'].map(FeeDetailsEntityFromJSON)),
+        'feesTotal': json['feesTotal'],
+        'adjustedTotal': json['adjustedTotal'],
+    };
+    return removeNullUndefined(typed);
+}
+export function PaymentMethodFeeDetailsEntityToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'method': value.method,
+        'fees': (value.fees.map(FeeDetailsEntityToJSON)),
+        'feesTotal': value.feesTotal,
+        'adjustedTotal': value.adjustedTotal,
+    };
+}

package/dist/mjs/models/TransactionEntity.d.ts

@@ -247,12 +247,6 @@ export interface TransactionEntity {
      * @memberof TransactionEntity
      */
     tags?: Array<TagEntity>;
-    /**
-     *
-     * @type {string}
-     * @memberof TransactionEntity
-     */
-    declineReason?: string;
 }
 /**
  * @export

package/dist/mjs/models/TransactionEntity.js

@@ -118,7 +118,6 @@ export function TransactionEntityFromJSONTyped(json, ignoreDiscriminator) {
         'settledAt': !exists(json, 'settledAt') ? undefined : (new Date(json['settledAt'])),
         'returnedAt': !exists(json, 'returnedAt') ? undefined : (new Date(json['returnedAt'])),
         'tags': !exists(json, 'tags') ? undefined : (json['tags'].map(TagEntityFromJSON)),
-        'declineReason': !exists(json, 'declineReason') ? undefined : json['declineReason'],
     };
     return removeNullUndefined(typed);
 }
@@ -169,6 +168,5 @@ export function TransactionEntityToJSON(value) {
         'settledAt': value.settledAt === undefined ? undefined : (value.settledAt.toISOString()),
         'returnedAt': value.returnedAt === undefined ? undefined : (value.returnedAt.toISOString()),
         'tags': value.tags === undefined ? undefined : (value.tags.map(TagEntityToJSON)),
-        'declineReason': value.declineReason,
     };
 }

package/dist/mjs/models/index.d.ts

@@ -48,6 +48,7 @@ export * from './ErrorEntity';
 export * from './FeatureEntity';
 export * from './FeatureTargetEntity';
 export * from './FeaturesEntity';
+export * from './FeeDetailsEntity';
 export * from './LogoUploadEntity';
 export * from './MerchantAccountEntity';
 export * from './MerchantAccountServiceEntity';
@@ -59,6 +60,7 @@ export * from './MerchantConnectorCredentialsServiceEntity';
 export * from './MerchantConnectorServiceEntity';
 export * from './MerchantCredentialsEntity';
 export * from './MerchantEntity';
+export * from './MerchantFeeDetailsEntity';
 export * from './MerchantServiceEntity';
 export * from './MerchantSettingsDto';
 export * from './MerchantSettingsEntity';
@@ -69,6 +71,7 @@ export * from './MerchantThemeLogoEntity';
 export * from './PaymentMethodBaseEntity';
 export * from './PaymentMethodDto';
 export * from './PaymentMethodEntity';
+export * from './PaymentMethodFeeDetailsEntity';
 export * from './PaymentMethodServiceEntity';
 export * from './PaymentMethodsSearchEntity';
 export * from './ReturnNotificationEntity';

package/dist/mjs/models/index.js

@@ -50,6 +50,7 @@ export * from './ErrorEntity';
 export * from './FeatureEntity';
 export * from './FeatureTargetEntity';
 export * from './FeaturesEntity';
+export * from './FeeDetailsEntity';
 export * from './LogoUploadEntity';
 export * from './MerchantAccountEntity';
 export * from './MerchantAccountServiceEntity';
@@ -61,6 +62,7 @@ export * from './MerchantConnectorCredentialsServiceEntity';
 export * from './MerchantConnectorServiceEntity';
 export * from './MerchantCredentialsEntity';
 export * from './MerchantEntity';
+export * from './MerchantFeeDetailsEntity';
 export * from './MerchantServiceEntity';
 export * from './MerchantSettingsDto';
 export * from './MerchantSettingsEntity';
@@ -71,6 +73,7 @@ export * from './MerchantThemeLogoEntity';
 export * from './PaymentMethodBaseEntity';
 export * from './PaymentMethodDto';
 export * from './PaymentMethodEntity';
+export * from './PaymentMethodFeeDetailsEntity';
 export * from './PaymentMethodServiceEntity';
 export * from './PaymentMethodsSearchEntity';
 export * from './ReturnNotificationEntity';

package/dist/mjs/runtime.js

@@ -64,7 +64,7 @@ export class BaseAPI {
     }
     async createFetchParams(context) {
         Object.keys(context.headers).forEach(key => context.headers[key] === undefined ? delete context.headers[key] : {});
-        context.headers['user-agent'] = "@channelpayments/node-sdk/v1.182.0";
+        context.headers['user-agent'] = "@channelpayments/node-sdk/v1.183.0";
         const token = this.generateAuthToken();
         context.headers['Authorization'] = `Bearer ${token}`;
         let url = this.url + context.path;

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@channelpayments/node-sdk",
 	"description": "Channel Payments nodejs sdk",
-	"version": "1.182.0",
+	"version": "1.183.0",
 	"author": "Channel Payments",
 	"license": "ISC",
 	"main": "dist/cjs/index.js",