Kard rewards API is one of 16 APIs that Kard publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.
Tagged areas include rewards. The published artifact set on APIs.io includes an OpenAPI specification, authentication docs, and an AsyncAPI specification.
This API exposes
9 operations
across 9 paths,
and defines 33 schemas.
It is described by OpenAPI 3.1.0, at version 1.0.0.
Requests are made against 2 base URLs: https://rewards-api.getkard.com, https://test-rewards-api.getkard.com.
9 operations9 paths33 schemas9 GET
Metadata
The identity and technical contract details declared by the specification.
Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://rewards-api.getkard.com
Authentication
HTTP Bearer
Resource Areas
1
Authentication & Security 1
Kard rewards API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (OAuthScheme).
Paths & Operations 9
Across 9 paths, the API surfaces 9 operations — 9 GET. Each is listed below with its method, path, parameters, and response codes.
The contract defines 33 schemas that model the data the API accepts and returns. The most detailed are type_rewards:OfferWithAttribution (24 properties), type_rewards:MerchantOfferWithAttribution (24 properties), type_rewards:FullLocationsOffer (23 properties), type_rewards:MerchantOffer (23 properties). Each schema is shown below with its type and property counts.
type_commons:CommissionType
string
Type of commission on offer (% or a flat $)
type_rewards:MerchantOffer
object
23 properties16 required
type_rewards:OfferMerchantWithAttribution
object
9 properties8 required
type_commons:RequestValidationErrorResponse
object
1 property1 required
type_rewards:ComponentType
string
Available UI component types for offers
type_rewards:Offer
object
22 properties16 required
type_commons:OfferType
string
Type of offer (whether it is run online or in-store)
type_commons:Source
string
Source of the merchant associated to the location
type_rewards:Location
object
13 properties11 required
type_rewards:LocationWithFullOffer
object
15 properties13 required
type_rewards:Merchant
object
12 properties11 required
type_rewards:LocationsMerchantWithAttribution
object
9 properties8 required
type_rewards:LocationType
string
type_commons:CategoryOption
string
Category of merchant. Please use URL Encode for non single word categories. (Food & Beverage should be Food%20%26%20Beverage)
type_rewards:OfferMerchant
object
Merchant associated with the offer
9 properties8 required
type_commons:InvalidRequestUnion
type_rewards:MerchantOfferWithAttribution
object
24 properties15 required
type_rewards:MerchantWithAttribution
object
12 properties11 required
type_commons:GeoLocation
object
2 properties2 required
type_rewards:LocationsMerchant
object
9 properties8 required
type_commons:MongoId
string
The unique identifier for a document in the database
type_commons:AcceptedCards
string
Card types accepted by merchant
type_rewards:OfferWithAttribution
object
24 properties16 required
type_rewards:LocationWithPartialOffer
object
15 properties13 required
type_commons:State
string
type_commons:SortOptions
string
type_rewards:FullLocationsOffer
object
23 properties14 required
type_commons:OperatingHours
object
7 properties
type_commons:Address
object
4 properties4 required
type_commons:EnrolledRewardsType
string
Enrolled Rewards
type_commons:UnauthorizedErrorBody
object
1 property1 required
type_rewards:LocationsOffer
object
11 properties5 required
type_rewards:GetMerchantByIdResponse
Specification
The full machine-readable OpenAPI contract behind this narrative.
