API Reference

Get Interest Earned

get
https://example.com/programs//accounts//purses//interestEarned

Retrieves the total interest earned for a specified purse within a given date range.

Path Params
string
required

The program code associated with the account.

string
required

The unique identifier (UID or GUID) of the account.

string
required

The unique identifier of the purse for which interest is being calculated.

Query Params
string

The start date (inclusive) for the interest calculation

string

The end date (inclusive) for the interest calculation

Headers
string
required

A unique identifier for tracking the request, provided in the X-GD-RequestId header.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Unauthorized

Updated 2 months ago

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json
text/json

Updated 2 months ago