v1

latestOpenAPI 3.0.12026-07-243407211.3 MB
InterestRate

Add a new interest rate tier to an existing purse.

This endpoint allows Partners to add Interest Rate Tiers to an existing primary and savings purses.<br><br>Notes: <br>• The interestYieldStartDate will be set to the current date, if you are adding an interestRateTier to the purse for the first time. <br>• If the interestYieldStartDate is not provided, the accountCycleDay will be on or after the current date of the request. <br>• If the purse already has an interestRateTier applied, then the interestYieldStartDate will be set to the next anniversary of the billing cycle. <br>• The next anniversary of the billing cycle will be returned as the accountCycleDay in the POST /enrollments, GET /accounts, and GET /enrollments endpoint responses. <br>• The interestYieldEndDate of the previous Interest Rate Tier on the purse is automatically set to the day before the new Interest Rate. <br>• If the purse has no Interest Rate Tiers applied yet, and autoAlignStartDate is False then the interestYieldStartDate is set to the current date of the request, otherwise it is set to the date provided in the request. On the new additional tiers, when the autoAlignStartDate is True, the interestYieldStartDate is set to start on the next accountCycleDay (Bill Cycle Date).

post/programs/{programCode}/accounts/{accountIdentifier}/purses/{purseIdentifier}/interestRateTier

Path parameters

programCodestring required

The program code associated with the request.

accountIdentifierstring required

The account identifier (GUID format) for which to add the interest rate tier.

purseIdentifierstring required

The purse identifier (GUID format) for which to add the interest rate tier.

Headers

X-GD-RequestIdstring required

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

Request body

interestRateTierstring required

Gets or sets the interest rate tier to be added. This value is required.

interestYieldStartDatestring nullable

Gets or sets the start date for interest yield calculation, in ISO 8601 format (yyyy-MM-dd). Optional. If not provided, the system may determine the start date automatically.

autoAlignStartDateboolean nullable

Gets or sets a value indicating whether the interest yield start date should be auto-aligned. Optional. If true, the system will automatically align the start date.

Response

OK

interestRateTierIdentifierstring nullable
interestYieldStartDatestring nullable
apystring nullable