List of Merge Fields



Merge Fields and their descriptions are directly available to back-office users editing the templates. 

The list of Merge Fields in this article can be amended on custom projects. New Merge Fields can be added to accommodate the specific needs of the lending company.




Merge Fields and their descriptions are directly available to back-office users editing the templates. 

The list of Merge Fields in this article can be amended on custom projects. New Merge Fields can be added to accommodate the specific needs of the lending company.

Merge fields


NameDescriptionNote

General

Global attributes that can be used in all notifications and documents

CompanyLogoReturns the absolute URL to the company logo image. This logo can be uploaded using the 'System > Company Settings' page.
CompanyNameName of the company specified on the 'System > Company Settings' page.In the Demo version, "YourCompany" is set as the value for this field.
CompanyAddress

Company Address, Information from 'System > Company Settings' page.


CompanyCityCompany City, Information from 'System > Company Settings' page.
CompanyCountryCompany Country, Information from 'System > Company Settings' pag
CompanyWebsiteUrl

Link to the Company website

Information from 'System > Company Settings' page, field Website


CompanyPhoneInformation from 'System > Company Settings' page. same format as for BorrowerPhone
SupportEmailEmail address clients may use to contact the support department. This value can be changed in the application configuration file.In the Demo version "support@YourCompany.com" is displayed.
CurrentDateReturns the date when a notification or document was composed.
BaseAppPathReturns the 'base path' part of the application URL. Can be used to create links to various application pages.

 Documents

Information about system documents

DocSignatureSentDate

The date when a document has been sent for signing. Used only in document signing notifications.
DocSignatureLinkA link to the loan document signature page

User Account

General details about the account of the notification recipient (Customer, Investor)

Login

Login (user name) that was selected during the account creation
PasswordUser account password that was entered by the user or automatically generated by the system. Available only in notifications related to user registration.
PasswordResetUrlURL of the password restoration page (available only in 'Password Reset' notifications)


FullNameFull name of the user
ContactEmailContact email address specified by the user. Email notifications are sent to this address.

Investor

Details of the investor that receives a notification. Available for notifications that are sent to investors.

InvestorAccountBalance

Current value of the investor's account balance
InvestorAccountChangeAbsAbsolute value of the recent change of the investor's account (deposit or withdrawal). Used only in notifications for investor account modifications.

Investment

Information about a specific investment. Available for notifications that are sent to investors.

InvestmentCreationDateDate when investment was submitted


InvestmentAmountAmount invested into the loan
InvestmentInterestRateThe rate used to calculate interest return on the investment
InvestmentInterestRateFullThe rate used to calculate interest return on the investment in formated view, "5% per month" 
InvestmentReturnAmountTotal amount of funds repaid for the investment. Used only in 'Investment Return' notifications.
InvestmentCancellationReasonReason for canceling investment. 

text :

If Loan restructured 

"This loan has been restructured"

If Loan canceled 

"This loan has been canceled"

If Loan rejected

"This loan has been rejected"

InvestmentWithdrawalAmount to be returned if Investment has been withdrawn before the due date.

Loan

Provides information about a loan.

LoanIdUnique identifier of the loan that is visible to all users of the system. 


NewLoanIDRestructuredNew Loan ID created by restructuring. Applicable only for Loan Restructured Notifications
LoanAmountLoan amount value. Set by the Borrower or the Originator when a new loan is created.
InterestRateThe interest rate for the loan, set in the given credit product.
InterestRateFullThe interest rate in formated view, "5% per month" 
TotalCommissionThe amount of Origination and Administration Fees. This parameter does not take into account special Fees
GracePeriod

GracePeriod

Credit Product settings


LoanTermLoan term. Set by the Borrower or the Originator when a new loan is created.

Integer.Returns the numeric value of loan term.

LoanTermFullLoan term in formated veiw, "12 months"
APRAnnual Percentage Rate
FinanceChargeThe amount the loan costs to the Borrower. Includes Interest, Origination and Administration Fees, initially calculated in the schedule.
This parameter does not take into account possible Late fees, PastDue Interest.

ContractDate

The date when the contract was signed.

If Loan agreement e-signing is enabled, the date when Customer signed Loan agreement.

If e-signing is disabled, the date when Loan status changed to Approved.



LastPaymentDateLoan maturity date (the date when Loan should be fully paid). 
NextPaymentDate

