Loan Health Status Update

wbhk

LoanHealthStatusUpdate

This webhook sends updates when a loan transitions between different health status groups. For example, if a customer's loan-to-value ratio (LVR) changes from "Repayment Notice" to "Default Notice," a notification should be sent to the customer, prompting them to take action to restore the LVR as soon as possible.

Payload

Payload, sent to the URL provided in the subscriptions to this webhook type.

Loan health status update.

createdAt

date-time

required

Event creation time.

userId

uuid

required

Unique identifier of the sub-account.

externalUserId

string | null

User ID in your external system for cross-referencing.

loanId

uuid

required

Unique identifier of the loan.

externalTransactionId

string | null

Transaction ID in your external system for cross-referencing.

previousRatio

string

required

Previous loan-to-value ratio.

currentRatio

string

required

Current loan-to-value ratio.

previousStatus

string

enum

required

Previous health status.

Allowed:

currentStatus

string

enum

required

Current health status.

Allowed:

Headers

x-api-signature

string

required

Signature generated from the webhook event payload and subscription secret. See API Key Authentication. Except that there is no "x-api-key" in this case.

x-subscription-id

uuid

required

Unique identifier for the webhook subscription.

x-event-id

uuid

required

Unique identifier of a specific webhook event. Has the same value for retried requests. Should be treated as an idempotency key.

x-event-type

string

enum

required

Type of this webhook event.

Allowed:

Responses

1XX

Informational. The request will be retried.

2XX

Acknowledgement that the request was received and processed successfully.

3XX

Redirection. The request will be retried.

4XX

Client error (invalid signature, duplicated idempotency key, malformed request, etc.). The request will not be retried.

5XX

Server error while processing the request. The request will be retried.

Loading…