Where it lives
The directory is at/{tenantSlug}/admin/disbursement/payees, with /new to add one and /{payeeId} to edit one. The nav label is Saved payees.
For a workspace on https://loan.compuzign.com/your-slug, the directory is at https://loan.compuzign.com/your-slug/admin/disbursement/payees.
Who can manage it
The directory is gated by thedisbursements.payees.manage capability. Both the Disbursement role and the Credit Manager role hold it. A quick save this payee from the schedule form is gated by loans.disburse; the dedicated management page is gated by disbursements.payees.manage.
Payee types
Every saved payee is classified bypayeeType. The enum holds seven values.
A new saved payee defaults to
THIRD_PARTY.
Managing the directory
You can create, edit, deactivate, and restore a payee. Every action is audited.- Create adds a payee. It is validated and de-duplicated.
- Edit does a full replace of the editable fields.
- Deactivate hides a payee from the picker without losing the record. It flips the
activeflag rather than deleting. - Restore brings a deactivated payee back.
saved_payee.created, saved_payee.updated, saved_payee.deactivated, and saved_payee.restored.
The account number is never saved
A saved payee holds the name,payeeType, defaultMethod, bankCode, branchCode, routingNumber, bankName, accountType (one of CHEQUING, SAVINGS, SHARE), swiftBic, and payeeAddress. It does not hold the account number.
The account number is entered per disbursement and encrypted at rest. Picking a saved payee fills in the routing, then the officer types the account number for that specific payment. This is the same handling as a one-off payee: routing is non-secret and stored, the account number is secret and entered each time.
Loan payoff
ALENDER_PAYOFF payee settles an existing loan the member holds at another institution. It carries a payoffReference, the loan reference at that other lender.
A payoff payee is a payee like any other. It is one of the slices the net is split across, routed by its payment method to the other lender. The member receives the remainder. The payoff does not reduce the net itself; the net is set earlier by fees, GCT, and deductions, and the payee amounts must sum to it exactly.