Loan Default Status

wbhk

LoanDefaultStatus

A dedicated webhook to monitor loan enters Default Notice.

Payload

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

Loan default.

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.

country

string

required

ISO 3166-1 alpha-2 country code of the user.

loanId

uuid

required

Unique identifier of the loan.

defaultId

uuid

required

Unique identifier of the default event.

defaultStatus

string

enum

required

Current default status.

Allowed:

defaultReason

string

enum

required

The reason for the loan default.

Allowed:

lvr

string

required

Loan-to-value ratio as a decimal fraction (e.g., 0.55 = 55%).

periodInDays

int32

required

The default notice period duration in days.

defaultTriggeredAt

date-time | null

Timestamp when the loan entered default.

defaultNoticePdf

string

required

Public URL to the default notice PDF.

defaultVoidAt

date-time | null

Timestamp when the default was voided (if applicable).

forcedActionTriggeredAt

date-time | null

Timestamp when a forced action was triggered due to no user response.

repaymentRequiredFiat

string | null

Fiat amount (AUD) the user should repay when LVR is too high.

monthlyRepayment

string | null

Monthly repayment amount (AUD) for fixed term loans when a repayment is missed.

security

string

enum

required

The cryptocurrency used as security for this loan.

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…