Skip to content
Last updated

View, export, and import loan types

A loan type sets how loans behave on Peach: interest, due dates, autopay, fees, the payment waterfall, credit reporting, and statements. View your loan types in the Admin Portal and, on the redesigned Loan Types screen, export, import, and clone them.

Availability

  • Portal: Admin Portal
  • Role: Without the admin or peach-support role, the new layout's sidebar shows no Admin section, so no Loan types link. The legacy layout checks no role.
  • Permissions: admin.portal:read, plus all of the permissions an action lists:

    • List loan types: loan.type:list
    • Open a loan type: loan.type:read
    • Export a loan type: loan.type:read and loan.type:list
    • Import or clone a loan type: loan.type:create, loan.type:read, and loan.type:list

    Import and clone also need loan.type:create, which lenders' usual roles don't include. To get it, contact Peach.

  • Roles editor: Listed under LOAN.TYPE as create, delete, list, and read. None lets you edit a loan type's settings.

  • Admin Portal layout: Try it now, at the bottom of the sidebar, opens the new layout, and Go back returns. Your browser stores the choice.
  • Feature flags: Peach turns on the redesigned screen for your company. You see it after selecting Try it now, and the legacy screen otherwise. A second Peach setting turns on cloning and opening a loan type from the list. If you don't see Clone, contact Peach.
  • Status: Available where Peach has turned on the redesigned screen. The legacy screen is available to every lender.

What you can do on the redesigned screen:

Cloning on for your companyPermissions you holdSelect a rowRow menuHeader button
Noloan.type:listNothingNoneNone
No+ loan.type:readNothingExport Loan TypeNone
No+ loan.type:createNothingExport Loan TypeImport from Sandbox or Import from Production
Yesloan.type:listNothingNoneNone
Yes+ loan.type:readOpens the loan typeExport Loan TypeNone
Yes+ loan.type:createOpens the loan type, with CloneClone, Export Loan TypeImport from Sandbox or Import from Production

Before you start

  • You can't change an existing loan type's configuration in the Admin Portal. To change one, contact Peach.
  • An imported or cloned loan type is Active, and loans can use it as soon as it's created.
  • Don't edit an export file.
  • Import a file soon after you export it. By design, export files are short-lived: Peach checks the file against its current rules at import, so an older file may be rejected.

View loan types

1. Navigate to Loan types

From the Admin Portal sidebar, under Admin, select Loan types (legacy layout: select Loan Types).

The screen opens on the loan type list.

2. Find a loan type

The list shows 25 loan types per page by default. Known limitation: search matches name or ID on the current page only. Filter by Status (Active or Inactive), and sort by Configuration name, Type, Status, or Created at.

3. Open a loan type

Where cloning is on, select a row to open the loan type's configuration as JSON in a drawer. A removed loan type shows "That loan type no longer exists."

View loan types on the legacy screen

1. Find a loan type

The legacy screen lists 10 loan types per page by default. In the legacy layout, its columns are Configuration Name, Type, and Status. In the new layout, they're ID, External ID, Configuration Name, Type, Status, and Last Updated.

2. Open a loan type

Select a loan type to see its configuration as JSON. Two icon buttons in the header switch between a collapsible tree (the default) and a read-only code view.

Export a loan type

1. Open the row menu

Open the menu at the right end of the loan type's row. It lists Clone (where cloning is on), then Export Loan Type.

The row menu, open on a loan type:

Loan type row menu open, showing where Clone and Export Loan Type sit

2. Select Export Loan Type

Select Export Loan Type to download a .json file named with the export date and ending _Loan_Type.json.

Import a loan type

1. Sign in

Sign in to the Admin Portal in the environment you're importing into.

2. Start the import

In the upper right, select Import from Sandbox (in production) or Import from Production (in sandbox).

3. Upload the file

In the Import loan type sheet, add the file under File upload, then select Continue, which stays unavailable until the file reads correctly. Messages appear under the file:

MessageWhat to do
"This is not a Peach loan type export file."Choose a file exported from the Loan Types screen.
"This file was exported by a newer version of Peach. Refresh the page and try again."Refresh the page, then choose the file again.
"This file came from this environment. Use Clone instead."Clone the loan type in this environment instead of importing it.
"This file came from [environment]. [This environment] only imports from [other environment]."Export the loan type from the environment the message names last.
"This file is incomplete. Export it again."Export a fresh copy.
"This file contains an unsupported loan type."Contact Peach.
"This file could not be read. Choose it again."Choose the file again.
"This file was exported against a different API version."Appears when the file was exported before Peach changed its API version. A warning only. It doesn't block the import.
"We've detected changes to this file since it was exported. Check them before you continue."A warning only. Export a fresh copy rather than importing an edited file.

The sheet then lists five steps: Identity, Scheduling and timing, Money mechanics, Servicing and borrower experience, and Lifecycle and compliance. Only Identity is editable; the rest show INHERITED FROM SOURCE.

4. Set up Identity

On Identity, select Setup, fill in White labeling and Naming (see Field reference), then select Save and return to lobby.

The Identity fields, before any is edited:

Identity step of the Import loan type sheet, showing the White labeling and Naming fields you edit

5. Select Import loan type

Select Import loan type. If the import fails, an error message appears. If you leave with unsaved changes, select Exit to confirm.

Clone a loan type

1. Select Clone

Where cloning is on, select Clone from the row menu or the open drawer.

2. Set up Identity

Set up Identity as for an import.

3. Select Clone loan type

Select Clone loan type.

Field reference

Editable fields (the Identity step):

FieldDescriptionType / ValuesDefaultRequired
Enable white-labeling this loan typeGives the loan type its own brand, which you set with Configure. The brand applies to statements, communications, and collections, not the Borrower Portal.SwitchOn if the source has its own brandNo
Internal nameNames the loan type in the Admin Portal list.Text, up to 255 charactersImport: the source's name. Clone: "Copy of" plus the source's name.No
Display nameNames the loan type for borrowers.Text, up to 50 charactersThe source's valueYes
External IDSets your own identifier for the loan type. On import, a message notes when you keep the source's ID; keep it if this environment should use the same ID.Text, up to 255 characters; must be unusedThe source's valueNo
Bank-statement codeSets a short code for the loan type on bank statements.Text, up to 4 charactersThe source's valueNo
DescriptionDescribes the loan type.TextThe source's valueNo

Read-only fields (list columns, in order):

FieldDescription
Configuration nameThe loan type's internal name, with its ID beneath.
BrandThe brand a borrower sees for this loan type. A loan type without its own brand shows none.
TypeInstallment or line of credit.
StatusActive or Inactive.
Created atWhen the loan type was created.
Last updatedWhen the loan type was last changed.

Read-only fields (sections of the configuration in the JSON view):

FieldDescription
dueDatesPayment frequency options, the gap between due dates, and limits on frequency changes.
autoPayACH debit timing, retry logic, and balance-check settings for autopay.
futurePayACH debit timing and balance-check settings for future payments.
feesOrigination fee and draw fee charge logic and display names. Draw fees apply to lines of credit only.
paymentWaterfallHow payments are applied across fees, interest, and principal, for a single loan and across multiple loans.
creditReportingMetro 2® identifiers and settings for credit bureau reporting.
statementsStatement settings, including whether final statements are on and the statement logic version.
refundsWhether a borrower can receive a refund.
interestInterest accrual method, daily calculation, APR method, rate ranges, and index rate timing.
termsAcceleration, charge-off, and loan extension settings.
duePaymentsHow due payments are calculated, including the amortization method and prepayments.

Result

After an import or clone, the sheet closes, the new loan type opens in its drawer, and the list shows it as Active.