@mbanq/core-sdk-js / commands / UpdateCharge

Function: UpdateCharge()

UpdateCharge(chargeId, data): Command<{ chargeId: number; data: { active?: boolean; amount?: number; applyToExistingAccount?: boolean; applyUpfrontCharge?: boolean; chargeAppliesTo?: INVALID | LOAN | SAVINGS | CLIENT | SHARES | TRANSFER | CREDIT_CARD; chargeCalculationType?: INVALID | FLAT | PERCENT_OF_AMOUNT | PERCENT_OF_AMOUNT_AND_INTEREST | PERCENT_OF_INTEREST | PERCENT_OF_DISBURSEMENT_AMOUNT | PERCENT_OF_MIN_DUE_AMOUNT | PERCENT_OF_OUTSTANDING_AMOUNT; chargeDueDateOnAccountActivation?: boolean; chargePaymentMode?: REGULAR | ACCOUNT_TRANSFER; chargeTimeType?: INVALID | DISBURSEMENT | SPECIFIED_DUE_DATE | SAVINGS_ACTIVATION | SAVINGS_CLOSURE | WITHDRAWAL_FEE | ANNUAL_FEE | MONTHLY_FEE | INSTALMENT_FEE | OVERDUE_INSTALLMENT | OVERDRAFT_FEE | WEEKLY_FEE | TRANCHE_DISBURSEMENT | SHAREACCOUNT_ACTIVATION | SHARE_PURCHASE | SHARE_REDEEM | SAVINGS_NOACTIVITY_FEE | DOMESTIC_ATM_WITHDRAWAL_FEE | INTERNATIONAL_ATM_WITHDRAWAL_FEE | INTERNATIONAL_TRANSACTIONS_FEE | EXTERNAL_CARD_PUSH_TRANSACTION_FEE | EXTERNAL_CARD_PULL_TRANSACTION_FEE | TRANSFER_EXECUTE | SAVINGS_DORMANT_FEE | SAVINGS_ESCHEAT_FEE | SPECIFIED_MCC_FEE | CARD_ORDERING_FEE | CARD_RE_ORDERING_FEE | TRANSFER_RETURN | LATE_PAYMENT_FEE | RETURN_PAYMENT_FEE | OVER_CREDIT_LIMIT_FEE | STOP_PAYMENT_FEE | JOINING_FEE | DIRECT_DEPOSIT_CASH_ADVANCE_FEE | PHYSICAL_CARD_ORDERING_FEE | OVERDRAFT_WITHDRAWAL_FEE | NSF_FEE | FX_TRADE_BUY_CURRENCY_FEE; clientClassificationId?: number; collectOnlyTotalDeferCharge?: boolean; currencyCode?: string; exemptedFeeAmount?: string | number; feeFrequency?: number; feeInterval?: number; feeOnMonthDay?: string; ignoreChargesOnNegativeBalance?: boolean; incomeAccountId?: number; locale?: string; maxCap?: number; minCap?: number; monthDayFormat?: string; name?: string; numberOfExemptedFee?: string | number; paymentDirection?: IN | OUT; paymentRail?: number; penalty?: boolean; productIDs?: number[]; reverseOnTransferFail?: boolean; taxGroupId?: number; transferType?: CREDIT | DEBIT; }; }, { changes?: { active?: boolean; amount?: number; applyToExistingAccount?: boolean; applyUpfrontCharge?: boolean; chargeAppliesTo?: INVALID | LOAN | SAVINGS | CLIENT | SHARES | TRANSFER | CREDIT_CARD; chargeCalculationType?: INVALID | FLAT | PERCENT_OF_AMOUNT | PERCENT_OF_AMOUNT_AND_INTEREST | PERCENT_OF_INTEREST | PERCENT_OF_DISBURSEMENT_AMOUNT | PERCENT_OF_MIN_DUE_AMOUNT | PERCENT_OF_OUTSTANDING_AMOUNT; chargeDueDateOnAccountActivation?: boolean; chargePaymentMode?: REGULAR | ACCOUNT_TRANSFER; chargeTimeType?: INVALID | DISBURSEMENT | SPECIFIED_DUE_DATE | SAVINGS_ACTIVATION | SAVINGS_CLOSURE | WITHDRAWAL_FEE | ANNUAL_FEE | MONTHLY_FEE | INSTALMENT_FEE | OVERDUE_INSTALLMENT | OVERDRAFT_FEE | WEEKLY_FEE | TRANCHE_DISBURSEMENT | SHAREACCOUNT_ACTIVATION | SHARE_PURCHASE | SHARE_REDEEM | SAVINGS_NOACTIVITY_FEE | DOMESTIC_ATM_WITHDRAWAL_FEE | INTERNATIONAL_ATM_WITHDRAWAL_FEE | INTERNATIONAL_TRANSACTIONS_FEE | EXTERNAL_CARD_PUSH_TRANSACTION_FEE | EXTERNAL_CARD_PULL_TRANSACTION_FEE | TRANSFER_EXECUTE | SAVINGS_DORMANT_FEE | SAVINGS_ESCHEAT_FEE | SPECIFIED_MCC_FEE | CARD_ORDERING_FEE | CARD_RE_ORDERING_FEE | TRANSFER_RETURN | LATE_PAYMENT_FEE | RETURN_PAYMENT_FEE | OVER_CREDIT_LIMIT_FEE | STOP_PAYMENT_FEE | JOINING_FEE | DIRECT_DEPOSIT_CASH_ADVANCE_FEE | PHYSICAL_CARD_ORDERING_FEE | OVERDRAFT_WITHDRAWAL_FEE | NSF_FEE | FX_TRADE_BUY_CURRENCY_FEE; clientClassificationId?: number; collectOnlyTotalDeferCharge?: boolean; currencyCode?: string; exemptedFeeAmount?: string | number; feeFrequency?: number; feeInterval?: number; feeOnMonthDay?: string; ignoreChargesOnNegativeBalance?: boolean; incomeAccountId?: number; locale?: string; maxCap?: number; minCap?: number; monthDayFormat?: string; name?: string; numberOfExemptedFee?: string | number; paymentDirection?: IN | OUT; paymentRail?: number; penalty?: boolean; productIDs?: number[]; reverseOnTransferFail?: boolean; taxGroupId?: number; transferType?: CREDIT | DEBIT; }; id: string; resourceId: number; }>

