Event that is fired to relay changes to a loan's state.
Headers:
Ce-Type- LoanDetailsChangedEventCe-Source- breadpayments.webhooks.servicing
{
"identity": {
"tenantID": "dc0dc633-1760-4d43-ba1d-da94ed701f06",
"buyerID": "dc0dc633-1760-4d43-ba1d-da94ed701f06",
"merchantID": "dc0dc633-1760-4d43-ba1d-da94ed701f06",
"partnerID": "dc0dc633-1760-4d43-ba1d-da94ed701f06",
"programID": "dc0dc633-1760-4d43-ba1d-da94ed701f06"
},
"timestamp": "2020-12-31T15:10:55Z",
"loanID": "dc0dc633-1760-4d43-ba1d-da94ed701f06",
"loanNumber": "string",
"productType": "UNKNOWN",
"paymentProductID": "dc0dc633-1760-4d43-ba1d-da94ed701f06",
"loanStatus": "UNKNOWN_STATUS",
"loanSubStatus": "UNKNOWN_SUB_STATUS",
"disputeStatus": true,
"balance": {
"currency": "USD",
"value": 50000
},
"firstPaymentDue": "2020-12-31",
"pastDue": true,
"chargebackAmount": {
"currency": "USD",
"value": 50000
},
"paymentAmount": {
"currency": "USD",
"value": 50000
},
"loanStartDate": "2020-12-31",
"loanOriginationDate": "2020-12-31",
"loanEndDate": "2020-12-31",
"nextDueDate": "2020-12-31",
"autopayStatus": true,
"autopayPaymentMethodID": "dc0dc633-1760-4d43-ba1d-da94ed701f06",
"interestRate": 0,
"loanInterval": "BIWEEKLY",
"loanLength": 12
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| identity | object | true | none | The claims that determines the access level of the caller. |
| ➥ tenantID | string(uuid) | true | none | An UUID that represents a tenant. |
| ➥ buyerID | string(uuid)¦null | false | none | An UUID that represents a buyer. |
| ➥ merchantID | string(uuid)¦null | false | none | An UUID that represents a merchant. |
| ➥ partnerID | string(uuid)¦null | false | none | An UUID that represents a partner. |
| ➥ programID | string(uuid)¦null | false | none | An UUID that represents a program. |
| timestamp | string(date-time) | true | none | The timestamp value formatted per RFC3339. This does not allow nulls. |
| loanID | string(uuid) | true | none | A universally unique identifier (Version 4) as defined in RFC4122. This does not allow nulls. |
| loanNumber | string | false | none | A human-friendly unique ID for a payment agreement. |
| productType | string | false | none | The type of payment product the loan is classified under. |
| paymentProductID | string(uuid) | false | none | A universally unique identifier (Version 4) as defined in RFC4122. This does not allow nulls. |
| loanStatus | string | false | none | The status of a payment agreement. |
| loanSubStatus | string | false | none | The substatus of a payment agreement. |
| disputeStatus | boolean | false | none | Boolean that represents whether a loan has a dispute. |
| balance | object | false | none | Represents a monetary amount in the specified currency |
| ➥ currency | string | true | none | The three letter currency code as defined in ISO 4217. |
| ➥ value | integer(int64) | true | none | Monetary value as an integral number of the currency fractional unit e.g for USD: cents |
| firstPaymentDue | string(date)¦null | false | none | The date value formatted per RFC3339. This allows nulls. |
| pastDue | boolean | false | none | Boolean that indicates whether the loan has passed its due date for the latest installment. |
| chargebackAmount | object | false | none | Represents a monetary amount in the specified currency |
| ➥ currency | string | true | none | The three letter currency code as defined in ISO 4217. |
| ➥ value | integer(int64) | true | none | Monetary value as an integral number of the currency fractional unit e.g for USD: cents |
| paymentAmount | object | false | none | Represents a monetary amount in the specified currency |
| ➥ currency | string | true | none | The three letter currency code as defined in ISO 4217. |
| ➥ value | integer(int64) | true | none | Monetary value as an integral number of the currency fractional unit e.g for USD: cents |
| loanStartDate | string(date)¦null | false | none | The date value formatted per RFC3339. This allows nulls. |
| loanOriginationDate | string(date)¦null | false | none | The date value formatted per RFC3339. This allows nulls. |
| loanEndDate | string(date)¦null | false | none | The date value formatted per RFC3339. This allows nulls. |
| nextDueDate | string(date)¦null | false | none | The date value formatted per RFC3339. This allows nulls. |
| autopayStatus | boolean | false | none | Boolean representing whether the loan is enrolled in autopay. |
| autopayPaymentMethodID | string(uuid)¦null | false | none | A universally unique identifier (Version 4) as defined in RFC4122. This allows nulls. |
| interestRate | number(double) | false | none | Number indicating the current interest rate for the loan. |
| loanInterval | string | false | none | The payment interval for the term. |
| loanLength | integer(int64) | false | none | Length of the term. |
Enumerated Values
| Value |
|---|
| UNKNOWN |
| INSTALLMENTS |
| SPLITPAY |
| DEBT_CONSOLIDATION |
| PERSONAL_LOAN |
| UNKNOWN_STATUS |
| OFFERED |
| ACCEPTED |
| EXPIRED |
| REVIEW |
| OUTSTANDING |
| PAID |
| CHARGED_OFF |
| CANCELLED |
| CLOSED |
| UNKNOWN_SUB_STATUS |
| CURRENT |
| DELINQUENT_PAST_DUE |
| PENDING |
| FULFILLED |
| CHARGED_OFF_PAID |
| PAYMENTS_FROZEN |
| GRACE_PERIOD |
| PRE_GRACE_PERIOD |
| NONE |
| BIWEEKLY |
| MONTHLY |