API Documentation

Create interest scheme

post
https://apim.demo01.my.fivedegrees.cloud/sbx/account-configuration/interest-schemes

API endpoint to create a new interest scheme.

Body Params

Data Contract used to create a new Interest Scheme

string
required
length ≥ 1

Name for the Interest Scheme

compoundingPeriod
object

An interval expressed as a number of time units.

string | null

The day within the compounding period when interest is compounded

string | null

The day when interest are compounded if the compounding day falls on a non-business day

string | null

The day-count rule to use with the interest scheme

string | null

The interest tier rule to use with the interest scheme

int32

Which holiday calendar to use with the interest scheme

interestTiers
array of objects | null

The interest tiers which comprise the effective interest for the scheme. This list can't be empty when creating a new scheme

interestTiers
boolean

Compound the full interest period when the compounding is done earlier or later due to non-banking-date rules. This does not apply when closing services. Default value is false, interest is compounded until compounding date.

int32

Delay in days of compounding interests

boolean | null

Interest to Linked Account.

Headers
string
required
Defaults to v1

API versioning

uuid
required

Correlates HTTP requests between a client and server

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

500

Internal Server Error

Updated 13 days ago

Did this page help you?
Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/json

Updated 13 days ago

Did this page help you?