API Developer Documentation

INTRODUCTION

The RewardPay API enables developers to access a database of cash back offers across hundreds of advertisers.

The RewardPay can be accessed via a powerful API containing merchant names, cash back values including start date and expiry dates, titles, descriptions, categories, merchant id's, program id's, merchant logos, merchant urls and built deep links and tracking urls in the XML/CSV/JSON formats.

RewardPay issues an API Key after registration. A separate API Key is required to access data from specific countries.

Note: the RewardPay API Key is a unique token required to access the API feeds. It is our way of authenticating that the RewardPay client has access to the API.

  1. Only one API Key per country is allowed
  2. Every API request will contain a valid, active API Key and data format parameter

RESPONSE FORMAT

The cash back will be accessible from the RewardPay database via a secured API in XML/CSV/JSON format. The following data formats are available:

  1. JSON: JavaScript Object Notation (Recommended)
  2. XML: Extensible Mark-up Language
  3. CSV: Comma Separated Values

API REQUEST

Data feeds are accessible to clients via a web API with client id and API signature to make the API secured. We will issue the client id and API signature after client registration. The RewardPay API allows only the GET method.

https://api.rewardpay.com/{APIKey}/{MethodName}

Where

API KEY

The API Key used for API request authentication and this is a mandatory parameter of the API request call. The API Key is issued by RewardPay after successful registration. The API Key is country specific, so if the client subscribes to multiple countries, then RewardPay will generate unique API Key for each country.

METHODNAME

This is also a mandatory parameter of the API request call. This parameter can be used to get specific data from the API, e.g. cash back, merchants, categories etc.

DATAFORMAT

This is also a mandatory parameter of the API request call. This parameter can be used to get data in a specific format, i.e. JSON, XML & CSV.

ACCESS OFFERS

API Request URL Format: https://api.rewardpay.com/{APIKey}/{MethodName}?type={DataFormat}&SortBy={SortByValue}&MerchantName={MerchantName}&Category={CategoryName}&OfferType={OfferType}&PageNo={PageNo}&PageSize={PageSize}

ParameterValueTypeNote
Parameter----MandatoryShould have valid and active API Key
MethodNameGetOffersMandatory
TypeJSON | XML | CSVOptional(default is JSON)Only one data type is allowed at a time. Please use JSON or XML or CSV
SortBySTARTDATE | ENDDATE | MERCHANTNAME | OFFERTYPE | CLICKCOUNTOptionalUse this parameter if you want to get results sorted by specific fields. Only one field is allowed for sorting in API request.
MerchantNameOptionalPass merchant name if you want to get deals from specific merchant.
CategoryOptionalPass category name if you want to get deals from specific categories.
OfferTypeAll | Coupon | DiscountOptionalPass OFFERTYPE if you want to filter deals by specific type, e.g. coupon, discount etc.
StatusAll | Active | ExpiredOptional (Default is All)Pass Status if you want to filter offers by specific status, e.g. All, Active or Expired
PageNoOptionalBy default, API returns all data. But if the PageNo is being passed then the data will be shown accordingly. With this parameter, PageSize parameter is required.
PageSizeOptionalPass the value if the data required in paging. This parameter used to set the number of records in a page.

EXAMPLE

  1. Get coupon type deals from fashion category from Zalora merchant and in StartDate sorting order of page size 25. API Request URL: https://api.rewardpay.com/ef8f361d98222ca9de12814223aff0ac/getoffers?SortBy=STARTDATE &MerchantName=ZALORA&Category=Faishon&OfferType=Coupons&PageNo=1&PageSize=25
  2. Get all deals from fashion category from Zalora merchant and in StartDate sorting order of page size 25. API Request URL: https://api.rewardpay.com/ef8f361d98222ca9de12814223aff0ac/getoffers?SortBy=STARTDATE &MerchantName=ZALORA&Category=Faishon&PageNo=1&PageSize=25
  3. Get all deals from Zalora merchant and in StartDate sorting order of page size 25. API Request URL: https://api.rewardpay.com/ef8f361d98222ca9de12814223aff0ac/getoffers?SortBy=STARTDATE &MerchantName=ZALORA&PageNo=1&PageSize=25
  4. Get all deals from all subscribed merchants in StartDate sorting order of page size 25. API Request URL: https://api.rewardpay.com/ef8f361d98222ca9de12814223aff0ac/getoffers?SortBy=STARTDATE &MerchantName=ZALORA&PageNo=1&PageSize=25
  5. Get all deals from all subscribed merchants without paging and sorting API Request URL: https://api.rewardpay.com/ef8f361d98222ca9de12814223aff0ac/getoffers

