Skip to main content

SetCollectionDetailsCommand

Overview​

Configures the repayment collection details for a loan — the debit account, repayment schedule, and auto-debit preference. Each call replaces the previous schedule entirely.

For full details see the developer reference.

Request​

{
"cmd": "SetCollectionDetailsCommand",
"data": "{\"loanRequestId\":110,\"repaymentDayInMonth\":15,\"repaymentCount\":12,\"collectionStartDate\":\"2025-09-15\",\"accountNumber\":\"0123456789\",\"accountName\":\"John Doe\",\"bankCode\":\"000013\",\"collectionMode\":1,\"enableAutoDebit\":true}"
}

Parameters​

ParameterTypeRequiredDescription
loanRequestIdlongYesLoan quote ID (LoanQuote.Id)
repaymentDayInMonthintYesDay of month for debit (1–31)
repaymentCountintYesTotal installment count (≥ 1)
collectionStartDatestringYesFirst installment date (ISO 8601)
accountNumberstringYesAccount to debit
accountNamestringYesAccount holder name
bankCodestringYesNIBSS or internal bank code
collectionModeintYes0 = GSI, 1 = Direct Debit
enableAutoDebitboolNoEnable automated debit (default: false)
commentstringNoOfficer comment