Defined in: src/commands/rest/chargeSetup.ts:67

Update a charge definition

This endpoint allows updating an existing charge definition by its ID.

Parameters

chargeId

number

The ID of the charge to update

data

The charge update parameters

active?

boolean = ...

amount?

number = ...

applyToExistingAccount?

boolean = ...

applyUpfrontCharge?

boolean = ...

chargeAppliesTo?

chargeCalculationType?

chargeDueDateOnAccountActivation?

boolean = ...

chargePaymentMode?

REGULAR | ACCOUNT_TRANSFER = ...

chargeTimeType?

clientClassificationId?

number = ...

collectOnlyTotalDeferCharge?

boolean = ...

currencyCode?

string = ...

exemptedFeeAmount?

string | number = ...

feeFrequency?

number = ...

feeInterval?

number = ...

feeOnMonthDay?

string = ...

ignoreChargesOnNegativeBalance?

boolean = ...

incomeAccountId?

number = ...

locale?

string = ...

maxCap?

number = ...

minCap?

number = ...

monthDayFormat?

string = ...

name?

string = ...

numberOfExemptedFee?

string | number = ...

paymentDirection?

IN | OUT = ...

paymentRail?

number = ...

penalty?

boolean = ...

productIDs?

number[] = ...

reverseOnTransferFail?

boolean = ...

taxGroupId?

number = ...

transferType?

CREDIT | DEBIT = ...

Returns