Use same as above for XML and CSV format, only need to replace data format parameter values i.e. replaces json by xml or csv

ACCESS MERCHANTS

API Request URL Format: https://api.rewardpay.com/{APIKey}/{MethodName}/?type={DataFormat}&MerchantName={MerchantName}&RelationType={RelationType}&PageNo={PageNo}&PageSize={PageSize}

ParameterValueTypeNote
API KEY----MandatoryShould have valid and active API Key
MethodNameGetMerchantsMandatory
TypeJSON | XML | CSVOptional(default is JSON)Only one data type is allowed at a time. Please use JSON or XML or CSV
MerchantNameOptionalUse this filter parameter if you want to filter merchants by merchant name. Pass few characters from beginning of merchant name.
SortByCLICKCOUNTOptionalUse this parameter if you want to get results sorted by specific fields. Only one field is allowed for sorting in API request.
StatusAll | Active | InActiveOptional (Default is All)Pass Status if you want to filter offers by specific status, e.g. All, Active or InActive
PageNoOptionalBy default, API returns all data. But if the PageNo is being passed then the data will be shown accordingly. With this parameter, PageSize parameter is required.
PageSizeOptionalPass the value if the data required in paging. This parameter used to set the number of records in a page.

EXAMPLE:

  1. Get all merchants without paging. API Request URL: https://api.rewardpay.com/ef8f361d98222ca9de12814223aff0ac/GetMerchants?type=json
  2. Get all merchants of page size 25. API Request URL: https://api.rewardpay.com/ef8f361d98222ca9de12814223aff0ac/GetMerchants?type=json&PageNo=1&PageSize=25
  3. Search merchants by merchant name. Start with Zal (for Zalora search) to the RewardPay account, of page size 25. API Request URL: https://api.rewardpay.com/ef8f361d98222ca9de12814223aff0ac/GetMerchants?type=json&MerchantName=Zal&PageNo=1&PageSize=25

User same as above for XML and CSV format, only need to replace data format parameter values i.e.replaces json by xml or csv.

ACCESS CATEGORIES

API Request URL Format: https://api.rewardpay.com/{APIKey}/{MethodName}/?type={DataFormat}&CategoryName={CategoryName}&RelationType={RelationType}&PageNo={PageNo}&PageSize={PageSize}

ParameterValueTypeNote
API KEY----MandatoryShould have valid and active API Key
MethodNameGetCategoriesMandatory
TypeJSON | XML | CSVOptional(Default is JSON)Only one data type is allowed at a time. Please use JSON or XML or CSV
CategoryNameOptionalUse this filter parameter if you want to filter categories by category name. Pass few characters from beginning of the category name.
StatusAll | Active | InActiveOptional (Default is All)Pass Status if you want to filter offers by specific status, e.g. All, Active or InActive
PageNoOptionalBy default, API returns all data. But if the PageNo is being passed then the data will be shown accordingly. With this parameter, PageSize parameter is required.
PageSizeOptionalPass the value if the data required in paging. This parameter used to set number of records in a page.

EXAMPLE:

  1. Get all categories without paging. API Request URL: https://api.rewardpay.com/ef8f361d98222ca9de12814223aff0ac/GetCategories?type=json
  2. Get all categories of page size 25. API Request URL: https://api.rewardpay.com/ef8f361d98222ca9de12814223aff0ac/GetCategories /Json?PageNo=1&PageSize=25
  3. Get all categories joined/added to the RewardPay account, of page size 25. API Request URL: https://api.rewardpay.com/ef8f361d98222ca9de12814223aff0ac/GetCategories/?type=json&PageNo=1&PageSize=25
  4. Search categories by category name start with Fash (for Fashion search) in the RewardPay account, of page size 25. API Request URL: https://api.rewardpay.com/ef8f361d98222ca9de12814223aff0ac/GetCategories??type=json&CategoryName=fash&PageNo=1&PageSize=25

User same as above for XML and CSV format, only need to replace data format parameter values i.e.replaces json by xml or csv.

ACCESS TRANSACTIONS

This method is accessible to revenue share plan. You have subscribed revenue share plan then you can access the sale data via API.

API Request URL Format: https://api.rewardpay.com/{APIKey}/{MethodName}?type={DataFormat}&MerchantName={MerchantName}&Status={Status}&PageNo={PageNo}&PageSize={PageSize}

