v1
latestOpenAPI 3.0.12026-07-243407211.3 MBTransactions
Get Interest Earned
Retrieves the total interest earned for a specified purse within a given date range.
get/programs/{programCode}/accounts/{accountIdentifier}/purses/{purseIdentifier}/interestEarned
Path parameters
programCodestring required
The program code associated with the account.
accountIdentifierstring required
The unique identifier (UID or GUID) of the account.
purseIdentifierstring required
The unique identifier of the purse for which interest is being calculated.
Query parameters
startDatestring
The start date (inclusive) for the interest calculation
endDatestring
The end date (inclusive) for the interest calculation
Headers
X-GD-RequestIdstring required
A unique identifier for tracking the request, provided in the X-GD-RequestId header.
Response
OK