@mbanq/core-sdk-js v0.50.0

---

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

Function: DisburseLoan()

DisburseLoan(loanIdForDisburse, data): Command<{ data: { accountNumber?: string; actualDisbursementDate: string; bankNumber?: string; checkNumber?: string; dateFormat: string; locale: string; note?: string; paymentTypeId?: number; receiptNumber?: string; routingCode?: string; transactionAmount: number; }; loanIdForDisburse: number; }, { changes: { accountNumber?: string; actualDisbursementDate: string; bankNumber?: string; checkNumber?: string; dateFormat: string; locale: string; receiptNumber?: string; routingCode?: string; status: { active?: boolean; closed?: boolean; closedObligationsMet?: boolean; closedRescheduled?: boolean; closedWrittenOff?: boolean; code: string; id: number; overpaid?: boolean; pendingApproval?: boolean; value: string; waitingForDisbursal?: boolean; }; }; clientId: number; loanId: number; officeId: number; resourceId: number; }>

Defined in: src/commands/rest/loan.ts:326

Disburses a loan with payment details.

Parameters

loanIdForDisburse

number

The ID of the loan to disburse

data

accountNumber?

string = ...

actualDisbursementDate

string = ...

bankNumber?

string = ...

checkNumber?

string = ...

dateFormat

string = ...

locale

string = ...

note?

string = ...

paymentTypeId?

number = ...

receiptNumber?

string = ...

routingCode?

string = ...

transactionAmount

number = ...

Returns

Command<{ data: { accountNumber?: string; actualDisbursementDate: string; bankNumber?: string; checkNumber?: string; dateFormat: string; locale: string; note?: string; paymentTypeId?: number; receiptNumber?: string; routingCode?: string; transactionAmount: number; }; loanIdForDisburse: number; }, { changes: { accountNumber?: string; actualDisbursementDate: string; bankNumber?: string; checkNumber?: string; dateFormat: string; locale: string; receiptNumber?: string; routingCode?: string; status: { active?: boolean; closed?: boolean; closedObligationsMet?: boolean; closedRescheduled?: boolean; closedWrittenOff?: boolean; code: string; id: number; overpaid?: boolean; pendingApproval?: boolean; value: string; waitingForDisbursal?: boolean; }; }; clientId: number; loanId: number; officeId: number; resourceId: number; }>

A Command that when executed returns the disbursement response with status changes

Example

const disburseLoanCmd = DisburseLoan(17, {
  locale: "en",
  dateFormat: "dd MMMM yyyy",
  transactionAmount: 100000,
  actualDisbursementDate: "19 July 2023",
  note: "Disbursing loan",
  accountNumber: "accno123",
  checkNumber: "chec123",
  routingCode: "rou123",
  receiptNumber: "rec123",
  bankNumber: "ban123"
});
const result = await disburseLoanCmd.execute(config);
console.log(result.changes.status.value); // "Active"