transactions

Get Earned Rewards

Retrieve rewarded transaction history for a specific user. By default this returns only SETTLED transactions within the last 12 months regardless of payment status. Pass filter[range] to narrow the window to the last 6 months (6M), last 3 months (3M), or year to date (YTD). Pass filter[paidInFullOnly]=true to restrict the response to matched transactions that have been paid in full to the issuer (paidToIssuer is PAID_IN_FULL). <br/> <b>Required scopes:</b> transaction:read <br/> <b>Query Limit:</b> Maximum of 12 months of transaction data can be queried.

get/v2/issuers/{organizationId}/users/{userId}/earned-rewards

Request

  • Base URL: https://rewards-api.getkard.com
  • URL: https://rewards-api.getkard.com/v2/issuers/{organizationId}/users/{userId}/earned-rewards
  • Auth: HTTP bearer

Path parameters

organizationIdstring required

Your issuer organization ID, provided by Kard

userIdstring required

The ID of the user as defined on the issuers system

Query parameters

page[after]string

Cursor for next page (base64-encoded timestamp + transaction ID)

page[before]string

Cursor for previous page (base64-encoded timestamp + transaction ID)

page[size]integer

Number of results per page

filter[status]'APPROVED' | 'SETTLED'

Filter by transaction status. Supported values are APPROVED and SETTLED. Defaults to SETTLED when omitted. When APPROVED is specified, only approved transactions that do not yet have a corresponding settled transaction are returned.

filter[paidInFullOnly]boolean

When true, only return transactions that have been paid in full to the issuer (paidToIssuer is PAID_IN_FULL). By default (false), any matched transaction is returned regardless of payment status. This also controls whether unpaid transactions contribute to lifetimeRewardsInCents. Has no effect on APPROVED transactions, which are always returned when requested.

filter[range]'12M' | '6M' | '3M' | 'YTD'

Time window for earned rewards queries, ending now. YTD starts at January 1 of the current year (UTC).

Time window for the returned transactions, ending now. Supported values are 12M, 6M, 3M, and YTD (since January 1 of the current year). Defaults to 12M when omitted. Also scopes lifetimeRewardsInCents, so the meta total always matches the returned rows.

includestring

Comma-separated list of related resources to include in the response. Supported values are merchant and offer.

Response

Response with status 200

Changes

No recorded changes to this operation across all 1 revision of this API.