ParameterValueTypeNote
API KEY----MandatoryShould have valid and active API Key
MethodNameGetTransactionsMandatory
DataFormatJSON | XML | CSVOptional(Default is JSON)Only one data type is allowed at a time. Please use JSON or XML or CSV
MerchantNameOptionalIf you want to get sale from specific merchant, then pass the network name in this parameter.
StatusTRACKED | CONFIRMED | DECLINEOptionalUse to filter sale by sale status.
PageNoOptionalBy default, API returns all data. But if the PageNo is being passed then the data will be shown accordingly. With this parameter, PageSize parameter is required.
PageSizeOptionalPass the value if the data required in paging. This parameter used to set the number of records in a page.

EXAMPLE:

  1. Get all sales API Request URL: https://api.rewardpay.com/ef8f361d98222ca9de12814223aff0ac/gettransactions?type=Json
  2. Get all sales of page size 25. API Request URL: https://api.rewardpay.com/ef8f361d98222ca9de12814223aff0ac/gettransactions/?type=Json&PageNo=1&PageSize=25
  3. Filter sales by merchant name and get results in page size of 25. API Request URL: https://api.rewardpay.com/ef8f361d98222ca9de12814223aff0ac/gettransactions?type=Json&MerchantName=Zalora&PageNo=1&PageSize=25
  4. Filter sales by merchant name and status and get results in page size of 25. API Request URL: https://api.rewardpay.com/ef8f361d98222ca9de12814223aff0ac?type=Json&MerchantName=Zalora&Status=TRACKED&PageNo=1&PageSize=25

User same as above for XML and CSV format, only need to replace data format parameter values i.e.replace json by xml or csv.

ACCESS CLICKS

This method is accessible to Data Subcribers signed up to the revenue share plan.

API Request URL Format: https://api.rewardpay.com/{APIKey}/{MethodName}?type=Json&PageNo={PageNo}&PageSize={PageSize}

ParameterValueTypeNote
API KEY----MandatoryShould have valid and active API Key
MethodNameGetClicksMandatory
TypeJSON | XML | CSVOptional(default is JSON)Only one data type is allowed at a time. Please use JSON or XML or CSV
PageNoOptionalBy default, API returns all data. But if the PageNo is being passed then the data will be shown accordingly. With this parameter, PageSize parameter is required.
PageSizeOptionalPass the value if the data required in paging. This parameter used to set the number of records in a page.

EXAMPLE:

  1. Get all clicks API Request URL: https://api.rewardpay.com/ef8f361d98222ca9de12814223aff0ac/GetClicks?type={DataFormat}
  2. Get all clicks of page size 25. API Request URL: https://api.rewardpay.com/ef8f361d98222ca9de12814223aff0ac/GetClicks?type={DataFormat}&PageNo=1&PageSize=25

User same as above for XML and CSV format, only need to replace data format parameter values i.e.replaces json by xml or csv.

ACCESS MERCHANT BANNERS

API Request URL Format: https://api.rewardpay.com/{APIKey}/{MethodName}/?type={DataFormat}&MerchantName={MerchantName}&RelationType={RelationType}&PageNo={PageNo}&PageSize={PageSize}

ParameterValueTypeNote
API KEY----MandatoryShould have valid and active API Key
MethodNameGetBannersMandatory
TypeJSON | XML | CSVOptional(default is JSON)Only one data type is allowed at a time. Please use JSON or XML or CSV
MerchantNameOptionalUse this filter parameter if you want to filter banners by merchant name. Pass few characters from beginning of merchant name.
BannerTypeMandatoryUse this filter parameter if you want to filter banners by banner type.
BannerType=3 for Home page main banner.
BannerType=12 for offer box banner.
BannerType=13 for merchant page banner.
PageNoOptionalBy default, API returns all data. But if the PageNo is being passed then the data will be shown accordingly. With this parameter, PageSize parameter is required.
PageSizeOptionalPass the value if the data required in paging. This parameter used to set the number of records in a page.

EXAMPLE:

  1. Get all banners without paging. API Request URL: https://api.rewardpay.com/ef8f361d98222ca9de12814223aff0ac/GetBanners?type=json
  2. Get all banners of page size 25. API Request URL: https://api.rewardpay.com/ef8f361d98222ca9de12814223aff0ac/GetBanners?type=json&&=BannerType=12&PageNo=1&PageSize=25
  3. Search banners by merchant name. Start with Zal (for Zalora search) to the RewardPay account, of page size 25. API Request URL: https://api.rewardpay.com/ef8f361d98222ca9de12814223aff0ac/GetBanners?type=json&=BannerType=12&&MerchantName=Zalora&PageNo=1&PageSize=25

User same as above for XML and CSV format, only need to replace data format parameter values i.e.replaces json by xml or csv.

Ready to apply?

GET STARTED