UpdateLoanSettlementDetailsCommand
Overview​
Configures the settlement account for a loan — either a virtual account or a direct bank account — through which loan repayments will be settled. Updates the collection record linked to the loan.
Command Structure​
{
"cmd": "UpdateLoanSettlementDetailsCommand",
"data": "{\"loanRequestId\":110,\"settlementOption\":1,\"settlementAccountNumber\":\"0123456789\",\"providerCode\":\"GTB\",\"loanAccountReference\":\"LA202600110\",\"comment\":\"Settlement via GTBank account\"}"
}
Parameters​
| Parameter | Type | Required | Description |
|---|---|---|---|
loanRequestId | long | Yes | ID of the loan application |
settlementOption | int | Yes | How settlement is processed (see enum below) |
loanAccountReference | string | No | Core banking loan account reference |
comment | string | No | Notes |
virtualAccountId | long | Conditional | Required when settlementOption = 0 (VirtualAccount) |
settlementAccountNumber | string | Conditional | Required when settlementOption = 1 (DirectSettlementAccount) |
providerCode | string | Conditional | Required when settlementOption = 1 — bank code of the settlement account |
settlementOption Enum​
| Value | Name | Description |
|---|---|---|
0 | VirtualAccount | Settle through a BankLingo virtual account |
1 | DirectSettlementAccount | Settle via a named bank account number |
Process​
- Retrieves loan quote and associated collection information
- Based on
settlementOption:- VirtualAccount: validates the virtual account exists and belongs to the organisation
- DirectSettlementAccount: validates the account number and provider code
- Updates collection record with settlement details
- Records the action in approval history
- Persists changes
Response​
{
"ok": true,
"statusCode": "00",
"message": "Settlement details updated successfully.",
"outData": {
"LoanRequestId": 110,
"comment": "Settlement via GTBank account"
}
}