Date of the nearest scheduled repayment for the loan.

In Loan Agreement NextPaymentDate is applicable as First Payment Date according to schedule.

If Current Date > LastPaymentDate then NextPaymentDate = Current Date
NextPaymentAmount

Amount of the next nearest scheduled repayment for the loan.

Sum of Current installment (early payments are not taken into account), Past Due amounts and Fees.
OutstandingBalanceCurrent outstanding balance of the loan

OutstandingPrincipal

Current outstanding Principal of the loan

OutstandingInterest

Current outstanding Interest of the loan


Debt

Current past due debt of the loan. It includes Sum of unpaid dept of all missed installments. 

Used only in notifications about past due loans.


DueDateExpected due date of the overdue loan. Used only in notifications about overdue loans.
DPDThe number of days past due of the overdue loan. Used only in notifications about overdue loans.
PTPPaymentAmountThe Promise to Pay amount provided by the Borrower (entered by the Collector in'Contact > Promise to Pay > Payment Amount'). Used only for 'Promise to pay' notifications.
PTPPaymentDateThe Date when the Borrower pledges to make a repayment (entered by the Collector in 'Contact > Promise to Pay > Payment Amount'). Used only for 'Promise to pay' notifications.
InterestSuppressionEndDateInterest suppression end date
InterestSuppressionStartDateInterest suppression start date

InterestSuppressionDaysCount

Interest suppression days count
LateGraceDaysLate Grace Days of the relevant credit product.
AverageInstallment

 Average Installment amount.

(Sum of all installments according to the initial schedule) / ( number of installments).

Past Due, Late Fee values are not included


FirstInstallmentDate

Date of First Installment according to the initial schedule


FirstInstallment

First Installment amount according to the initial schedule


NumberOfInstallments

Number of Installments in the schedule.


PastDueInterestPast Due Interest Rate of the relevant credit product.
PastDueInterestFullPast Due Interest Rate in formatted view, "5%per month". Applicable only for Credit Product with the basic view
TotalOriginalInterestTotal interest to pay according to Initial schedule.
TotalInterestTotal interest to payTotal interest to pay according to current schedule.
TotalAmountToPayTotal amount to be paid by Customer. Sum of Loan Principal and Finance ChargesLoan amount value. Sum of LoanAmount and FinanceCharge
TotalFeeTotal Loan Fee (Administration and Origination) according to the schedule. Special Fees are not included.
DisbursementDate

The date when the transaction of Loan Disbursement was done. 

For Loan Agreement, when loan has not been disbursed, the Current date.


LoanBranch

Loan Branch


ScheduleLoan ScheduleSee 836730890 
LateFeesLate fees Table (LateFees)See 836730890
RejectionReasonValue is gathered from <Description> values for all rejection reasons of a rejected loan
CancelReasonCancel Reason Description
CancelCommentComments from Cancellation Confirmation
LastInstallmentAmount of the last repayment for the loan.
DayOfPaymentThe day of month when a installment to be paid. Applicable for Credit Product with the basic view and Monthly repayment period,only. Number from 1 to 31.  The day of month in the first Due date.
CreditProductCredit Product name
LoanCurrentStatusLoan Status
WrittenOffAmountWritten Off Amount.
OriginationFeeTotal Origination Fee according to the schedule. Special Fees are not included. Applicable only for Credit Product with the basic view
OriginationFeeFullOrigination Fee Rate in formatted view, "5%". Applicable only for Credit Product with the basic viewIf Credit product contains several values of OriginationFeeFull returns all values separated by commas
AdministrationFeeTotal Administration Fee according to the schedule. Special Fees are not included. Applicable only for Credit Product with the basic view.
AdministrationFeeFullAdministration Fee Rate in formatted view, "5% , 30$". Applicable only for Credit Product with the basic viewIf Credit product contains several values of AdministrationFeeFull returns all values separated by commas
LateFeeFullLate Fee Rate in formatted view, "5%, 10$". Applicable only for Credit Product with the basic viewIF Credit product contains several values of LateFeeFull returns all values separated by commas
NSFFullNSF Fee Rate in formatted view, "5% per month". Applicable only for Credit Product with the basic viewIf Credit product contains several values of NSFFull returns all values separated by commas
TotalLeasingContractTotal accrued fees with Fee type = 'Leasing' on the disbursement state. 
OutstandingLeasingSummarized outstanding amount for all fees with Fee type = 'Leasing'
SalesTaxRateSales Tax Rate in formatted view, "$30", "5%". B
SalesTaxFull Sales Tax amount expected to be paid during the whole Long Term
Value = Loan Amount * Sales Tax Rate 
or 
Value = Sum of all Leasing payments for all installments  * Sales Tax Rate 
B
PreApprovalAmountSum of all fees with (Event sub-type= 'Pre-approval') 
PreApprovalExpirationPeriodPre-approval. Expiration period (days) 
InitialPaymentExpectedSum of all unpaid fees with (Event type = 'Initial payment') 
InitialPaymentExpiryDate'Pre-approval Expiry Date' 
PurchaseAmountPurchase amount value.
Applicable if only there is a fee with (Fee Type = 'Down payment')

