GET
/
api
/
v1
/
rewards
Retrieve Rewards Information
const url = 'https://api.gnosispay.com/api/v1/rewards';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}, body: undefined};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
{
  "isOg": true,
  "gnoBalance": 10.5,
  "cashbackRate": 2.5
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

Successfully retrieved rewards information

​
isOg
boolean
required

Indicates if the user holds an OG NFT token. If true, the user gets an additional 1% cashback on top of the base cashbackRate.

Example:

true

​
gnoBalance
number
required

User's GNO token balance in their Safe account

Example:

10.5

​
cashbackRate
number
required

Base cashback rate calculated from GNO balance (0-4%). For OG NFT holders, add 1% to this rate to get the total cashback rate.

Example:

2.5