Purse
Calculate Interest – Calculates interest earned for a purse over a specified date range.
Calculates interest earned for a purse over a specified date range. Dates must be in YYYY-MM-DD format and the end date must be in the past. Returns the calculated interest amount.
get/programs/{programCode}/accounts/{accountIdentifier}/purses/{purseIdentifier}/interest
Request
- The document declares no server URL.
- AuthAPI key in header Authorization
Path parameters
programCodestring required
The unique code identifying the partner program context.
accountIdentifierstring required
The unique identifier of the account whose purse interest is being calculated.
purseIdentifierstring required
The unique identifier of the purse for which interest is calculated.
Query parameters
startDatestring
The start date for interest calculation (YYYY-MM-DD). Must be less than or equal to endDate.
endDatestring
The end date for interest calculation (YYYY-MM-DD). Must be a past date.
Headers
X-GD-RequestIdstring required
The unique request identifier (GUID) for tracking and idempotency. Required in the X-GD-RequestId header.
Response
OK
Changes
No recorded changes to this operation across all 2 revisions of this API.