DownPaymentAmountSum of all fees with (Fee Type = 'Down payment')

PreDisbursementAmountSum of all fees with (Event sub-type = 'Pre-Disbursement') 
PreDisbursementExpirationPeriodPre-disbursement. Expiration period (days) 
InitialPaymentExpectedSum of all unpaid fees with (Event sub-type = 'Pre-approval')  or (Event sub-type = 'Pre-Disbursement') depending on the current loan status 
InitialPaymentExpiryDate'Pre-approval Expiry Date' or 'Pre-disbursement Expiry Date' depending on the current loan status ('Pre-approval' or 'Pre-disbursement').
StoreStore name
StoreAddressStore's Address
VendorVendor name
VendorAddressVendor's Address
LateFee_DateDate when the late fees for current installment will be accrued Applied only for the Late Fee with the minimum “installment past due” value, and the "Fee value" is the amount.

LateFee_AbsoluteAmount

The amount will be accrued for the corresponding Late fee date 
DisbursementFeeRateDisbursement Fee Rate in formatted view, "$100", "5%". Applicable only for Credit Product with the basic viewIf Credit product contains several Disbursement Fees,  the DisbursementFeeFull merge field returns all values separated by commas
RepaymentFeeRateRepayment  Fee Rate in formatted view, "$30", "5%". Applicable only for Credit Product with the basic viewIf Credit product contains several Repayment Fees,  the RepaymentFeeFull merge field returns all values separated by commas
RepaymentFeeOnce repayment is applied, this merge field contains the sum of deducted repayment fees. In case Repayment fee not exist for credit product, value = $0
RolloverNewDueDatethe nearest due date after the change.
RolloverOldDueDatethe nearest due date before the change

CurrentInstallment_PreApprovalAmount

Current installment Pre-Approval fee amount


InstallmentDebt_Principal

Outstanding principal amount should be repaid in order to close this installment, not the loan in full


PayoffFee

Once repayment is applied, this merge field contains the sum of pay off fees.


PenultimateInstallmentDate

Second to last payment date of the loan


PrevInstallment_Leasing

Amount applied for Leasing


RepaidReason

Repaid reason.


TotalFeeType

Total of Fee (Fee type). Applicable only for Credit Product with the Advanced view.


TotalPastDueType

Total of Past Due Fee. Applicable only for Credit Product with the Advanced view.


TotalPenaltyType

Total of Penalty Fee. Applicable only for Credit Product with the Advanced view.


SeasonSeason in which the loan is paid. Set by the Borrower or the Originator when a new loan is created.
FirstDisbursementAmountFirst Funds Tranche
Applicable if only 'Enabled multiple disbursement'=ON 

TotalDisbursedAmountSum of all successful disbursement transactions
EqualPaymentEqual payment
Applicable if only 'Enable equal payments'=ON 

RepaymenPeriodRepayment period. Credit Product settings'Repayment period' from Credit product. 

Possible values:
Monthly, Twice Per Month, Bi-Weekly, Weekly, Daily

If the credit product is crated in Advance Mode, then the value is an empty string. 
WeeklyIncomeWeekly receivable forecast(warning) Only for 'MCA edition'
SpecifiedPercentage% of weekly Income(warning) Only for 'MCA edition'

Payments

Details of particular loan repayment. Available in repayment-related notifications.

