API Reference

Adds a new program-level interest rate tier.

post
https://example.com/programs//InterestRateTiers

This endpoint allows Partners to create a new interest rate tier.

Path Params
string
required

The program code associated with the request.

Body Params

The request object containing details of the program interest rate tier to add.

Represents a request to add a new interest rate tier to a program.
Contains details about the interest tier, balance types, frequency, applicable dates, and balance thresholds.

string | null

The name of the interest rate tier.

string | null

The type of account balance to which the interest tier applies.

string | null

The frequency at which the interest is applied (e.g., monthly, quarterly).

date-time | null

The start date from which the interest tier is effective.

date-time | null

The end date until which the interest tier is effective.

double | null

The annual percentage yield (APY) for the interest tier.

string | null

The type of maximum account interest applicable to this tier.

double | null

The minimum purse balance required for this interest tier.

double | null

The maximum purse balance allowed for this interest tier.

double | null

The maximum account interest balance for this tier.

Headers
string
required

The unique request identifier from the X-GD-RequestId header.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json-patch+json

Generated from available request content types

Allowed:
Responses

401

Unauthorized

Updated 6 months ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json
text/json

Updated 6 months ago

Did this page help you?