Loan Update

wbhk

LoanUpdate

This webhook sends updates when there is a major change to the loan security or loan balance.

Payload

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

Loan 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 application.

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 loan health status.

Allowed:

currentStatus

string

enum

required

Current loan health status.

Allowed:

previousSecurityCryptoAmount

string

required

Previous balance of cryptocurrency used as security.

currentSecurityCryptoAmount

string

required

Current balance of cryptocurrency used as security.

securityCryptoCurrency

string

enum

required

Type of cryptocurrency used as security.

Allowed:

previousFiatPrincipalAmount

string

required

Previous loan principal fiat balance.

currentFiatPrincipalAmount

string

required

Current loan principal fiat balance.

principalFiatCurrency

string

enum

required

Fiat currency used for the loan principal.

Allowed:

amountToRedraw

string | null

Fiat amount to be redrawn. This value is only relevant to redraw, so may be null for other scenarios

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…