Skip to main content

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. Pass userId to also get, per product, whether the user's current balance can be claimed as it (claimable) and how much more they need to earn to reach its minimum (amountToUnlock).

Request​

Query Parameters

    userId string

    Id of the user. When given, each product says whether this user's balance can be claimed as it.

Responses​

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

Schema

  • Array [

    • id string

    Id of the product. Same value as productId, kept for existing callers.

    productId string

    Id of the product, passed back as the product parameter when claiming.

    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

  • ]

    • minAmount number

    Smallest amount the provider accepts for this product. Null if the provider does not publish one.

    maxAmount number

    Largest amount the provider accepts for this product. Null if the provider does not publish one.

    currency string

    Currency of minAmount and maxAmount.

    claimable boolean

    Whether the user's current balance can be claimed as this product. Null when no userId was given.

    amountToUnlock number

    How much more the user must earn before this product's minimum is reached. 0 when already reached. Null when no userId was given.

  • ]

Loading...