Skip to main content
GET
/
api
/
v1
/
cashback
Retrieve Cashback Information
const url = 'https://api.gnosispay.com/api/v1/cashback';
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": 4,
  "weeklyCapUsd": 500
}

Authorizations

​
Authorization
string
header
required

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

Response

Successfully retrieved cashback information

​
isOg
boolean
required

Indicates if the user holds an OG NFT token. If true, the user receives higher cashback rates.

Example:

true

​
gnoBalance
string
required

User's GNO token balance in their Safe account (as string to preserve precision)

Example:

"10.5"

​
cashbackRate
number
required

Cashback rate percentage (0-5%). Includes OG NFT bonus if applicable.

Example:

4

​
weeklyCapUsd
number
required

Maximum weekly spending amount eligible for cashback in USD

Example:

500

⌘I