Skip to main content
GET
Get a consumer's aggregated reward information

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

x-api-version
string
default:2.0.0
required

Path Parameters

consumer_id
string
required

Unique ID of the consumer that you have registered when the user was onboarded.

Required string length: 2 - 100

Response

Successful Response

Aggregated reward information for a consumer.

Each field maps to a distinct backend and is only present when that backend responded. Backends are queried concurrently; a backend that fails, times out or has no data for the consumer is simply omitted from the payload.

perks
PerksRewardInfoOut · object | null