{"templateId":"openapi_docs","versions":[],"sharedDataIds":{"openAPIDocsStore":"oas-API Docs/@2023-11-29/api-public.yaml","sidebar":"sidebar-sidebar.yaml__api-docs_api-public"},"props":{"definitionId":"API Docs/@2023-11-29/api-public.yaml","dynamicMarkdocComponents":[],"baseSlug":"/api-docs/api-public","seo":{"title":"Events","description":"This object represents an event. Events are sent from Peach to you. Events can be\nrelated to any object in this API.\n\n| Event Name | Occurs when | Related Object |\n|---------------------------------------------|-----------------------------------------------------------------------|--------------------|\n| advance.statuschanged | an advance status changes | Advance |\n| advance.updated | an advance amount is updated | Advance |\n| autopay.schedule.created | an autopay schedule is set up | Autopay |\n| autopay.schedule.cancel | an autopay schedule is canceled | Autopay |\n| autopay.schedule.changed | an autopay schedule is changed | Autopay |\n| autopay.payment.rescheduled | an autopay payment is rescheduled | Autopay |\n| autopay.payment.canceled | an autopay payment is canceled | Autopay |\n| card.created | a card is created | Card |\n| card.replacement.requested | a card replacement is requested | Card |\n| card.status.changed | a card's status is changed | Card |\n| case.changed | a case is created, updated, or deleted, with precise change information | Case |\n| case.created | [**DEPRECATED** - no longer fired, use case.changed instead] a case is created | Case |\n| case.deleted | [**DEPRECATED** - was never used, use case.changed instead] a case is deleted | Case |\n| case.updated | [**DEPRECATED** - no longer fired, use case.changed instead] a case is updated | Case |\n| case.association.added | an association is added to a case | Case |\n| case.association.removed | an association is removed from a case | Case |\n| case.donotinteract.changed | a DoNotInteract object is created, updated, or deleted, with precise change information | Case |\n| case.donotinteract.created | [**DEPRECATED** - use case.donotinteract.changed instead] a DoNotInteract object is created | Case |\n| case.donotinteract.deleted | [**DEPRECATED** - use case.donotinteract.changed instead] a DoNotInteract object is deleted | Case |\n| case.donotinteract.updated | [**DEPRECATED** - use case.donotinteract.changed instead] a DoNotInteract object is updated | Case |\n| case.donotinteract.expired | a DoNotInteract object has expired | Case |\n| case.escalation.changed | a case escalation is created, updated, or deleted, with precise change information | Case |\n| case.escalation.created | [**DEPRECATED** - use case.escalation.changed instead] a case escalation is created | Case |\n| case.escalation.canceled | [**DEPRECATED** - use case.escalation.changed instead] a case escalation is canceled | Case |\n| contact.created | a contact is created | Contact |\n| contact.deleted | a contact is deleted | Contact |\n| contact.updated | a contact is updated | Contact |\n| communication.send | communication is attempted | Interaction |\n| indexrate.created | index rate is created | Loan Type |\n| indexrate.updated | index rate is updated | Loan Type |\n| interaction.blocked | interaction is blocked for a borrower | Interaction |\n| loan.balance.changed | a loan balance changed | Loan |\n| loan.closed | a loan is closed | Loan |\n| loan.created | a loan is created | Loan |\n| loan.credit.limit.changed | a loan credit limit was changed | Loan |\n| draw.credit.limit.changed | a draw credit limit was changed | Draw |\n| loan.creditreporting.created | a loan is scheduled to start credit reporting | Credit Reporting Status |\n| loan.creditreporting.stopped | a loan is scheduled to stop credit reporting | Credit Reporting Status |\n| loan.current | a loan is current or became current | Loan |\n| loan.duedate.defer | a single loan due date is deferred | Loan |\n| loan.fee.booked | a dynamic fee is applied | Loan |\n| loan.fee.canceled | a dynamic fee is canceled | Loan |\n| loan.fee.changed | a dynamic fee is changed | Loan |\n| loan.interest.capitalized | interest capitalization is triggered after a due date | Loan |\n| loan.interestaccrued.min | minimum interest charge is triggered on a draw | Draw |\n| loan.latefee.booked | a late fee is applied | Loan |\n| loan.modificationfee.booked | a modification fee is applied | Loan |\n| loan.migration.succeeded | a loan migration succeeds | Loan |\n| loan.migration.failed | a loan migration fails | Loan |\n| loan.obligation.statuschanged | a change in a loan's obligation status is recorded | Loan |\n| loan.overdue | a loan is overdue | Loan |\n| loan.overdue.update | a loan is overdue | Loan |\n| loan.ownerchanged | a loan changes owners | Loan |\n| loan.paymentplan.setup | a loan payment plan is set up | Loan |\n| loan.period.started | a loan period has started | Loan |\n| loan.promiseplan.created | a promise to pay plan is created | Promise to Pay Plan|\n| loan.promiseplan.statuschanged | a promise to pay plan status changes | Promise to Pay Plan|\n| loan.promiseplan.due.today | a promise to pay plan is due today | Promise to Pay Plan|\n| loan.promiseplan.overdue | a promise to pay plan becomes \"overdue\" | Promise to Pay Plan|\n| loan.promiseplan.current | a promise to pay plan changes from \"overdue\" to \"current\" | Promise to Pay Plan|\n| loan.promoprogram.created | a promo program is created | Loan |\n| loan.promoprogram.updated | a promo program is updated | Loan |\n| loan.rate.created | rate is created | Loan |\n| loan.rate.updated | rate is updated | Loan |\n| loan.refunded | payments on a loan are refunded | Loan |\n| loan.reimbursement.initiated | a borrower reimbursement is initiated | Loan |\n| loan.reimbursement.processed | a borrower reimbursement is processed | Loan |\n| loan.schedule.defer | a loan schedule is deferred | Loan |\n| loan.changeloanterms.scra.update | a loan SCRA plan is created | Loan |\n| loan.scraplan.changed | a loan SCRA plan is changed | Loan |\n| loan.scraplan.deleted | a loan SCRA plan is deleted | Loan |\n| loan.servicefee.booked | a service fee is booked | Loan |\n| loan.membershipfee.booked | a membership fee is booked | Loan |\n| loan.statuschanged | a loan changes status | Loan |\n| person.consent.updated | a borrower updates their consents | Borrower |\n| person.created | a borrower is created | Borrower |\n| person.monitoring.bankruptcy.started | bankruptcy and deceased monitoring begins for a borrower | Borrower |\n| person.monitoring.scra.started | SCRA monitoring begins for a borrower | Borrower |\n| payment.instrument.created | a payment instrument is created | Payment Instrument |\n| payment.instrument.updated | a payment instrument is updated | Payment Instrument |\n| payment.instrument.deactivated | a payment instrument is deactivated | Payment Instrument |\n| payment.applied | **DEPRECATED** used in place of payment.initiated for internal ACH prior to deprecation. | Transaction |\n| payment.chargeback | a payment is charged back | Transaction |\n| payment.chargeback.reversed | a payment is chargeback is reversed | Transaction |\n| payment.failed | a payment fails | Transaction |\n| payment.initiated | a payment is initiated | Transaction |\n| payment.pending | a payment is pending | Transaction |\n| payment.reversed | a payment is reversed | Transaction |\n| payment.succeeded | a payment is succeeded | Transaction |\n| payment.scheduled | a payment is scheduled | Transaction |\n| payment.rescheduled | a payment is rescheduled | Transaction |\n| payment.due.today | periodically for external transactions with a status of \"scheduled\" | Transaction |\n| payment.hold.days.expired | a transaction's hold days expired | Transaction |\n| paymentplan.created | a payment plan is created | Payment Plan |\n| paymentplan.statuschanged | a payment plan changes status | Payment Plan |\n| purchase.authorized | a purchase is authorized | Purchase |\n| purchase.settled | a purchase is settled | Purchase |\n| purchase.applied | a purchase is applied. | Purchase |\n| purchase.created | a purchase is created | Purchase |\n| purchase.changed | a purchase is updated | Purchase |\n| purchase.dispute.created | a purchase dispute is created | Purchase Dispute |\n| purchase.dispute.updated | a purchase dispute is updated | Purchase Dispute |\n| statement.created | a statement is created | Loan |\n| reconciliation.payment.failed | a reconciliation payment fails | Transaction |\n"},"itemId":"events","disableAutoScroll":true,"metadata":{},"compilationErrors":[],"markdown":{"partials":{},"variables":{"rbac":{"teams":["anonymous"]},"user":{},"headers":{"accept":"*/*","accept-encoding":"br,gzip","host":"peach-docs-dev.redocly.app","user-agent":"Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; ClaudeBot/1.0; +claudebot@anthropic.com)","via":"2.0 Caddy, 2.0 a71dc86d67780d7478c72e1b147b8a32.cloudfront.net (CloudFront), 1.1 Caddy","x-amz-cf-id":"vKv3OuPJDt-md5vXC3DURUKFPztxWAoIvuKEnmYz2793F2n3I_VbmQ==","x-forwarded-for":"216.73.216.253, 54.156.60.142, 64.252.67.94","x-forwarded-host":"peach-docs-dev.redocly.app","x-forwarded-proto":"https","x-request-id":"cds-61043c85-a6f9-4c7f-a3a4-7c92d56ec8e1"},"remoteAddr":{"hostname":"::ffff:10.0.3.26","port":53408},"lang":"default_locale","env":{"PUBLIC_REDOCLY_BRANCH_NAME":"develop"}}},"pagePropGetterError":{"message":"","name":""}},"slug":"/api-docs/api-public/events","userData":{"isAuthenticated":false,"teams":["anonymous"]}}