@mbanq/core-sdk-js / commands / GetCharge
Function: GetCharge()
GetCharge(
chargeId):Command<{chargeId:number; }, {active:boolean;amount:number;applyToExistingAccount:boolean;applyUpfrontCharge:boolean;chargeAppliesTo: {code:string;id:number;value:string; };chargeCalculationType: {code:string;id:number;value:string; };chargeDueDateOnAccountActivation:boolean;chargePaymentMode: {code:string;id:number;value:string; };chargeTimeType: {code:string;id:number;value:string; };clientClassification: {id:number;name:string; };collectOnlyTotalDeferCharge:boolean;createdByUsername:string;createdDate:number[];currency: {code:string;decimalPlaces:number;displayLabel:string;displaySymbol:string;name:string;nameCode:string; };exemptedFeeAmount:number;id:number;ignoreChargesOnNegativeBalance:boolean;isMandatory:boolean;maxCap:number;minCap:number;name:string;numberOfExemptedFee:number;penalty:boolean;reverseOnTransferFail:boolean;savingsProducts:object[]; }>
Defined in: src/commands/rest/chargeSetup.ts:132
Get a charge definition
This endpoint allows retrieving a charge definition by its ID.
Parameters
chargeId
number
The ID of the charge
Returns
Command<{ chargeId: number; }, { active: boolean; amount: number; applyToExistingAccount: boolean; applyUpfrontCharge: boolean; chargeAppliesTo: { code: string; id: number; value: string; }; chargeCalculationType: { code: string; id: number; value: string; }; chargeDueDateOnAccountActivation: boolean; chargePaymentMode: { code: string; id: number; value: string; }; chargeTimeType: { code: string; id: number; value: string; }; clientClassification: { id: number; name: string; }; collectOnlyTotalDeferCharge: boolean; createdByUsername: string; createdDate: number[]; currency: { code: string; decimalPlaces: number; displayLabel: string; displaySymbol: string; name: string; nameCode: string; }; exemptedFeeAmount: number; id: number; ignoreChargesOnNegativeBalance: boolean; isMandatory: boolean; maxCap: number; minCap: number; name: string; numberOfExemptedFee: number; penalty: boolean; reverseOnTransferFail: boolean; savingsProducts: object[]; }>
Command object for getting a charge
Example
const command = GetCharge(123);
const result = await client.request(command);
console.log(result.name);