For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
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.
Authentication
AuthorizationBearer
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
organizationIdstringRequired
Your issuer organization ID, provided by Kard
userIdstringRequired
The ID of the user as defined on the issuers system
Query parameters
page[after]stringOptional
Cursor for next page (base64-encoded timestamp + transaction ID)
page[before]stringOptional
Cursor for previous page (base64-encoded timestamp + transaction ID)
page[size]integerOptional
Number of results per page
filter[status]enumOptional
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.
Allowed values:
filter[paidInFullOnly]booleanOptional
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]enumOptional
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.
Allowed values:
includestringOptional
Comma-separated list of related resources to include in the response. Supported values are merchant and offer.
Response
This endpoint returns an object.
datalist of objects
linksobject
Related links to the API call
metaobject
Additional metadata for the earned rewards response.
includedlist of objectsOptional
Additional resources referenced in the response
Errors
400
Invalid Request
401
Unauthorized Error
404
Does Not Exist Error
500
Internal Server Error
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).
Required scopes:transaction:read
Query Limit: Maximum of 12 months of transaction data can be queried.
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.
