Skip to content

@mbanq/core-sdk-js v0.50.0


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

Function: MakeRepayment()

MakeRepayment(loanId, data): Command<{ data: { accountNumber?: string; bankNumber?: string; checkNumber?: string; dateFormat: string; locale: string; note?: string; paymentTypeId?: number; receiptNumber?: string; routingCode?: string; transactionAmount: number; transactionDate: string; }; loanId: number; }, { changes: { accountNumber?: string; bankNumber?: string; checkNumber?: string; dateFormat: string; locale: string; note?: string; paymentTypeId?: string; receiptNumber?: string; routingCode?: string; transactionAmount: string; transactionDate: string; }; clientId: number; id: string; loanId: number; officeId: number; resourceId: number; }>

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

Makes a repayment on a loan. Repayments can be specific installments, advance payments before the due date, or late payments.

Parameters

loanId

number

The ID of the loan to make a repayment for

data

accountNumber?

string = ...

bankNumber?

string = ...

checkNumber?

string = ...

dateFormat

string = ...

locale

string = ...

note?

string = ...

paymentTypeId?

number = ...

receiptNumber?

string = ...

routingCode?

string = ...

transactionAmount

number = ...

transactionDate

string = ...

Returns

Command<{ data: { accountNumber?: string; bankNumber?: string; checkNumber?: string; dateFormat: string; locale: string; note?: string; paymentTypeId?: number; receiptNumber?: string; routingCode?: string; transactionAmount: number; transactionDate: string; }; loanId: number; }, { changes: { accountNumber?: string; bankNumber?: string; checkNumber?: string; dateFormat: string; locale: string; note?: string; paymentTypeId?: string; receiptNumber?: string; routingCode?: string; transactionAmount: string; transactionDate: string; }; clientId: number; id: string; loanId: number; officeId: number; resourceId: number; }>

A Command that when executed returns the repayment response with transaction details

Example

typescript
const repaymentCmd = MakeRepayment(507, {
  locale: "en",
  dateFormat: "dd MMMM yyyy",
  transactionAmount: 95,
  transactionDate: "28 March 2024",
  paymentTypeId: 172,
  note: "Monthly payment",
  accountNumber: "0000000192",
  checkNumber: "0000000123",
  routingCode: "0000000123",
  receiptNumber: "526678181992",
  bankNumber: "62389390092"
});
const result = await repaymentCmd.execute(config);
console.log(result.resourceId); // 15768
console.log(result.changes.transactionAmount); // 95

Released under the MIT License.