Skip to main content
GET
Get the caller's StockBack/Cashback promo status

Authorizations

x-api-key
string
header
default:lhgfaslk21490FAScVPkdsb53F9dNkfHG4faZSG5vfjndfcfgdssdgsdHF4663
required

API key of the application. Only valid together with the x-user-key header — the pair is an alternative to OAuth bearer authentication, never sent alongside it. The pair is granted the same permissions the operation's OAuth scopes describe.

Demo credential for trying the API from these docs: lhgfaslk21490FAScVPkdsb53F9dNkfHG4faZSG5vfjndfcfgdssdgsdHF4663

x-user-key
string
header
default:eyJlYW4iOiJVbnJlZ2lzdGVyZWRBcHBsaWNhdGlvbiIsImVrIjoiOE5sZ2cwcW5EUVdROUFNWGpXT2lmOWktZnpidG5KcUlqWGJ3WHJZZkpZcldrbG90ZEhvLVBjSWhQaU8xU1ZtMW84aU1WZGZqN2xWNzFjLXFxLmcybXE1dnh4Q1hUT25xaWRUaTFlcEhmVk1fIn0_
required

User-specific authentication key. Only valid together with the x-api-key header — the pair is an alternative to OAuth bearer authentication, never sent alongside it.

Demo credential for trying the API from these docs: eyJlYW4iOiJVbnJlZ2lzdGVyZWRBcHBsaWNhdGlvbiIsImVrIjoiOE5sZ2cwcW5EUVdROUFNWGpXT2lmOWktZnpidG5KcUlqWGJ3WHJZZkpZcldrbG90ZEhvLVBjSWhQaU8xU1ZtMW84aU1WZGZqN2xWNzFjLXFxLmcybXE1dnh4Q1hUT25xaWRUaTFlcEhmVk1fIn0_

Headers

x-request-id
string<uuid>
required

A unique request identifier.

Example:

"dcce8e27-c2c5-43da-b669-a499ec37ecdb"

Response

The caller's current StockBack/Cashback promo status.

The caller's current StockBack/Cashback promo enrollment and lifetime USD figures. Every field is nullable: a caller not (yet) enrolled in the promo still returns 200 with mostly-null values.

isOptedIn
boolean | null

Whether the caller is currently opted into the StockBack promo.

Example:

true

selectedStock
string | null

Ticker symbol of the stock the caller selected for StockBack, if opted in.

Example:

"AAPL"

currentIsPi
boolean | null

Whether the caller is currently classified as a Professional Investor.

Example:

false

rewardChannel
string | null

The channel this caller's reward is delivered through.

Example:

"stockback"

currentClub
string | null

The caller's current eToro Club tier.

Example:

"Silver"

currentCountry
string | null

The caller's current country.

Example:

"GB"

expectedCurrentMonthUsd
number<double> | null

Reward expected to accrue this calendar month, in USD.

Example:

12.34

stockbackLifetimeUsd
number<double> | null

Lifetime StockBack reward earned, in USD.

Example:

100.5

cashbackLifetimeUsd
number<double> | null

Lifetime Cashback reward earned, in USD.

Example:

50.25

totalLifetimeUsd
number<double> | null

Lifetime total reward earned (StockBack + Cashback), in USD.

Example:

150.75