Peach Finance

Repayment Engine

Notification settings designed to increase loan repayment.

Get all company notification types

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
companyId
required
string

The unique company identifier.

query Parameters
limit
integer [ 1 .. 100 ]
Default: 25

The maximum count of results to retrieve.

offset
integer >= 0

Offset from the start of results.

sortBy
Array of strings

The data attributes by which to sort the results.

productId
string (AnyId) ^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+...

Peach's unique or lender's external identifier.

trigger
string (RepaymentNotificationTrigger)

A description of the conditions that trigger a communication. NOTE: autopayExpectedPaymentChangedAmount will never occur for LOC, because autopays are finalized after the statement date and not updated again.

Enum: "autopayFirstPayment" "autopayExpectedPayment" "autopayExpectedPaymentChangedAmount" "cardExpiration" "expectedPayment" "futurePayment" "loginFirstPayment" "loanOverdue" "loanRightToCure"
Example: trigger=expectedPayment
subject
string (RepaymentEngineInteractionSubject)

The InteractionSubject for the notification that is sent to the borrower.

Enum: "autopayAmountChanged" "autopayEnableReminder" "autopayPaymentReminder" "cardExpiresReminder" "futurepayPaymentDueReminder" "loanOverdueFirstNotice" "loanOverdueSecondNotice" "loanOverdueThirdNotice" "loanOverdueFourthNotice" "loanOverdueFifthNotice" "loanOverdueSixthNotice" "loanRightToCurePersonalUnsecured" "loginFirstPaymentReminder" "paymentDueDateReminder" "promoProgramReminder" "promoProgramEligibilityAtRisk"
Example: subject=paymentDueDateReminder
status
string
Enum: "active" "inactive"
dayType
string (DayType)

Whether day field refers to weekends and holidays or only business days.

Enum: "business" "calendar"
Responses
200

Success

get/companies/{companyId}/repayment-engine/notifications
Response samples
application/json
{
  • "status": 0,
  • "total": 0,
  • "count": 0,
  • "nextUrl": "string",
  • "previousUrl": "string",
  • "data": [
    ]
}

Get product notification types

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
companyId
required
string

The unique company identifier.

loanTypeId
required
string (AnyId) ^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+...

The loan type identifier.

query Parameters
trigger
string (RepaymentNotificationTrigger)

A description of the conditions that trigger a communication. NOTE: autopayExpectedPaymentChangedAmount will never occur for LOC, because autopays are finalized after the statement date and not updated again.

Enum: "autopayFirstPayment" "autopayExpectedPayment" "autopayExpectedPaymentChangedAmount" "cardExpiration" "expectedPayment" "futurePayment" "loginFirstPayment" "loanOverdue" "loanRightToCure"
Example: trigger=expectedPayment
subject
string (RepaymentEngineInteractionSubject)

The InteractionSubject for the notification that is sent to the borrower.

Enum: "autopayAmountChanged" "autopayEnableReminder" "autopayPaymentReminder" "cardExpiresReminder" "futurepayPaymentDueReminder" "loanOverdueFirstNotice" "loanOverdueSecondNotice" "loanOverdueThirdNotice" "loanOverdueFourthNotice" "loanOverdueFifthNotice" "loanOverdueSixthNotice" "loanRightToCurePersonalUnsecured" "loginFirstPaymentReminder" "paymentDueDateReminder" "promoProgramReminder" "promoProgramEligibilityAtRisk"
Example: subject=paymentDueDateReminder
status
string
Enum: "active" "inactive"
Responses
200

Success

get/companies/{companyId}/loan-types/{loanTypeId}/repayment-engine/notifications
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": [
    ]
}

Create a notification type

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
companyId
required
string

The unique company identifier.

loanTypeId
required
string (AnyId) ^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+...

The loan type identifier.

Request Body schema: application/json
required
subject
string (RepaymentEngineInteractionSubject)

The InteractionSubject for the notification that is sent to the borrower.

Enum: "autopayAmountChanged" "autopayEnableReminder" "autopayPaymentReminder" "cardExpiresReminder" "futurepayPaymentDueReminder" "loanOverdueFirstNotice" "loanOverdueSecondNotice" "loanOverdueThirdNotice" "loanOverdueFourthNotice" "loanOverdueFifthNotice" "loanOverdueSixthNotice" "loanRightToCurePersonalUnsecured" "loginFirstPaymentReminder" "paymentDueDateReminder" "promoProgramReminder" "promoProgramEligibilityAtRisk"
productId
string
loanTypeAssetName
string
promoType
string or null

Only used for notifications with subject promoProgramReminder and promoProgramEligibilityAtRisk

Value: "sameAsCash"
status
string
Enum: "active" "inactive"
(integer or null) or object (DaysOffsetDueDate)
dayType
string (DayType)

Whether day field refers to weekends and holidays or only business days.

Enum: "business" "calendar"
Responses
200

Created

post/companies/{companyId}/loan-types/{loanTypeId}/repayment-engine/notifications
Request samples
application/json
{
  • "subject": "paymentDueDateReminder",
  • "productId": "string",
  • "loanTypeAssetName": "string",
  • "promoType": "sameAsCash",
  • "status": "active",
  • "daysOffsetDueDate": -5,
  • "dayType": "business"
}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Get notification type by ID

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
companyId
required
string

The unique company identifier.

loanTypeId
required
string (AnyId) ^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+...

The loan type identifier.

repaymentNotificationTypeId
required
string (AnyId) ^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+...

The notification type identifier.

Responses
200

Success

get/companies/{companyId}/loan-types/{loanTypeId}/repayment-engine/{repaymentNotificationTypeId}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Update a notification type

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
companyId
required
string

The unique company identifier.

loanTypeId
required
string (AnyId) ^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+...

The loan type identifier.

repaymentNotificationTypeId
required
string (AnyId) ^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+...

The notification type identifier.

Request Body schema: application/json
required
productId
string
loanTypeAssetName
string
promoType
string or null

Only used for notifications with subject promoProgramReminder and promoProgramEligibilityAtRisk

Value: "sameAsCash"
status
string
Enum: "active" "inactive"
(integer or null) or object (DaysOffsetDueDate)
dayType
string (DayType)

Whether day field refers to weekends and holidays or only business days.

Enum: "business" "calendar"
Responses
200

Updated

put/companies/{companyId}/loan-types/{loanTypeId}/repayment-engine/{repaymentNotificationTypeId}
Request samples
application/json
{
  • "productId": "string",
  • "loanTypeAssetName": "string",
  • "promoType": "sameAsCash",
  • "status": "active",
  • "daysOffsetDueDate": -5,
  • "dayType": "business"
}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Delete a notification type

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
companyId
required
string

The unique company identifier.

loanTypeId
required
string (AnyId) ^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+...

The loan type identifier.

repaymentNotificationTypeId
required
string (AnyId) ^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+...

The notification type identifier.

Responses
204

Success

delete/companies/{companyId}/loan-types/{loanTypeId}/repayment-engine/{repaymentNotificationTypeId}
➔ Next to Payment Processors

Request sandbox access