Change Interest

post

https://apim.demo01.my.fivedegrees.cloud/lending/revolving-credits/{loanId}/change-interest

API endpoint to change interest of a revolving credit loan.

Path Params

loanId

uuid

required

Format - uuid. Identifier (GUID) of the loan.

Body Params

Create change-interest request

Model for Change Interest endpoint dto.

interestType

string

required

length ≥ 1

Defines whether the change interest action is related to changing (to) a fixed or floating interest rate. Two options:

FIXED

FLOATING

effectiveDate

date

required

The date when the interest change will be active.

periodStartType

string

required

length ≥ 1

Options from when the fixed interest becomes active, the following values are allowed:

'INT ACT FROM LAST' (active from last period)

'INT ACT FROM NEXT' (active from next period)

fixedBasePercentage

double | null

The new fixed base interest.

floatInterestCategoryId

int32 | null

The floating interest category id, in the public API endpoint 'interest-categories' a user can get the full list of available values.

spreadPercentage

double | null

The new interest spread (for both fixed and floating rate loans)

Headers

Accept-version

string

x-request-id

uuid

required

Format - uuid. Correlates HTTP requests between a client and server

Responses

202

Accepted

500

Server Error

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

400Bad Request

401Unauthorized

403Forbidden

404Not Found

422Client Error