@mbanq/core-sdk-js v0.50.0

---

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

Function: HoldAmount()

HoldAmount(accountId, data): Command<{ accountId: number; data: { holdAmountReasonCodeId: number; transactionAmount: number; }; }, { changes: { blockAmountReason: { codeName: string; id: number; name: string; }; savingsAmountOnHold: number; }; id: string; resourceId: number; }>

Defined in: src/commands/rest/account.ts:417

Places a hold on a specific amount in a client's account.

Parameters

accountId

number

The ID of the savings account

data

holdAmountReasonCodeId

number = ...

transactionAmount

number = ...

Returns

Command<{ accountId: number; data: { holdAmountReasonCodeId: number; transactionAmount: number; }; }, { changes: { blockAmountReason: { codeName: string; id: number; name: string; }; savingsAmountOnHold: number; }; id: string; resourceId: number; }>

A Command that when executed returns the hold amount confirmation

Example

const holdCmd = HoldAmount(
  123,
  { transactionAmount: 45, holdAmountReasonCodeId: 6100 }
);
const result = await holdCmd.execute(config);
console.log(result.changes.savingsAmountOnHold); // 45