Events

This object represents an event. Events are sent from Peach to you. Events can be related to any object in this API.

Event Name Occurs when Related Object
autopay.schedule.created an autopay schedule is setup Autopay
autopay.schedule.cancel an autopay schedule is canceled Autopay
autopay.schedule.changed an autopay schedule is changed Autopay
autopay.payment.rescheduled an autopay payment is rescheduled Autopay
autopay.payment.canceled an autopay payment is canceled Autopay
case.association.added an association is added to a case Case
case.association.removed an association is removed from a case Case
case.donotinteract.created a DoNotInteract object is created Case
case.donotinteract.deleted a DoNotInteract object is deleted Case
case.donotinteract.updated a DoNotInteract object is updated Case
case.created a case is created Case
case.deleted a case is deleted Case
case.updated a case is updated Case
contact.created a contact is created Contact
contact.deleted a contact is deleted Contact
contact.updated a contact is updated Contact
indexrate.created index rate is created Loan Type
indexrate.updated index rate is updated Loan Type
interaction.blocked interaction is blocked for a borrower Interaction
loan.acceleration.initiated a loan acceleration is initiated Loan
loan.acceleration.processed a loan acceleration is processed Loan
loan.acceleration.reversed a loan acceleration is reversed Loan
loan.activated a loan is activated Loan
loan.chargeoff.initiated a loan charge off is initiated Loan
loan.chargeoff.processed a loan charge off is processed Loan
loan.chargeoff.reversed a loan charge off is reversed Loan
loan.created a loan is created Loan
loan.creditreporting.created a loan is scheduled to start credit reporting Credit Reporting Status
loan.creditreporting.stopped a loan is scheduled to stop credit reporting Credit Reporting Status
loan.canceled a loan is canceled Loan
loan.current a loan is current or became current Loan
loan.draw.created a borrower makes a draw on a line of credit Loan
loan.draw.purchase.dispute.updated a purchase dispute is updated Purchase Dispute
loan.draw.purchase.dispute.created a purchase dispute is created Purchase Dispute
loan.draws.frozen draws are frozen on a line of credit Loan
loan.draws.unfrozen draws on a line of credit are unfrozen Loan
loan.duedate.defer a single loan due date is deferred Loan
loan.frozen a loan is frozen Loan
loan.interest.capitalized interest capitalization is triggered after a due date Loan
loan.latefee.booked a late fee is applied Loan
loan.modificationfee.booked a modification fee is applied Loan
loan.obligation.statuschanged a change in a loan's obligation status is recorded Loan
loan.originated a loan is originated Loan
loan.overdue a loan is overdue Loan
loan.ownerchanged a loan changes owners Loan
loan.paidoff a loan is paid off Loan
loan.paymentplan.setup a loan payment plan is setup Loan
loan.period.started a loan period has started Loan
loan.promoprogram.created a promo program is created Loan
loan.promoprogram.updated a promo program is updated Loan
loan.rate.created rate is created Loan
loan.rate.updated rate is updated Loan
loan.refunded payments on a loan are refunded Loan
loan.reimbursement.initiated a borrower reimbursement is initiated Loan
loan.reimbursement.processed a borrower reimbursement is processed Loan
loan.schedule.defer a loan schedule is deferred Loan
loan.statuschanged a loan changes status Loan
loan.unfrozen a loan is unfrozen Loan
person.consent.updated a borrower updates their consents Borrower
person.created a borrower is created Borrower
person.monitoring.bankruptcy.started bankruptcy and deceased monitoring begins for a borrower Borrower
person.monitoring.scra.started SCRA monitoring begins for a borrower Borrower
payment.instrument.created a payment instrument is created Payment Instrument
payment.instrument.deactivated a payment instrument is deactivated Payment Instrument
payment.applied a payment has been applied to the ledger waterfall Transaction
payment.confirmed a payment is confirmed Transaction
payment.failed a payment fails Transaction
payment.initiated a payment is initiated Transaction
payment.pending a payment is pending Transaction
payment.reversed a payment is reversed Transaction
payment.scheduled a payment is scheduled Transaction
servicecredit.applied a service credit is applied to a loan Transaction
statement.created a statement is created Loan

Retrieve events

