Retrieve list of products

GET 
/api/rewards/products

Retrieve a list of products. These should be presented to the user, as choices, when the latter claims their rewards.

Request

Header Parameters

partnerId stringrequired

Partner Id

clientId stringrequired

Client Id

clientSecret stringrequired

Client Secret

Responses

200

List of products to display to the user as choices for claiming the reward.

application/json

Schema

Schema

• Array [

id string
name string

Name of the product

currencyCodes string[]

Available currencies for this product

countries string[]

List of countries in which this product is available to recipients.

description string

Detailed description of the product.

disclosure string

Legal disclosures for this product. Can be in HTML format.

category string

Possible values: [bank, charities, merchant_cards, paypal, visa]

images

object[]

List of product images associated with this product (e.g. logos or images of the gift cards).

Array [

src string

URL to this image

type string

Type of image

]

• ]

Example (from schema)

[
  {
    "id": "string",
    "name": "string",
    "currencyCodes": [
      "string"
    ],
    "countries": [
      "string"
    ],
    "description": "string",
    "disclosure": "string",
    "category": "bank",
    "images": [
      {
        "src": "string",
        "type": "string"
      }
    ]
  }
]

401

Authorization error e.g. due to an invalid or missing API keys.

500

Error fetching products because of remote call issues. Other Internal errors. Possible error codes

1. INTERNAL_SERVER_ERROR

2. ERROR_FETCHING_REWARDS_PRODUCTS

application/json

Schema

Schema

error_code string

Error code

error_message string

A verbose error message

Example (from schema)

{
  "error_code": "string",
  "error_message": "string"
}

Loading...