PaymentAmountThe payment amount received from the Borrower.
PaymentsDone
The total amount of payments received from the Borrower in the current installment of the loan. 
RestPaymentAmountTotal unpaid amount for the current installment of the loan.

Applicable only for notification:

Payment is greater than scheduled
Full Payment
Partial Payment

PaymentDateThe Date when payment received. 
NSFFeeNSF fee amount
DisbursementFeeOnce repayment is applied, this merge field contains the sum of deducted disbursement fees. In case Disburement fee does not exist for credit product, value = $0
InstallmentDebt_TotalTotal amount should be repaid in order to close this installment, not the loan in full
InstallmentDebt_InterestOutstanding Interest amount should be repaid in order to close this installment, not the loan in full
Installment_ScheduledAmountTotal scheduled amount to be paid by the customer for the current installment. 
InstallmentDebt_FeesOutstanding fees amount should be repaid in order to close this installment, not the loan in full
InstallmentDebt_PastDueOutstanding Past Due amount should be repaid in order to close this installment, not the loan in full
InstallmentDebt_PenaltyOutstanding Penalty amount should be repaid in order to close this installment, not the loan in full
InstallmentDebt_LeasingOutstanding Leasing amount should be repaid in order to close this installment, not the loan in full
InstallmentDebt_DownPaymentAmountOutstanding Down Payment amount should be repaid in order to close this installment, not the loan in full
InstallmentDebt_PreApprovalAmountOutstanding Pre-Approval Fee amount should be repaid in order to close this installment, not the loan in full
InstallmentDebt_PreDisbursementAmountOutstanding Pre-Disbursement Fee amount should be repaid in order to close this installment, not the loan in full
InstallmentBadDebt_PrincipalNot paid principal amount for previous installments
InstallmentBadDebt_InterestNot paid Interest amount for previous installments
InstallmentBadDebt_FeesNot paid fees amount for previous installments

InstallmentBadDebt_PenaltyNot paid Penalty amount for previous installments

InstallmentBadDebt_LeasingNot paid Leasing amount for previous installments

CurrentInstallment_PrincipalCurrent installment principal amount
CurrentInstallment_InterestCurrent installment Interest amount
CurrentInstallment_FeesCurrent installmentfees amount
CurrentInstallment_PenaltyCurrent installment Penalty amount 
CurrentInstallment_LeasingCurrent installment Leasing amount
CurrentInstallment_DownPaymentAmountCurrent installment Down Payment amount
CurrentInstallment_PreDisbursementAmountCurrent installment Pre-Disbursement Fee amount
PrevInstallment_StartDatePrevious installment Start date. 

Start day is the day next to the due date of the previous installment.

For the 1st statement, there is a Loan creation date. 

for example, if the due date is the 1st of each month, the Start day is 2d day of each month.

PrevInstallment_DueDatePrevious installment due date For the 1st statement, there is a Disbursement date.
PrevInstallment_TotalRepaidSum of payment amounts from the previous installmentsIf the previous installment does not have any transactions, the displayed amount is 0

PrevInstallment_PrincipalAmount applied for the principal 
PrevInstallment_InterestAmount applied for the interest
PrevInstallment_FeesAmount applied for Fees
PrevInstallment_PastDueAmount applied for Past Due
PrevInstallment_PenaltyAmount applied for Penalty
PrevInstallment_LeasingAmount applied for Leasing
PrevInstallment_SalesTaxAmount applied for SalesTax
PrevInstallment_DownPaymentAmountAmount applied for Down Payment
PrevInstallment_PreDisbursementAmountAmount applied for Pre-Disbursement Fee
PrevInstallment_PreApprovalAmountAmount applied for Pre-Approval Fee

PaymentError

Payment Error


Disbursements

Provides information about a disbursement transaction

DisbursementAmountAmount that is disbursed to a customer with this transaction
DisbursementTransactionDate Date of this disbursement transaction

Customer Details

CardHintSeveral last digits of the cardCustomer Credit Card details 
ExpirationDateCard expiration dateCustomer Credit Card details
BankAccountVerificationSentDateDate when the Bank Account verification Request was sent to the Borrower
BankAccountVerificationExpiryDateDate when the Bank Account verification Request will expire
BorrowerAddress_Street

'Street' part of the borrower's address

For US edition 

Street Address 2 & Street Address 2

