API Reference

Calculate Interest – Calculates interest earned for a purse over a specified date range.

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

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.

Path Params
string
required

The unique code identifying the partner program context.

string
required

The unique identifier of the account whose purse interest is being calculated.

string
required

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

Query Params
string

The start date for interest calculation (YYYY-MM-DD). Must be less than or equal to endDate.

string

The end date for interest calculation (YYYY-MM-DD). Must be a past date.

Headers
string
required

The unique request identifier (GUID) for tracking and idempotency. Required 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