Fetch the latest catalog of products available for use in payouts
countries_redeemable_in
query parameter, in the endpoint described below.
gift_card
, subscription
, and payment
type products, and we’ll be looking to add to these in the future. At the bottom of this page, in the Example response section, there are examples of a few permutations of responses.
We recommend that you poll the list endpoint to retrieve full catalog details hourly and in any critical journeys where you fetch the details of an individual product by using the code
query parameter to return the latest details of a product in a timely manner.
is_orderable
true
- we will reject any orders placed for products where this is false
. You can pass this as a query parameter as part of your request.
currency & countries_redeemable_in
discount_multiplier
payout_type
gift_card
, subscription
, and payment
that are nullable and will not be present in certain responses. The payout_type
field will indicate which of these fields is present, and your implementation should then use this key to extract the relevant required details.
We’ll be adding more payout types in the future, and your implementation should handle these additions gracefully.
categories
department-stores
home-and-diy
toys-and-games
supermarkets
booksellers
experiences
fashion
electricals
entertainment
travel
leisure-and-sports
food-and-drink
beauty-and-lifestyle
jewellers
prepaid-card
.
content_resources
null
when the text has been removed, and present when added. We’ll update this content semi-regularly; a 403
/ 404
will be returned, should this content have been removed. Your implementation should handle this.
denominations
open
or fixed
:
open
products will include minimum_value
and maximum_value
fields. This means that you can order gift cards within the range of minimum_value
and maximum_value
.fixed
products will include a list of values in the available_denominations
field. You can only order values contained in the list that is returned to you.subscription_plans
denominations
minimum_value
and maximum_value
fields that define the allowed payment ranges, but will always be open denomination. Therefore, we don’t have the list of available denominations here.