Command<{ chargeId: number; data: { active?: boolean; amount?: number; applyToExistingAccount?: boolean; applyUpfrontCharge?: boolean; chargeAppliesTo?: INVALID | LOAN | SAVINGS | CLIENT | SHARES | TRANSFER | CREDIT_CARD; chargeCalculationType?: INVALID | FLAT | PERCENT_OF_AMOUNT | PERCENT_OF_AMOUNT_AND_INTEREST | PERCENT_OF_INTEREST | PERCENT_OF_DISBURSEMENT_AMOUNT | PERCENT_OF_MIN_DUE_AMOUNT | PERCENT_OF_OUTSTANDING_AMOUNT; chargeDueDateOnAccountActivation?: boolean; chargePaymentMode?: REGULAR | ACCOUNT_TRANSFER; chargeTimeType?: INVALID | DISBURSEMENT | SPECIFIED_DUE_DATE | SAVINGS_ACTIVATION | SAVINGS_CLOSURE | WITHDRAWAL_FEE | ANNUAL_FEE | MONTHLY_FEE | INSTALMENT_FEE | OVERDUE_INSTALLMENT | OVERDRAFT_FEE | WEEKLY_FEE | TRANCHE_DISBURSEMENT | SHAREACCOUNT_ACTIVATION | SHARE_PURCHASE | SHARE_REDEEM | SAVINGS_NOACTIVITY_FEE | DOMESTIC_ATM_WITHDRAWAL_FEE | INTERNATIONAL_ATM_WITHDRAWAL_FEE | INTERNATIONAL_TRANSACTIONS_FEE | EXTERNAL_CARD_PUSH_TRANSACTION_FEE | EXTERNAL_CARD_PULL_TRANSACTION_FEE | TRANSFER_EXECUTE | SAVINGS_DORMANT_FEE | SAVINGS_ESCHEAT_FEE | SPECIFIED_MCC_FEE | CARD_ORDERING_FEE | CARD_RE_ORDERING_FEE | TRANSFER_RETURN | LATE_PAYMENT_FEE | RETURN_PAYMENT_FEE | OVER_CREDIT_LIMIT_FEE | STOP_PAYMENT_FEE | JOINING_FEE | DIRECT_DEPOSIT_CASH_ADVANCE_FEE | PHYSICAL_CARD_ORDERING_FEE | OVERDRAFT_WITHDRAWAL_FEE | NSF_FEE | FX_TRADE_BUY_CURRENCY_FEE; clientClassificationId?: number; collectOnlyTotalDeferCharge?: boolean; currencyCode?: string; exemptedFeeAmount?: string | number; feeFrequency?: number; feeInterval?: number; feeOnMonthDay?: string; ignoreChargesOnNegativeBalance?: boolean; incomeAccountId?: number; locale?: string; maxCap?: number; minCap?: number; monthDayFormat?: string; name?: string; numberOfExemptedFee?: string | number; paymentDirection?: IN | OUT; paymentRail?: number; penalty?: boolean; productIDs?: number[]; reverseOnTransferFail?: boolean; taxGroupId?: number; transferType?: CREDIT | DEBIT; }; }, { changes?: { active?: boolean; amount?: number; applyToExistingAccount?: boolean; applyUpfrontCharge?: boolean; chargeAppliesTo?: INVALID | LOAN | SAVINGS | CLIENT | SHARES | TRANSFER | CREDIT_CARD; chargeCalculationType?: INVALID | FLAT | PERCENT_OF_AMOUNT | PERCENT_OF_AMOUNT_AND_INTEREST | PERCENT_OF_INTEREST | PERCENT_OF_DISBURSEMENT_AMOUNT | PERCENT_OF_MIN_DUE_AMOUNT | PERCENT_OF_OUTSTANDING_AMOUNT; chargeDueDateOnAccountActivation?: boolean; chargePaymentMode?: REGULAR | ACCOUNT_TRANSFER; chargeTimeType?: INVALID | DISBURSEMENT | SPECIFIED_DUE_DATE | SAVINGS_ACTIVATION | SAVINGS_CLOSURE | WITHDRAWAL_FEE | ANNUAL_FEE | MONTHLY_FEE | INSTALMENT_FEE | OVERDUE_INSTALLMENT | OVERDRAFT_FEE | WEEKLY_FEE | TRANCHE_DISBURSEMENT | SHAREACCOUNT_ACTIVATION | SHARE_PURCHASE | SHARE_REDEEM | SAVINGS_NOACTIVITY_FEE | DOMESTIC_ATM_WITHDRAWAL_FEE | INTERNATIONAL_ATM_WITHDRAWAL_FEE | INTERNATIONAL_TRANSACTIONS_FEE | EXTERNAL_CARD_PUSH_TRANSACTION_FEE | EXTERNAL_CARD_PULL_TRANSACTION_FEE | TRANSFER_EXECUTE | SAVINGS_DORMANT_FEE | SAVINGS_ESCHEAT_FEE | SPECIFIED_MCC_FEE | CARD_ORDERING_FEE | CARD_RE_ORDERING_FEE | TRANSFER_RETURN | LATE_PAYMENT_FEE | RETURN_PAYMENT_FEE | OVER_CREDIT_LIMIT_FEE | STOP_PAYMENT_FEE | JOINING_FEE | DIRECT_DEPOSIT_CASH_ADVANCE_FEE | PHYSICAL_CARD_ORDERING_FEE | OVERDRAFT_WITHDRAWAL_FEE | NSF_FEE | FX_TRADE_BUY_CURRENCY_FEE; clientClassificationId?: number; collectOnlyTotalDeferCharge?: boolean; currencyCode?: string; exemptedFeeAmount?: string | number; feeFrequency?: number; feeInterval?: number; feeOnMonthDay?: string; ignoreChargesOnNegativeBalance?: boolean; incomeAccountId?: number; locale?: string; maxCap?: number; minCap?: number; monthDayFormat?: string; name?: string; numberOfExemptedFee?: string | number; paymentDirection?: IN | OUT; paymentRail?: number; penalty?: boolean; productIDs?: number[]; reverseOnTransferFail?: boolean; taxGroupId?: number; transferType?: CREDIT | DEBIT; }; id: string; resourceId: number; }>

