API – Loan Settings


You can configure loan settings either within the UI or in the API, which this article covers. It assumes you already have an existing loan; if not, see Creating a Loan with the API.

To add loan settings to a loan, you will need to send a PUT request to the URL of the desired loan. For example, to add loan settings to a loan with id 515 the URL would be


Request Body

The request body will be formatted as follows:

"LoanSettings": {
"MerchantProcessorGroup": {},
"id": 1562,
"loanId": 2893,
"cardFeeAmount": 0,
"cardFeeType": "loan.cardfee.types.1",
"cardFeePercent": 0,
"agent": 0,
"loanStatusId": 2,
"loanSubStatusId": 9,
"sourceCompany": null,
"paymentTypeDefault": 0,
"eBilling": 0,
"ECOACode": "loan.ecoacodes.1",
"coBuyerECOACode": "loan.ecoacodes.0",
"creditStatus": "loan.creditstatus.0",
"creditBureau": "loan.creditbureau.00",
"reportingType": "loan.reportingtype.I",
"secured": 1,
"autopayEnabled": 1,
"repoDate": "",
"closedDate": "",
"liquidationDate": "",
"followUpDate": "",
"isStoplightManuallySet": 0,
"merchantProcessorGroupId": 0,
"displayId": "2893",
"repo": false,
"closed": false,
"liquidation": false,
"paymentTypeDefaultText": "Company Default",
"_$isSystemId": true,
"CustomFieldValues": {
"results": []
"__id": 1562,
"__update": true
"CustomFieldValues": {},
"Portfolios": {
"results": [
"__metadata": {
"uri": "/api/1/odata.svc/Portfolios(id=39)",
"type": "Entity.Portfolio"
"SubPortfolios": {
"results": [
"__metadata": {
"uri": "/api/1/odata.svc/Portfolios(id=40)",
"type": "Entity.SubPortfolio"
"StopInterestDates": {
"results": []
"displayId": "2893"
  • loanId – This is the ID of the associated loan
  • cardFeeAmount – This is the flat fee amount for processing a card
  • cardFeeType – The type of the card fee. See Loan Settings Collections
  • cardFeePercent – This is the percentage used for calculating the fee amount
  • agent – The ID of the assigned agent user
  • loanStatusId – The ID of the corresponding Loan Status
  • loanSubStatusId – The ID of the corresponding Loan Sub-Status
  • sourceCompany – The ID of the source company that the loan is linked to
  • paymentTypeDefault – This determines the default payment type (principal only, fees only, etc.). This field allows you to set a default that is specific to this loan, but you can also set it to zero to leave it as your company default. This list comprises both LoanPro default types and any custom types that you've created, and a full list is available within Settings > Loan > Payments > Types.
  • eBilling – Whether or not the loan is marked for eBilling. See Loan Settings Collections
  • ECOACode – The ECOA code to use for credit reporting for the primary borrower. See Loan Settings Collections
  • coBuyerECOACode – The ECOA code to use for credit reporting for the secondary borrower. See Loan Settings Collections
  • creditStatus – The credit status for the account. See Loan Settings Collections
  • creditBureau – Type of loan to report to the Credit Bureau. See Loan Settings Collections
  • reportingType – Reporting type for reporting credit. See Loan Settings Collections
  • secured – Whether or not the loan is secured. 1 indicates yes; 2 no.
  • autopayEnabled – Whether or not AutoPays will be processed.
  • repoDate – The date of repossession (YYYY-MM-DD)
  • closedDate – The date the loan was closed (YYYY-MM-DD)
  • liquidationDate – The date the loan was liquidated (YYYY-MM-DD)
  • followUpDate – The when the loan was followed up on (YYYY-MM-DD)
  • isStoplightManuallySet – Whether or not the stoplight was manually set. 1 indicates yes; 2 no.
  • merchantProcessorGroupId – ID for the merchant processor group. If left blank, the default group will be applied.
  • displayId – The display ID of the loan
  • repo – Whether the collateral has been repossessed
  • closed – Whether the loan account has been closed
  • liquidation – Whether the account has been liquidated
  • paymentTypeDefaultText – Text associated with the paymentTypeDefault field

How did we do?

Powered by HelpDocs (opens in a new tab)