BorrowerAddress_CityThe 'City' part of the borrower's address.
BorrowerAddress_ZipCode'ZipCode' part of the borrower's address
BorrowerAddress_State'State' part of the borrower's address

BorrowerAddress_StateCode 

US state code from the borrower's addressUS edition specific
BorrowerAddress_Province 'Province' part of the borrower's addressCanada edition specific
BorrowerAddress_Appartment'Appartment' part of the borrower's address
BorrowerAddressThe full address of the borrower.
Information from the Application form
Country Address format
BorrowerPhoneThe phone number of the Borrower. Field form Application formCountry Phone format
BorrowerDateOfBirthDate of Birth
EnterpriseNameEnterprise Namefor SME edition only
EnterpriseTaxNumberEnterprise Tax Identification Number for SME edition only
RegistrationDateRegistration datefor SME edition only
EnterprisePhoneOffice phone number for SME edition only
EnterpriseEmailCompany emailfor SME edition only
EnterpriseEntityTypeEntity typefor SME edition only
EnterpriseWebsiteEnterprise Websitefor SME edition only
EnterpriseAddress_Street'Street' part of the borrower's address

For US & SME edition 

Street Address 2 & Street Address 2

EnterpriseAddress_CityThe 'City' part of the Enterprise Legal address.for SME edition only
EnterpriseAddress_ZipCode'ZipCode' part of the Enterprise Legal addressfor SME edition only
EnterpriseAddress_State'State' part of the Enterprise Legal addressfor SME edition only
EnterpriseAddress_StateCode US state code from the Enterprise Legal address

US & SME edition specific

EnterpriseAddress_Province 'Province' part of the Enterprise Legal address

Canada & SME specific

EnterpriseAddress_Appartment'Apartment part of the Enterprise Legal addressfor SME edition only
EnterpriseLegalAddressThe full address of the Enterprise Legal Address
Information from the Application form

Country specific address format

for SME edition only

EnterpriseBusinessAddressThe full address of the Enterprise Actual business address
Information from the Application form

Country specific address format

for SME edition only

BorrowerBankNameThe Bank of the Borrower. Field from the Default payment option
BorrowerBankAccountThe Bank Account of the Borrower. Field from the Default payment option
BorrowerBankRoutingNumberThe Bank Routing Number of the Borrower. Field from the Default payment option
BorrowerBankAccountTypeType of account (Saving | Checking) 

Payment Table (Schedule)

InstallmentNumber

Number of Payment (for the Payment Schedule)

The number of each regular payment according to the schedule


DueDate

Payment Due Dates (for the Payment Schedule)

The date of each regular payment according to the schedule.


Total

Total Amount of Each Payment (for the Payment Schedule)

The total amount of each regular payment scheduled to come due under the loan.


Principal

Amount of Each Payment that is Applied to the Outstanding Principal Amount (for the Payment Schedule)

The Principal portion of each regular payment scheduled to come due under the loan. 


Interest

Amount of Each Payment that is Applied to Interest (for the Payment Schedule)

The Interest portion of each regular payment scheduled to come due under the loan. 


Commission

The amount of Administrative Fee and Origination Fee for the Installment 


BalanceBalance of Installment (for the Payment Schedule)
NSFTotal NSF Fee according to the schedule. Special Fees are not included. Applicable only for Credit Product with the basic view
LateFeeTotal Late Fee according to the schedule. Special Fees are not included. Applicable only for Credit Product with the basic view
PastDueInterestTotal Past Due  Interest  according to the schedule. Special Fees are not included. Applicable only for Credit Product with the basic view
AdministrationFeeTotal Administration Fee according to the schedule. Special Fees are not included. Applicable only for Credit Product with the basic view
OriginationFeeTotal Origination Fee according to the schedule. Special Fees are not included. Applicable only for Credit Product with the basic view
InstallmentCloseDateThe Day of the charge (Installment past due). Late Fee Settings from Credit Product. Applicable only for Credit Product with the basic view
InstallmentStatusStatus of Installment
PenaltyTotal Penalty for the Installment according to the schedule. 
PastDueTotal Past Due for the Installment according to the schedule. 
PercentageOfWeeklyIncomePercentage = 100% * Debit / Weekly Receivable ForecastOnly for 'MCA edition'
WeeklyIncomeWeekly Receivable ForecastOnly for 'MCA edition'

