System Documents & UI

Peach displays some messages as documents or UI elements. You may choose to customize the content of these messages using the templating system.

Available Context Variables

In this section of the docs you can see what context variables are automatically calculated for a given subject's system displayed message. (Note the list is currently incomplete.)

autopayAgreement

Displayed When

Autopay agreement shown to a borrower when they turn on Autopay.

The context variables included by system when it displays autopayAgreement

object (Company)

The company object represents a company of Peach which uses some of Peach's applications.

It contains metadata about the company and configuration settings for how the applications should function.

Person (object) or Business (object) (ContextVarPerson)
Installment (object) or Line of Credit (object) (ContextVarLoanDataSource)

Represents a loan. A loan always belongs to a borrower, and most of the interactions between a lender and a borrower are associated with a particular loan.

paymentMethod
string (ContextVarPaymentMethod)

The payment method

Enum: "bankAccount" "card" "check" "payroll" "paymentNetwork" "moneyOrder" "wire"
{
  • "company": {
    },
  • "person": {
    },
  • "loan": {
    },
  • "paymentMethod": "bankAccount"
}

drawFundsDisclosure

Displayed When

Dislosure/consent shown to a borrower when they request to draw additional funds on line of credit.

The context variables included by system when it displays drawFundsDisclosure

object (Company)

The company object represents a company of Peach which uses some of Peach's applications.

It contains metadata about the company and configuration settings for how the applications should function.

Person (object) or Business (object) (ContextVarPerson)
institutionName
string

The name of the institution from which the funds are drawn.

drawAmount
number

The amount of additional funds drawn.

paymentMethod
string (ContextVarPaymentMethod)

The payment method

Enum: "bankAccount" "card" "check" "payroll" "paymentNetwork" "moneyOrder" "wire"
paymentMethodLastFour
string (ContextVarPaymentMethodLastFour)

The last four digits of the payment method

{
  • "company": {
    },
  • "person": {
    },
  • "institutionName": "string",
  • "drawAmount": 0,
  • "paymentMethod": "bankAccount",
  • "paymentMethodLastFour": "string"
}