Command object for updating a charge

Example

typescript

const command = UpdateCharge(123, {
  name: "Updated Savings Charge",
  amount: 15.0,
  active: false
});
const result = await client.request(command);
console.log(result.resourceId);

Function: UpdateCharge() ​

Parameters ​

chargeId ​

data ​

active? ​

amount? ​

applyToExistingAccount? ​

applyUpfrontCharge? ​

chargeAppliesTo? ​

chargeCalculationType? ​

chargeDueDateOnAccountActivation? ​

chargePaymentMode? ​

chargeTimeType? ​

clientClassificationId? ​

collectOnlyTotalDeferCharge? ​

currencyCode? ​

exemptedFeeAmount? ​

feeFrequency? ​

feeInterval? ​

feeOnMonthDay? ​

ignoreChargesOnNegativeBalance? ​

incomeAccountId? ​

locale? ​

maxCap? ​

minCap? ​

monthDayFormat? ​

name? ​

numberOfExemptedFee? ​

paymentDirection? ​

paymentRail? ​

penalty? ​

productIDs? ​

reverseOnTransferFail? ​

taxGroupId? ​

transferType? ​

Returns ​

Example ​

Function: UpdateCharge()

Parameters

chargeId

data

active?

amount?

applyToExistingAccount?

applyUpfrontCharge?

chargeAppliesTo?

chargeCalculationType?

chargeDueDateOnAccountActivation?

chargePaymentMode?

chargeTimeType?

clientClassificationId?

collectOnlyTotalDeferCharge?

currencyCode?

exemptedFeeAmount?

feeFrequency?

feeInterval?

feeOnMonthDay?

ignoreChargesOnNegativeBalance?

incomeAccountId?

locale?

maxCap?

minCap?

monthDayFormat?

name?

numberOfExemptedFee?

paymentDirection?

paymentRail?

penalty?

productIDs?

reverseOnTransferFail?

taxGroupId?

transferType?

Returns

Example