Peach displays some messages as documents or UI elements. You may choose to customize the content of these messages using the templating system.
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.)
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 |
{- "company": {
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "deletedAt": "2019-08-24T14:15:22Z",
- "object": "company",
- "legalName": "string",
- "slug": "string",
- "domainName": "string",
- "shortDomainName": "string",
- "type": "string",
- "name": "string",
- "brandName": "string",
- "borrowerAuthType": "basic",
- "agentAuthType": "basic",
- "borrowerAuthValueType": "email",
- "agentAuthValueType": "email",
- "femaPolicy": true,
- "bankruptcyPolicy": true,
- "deceasedPolicy": true,
- "bankruptcyServiceId": 0,
- "deceasedServiceId": 0,
- "femaServiceId": 0,
- "scraServiceId": 0,
- "ofacServiceId": 0,
- "rndServiceId": 0,
- "appDomains": [
- {
- "id": "string",
- "companyId": "string",
- "domain": "string",
- "type": "borrower"
}
], - "timezone": "string",
- "tokenizationKeyId": 0,
- "status": "active",
- "config": {
- "borrowerVerification": {
- "crmDefaultTypeId": "VT-1234-ABDE"
}, - "documents": {
- "signing_key": "string",
- "signing_key_password_token": "string",
- "signer_contact": "string",
- "signer_location": "string"
}, - "compliance": {
- "no_review_task_for_autocreated_cases": true,
- "no_review_task_for_autoupdated_cases": true,
- "rndCompanyId": "string"
}, - "evidence": {
- "captureScreenshot": true
}, - "communication": {
- "email_from": "jondoe@example.com",
- "email_inbound": {
- "monitored_emails": [
- "jondoe@example.com"
], - "reject_others": false
}, - "text_from_number": "+18085551234",
- "address_from": {
- "object": "address",
- "addressLine1": "string",
- "addressLine2": "string",
- "city": "string",
- "countyOrRegion": "string",
- "state": "string",
- "postalCode": "string",
- "country": "string",
- "POBox": "string",
- "timezone": "string"
}, - "enableInboundVoiceCall": true,
- "enableInboundWebChat": true,
- "enable_two_way_texting": true
}, - "support": {
- "phone": "string",
- "email": "string",
- "departmentName": "string",
- "mailingAddress": {
- "object": "address",
- "addressLine1": "string",
- "addressLine2": "string",
- "city": "string",
- "countyOrRegion": "string",
- "state": "string",
- "postalCode": "string",
- "country": "string",
- "POBox": "string",
- "timezone": "string"
}, - "outboundCallRecordingConsentScript": "string",
- "privacyPolicyUrl": "string",
- "phoneSupportPleaseHoldMessage": "string",
- "enableVoicemailWhenClosed": true,
- "phoneSupportClosedMessage": "string",
- "phoneSupportDisabledMessage": "string",
- "phoneSupportClosedLeaveVoicemailMessage": "string",
- "enableVoicemailWhenNoAgents": true,
- "phoneSupportNoAgentsLeaveVoicemailMessage": "string",
- "recordAllInboundVoiceCalls": true,
- "recordAllOutboundVoiceCalls": true,
- "textSupportRejectUnknownNumberMessage": "string",
- "textSupportPleaseWaitMessage": "string",
- "textSupportClosedPleaseWaitMessage": "string",
- "textSupportFindNewAgentPleaseWaitMessage": "string",
- "textSupportDisabledMessage": "string"
}, - "payment": {
- "disablePaymentProcessing": false,
- "scheduleAutopayTransactions": false,
- "processedByPeach": true,
- "allowedCreditCardTx": {
- "payment": false,
- "downPayment": true
}, - "bypassCollisionCheck": true,
- "transactionLimitAmount": 100000,
- "maxNumberNewPaymentMethodsIn30Days": 0,
- "externalTransactions": [
- {
- "transactionType": "ach",
- "statusTransition": "auto",
- "transitionLogic": {
- "type": "numDays",
- "dayType": "calendar",
- "numDays": 0
}
}
]
}, - "paymentTypes": {
- "ach": false,
- "check": false,
- "creditCard": false,
- "debitCard": false,
- "payroll": false,
- "paymentNetwork": false,
- "moneyOrder": false,
- "wire": false,
- "achVerification": {
- "microdeposit": true,
- "plaid": true
}, - "balanceCheck": {
- "plaid": true
}
}, - "timezone": "string",
- "openHours": {
- "businessHours": {
- "normal": "Mon 24hrs; Tue-Fri 9:00-18:00; Sat-Sun Closed",
- "holidays": [
- {
- "date": "2024-04-01",
- "name": "April Fools Day",
- "hours": "09:00-15:00"
}
]
}
}, - "brandAssets": {
- "logos": {
- "primary": "string",
- "small": "string"
}, - "colors": {
- "primary": "string",
- "secondary": "string",
- "tertiary": "string",
- "lighten": "string",
- "button": "string",
- "link": "string",
- "secondButton": "string",
- "secondButtonBackground": "string"
}, - "copies": {
- "consent": "string",
- "disclosures": "string"
}
}, - "requireBorrowerIdentity": true,
- "addressValidation": "smartyStreets",
- "allowPartialAddress": false,
- "forceCaseIdOnAgentActions": true,
- "collections": {
- "intensityLimits": {
- "property1": {
- "heavy": 0,
- "normal": 0,
- "light": 0
}, - "property2": {
- "heavy": 0,
- "normal": 0,
- "light": 0
}
}, - "autoInitiate": {
- "enabled": false,
- "collectionCaseTypeId": "string",
- "inspectionProcName": "string",
- "totalOverdueAmountThreshold": 0,
- "nPastCollectionsThreshold": 0,
- "nOverdueNoticesRequired": 0,
- "loanDaysOverdueThreshold": {
- "weekly": 0,
- "everyTwoWeeks": 0,
- "twiceMonthly": 0,
- "monthly": 0
}, - "interactionDaysPassedThreshold": {
- "weekly": 0,
- "everyTwoWeeks": 0,
- "twiceMonthly": 0,
- "monthly": 0
}, - "enableReviewTask": true
}, - "autoClose": {
- "enabled": false,
- "closeOnlyWhenPaidOff": false
}
}, - "search": {
- "indexing": {
- "enabled": true
}
}, - "auth": {
}, - "creditCounselingServicesNumber": "string",
- "links": {
- "helpUrl": "string",
- "termsOfUseUrl": "string",
- "privacyPolicyUrl": "string"
}, - "ui": {
- "directPaymentToDraw": "shown",
- "mobileFooter": "hidden",
- "mobileHeader": "hidden",
- "mobileDisclosures": "hidden",
- "manageAutopayPage": {
- "minimumPaymentDue": "hidden",
- "statementBalance": "hidden"
}, - "makePaymentPage": {
- "remainingBalance": "hidden"
}, - "loginPage": {
- "fallbackAuthLink": "hidden"
}, - "managePaymentMethodsPage": {
- "borrower": {
- "check": "hidden",
- "creditCard": "hidden",
- "debitCard": "hidden",
- "payroll": "hidden",
- "paymentNetwork": "hidden",
- "wire": "hidden",
- "moneyOrder": "hidden",
- "deleteButton": "hidden"
}, - "agent": {
- "check": "hidden",
- "creditCard": "hidden",
- "debitCard": "hidden",
- "payroll": "hidden",
- "paymentNetwork": "hidden",
- "wire": "hidden",
- "moneyOrder": "hidden",
- "deleteButton": "hidden"
}
}, - "help": "hidden",
- "signOut": "hidden",
- "accountSettings": "hidden",
- "contactUs": "hidden",
- "loanOptions": {
- "managePaymentMethods": "hidden",
- "makePayment": "hidden",
- "changeDueDate": "hidden",
- "getPayoffStatement": "hidden",
- "changeNickname": "hidden",
- "manageAutopay": "hidden",
- "drawFunds": "hidden"
}, - "accountSettingsPage": {
- "profile": "hidden",
- "contactInformation": "hidden",
- "commPreferences": "hidden",
- "additionalContacts": "hidden",
- "paymentMethods": "hidden"
}, - "accountSummaryPage": {
- "summary": "hidden",
- "loanTerms": "hidden",
- "balancesDetails": "hidden",
- "promotions": "hidden",
- "merchantDetails": "hidden",
- "cardDetails": "hidden"
}, - "caseTypeOrdering": [
- {
- "category": "string",
- "caseTypes": [
- "string"
]
}
], - "agentDashboardTools": {
- "enabled": false,
- "dashboardToolDetails": [
- {
- "name": "string",
- "url": "string"
}
]
}, - "websiteTitle": "string",
- "projectSlug": "string",
- "analyticsScript": "string",
- "headScripts": "string"
}, - "statements": {
- "isMailStatementAllowed": true,
- "defaultStatementChannel": "email"
}, - "zendesk": {
- "sso": {
- "enabled": true,
- "subdomain": "string",
- "sharedSecretToken": "string"
}
}, - "tasks": {
- "disableTaskTypes": [
- "answerInboundVoiceCall"
], - "disableTaskRouter": true,
- "channelCapacities": {
- "default": 0,
- "voice": 0,
- "chat": 0,
- "email": 0,
- "text": 0
}, - "enableCaseOwnership": true
}, - "monitoring": {
- "criteria": "borrowerStatus",
- "scraCaseCreationCriteria": "borrowerOnly"
}
}
}, - "person": {
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "deletedAt": "2019-08-24T14:15:22Z",
- "borrowerType": "person",
- "externalId": "string",
- "status": "active",
- "statusUpdatedAt": "2019-08-24T14:15:22Z",
- "collectionsIntensity": "light",
- "displayId": "string",
- "metaData": { },
- "commPreferences": {
- "statementDeliveryChannels": [
- "email"
], - "sendRemindersWhenCurrent": true
}, - "monitorStartDate": "2019-08-24",
- "companyId": "string",
- "user": {
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "deletedAt": "2019-08-24T14:15:22Z",
- "companyId": "string",
- "externalId": "string",
- "status": "active",
- "type": "borrower",
- "roleIds": [
- "string"
], - "object": "user",
- "userId": 0,
- "userName": "string",
- "auths": [
- {
- "authType": "basic",
- "authValueType": "email",
- "value": "string"
}
]
}, - "object": "person",
- "name": {
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "deletedAt": "2019-08-24T14:15:22Z",
- "object": "name",
- "prefix": "string",
- "firstName": "string",
- "middleName": "string",
- "lastName": "string",
- "maidenLastName": "string",
- "suffix": "strin",
- "preferredFirstName": "string",
- "current": true,
- "status": "active",
- "effectiveAt": "2019-08-24T14:15:22Z",
- "originalValue": { },
- "source": "peach"
}, - "dateOfBirth": "2019-08-24",
- "identities": [
- {
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "deletedAt": "2019-08-24T14:15:22Z",
- "object": "identity",
- "identityType": "SSN",
- "customIdentityTypeName": "string",
- "value": "string",
- "valid": true,
- "issueDate": "2019-08-24",
- "expirationDate": "2019-08-24",
- "issuingCountry": "",
- "isArchived": true,
- "isPrimary": false
}
], - "address": {
- "object": "address",
- "addressLine1": "string",
- "addressLine2": "string",
- "city": "string",
- "countyOrRegion": "string",
- "state": "string",
- "postalCode": "string",
- "country": "string",
- "POBox": "string",
- "timezone": "string"
}
}, - "loan": {
- "id": "string",
- "loanTypeId": "string",
- "externalId": "string",
- "displayId": "string",
- "assetDisplayName": "string",
- "cancellationReason": "technicalIssue",
- "declineReason": {
- "mainExternalReasonCode": "string",
- "mainText": "string",
- "mainScriptForRep": "string",
- "subReasons": [
- {
- "externalReasonCode": "string",
- "reasonText": "string",
- "scriptForRep": "string"
}
]
}, - "timestamps": {
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "deletedAt": "2019-08-24T14:15:22Z",
- "startedAt": "2019-08-24T14:15:22Z",
- "originatedAt": "2019-08-24T14:15:22Z",
- "activatedAt": "2019-08-24T14:15:22Z",
- "frozenAt": "2019-08-24T14:15:22Z",
- "lastAmortizedAt": "2019-08-24T14:15:22Z",
- "acceleratedAt": "2019-08-24T14:15:22Z",
- "chargedOffAt": "2019-08-24T14:15:22Z",
- "paidOffAt": "2019-08-24T14:15:22Z",
- "closedAt": "2019-08-24T14:15:22Z",
- "migratedAt": "2019-08-24T14:15:22Z",
- "canceledAt": "2019-08-24T14:15:22Z"
}, - "endDate": "2019-08-24",
- "metaData": { },
- "additionalBorrowers": [
- {
- "id": "string",
- "relationType": "coBorrower",
- "externalId": "string",
- "name": "string"
}
], - "labels": [
- {
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "deletedAt": "2019-08-24T14:15:22Z",
- "externalId": "string",
- "companyId": "string",
- "name": "string",
- "description": "string"
}
], - "companyId": "string",
- "assetType": "personalClosedEndUnsecured",
- "mainBorrowerId": "string",
- "chargedOffReason": "term",
- "object": "installment",
- "type": "installment",
- "nickname": "string",
- "servicedBy": "creditor",
- "status": "pending",
- "isClosed": true,
- "muteLoanNotices": true,
- "aprEffectiveAtActivation": 0,
- "aprNominalAtActivation": 0,
- "ratesValidation": {
- "interestRateAtOrigExceedsMax": true,
- "interestRateAtOrigBelowMin": true,
- "aprEffectiveAtOrigExceedsMax": true,
- "aprNominalAtOrigExceedsMax": true,
- "aprEffectiveAtActExceedsMax": true,
- "aprNominalAtActExceedsMax": true
}, - "amountsValidation": {
- "principalMatch": true,
- "interestMatch": true,
- "feesMatch": true,
- "totalAdvancesMatch": true,
- "recurringAmountsMatch": true,
- "amountFinancedMatch": null
}, - "current": {
- "duration": 0,
- "periodicPayment": 0,
- "autopayEnabled": true,
- "paymentFrequency": "weekly",
- "specificDays": [
- "string"
]
}, - "atOrigination": {
- "amountFinanced": 0,
- "principalAmount": 0,
- "duration": 0,
- "enforcedEndDate": "2019-08-24",
- "bufferToPushOutSchedule": 0,
- "originationLicense": "nationalBank",
- "originatingCreditorName": "string",
- "interestRates": [
- {
- "interestType": "absolute",
- "days": 0,
- "rate": 0
}
], - "promoRates": [
- {
- "days": 0,
- "rate": 0
}
], - "aprNominal": 0,
- "aprEffective": 0,
- "amortizationMethod": "equalPayments",
- "expectedPayments": [
- {
- "date": "2019-08-24",
- "paymentType": "periodicPayment",
- "amount": 0,
- "principalAmount": 0,
- "interestAmount": 0,
- "interestBeforeDiscountAmount": 0,
- "unroundedPrincipalAmount": "string",
- "unroundedInterestAmount": "string",
- "unroundedInterestBeforeDiscountAmount": "string",
- "isForcedAmount": false,
- "dynamicFeeDetails": {
- "dynamicFeeTypeId": "string",
- "chargeDate": "2019-08-24",
- "chargeTimeOfDay": {
- "hour": 23,
- "minute": 59,
- "second": 0
}
}
}
], - "advanceSchedule": [
- {
- "id": "string",
- "externalId": "string",
- "status": "scheduled",
- "amount": 0,
- "originalAmount": 0,
- "advanceDate": "2019-08-24",
- "advanceTimeOfDay": {
- "hour": 23,
- "minute": 59,
- "second": 0
}, - "advanceDetails": {
- "description": "Advance",
- "pointOfSaleType": "online",
- "categoryId": "string",
- "merchantId": "string",
- "merchantName": "string",
- "metadata": { }
}, - "canceledBy": "string",
- "metadata": { },
- "timestamps": {
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "canceledAt": "2019-08-24T14:15:22Z"
}
}
], - "periodicPaymentAmount": 0,
- "paymentFrequency": "weekly",
- "specificDays": [
- "string"
], - "fees": {
- "originationFeeAmount": 0,
- "dynamicFees": [
- {
- "apiName": "string",
- "feeAmount": 0,
- "feeCapAmount": 0
}
], - "serviceFeeAmount": 0,
- "serviceFeeCapAmount": 0,
- "totalOtherFeesAmount": 0
}, - "personAddress": {
- "object": "address",
- "addressLine1": "string",
- "addressLine2": "string",
- "city": "string",
- "countyOrRegion": "string",
- "state": "string",
- "postalCode": "string",
- "country": "string",
- "POBox": "string",
- "timezone": "string"
}, - "downPaymentAmount": 0,
- "totalInterestAmount": 0,
- "totalDiscountAmount": 0,
- "totalInterestCapAmount": 0,
- "discountProgramIds": [
- 0
], - "validAddress": false,
- "investors": [
- {
- "investorId": "string",
- "share": 0,
- "effectiveDate": "2019-08-24"
}
], - "itemsOrServicesFinanced": "string",
- "mdr": {
- "mdrRate": 0,
- "mdrAmount": 0,
- "isAmortized": true,
- "amortizationPeriod": 0
}, - "merchantId": "string",
- "isValidMerchantId": true,
- "skipCreditReporting": false,
- "promoPrograms": [
- {
- "promoTypeId": "string",
- "externalId": "string",
- "status": "pending",
- "promoStartDate": "2019-08-24",
- "promoEndDate": "2019-08-24",
- "promoDurationDays": 0,
- "promoGracePeriodDays": 0,
- "disqualifyOverdueDays": 0,
- "metaData": { },
- "id": "string"
}
]
}, - "atActivation": {
- "expectedPayments": [
- {
- "date": "2019-08-24",
- "paymentType": "periodicPayment",
- "amount": 0,
- "principalAmount": 0,
- "interestAmount": 0,
- "interestBeforeDiscountAmount": 0,
- "unroundedPrincipalAmount": "string",
- "unroundedInterestAmount": "string",
- "unroundedInterestBeforeDiscountAmount": "string",
- "isForcedAmount": false,
- "dynamicFeeDetails": {
- "dynamicFeeTypeId": "string",
- "chargeDate": "2019-08-24",
- "chargeTimeOfDay": {
- "hour": 23,
- "minute": 59,
- "second": 0
}
}
}
]
}, - "migration": {
- "migrationStatus": "nonMigrated"
}, - "loanType": {
- "assetType": "personalClosedEndUnsecured",
- "externalId": "string",
- "name": "string",
- "assetDisplayName": "string",
- "txDescriptorAssetDisplayName": "Loan",
- "description": "string",
- "status": "inactive",
- "currency": "USD",
- "timezone": "string",
- "paymentAllowedWhenChargedOff": false,
- "paydayNotices": {
- "sendFirstPaymentWithdrawalNotice": false,
- "sendConsumerRightsNotice": false
}, - "futurePay": {
- "achDebitTiming": "initiateOnDueDate",
- "achDebitTimingShiftOnNonBusinessDay": "forward",
- "overpaymentAmountLimitFactor": 1.5,
- "balanceCheck": {
- "enabled": true,
- "checkOffsetDays": 0,
- "thresholds": [
- {
- "zone": "balanceRed",
- "value": 0
}
], - "debitLogic": [
- {
- "condition": "balanceNA",
- "action": "cancel"
}
], - "rescheduleBufferInDays": 0,
- "rescheduleBufferDayType": "business"
}
}, - "paymentHoldDays": {
- "holdDayType": "calendar",
- "numHoldDays": 0
}, - "openToBuyCalculation": {
- "calculationType": "transactionStatus"
}, - "fees": {
- "originationFeeChargeLogic": "onTopPeriodicPayment",
- "originationFeeAPRCalcOverride": "noOverride",
- "originationFeeDisplayName": "Origination Fee"
}, - "refunds": {
- "isRefundAllowed": true
}, - "paymentWaterfall": {
- "single": [
- {
- "transactionType": "payment",
- "loanStatus": "active",
- "balancesOrder": [
- "overdueFee"
]
}
], - "multi": [
- {
- "transactionType": "payment",
- "loansOrder": [
- "highestInterestRate"
]
}
], - "multiPrioritizeNonDueEqually": false,
- "multiPrioritizeOverdue": false
}, - "managedByPeach": true,
- "automatedDebtValidationNotification": [
- [
- "IL",
- "US",
- "debtValidationNoticeAutomatic",
- "loanActivation"
]
], - "creditReporting": {
- "isCreditReportingAllowed": true,
- "metro2": {
- "innovisProgramIdentifier": "string",
- "equifaxProgramIdentifier": "string",
- "experianProgramIdentifier": "strin",
- "transunionProgramIdentifier": "string",
- "reporterName": "string",
- "reporterAddress": "string",
- "reporterTelephoneNumber": "string",
- "softwareVendorName": "Peach Finance Inc.",
- "softwareVersionNumber": "1.1",
- "microBiltPrbcProgramIdentifier": "string",
- "innovisIdentificationNumber": "string",
- "equifaxIdentificationNumber": "string",
- "experianIdentificationNumber": "string",
- "transunionIdentificationNumber": "string",
- "portfolioType": "C",
- "accountType": "st",
- "interestTypeIndicator": "s",
- "creditorClassification": "01",
- "skipSegments": [
- "header"
]
}
}, - "useExternalIdInUI": true,
- "snapshots": {
- "reportDaysWhenPaidOff": 10
}, - "extraFields": { }
}, - "balances": {
- "isLocked": true,
- "outstandingBalances": {
- "outstandingTotalAmount": 0,
- "outstandingPrincipalAmount": 0,
- "outstandingInterestAmount": 0,
- "outstandingFeesAmount": 0,
- "outstandingOriginationFeesAmount": 0,
- "outstandingDrawFeesAmount": 0,
- "outstandingLateFeesAmount": 0,
- "outstandingModificationFeesAmount": 0
}, - "outstandingBalancesWithPromo": {
- "outstandingTotalAmount": 0
}, - "nonDueBalances": {
- "nonDueTotalAmount": 0,
- "nonDuePrincipalAmount": 0,
- "nonDueInterestAmount": 0,
- "nonDueFeesAmount": 0,
- "nonDueOriginationFeesAmount": 0,
- "nonDueDrawFeesAmount": 0,
- "nonDueLateFeesAmount": 0,
- "nonDueModificationFeesAmount": 0
}, - "dueBalances": {
- "dueTotalAmount": 0,
- "duePrincipalAmount": 0,
- "dueInterestAmount": 0,
- "dueFeesAmount": 0,
- "dueOriginationFeesAmount": 0,
- "dueDrawFeesAmount": 0,
- "dueLateFeesAmount": 0,
- "dueModificationFeesAmount": 0
}, - "overdueBalances": {
- "overdueTotalAmount": 0,
- "overduePrincipalAmount": 0,
- "overdueInterestAmount": 0,
- "overdueFeesAmount": 0,
- "overdueOriginationFeesAmount": 0,
- "overdueDrawFeesAmount": 0,
- "overdueLateFeesAmount": 0,
- "overdueModificationFeesAmount": 0
}, - "nonAccrualBalances": {
- "nonAccrualTotalAmount": 0,
- "nonAccrualPrincipalAmount": 0,
- "nonAccrualInterestAmount": 0,
- "nonAccrualFeesAmount": 0
}, - "chargedOffBalances": {
- "chargedOffTotalAmount": 0,
- "chargedOffPrincipalAmount": 0,
- "chargedOffInterestAmount": 0,
- "chargedOffFeesAmount": 0
}, - "paidBalances": {
- "paidTotalAmount": 0,
- "paidPaymentsAmount": 0,
- "paidCreditsAmount": 0,
- "paidReimbursementsAmount": 0,
- "paidPrincipalAmount": 0,
- "paidInterestAmount": 0,
- "paidFeesAmount": 0,
- "paidOverAmount": 0
}, - "interestAndFeesAmounts": {
- "interestAccruedTotalAmount": 0,
- "interestDiscountTotalAmount": 0,
- "forgoneInterestCapAmount": 0,
- "forgoneInterestRoundingAmount": 0,
- "interestAccruedYearToDateAmount": 0,
- "interestAccruedYearToDateForStatementAmount": 0,
- "feesChargedYearToDateAmount": 0,
- "deferredInterestAccruedTotalAmount": 0,
- "forgoneInterestDeferredAmount": 0
}, - "overdueNumberDays": 0,
- "reimbursementAmount": 0,
- "creditLimitAmount": 0,
- "availableCreditAmount": 0,
- "openToBuyAmount": 0,
- "utilizationAmount": 0,
- "overLimitAmount": 0,
- "loanStatus": "pending",
- "calculatedAt": "2019-08-24T14:15:22Z"
}, - "futureBalances": {
- "isLocked": true,
- "expectedTotalAmount": 0,
- "projectedPayoffDate": "2019-08-24",
- "projectedTotalDueBalanceTenDays": 0
}, - "transactions": [
- {
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "deletedAt": "2019-08-24T14:15:22Z",
- "externalId": "string",
- "status": "scheduled",
- "timestamps": {
- "effectiveDate": "2019-08-24",
- "originalEffectiveDate": "2019-08-24",
- "originalDisplayDate": "2019-08-24",
- "scheduledDate": "2019-08-24",
- "displayDate": "2019-08-24",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "deletedAt": "2019-08-24T14:15:22Z",
- "initiatedAt": "2019-08-24T14:15:22Z",
- "pendingAt": "2019-08-24T14:15:22Z",
- "succeededAt": "2019-08-24T14:15:22Z",
- "failedAt": "2019-08-24T14:15:22Z",
- "canceledAt": "2019-08-24T14:15:22Z",
- "inDisputeAt": "2019-08-24T14:15:22Z",
- "chargebackAt": "2019-08-24T14:15:22Z",
- "appliedAt": "2019-08-24T14:15:22Z"
}, - "transactionType": "payment",
- "paymentDetails": {
- "type": "ach",
- "reason": "autoPay",
- "fromInstrumentId": "string",
- "fromInstrument": {
- "instrumentType": "bankAccount",
- "accountNumberLastFour": "string"
}, - "toInstrumentId": "string",
- "toInstrument": {
- "instrumentType": "bankAccount",
- "accountNumberLastFour": "string"
}
}, - "actualAmount": 0,
- "scheduledAmount": 0,
- "currency": "string",
- "processingFeeAmount": 0,
- "processingFeeType": "net",
- "processorTransactionId": "string",
- "processorReversalId": "string",
- "processorReconciliationId": "string",
- "avsResult": "s",
- "failureReason": "insufficientFunds",
- "failureDescriptionShort": "string",
- "failureDescriptionLong": "string",
- "processorFailureReason": "string",
- "processorFailureDetails": null,
- "achReturnCode": "strin",
- "reversedByTransactionId": "string",
- "reversedByTransactionExternalId": "string",
- "reversedByTransactionIds": [
- {
- "id": "string",
- "externalId": "string"
}
], - "reversesTransactionId": "string",
- "reversesTransactionExternalId": "string",
- "reversedAmount": 0,
- "parentTransactionId": "string",
- "createdBy": {
- "id": "string",
- "name": "string",
- "userType": "agent",
- "descriptor": "Agent bob@acme.com",
- "employee": {
- "id": "string"
}
}, - "cancelReason": "invalidPaymentMethod",
- "holdDaysEndDate": "2019-08-24",
- "metaData": { },
- "customDisplayName": "string",
- "retryAttempt": 0,
- "processorMerchantId": "string",
- "achConfirmed": true,
- "achSameDay": true,
- "achProcessedSameDay": true,
- "cancelShortDescription": "string",
- "cancelLongDescription": "string",
- "retryOriginalTransactionId": "string",
- "isExternal": null,
- "isVirtual": null,
- "paidPrincipalAmount": null,
- "paidInterestAmount": null,
- "paidFeesAmount": null,
- "paidOverAmount": null,
- "serviceCreditDetails": {
- "type": "serviceAgent",
- "sponsor": "loanOwner",
- "reason": "oneTimePayment"
}, - "chargebackDetails": [
- {
- "id": "string",
- "externalId": "string",
- "caseId": "string",
- "status": "open",
- "amount": 0,
- "description": "string",
- "externalCaseNumber": "string",
- "reasonCode": "string",
- "category": "string"
}
], - "effectiveAmount": 0,
- "chargebackAmount": 0,
- "unroundedPaidPrincipalAmount": 0,
- "unroundedPaidInterestAmount": 0,
- "unroundedPaidFeesAmount": 0,
- "unroundedPaidOverAmount": 0,
- "initiatingBorrowerId": "string",
- "autopayPlanId": "string",
- "autopayPaymentIds": [
- 0
], - "enablePrepayments": true,
- "loanId": "string",
- "drawId": "string",
- "mainBorrowerId": "string"
}
], - "creditReporting": {
- "isReporting": true,
- "creditAgencies": [
- {
- "agencyName": "string",
- "reportingStartDate": "2019-08-24"
}
]
}, - "investors": [
- { }
], - "people": [
- {
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "deletedAt": "2019-08-24T14:15:22Z",
- "borrowerType": "person",
- "externalId": "string",
- "status": "active",
- "statusUpdatedAt": "2019-08-24T14:15:22Z",
- "collectionsIntensity": "light",
- "displayId": "string",
- "metaData": { },
- "commPreferences": {
- "statementDeliveryChannels": [
- "email"
], - "sendRemindersWhenCurrent": true
}, - "monitorStartDate": "2019-08-24",
- "companyId": "string",
- "user": {
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "deletedAt": "2019-08-24T14:15:22Z",
- "companyId": "string",
- "externalId": "string",
- "status": "active",
- "type": "borrower",
- "roleIds": [
- "string"
], - "object": "user",
- "userId": 0,
- "userName": "string",
- "auths": [
- {
- "authType": "basic",
- "authValueType": "email",
- "value": "string"
}
]
}, - "object": "person",
- "name": {
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "deletedAt": "2019-08-24T14:15:22Z",
- "object": "name",
- "prefix": "string",
- "firstName": "string",
- "middleName": "string",
- "lastName": "string",
- "maidenLastName": "string",
- "suffix": "strin",
- "preferredFirstName": "string",
- "current": true,
- "status": "active",
- "effectiveAt": "2019-08-24T14:15:22Z",
- "originalValue": { },
- "source": "peach"
}, - "dateOfBirth": "2019-08-24",
- "identities": [
- {
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "deletedAt": "2019-08-24T14:15:22Z",
- "object": "identity",
- "identityType": "SSN",
- "customIdentityTypeName": "string",
- "value": "string",
- "valid": true,
- "issueDate": "2019-08-24",
- "expirationDate": "2019-08-24",
- "issuingCountry": "",
- "isArchived": true,
- "isPrimary": false
}
]
}
], - "overdueSummary": {
- "daysOverdue": 0,
- "overdueAmount": 0,
- "isOverdue": true
}, - "daysOverdue": 0,
- "overdueAmount": 0,
- "daysToChargeOff": 0,
- "autopayData": { }
}, - "paymentMethod": "bankAccount"
}
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 |
paymentMethodLastFour | string (ContextVarPaymentMethodLastFour) The last four digits of the payment method |
{- "company": {
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "deletedAt": "2019-08-24T14:15:22Z",
- "object": "company",
- "legalName": "string",
- "slug": "string",
- "domainName": "string",
- "shortDomainName": "string",
- "type": "string",
- "name": "string",
- "brandName": "string",
- "borrowerAuthType": "basic",
- "agentAuthType": "basic",
- "borrowerAuthValueType": "email",
- "agentAuthValueType": "email",
- "femaPolicy": true,
- "bankruptcyPolicy": true,
- "deceasedPolicy": true,
- "bankruptcyServiceId": 0,
- "deceasedServiceId": 0,
- "femaServiceId": 0,
- "scraServiceId": 0,
- "ofacServiceId": 0,
- "rndServiceId": 0,
- "appDomains": [
- {
- "id": "string",
- "companyId": "string",
- "domain": "string",
- "type": "borrower"
}
], - "timezone": "string",
- "tokenizationKeyId": 0,
- "status": "active",
- "config": {
- "borrowerVerification": {
- "crmDefaultTypeId": "VT-1234-ABDE"
}, - "documents": {
- "signing_key": "string",
- "signing_key_password_token": "string",
- "signer_contact": "string",
- "signer_location": "string"
}, - "compliance": {
- "no_review_task_for_autocreated_cases": true,
- "no_review_task_for_autoupdated_cases": true,
- "rndCompanyId": "string"
}, - "evidence": {
- "captureScreenshot": true
}, - "communication": {
- "email_from": "jondoe@example.com",
- "email_inbound": {
- "monitored_emails": [
- "jondoe@example.com"
], - "reject_others": false
}, - "text_from_number": "+18085551234",
- "address_from": {
- "object": "address",
- "addressLine1": "string",
- "addressLine2": "string",
- "city": "string",
- "countyOrRegion": "string",
- "state": "string",
- "postalCode": "string",
- "country": "string",
- "POBox": "string",
- "timezone": "string"
}, - "enableInboundVoiceCall": true,
- "enableInboundWebChat": true,
- "enable_two_way_texting": true
}, - "support": {
- "phone": "string",
- "email": "string",
- "departmentName": "string",
- "mailingAddress": {
- "object": "address",
- "addressLine1": "string",
- "addressLine2": "string",
- "city": "string",
- "countyOrRegion": "string",
- "state": "string",
- "postalCode": "string",
- "country": "string",
- "POBox": "string",
- "timezone": "string"
}, - "outboundCallRecordingConsentScript": "string",
- "privacyPolicyUrl": "string",
- "phoneSupportPleaseHoldMessage": "string",
- "enableVoicemailWhenClosed": true,
- "phoneSupportClosedMessage": "string",
- "phoneSupportDisabledMessage": "string",
- "phoneSupportClosedLeaveVoicemailMessage": "string",
- "enableVoicemailWhenNoAgents": true,
- "phoneSupportNoAgentsLeaveVoicemailMessage": "string",
- "recordAllInboundVoiceCalls": true,
- "recordAllOutboundVoiceCalls": true,
- "textSupportRejectUnknownNumberMessage": "string",
- "textSupportPleaseWaitMessage": "string",
- "textSupportClosedPleaseWaitMessage": "string",
- "textSupportFindNewAgentPleaseWaitMessage": "string",
- "textSupportDisabledMessage": "string"
}, - "payment": {
- "disablePaymentProcessing": false,
- "scheduleAutopayTransactions": false,
- "processedByPeach": true,
- "allowedCreditCardTx": {
- "payment": false,
- "downPayment": true
}, - "bypassCollisionCheck": true,
- "transactionLimitAmount": 100000,
- "maxNumberNewPaymentMethodsIn30Days": 0,
- "externalTransactions": [
- {
- "transactionType": "ach",
- "statusTransition": "auto",
- "transitionLogic": {
- "type": "numDays",
- "dayType": "calendar",
- "numDays": 0
}
}
]
}, - "paymentTypes": {
- "ach": false,
- "check": false,
- "creditCard": false,
- "debitCard": false,
- "payroll": false,
- "paymentNetwork": false,
- "moneyOrder": false,
- "wire": false,
- "achVerification": {
- "microdeposit": true,
- "plaid": true
}, - "balanceCheck": {
- "plaid": true
}
}, - "timezone": "string",
- "openHours": {
- "businessHours": {
- "normal": "Mon 24hrs; Tue-Fri 9:00-18:00; Sat-Sun Closed",
- "holidays": [
- {
- "date": "2024-04-01",
- "name": "April Fools Day",
- "hours": "09:00-15:00"
}
]
}
}, - "brandAssets": {
- "logos": {
- "primary": "string",
- "small": "string"
}, - "colors": {
- "primary": "string",
- "secondary": "string",
- "tertiary": "string",
- "lighten": "string",
- "button": "string",
- "link": "string",
- "secondButton": "string",
- "secondButtonBackground": "string"
}, - "copies": {
- "consent": "string",
- "disclosures": "string"
}
}, - "requireBorrowerIdentity": true,
- "addressValidation": "smartyStreets",
- "allowPartialAddress": false,
- "forceCaseIdOnAgentActions": true,
- "collections": {
- "intensityLimits": {
- "property1": {
- "heavy": 0,
- "normal": 0,
- "light": 0
}, - "property2": {
- "heavy": 0,
- "normal": 0,
- "light": 0
}
}, - "autoInitiate": {
- "enabled": false,
- "collectionCaseTypeId": "string",
- "inspectionProcName": "string",
- "totalOverdueAmountThreshold": 0,
- "nPastCollectionsThreshold": 0,
- "nOverdueNoticesRequired": 0,
- "loanDaysOverdueThreshold": {
- "weekly": 0,
- "everyTwoWeeks": 0,
- "twiceMonthly": 0,
- "monthly": 0
}, - "interactionDaysPassedThreshold": {
- "weekly": 0,
- "everyTwoWeeks": 0,
- "twiceMonthly": 0,
- "monthly": 0
}, - "enableReviewTask": true
}, - "autoClose": {
- "enabled": false,
- "closeOnlyWhenPaidOff": false
}
}, - "search": {
- "indexing": {
- "enabled": true
}
}, - "auth": {
}, - "creditCounselingServicesNumber": "string",
- "links": {
- "helpUrl": "string",
- "termsOfUseUrl": "string",
- "privacyPolicyUrl": "string"
}, - "ui": {
- "directPaymentToDraw": "shown",
- "mobileFooter": "hidden",
- "mobileHeader": "hidden",
- "mobileDisclosures": "hidden",
- "manageAutopayPage": {
- "minimumPaymentDue": "hidden",
- "statementBalance": "hidden"
}, - "makePaymentPage": {
- "remainingBalance": "hidden"
}, - "loginPage": {
- "fallbackAuthLink": "hidden"
}, - "managePaymentMethodsPage": {
- "borrower": {
- "check": "hidden",
- "creditCard": "hidden",
- "debitCard": "hidden",
- "payroll": "hidden",
- "paymentNetwork": "hidden",
- "wire": "hidden",
- "moneyOrder": "hidden",
- "deleteButton": "hidden"
}, - "agent": {
- "check": "hidden",
- "creditCard": "hidden",
- "debitCard": "hidden",
- "payroll": "hidden",
- "paymentNetwork": "hidden",
- "wire": "hidden",
- "moneyOrder": "hidden",
- "deleteButton": "hidden"
}
}, - "help": "hidden",
- "signOut": "hidden",
- "accountSettings": "hidden",
- "contactUs": "hidden",
- "loanOptions": {
- "managePaymentMethods": "hidden",
- "makePayment": "hidden",
- "changeDueDate": "hidden",
- "getPayoffStatement": "hidden",
- "changeNickname": "hidden",
- "manageAutopay": "hidden",
- "drawFunds": "hidden"
}, - "accountSettingsPage": {
- "profile": "hidden",
- "contactInformation": "hidden",
- "commPreferences": "hidden",
- "additionalContacts": "hidden",
- "paymentMethods": "hidden"
}, - "accountSummaryPage": {
- "summary": "hidden",
- "loanTerms": "hidden",
- "balancesDetails": "hidden",
- "promotions": "hidden",
- "merchantDetails": "hidden",
- "cardDetails": "hidden"
}, - "caseTypeOrdering": [
- {
- "category": "string",
- "caseTypes": [
- "string"
]
}
], - "agentDashboardTools": {
- "enabled": false,
- "dashboardToolDetails": [
- {
- "name": "string",
- "url": "string"
}
]
}, - "websiteTitle": "string",
- "projectSlug": "string",
- "analyticsScript": "string",
- "headScripts": "string"
}, - "statements": {
- "isMailStatementAllowed": true,
- "defaultStatementChannel": "email"
}, - "zendesk": {
- "sso": {
- "enabled": true,
- "subdomain": "string",
- "sharedSecretToken": "string"
}
}, - "tasks": {
- "disableTaskTypes": [
- "answerInboundVoiceCall"
], - "disableTaskRouter": true,
- "channelCapacities": {
- "default": 0,
- "voice": 0,
- "chat": 0,
- "email": 0,
- "text": 0
}, - "enableCaseOwnership": true
}, - "monitoring": {
- "criteria": "borrowerStatus",
- "scraCaseCreationCriteria": "borrowerOnly"
}
}
}, - "person": {
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "deletedAt": "2019-08-24T14:15:22Z",
- "borrowerType": "person",
- "externalId": "string",
- "status": "active",
- "statusUpdatedAt": "2019-08-24T14:15:22Z",
- "collectionsIntensity": "light",
- "displayId": "string",
- "metaData": { },
- "commPreferences": {
- "statementDeliveryChannels": [
- "email"
], - "sendRemindersWhenCurrent": true
}, - "monitorStartDate": "2019-08-24",
- "companyId": "string",
- "user": {
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "deletedAt": "2019-08-24T14:15:22Z",
- "companyId": "string",
- "externalId": "string",
- "status": "active",
- "type": "borrower",
- "roleIds": [
- "string"
], - "object": "user",
- "userId": 0,
- "userName": "string",
- "auths": [
- {
- "authType": "basic",
- "authValueType": "email",
- "value": "string"
}
]
}, - "object": "person",
- "name": {
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "deletedAt": "2019-08-24T14:15:22Z",
- "object": "name",
- "prefix": "string",
- "firstName": "string",
- "middleName": "string",
- "lastName": "string",
- "maidenLastName": "string",
- "suffix": "strin",
- "preferredFirstName": "string",
- "current": true,
- "status": "active",
- "effectiveAt": "2019-08-24T14:15:22Z",
- "originalValue": { },
- "source": "peach"
}, - "dateOfBirth": "2019-08-24",
- "identities": [
- {
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "deletedAt": "2019-08-24T14:15:22Z",
- "object": "identity",
- "identityType": "SSN",
- "customIdentityTypeName": "string",
- "value": "string",
- "valid": true,
- "issueDate": "2019-08-24",
- "expirationDate": "2019-08-24",
- "issuingCountry": "",
- "isArchived": true,
- "isPrimary": false
}
], - "address": {
- "object": "address",
- "addressLine1": "string",
- "addressLine2": "string",
- "city": "string",
- "countyOrRegion": "string",
- "state": "string",
- "postalCode": "string",
- "country": "string",
- "POBox": "string",
- "timezone": "string"
}
}, - "institutionName": "string",
- "drawAmount": 0,
- "paymentMethod": "bankAccount",
- "paymentMethodLastFour": "string"
}
Request sandbox access