Payment Table (Initial Schedule)

InstallmentNumber

Number of Payment (for the Payment Schedule)

The number of each regular payment according to the schedule


DueDate

Payment Due Dates (for the Payment Schedule)

The date of each regular payment according to the schedule.


Total

Total Amount of Each Payment (for the Payment Schedule)

The total amount of each regular payment scheduled to come due under the loan.


Principal

Amount of Each Payment that is Applied to the Outstanding Principal Amount (for the Payment Schedule)

The Principal portion of each regular payment scheduled to come due under the loan. 


Interest

Amount of Each Payment that is Applied to Interest (for the Payment Schedule)

The Interest portion of each regular payment scheduled to come due under the loan. 


CommissionThe amount of Administrative Fee and Origination Fee for the Installment 
BalanceBalance of Installment (for the Payment Schedule)
NSFTotal NSF Fee according to the schedule. Special Fees are not included. Applicable only for Credit Product with the basic view
LateFeeTotal Late Fee according to the schedule. Special Fees are not included. Applicable only for Credit Product with the basic view
PastDueInterestTotal Past Due  Interest  according to the schedule. Special Fees are not included. Applicable only for Credit Product with the basic view
AdministrationFeeTotal Administration Fee according to the schedule. Special Fees are not included. Applicable only for Credit Product with the basic view
OriginationFeeTotal Origination Fee according to the schedule. Special Fees are not included. Applicable only for Credit Product with the basic view
InstallmentCloseDateThe Day of the charge (Installment past due). Late Fee Settings from Credit Product. Applicable only for Credit Product with the basic view
InstallmentStatusStatus of Installment
PercentageOfWeeklyIncomePercentage = 100% * Debit / Weekly Receivable Forecast(warning) Only for 'MCA edition'
WeeklyIncomeWeekly Receivable Forecast
currency format
(warning) Only for 'MCA edition'

Late fees Table (LateFees)

DPD

The Day of the charge (Installment past due). Late Fee Settings from Credit Product 


LFAbsolute

Late Fee Settings. Absolute fee set in the given credit product.

Late Fee Charges need to be indicated in the Loan Agreement.


LFPercent

Late Fee Settings. Outst. balance % fee set in the given credit product.

Late Fee Charges need to be indicated in the Loan Agreement.


LFType

Basis debt for calculation of late fee amount.


Previous Payments Table (PrevPayments)

PaymentDateThe date of the previous transaction 

Disbursement transaction is not included.

If the installment does not have any transactions, nothing (-) should be displayed.

TransactionStatus Transaction status. Successful | Failed | in Progress
TransactionTypeTransaction type. Cash | Check | Direct bank transfer | Card
PaymentAmountTransaction Amount. 

Co-applicant

CoApplicantFullNameFull name of the Co-applicant
CoApplicantPhoneThe phone number of the Co-applicant. 
CoApplicantAddressCo-applicant's address
CoApplicantEmailContact email address of the Co-applicant. 
CoApplicantBorrowerFullNameFull name of the borrower.
CoApplicantDateOfBirthCo-applicant's date of birth
CoApplicantNationalIDCo-applicants national ID depending on the country (SSN, INN, ets.) 

Notification recipient

RecipientFullName The name of the user who is supposed to be receiving the notificationAlias (existing merge field) - FullName
RecipientEmailThe email of the user where to notification should be sent toAlias (existing merge field) - ContactEmail
RecipientLogin The login of the user who is supposed to be receiving the notificationAlias (existing merge field) - Login

Table creation


To create a table in Loan Agreement the commands need to be used:

in the table begin - «TableStart:Tablename»

in the table end - «TableEnd:Tablename».



Where TableStart, TableEnd - commands, Table name - merge filed in format Table. Examples are presented in Table 2 and Table 3.


Table 2. Schedule table example

Installment NumberDue DateTotal AmountPrincipal AmountInterest AmountFeeBalance

«TableStart:Schedule»«InstallmentNumber»

«DueDate»

«Total»

«Principal»

«Interest»

«Commission»

«Balance»«TableEnd:Schedule»

Table 2. Late Fee table example

Installment past due (days)

Absolute fee

% fee

Past Due Interest Type

«TableStart:LateFees»«DPD»

«LFAbsolute»

«LFPercent»

«LFType»«TableEnd:LateFees»