Securityoauth2 or bearerAuth or apiKeyHeader
Request
query Parameters
limit
integer [ 1 .. 100 ]
Default: 25

The maximum count of results to retrieve.

startingAfter
string

Return results starting after the provided object identifier.

endingBefore
string

Return results ending before the provided object identifier.

sortBy
Array of strings

The data attributes by which to sort the results.

personId
string^ext-|^[A-Z]{2}-[A-Z0-9]+-[A-Z0-9]+|^\d+$

Filter by a Borrower's unique identifier. Can be Peach or lender's external identifier.

periodId
string

Use this to limit results to a specific periodId.

loanId
string^ext-|^[A-Z]{2}-[A-Z0-9]+-[A-Z0-9]+|^\d+$

Filter by Loan's unique identifier. Can be Peach or lender's external identifier.

caseId
string^ext-|^[A-Z]{2}-[A-Z0-9]+-[A-Z0-9]+|^\d+$

Filter by case's object unique identifier. Can be Peach or lender's external identifier.

reversible
boolean

Filter by whether events are reversible.

transactionId
string^ext-|^[A-Z]{2}-[A-Z0-9]+-[A-Z0-9]+|^\d+$

Filter by transaction's unique identifier. Can be Peach or lender's external identifier.

createdAtFrom
string <date-time>

Get events created at or after the specified time.

createdAtTo
string <date-time>

Get events created at or before the specified time.

effectiveAtFrom
string <date-time>

Get events effective at or after the specified time.

effectiveAtTo
string <date-time>

Get events effective at or before the specified time.

accrualDate
string <date>

Get events by matching accrual date. to be used for AccrueInterestEvent only.

events
string

A comma separated list of event names to return. Event name queries can end with a wildcard * character to specify all events starting with the given string. For example, case.* would give all case-related events.

Responses
200

Success

get/events
Response samples
application/json
{
  • "count": 0,
  • "data": [
    ]
}

Create event

Create a new event.

Securityoauth2 or bearerAuth or apiKeyHeader
Request
query Parameters
firingMode
string
Enum: "full" "database" "queue"
priority
string
Enum: "low" "normal" "high" "manualReplay"
Request Body schema: application/json
Any of:
loanId
string >= 1

Loan's unique identifier.

personId
string >= 1

A Borrower's unique identifier.

periodId
string >= 1

Period's unique identifier.

eventType
required
string
Value: "autopay.payment.rescheduled"
condition
string
Enum: "balanceNA" "balanceBroken" "balanceRed" "balanceYellow" "balanceGreen"
companyId
required
string >= 1

Company's unique identifier.

discriminator
string

String indicating the type of the parent object.

parentId
string >= 1

Unique identifier of the parent object for the event.

effectiveAt
string <date-time>

The date and time at which the event was effective. This may differ from the date of creation.

Responses
200

Success

post/events
Request samples
application/json
{
  • "loanId": "string",
  • "personId": "string",
  • "periodId": "string",
  • "eventType": "autopay.payment.rescheduled",
  • "condition": "balanceNA",
  • "companyId": "string",
  • "discriminator": "string",
  • "parentId": "string",
  • "effectiveAt": "2019-08-24T14:15:22Z"
}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Create many events

Create many new events.

Securityoauth2 or bearerAuth or apiKeyHeader
Request
query Parameters
firingMode
string
Enum: "full" "database" "queue"
priority
string
Enum: "low" "normal" "high" "manualReplay"
Request Body schema: application/json
Array
Any of:
loanId
string >= 1

Loan's unique identifier.

personId
string >= 1

A Borrower's unique identifier.

periodId
string >= 1

Period's unique identifier.

eventType
required
string
Value: "autopay.payment.rescheduled"
condition
string
Enum: "balanceNA" "balanceBroken" "balanceRed" "balanceYellow" "balanceGreen"
companyId
required
string >= 1

Company's unique identifier.

discriminator
string

String indicating the type of the parent object.

parentId
string >= 1

Unique identifier of the parent object for the event.

effectiveAt
string <date-time>

The date and time at which the event was effective. This may differ from the date of creation.

Responses
200

Success

post/events/bulk
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "count": 0,
  • "data": [
    ]
}