GRgreendot
InterestRate

Adds a new program-level interest rate tier.

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

post/programs/{programCode}/InterestRateTiers

Request

  • The document declares no server URL.
  • Auth
    API key in header Authorization

Path parameters

programCodestring required

The program code associated with the request.

Headers

X-GD-RequestIdstring required

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

Request body

interestTierNamestring nullable

The name of the interest rate tier.

accountBalanceTypestring nullable

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

frequencystring nullable

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

startDatestring date-time nullable

The start date from which the interest tier is effective.

endDatestring date-time nullable

The end date until which the interest tier is effective.

APYnumber double nullable

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

maxAccountInterestTypestring nullable

The type of maximum account interest applicable to this tier.

minimumPurseBalancenumber double nullable

The minimum purse balance required for this interest tier.

maximumPurseBalancenumber double nullable

The maximum purse balance allowed for this interest tier.

maxAccountInterestBalancenumber double nullable

The maximum account interest balance for this tier.

Response

OK

Changes

No recorded changes to this operation across all 2 revisions of this API.