NAV Navbar
PHP HTTP Shell JavaScript

REST API v2.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

REST API version 2.0 is currently the stable release.

Base URLs:

Email: Reward Gateway Engineering Team Web: Reward Gateway Engineering Team License: Apache 2.0

Authentication

Scope Scope Description
user.read Read your profile information
user.write Update user's profile info
user.instrument.read View user's saved instruments
user.instrument.write Manage user's saved instruments
user.payment.read View user's stored payment card information
user.order.read View user’s completed order information
user.savings_account View user's savings account statistics, cashback balance
user.retailers Manage user's retailer preferences
programme.read View programme information
programme.modules View programme's enabled modules
programme.statistics View programme's dashboard data, milestones, timeline of events
checkout.basket.read View active basket information
checkout.basket.write Update basket by adding or removing items
checkout.payment Make payment on behalf of user
retailers.read View a list of retailers, products and offers supported through SmartSpending™
device.manage Manage registering/unregistering devices for notifications to be sent out
scim.readOnly Read member information on your programme. This will NOT allow the client to write any data.
scim.readWrite Read member information on your programme as well as be able to make changes to Eligibility Listen
user.app.review App review service
notification.read Read members notifications
notification.write Manage notifcations
notification.preferences.read Read members notification preferences
notification.preferences.write Manager members notification preferences
srw.feed.read List the Social Recognition Wall feed
srw.feed.write Add feed items the Social Recognition Wall feed
srw.feed.delete Delete an item from the Social Recognition Wall feed
srw.feed.filter.read Filters on Social Recognition Wall
srw.feed.filter.write Add a filter to search items from the Social Recognition Wall feed
srw.feed.filter.delete Delete a filter used to search items from the Social Recognition Wall feed
srw.feed.reaction.read List the Social Recognition Wall feed item reactions
srw.feed.reaction.write React on the Social Recognition Wall feed item
srw.feed.comment.read List the Social Recognition Wall feed item comments
srw.feed.comment.write Comment on the Social Recognition Wall feed item
srw.feed.comment.reply.read List the Social Recognition Wall feed item comment replies
srw.feed.comment.reply.write Reply on the Social Recognition Wall feed item comment
srw.feed.reaction.toolbar.read List the Social Recognition Wall toolbar reactions
srw.ecard.read List the Social Recognition Wall ecard categories within ecards
srw.user.activity.read List user SRW activity
srw.user.stats.read List user SRW statistics
user.hierarchy.read List user hierarchy
user.details.read List user details
user.search Search members
surveys.write Manage surveys data
programme.create Create a programme
programme.write Write to a programme

SmartSpending™

Endpoints to manage SmartSpending™ related functionality. i.e. View offers, make purchases and manage a member's shopping basket.

Get all items in the shopping basket

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/basket', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/basket HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/basket \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/basket',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /basket

This endpoint will return all items the current member has in their shopping basket.

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
basketId query string false Basket identifier

Example responses

200 Response

{
  "basketId": "string",
  "currency": "string",
  "total": 0.1,
  "subtotal": 0.1,
  "saving": 0.1,
  "items": [
    {
      "id": 0,
      "type": "string",
      "productId": 0,
      "productType": "string",
      "name": "string",
      "image": "string",
      "currency": "string",
      "price": 0.1,
      "cost": 0.1,
      "tax": 0.1,
      "saving": 0.1,
      "quantity": 0.1,
      "termsAndConditions": "string",
      "adjustments": [
        null
      ]
    }
  ],
  "messages": [
    null
  ]
}

Responses

Status Meaning Description Schema
200 OK Successful operation basket
403 Forbidden Access to the resource has been denied errorModel
404 Not Found Basket was not found errorModel

Add an item to the shopping basket

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'multipart/form-data',
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.rewardgateway.net/basket/{basketId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST https://api.rewardgateway.net/basket/{basketId} HTTP/1.1
Host: api.rewardgateway.net
Content-Type: multipart/form-data
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X POST https://api.rewardgateway.net/basket/{basketId} \
  -H 'Content-Type: multipart/form-data' \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'

const inputBody = '{
  "productId": 0,
  "amount": 0,
  "cardId": 0
}';
const headers = {
  'Content-Type':'multipart/form-data',
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/basket/{basketId}',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /basket/{basketId}

This endpoint allows you to add an item to the current member's shopping basket.

Body parameter

productId: 0
amount: 0
cardId: 0

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
basketId path string true Basket identifier
body body object false none
» productId body integer true Product Identifier
» amount body integer true Product Amount
» cardId body integer false Reloadable Card Identifier (only for topups)

Example responses

200 Response

{
  "code": 0,
  "message": "string",
  "details": null
}

Responses

Status Meaning Description Schema
200 OK Basket updated successfully standardModel
400 Bad Request Invalid request errorModel
403 Forbidden Access to the resource has been denied errorModel
404 Not Found Product was not found errorModel

Clear the shopping basket

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://api.rewardgateway.net/basket/{basketId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

DELETE https://api.rewardgateway.net/basket/{basketId} HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X DELETE https://api.rewardgateway.net/basket/{basketId} \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/basket/{basketId}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /basket/{basketId}

This endpoint will clear all items currently available in the current member's shopping basket.

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
basketId path string true Basket identifier

Example responses

200 Response

{
  "code": 0,
  "message": "string",
  "details": null
}

Responses

Status Meaning Description Schema
200 OK Basket emptied successfully standardModel
403 Forbidden Access to the resource has been denied errorModel
404 Not Found Basket was not found errorModel

Remove a single item the shopping basket

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://api.rewardgateway.net/basket/{basketId}/{itemId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

DELETE https://api.rewardgateway.net/basket/{basketId}/{itemId} HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X DELETE https://api.rewardgateway.net/basket/{basketId}/{itemId} \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/basket/{basketId}/{itemId}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /basket/{basketId}/{itemId}

This endpoint removes a single product from the current member's shopping basket

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
basketId path string true Basket identifier
itemId path integer true Basket item identifier

Example responses

200 Response

{
  "code": 0,
  "message": "string",
  "details": null
}

Responses

Status Meaning Description Schema
200 OK Basket updated successfully standardModel
400 Bad Request Invalid request errorModel
403 Forbidden Access to the resource has been denied errorModel
404 Not Found Basket was not found errorModel

Purchase items currently in the shopping basket

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'multipart/form-data',
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.rewardgateway.net/checkout', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST https://api.rewardgateway.net/checkout HTTP/1.1
Host: api.rewardgateway.net
Content-Type: multipart/form-data
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X POST https://api.rewardgateway.net/checkout \
  -H 'Content-Type: multipart/form-data' \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'

const inputBody = '{
  "basketId": "string",
  "applyCashback": true,
  "telephoneNumber": "string",
  "mobilePhoneNumber": "string",
  "cardCVV": "string",
  "cardId": 0,
  "cardNumber": "string",
  "cardBin": "string",
  "cardLast": "string",
  "cardPaymentMethod": "string",
  "cardExpiryMonth": "string",
  "cardExpiryYear": "string",
  "cardIssueNumber": "string",
  "cardStartMonth": "string",
  "cardStartYear": "string",
  "cardFirstName": "string",
  "cardLastName": "string",
  "cardAddressLine1": "string",
  "cardAddressLine2": "string",
  "cardAddressLine3": "string",
  "cardAddressLine4": "string",
  "cardPostalCode": "string",
  "cardTokenize": true,
  "cardTokenAlias": "string",
  "otp": "string"
}';
const headers = {
  'Content-Type':'multipart/form-data',
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/checkout',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /checkout

This endpoint will purchase all items currently available in the shopping basket

Body parameter

basketId: string
applyCashback: true
telephoneNumber: string
mobilePhoneNumber: string
cardCVV: string
cardId: 0
cardNumber: string
cardBin: string
cardLast: string
cardPaymentMethod: string
cardExpiryMonth: string
cardExpiryYear: string
cardIssueNumber: string
cardStartMonth: string
cardStartYear: string
cardFirstName: string
cardLastName: string
cardAddressLine1: string
cardAddressLine2: string
cardAddressLine3: string
cardAddressLine4: string
cardPostalCode: string
cardTokenize: true
cardTokenAlias: string
otp: string

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
body body object false none
» basketId body string true Basket identifier
» applyCashback body boolean true Use cashback balance
» telephoneNumber body string true Telephone Number
» mobilePhoneNumber body string false Mobile number where the SMS voucher will be send.
» cardCVV body string false Payment card CVV (not required if fully paying with cashback)
» cardId body integer false Payment card identifier
» cardNumber body string false Payment card number
» cardBin body string false Payment card bin
» cardLast body string false Payment card last 4 digits
» cardPaymentMethod body string false Payment card method
» cardExpiryMonth body string false Payment card expiry month
» cardExpiryYear body string false Payment card expiry year
» cardIssueNumber body string false Payment card issue number
» cardStartMonth body string false Payment card start month
» cardStartYear body string false Payment card start year
» cardFirstName body string false Payment card owner's first name
» cardLastName body string false Payment card owner's last name
» cardAddressLine1 body string false Payment card address line 1
» cardAddressLine2 body string false Payment card address line 2
» cardAddressLine3 body string false Payment card address line 3
» cardAddressLine4 body string false Payment card address line 4
» cardPostalCode body string false Payment card postal code
» cardTokenize body boolean false Save token for payment card
» cardTokenAlias body string false Alias for payment card token
» otp body string false OneTimePasscode associated with the member's external user profile data. eg. Amazon/Avios user profile data

Example responses

200 Response

{
  "code": 0,
  "message": "string",
  "details": null
}

Responses

Status Meaning Description Schema
200 OK Payment success standardModel
400 Bad Request Invalid request errorModel
403 Forbidden Access to the resource has been denied errorModel
404 Not Found Payment card is not found errorModel
500 Internal Server Error Internal error standardModel

Verify 3D Secure on a payment card

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'multipart/form-data',
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.rewardgateway.net/checkout/verify3ds', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST https://api.rewardgateway.net/checkout/verify3ds HTTP/1.1
Host: api.rewardgateway.net
Content-Type: multipart/form-data
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X POST https://api.rewardgateway.net/checkout/verify3ds \
  -H 'Content-Type: multipart/form-data' \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'

const inputBody = '{
  "basketId": "string",
  "paRes": "string",
  "md": "string"
}';
const headers = {
  'Content-Type':'multipart/form-data',
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/checkout/verify3ds',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /checkout/verify3ds

Verify 3D Secure on a payment card

Body parameter

basketId: string
paRes: string
md: string

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
body body object true none
» basketId body string true Basket identifier
» paRes body string true Payment authentication result
» md body string true Merchant data

Example responses

200 Response

{
  "code": 0,
  "message": "string",
  "details": null
}

Responses

Status Meaning Description Schema
200 OK Payment successful standardModel
400 Bad Request Invalid request errorModel
403 Forbidden Access to the resource has been denied errorModel
404 Not Found Payment not found errorModel
500 Internal Server Error Internal error standardModel

Get a list of offers

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/offer', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/offer?retailer=0 HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/offer?retailer=0 \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/offer?retailer=0',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /offer

This endpoint returns a list of offers available based on the filter criteria

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
retailer query integer true Value must be a valid retailer identifier
type query string false Value must be comma-separated combination of 'sms', 'evoucher', 'egiftcard', cashback', 'instant', 'instore', 'online', 'topup', 'easysaver'

Example responses

200 Response

[
  {
    "id": 0,
    "typeId": 0,
    "typeName": "string",
    "trackingType": "string",
    "offerDescription": "string",
    "discountRateTitles": [
      "string"
    ],
    "discountRate": "string",
    "discountRatePrefix": "string",
    "discountType": "string",
    "discountValue": 0.1,
    "discountDescription": "string",
    "discountFullTitle": "string",
    "discountNormal": "string",
    "canBeUsedOnline": true,
    "canBeUsedInstore": true,
    "redeemableOnDesktop": true,
    "redeemableOnMobile": true,
    "keyInformation": "string",
    "howItWorks": "string",
    "termsAndConditions": "string",
    "isSpecialOffer": true,
    "isExpiring": true,
    "expiryDate": "string",
    "buttons": [
      {
        "productId": 0,
        "title": "string",
        "handoverUrl": "string",
        "product": null,
        "extras": [
          null
        ],
        "primaryUrl": "string"
      }
    ],
    "additionalInformation": [
      {
        "imageURL": "string",
        "title": "string",
        "description": "string"
      }
    ]
  }
]

Responses

Status Meaning Description Schema
200 OK Successful operation Inline
400 Bad Request Invalid request errorModel
403 Forbidden Access to the resource has been denied errorModel
404 Not Found Retailer is not found errorModel

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [offer] false none none
» id integer true none Offer identifier
» typeId integer true none Offer type identifier
» typeName string true none Offer type name
» trackingType string true none Offer tracking type
» offerDescription string true none Offer description
» discountRateTitles [string] true none Discount rate prefixes
» discountRate string true none Discount rate
» discountRatePrefix string true none Discount rate prefix
» discountType string true none Discount type
» discountValue number(float) true none Discount value
» discountDescription string true none Discount description
» discountFullTitle string true none Discount full title
» discountNormal string true none Normal discount rate
» canBeUsedOnline boolean true none Can be used online?
» canBeUsedInstore boolean true none Can be used instore?
» redeemableOnDesktop boolean true none Is redeemable on desktop?
» redeemableOnMobile boolean true none Is redeemable on mobile?
» keyInformation string true none Key Information about the offer
» howItWorks string true none How the Offer works
» termsAndConditions string true none Terms and conditions
» isSpecialOffer boolean true none Is this a special offer?
» isExpiring boolean true none Is the offer expiring?
» expiryDate string true none Expiry date
» buttons [offerButton] true none Offer buttons
»» productId integer true none Product identifier
»» title string true none Button title
»» handoverUrl string false none Handover URL
»» product any false none Product entity
»» extras [any] false none Code
»» primaryUrl string false none The offer's retailer primary domain URL
» additionalInformation [info] true none Additional Information about the offer
»» imageURL string false none Url to an image
»» title string true none Title
»» description string false none Description

Get an offer by id

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/offer/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/offer/{id} HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/offer/{id} \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/offer/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /offer/{id}

This endpoint returns information about a specific offer.

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
id path integer true Offer identifier

Example responses

200 Response

{
  "id": 0,
  "typeId": 0,
  "typeName": "string",
  "trackingType": "string",
  "offerDescription": "string",
  "discountRateTitles": [
    "string"
  ],
  "discountRate": "string",
  "discountRatePrefix": "string",
  "discountType": "string",
  "discountValue": 0.1,
  "discountDescription": "string",
  "discountFullTitle": "string",
  "discountNormal": "string",
  "canBeUsedOnline": true,
  "canBeUsedInstore": true,
  "redeemableOnDesktop": true,
  "redeemableOnMobile": true,
  "keyInformation": "string",
  "howItWorks": "string",
  "termsAndConditions": "string",
  "isSpecialOffer": true,
  "isExpiring": true,
  "expiryDate": "string",
  "buttons": [
    {
      "productId": 0,
      "title": "string",
      "handoverUrl": "string",
      "product": null,
      "extras": [
        null
      ],
      "primaryUrl": "string"
    }
  ],
  "additionalInformation": [
    {
      "imageURL": "string",
      "title": "string",
      "description": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Successful operation offer
403 Forbidden Access to the resource has been denied errorModel
404 Not Found Offer is not found errorModel

Get tracking token for cashback

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'multipart/form-data',
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.rewardgateway.net/offer/starttracking', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST https://api.rewardgateway.net/offer/starttracking HTTP/1.1
Host: api.rewardgateway.net
Content-Type: multipart/form-data
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X POST https://api.rewardgateway.net/offer/starttracking \
  -H 'Content-Type: multipart/form-data' \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'

const inputBody = '{
  "offerId": 0
}';
const headers = {
  'Content-Type':'multipart/form-data',
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/offer/starttracking',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /offer/starttracking

This endpoint generates and returns a new token for cashback tracking

Body parameter

offerId: 0

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
body body object true none
» offerId body integer false Offer identifier

Example responses

200 Response

{
  "trackingId": "string",
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Successful operation Inline
403 Forbidden Access to the resource has been denied errorModel
404 Not Found Offer is not found errorModel

Response Schema

Status Code 200

Name Type Required Restrictions Description
» trackingId string true none none
» message string true none none

List most recent orders

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/order', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/order?type=string HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/order?type=string \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/order?type=string',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /order

This endpoint will return a list of most recent orders for the current member

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
type query string true Value must be one of 'instant', 'all'
page query integer false Offset the number of results returned
limit query integer false Constrain the number of results returned

Example responses

200 Response

[
  {
    "id": 0,
    "date": "string",
    "email": "string",
    "telephone": "string",
    "shippingAddress": "string",
    "amount": 0.1,
    "paid": 0.1,
    "items": [
      {
        "date": "string",
        "logo": "string",
        "name": "string",
        "status": "string",
        "quantity": 0,
        "amount": 0.1,
        "paid": 0.1,
        "vouchers": [
          {
            "transactionId": 0,
            "entityId": 0,
            "date": "string",
            "logo": "string",
            "name": "string",
            "type": "Paper",
            "denomination": 0.1,
            "redeemed": true,
            "archived": true,
            "refundable": true,
            "currency": "string"
          }
        ],
        "instrumentId": 0,
        "product": {
          "id": 0,
          "name": "string",
          "price": 0.1,
          "type": "Paper",
          "typeId": 0,
          "visibility": [
            "string"
          ],
          "stockCode": "string",
          "stockStatus": "string",
          "statusMessage": "string",
          "retailer": "string",
          "printingRequired": true,
          "minimumOrder": 0.1,
          "maximumOrder": 0.1,
          "denominations": [
            0
          ],
          "related": {},
          "instant": true,
          "maxLimit": 0
        }
      }
    ],
    "messages": [
      "string"
    ]
  }
]

Responses

Status Meaning Description Schema
200 OK Successful operation Inline
400 Bad Request Invalid request errorModel
403 Forbidden Access to the resource has been denied errorModel

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [order] false none none
» id integer true none Order identifier
» date string true none Order date
» email string true none Order email address
» telephone string true none Order telephone number
» shippingAddress string true none Order shipping address
» amount number(float) true none Order amount
» paid number(float) true none Order paid
» items [orderItem] false none Order items
»» date string true none Order date
»» logo string true none Order item logo
»» name string true none Order item name
»» status string false none Order item status
»» quantity integer false none Order item quantity
»» amount number(float) true none Order item amount
»» paid number(float) true none Order item paid
»» vouchers [minimalVoucher] true none Order item Vouchers
»»» transactionId integer true none Voucher transaction identifier
»»» entityId integer true none Voucher entity identifier
»»» date string true none Voucher purchase date (from Order)
»»» logo string true none Voucher logo (from product/retailer)
»»» name string true none Voucher name (from product)
»»» type string true none Voucher product type
»»» denomination number(float) true none Voucher denomination
»»» redeemed boolean true none Voucher redemption status
»»» archived boolean true none Voucher archival status
»»» refundable boolean false none Is the voucher refundable
»»» currency string false none Currency
»» instrumentId integer false none Instrument identifier
»» product product true none none
»»» id integer true none Product identifier
»»» name string true none Product name
»»» price number(float) true none Product price
»»» type string true none Product type
»»» typeId integer true none Product type id
»»» visibility [string] true none Product visibility
»»» stockCode string true none Product stock code
»»» stockStatus string true none Product stock status
»»» statusMessage string true none Product status message
»»» retailer string false none Product retailer`s name
»»» printingRequired boolean true none Product requires printing
»»» minimumOrder number(float) true none Product minimum order amount
»»» maximumOrder number(float) true none Product maximum order amount
»»» denominations [number] true none Product denominations
»»» related product false none none
»»» instant boolean false none Is product instant (Available only for Top Up Product)
»»» maxLimit integer false none Max Card Limit (Available only for Top Up Card Product)
» messages [string] false none Order messages

Enumerated Values

Property Value
type Paper
type Electronic
type Card
type Topup
type SMS
type EGiftCard
type Paper
type Electronic
type Card
type Topup
type SMS
type EGiftCard

Get an order by id

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/order/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/order/{id} HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/order/{id} \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/order/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /order/{id}

This endpoint will return information about a specific order

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
id path integer true Order Reference'

Example responses

200 Response

{
  "id": 0,
  "date": "string",
  "email": "string",
  "telephone": "string",
  "shippingAddress": "string",
  "amount": 0.1,
  "paid": 0.1,
  "items": [
    {
      "date": "string",
      "logo": "string",
      "name": "string",
      "status": "string",
      "quantity": 0,
      "amount": 0.1,
      "paid": 0.1,
      "vouchers": [
        {
          "transactionId": 0,
          "entityId": 0,
          "date": "string",
          "logo": "string",
          "name": "string",
          "type": "Paper",
          "denomination": 0.1,
          "redeemed": true,
          "archived": true,
          "refundable": true,
          "currency": "string"
        }
      ],
      "instrumentId": 0,
      "product": {
        "id": 0,
        "name": "string",
        "price": 0.1,
        "type": "Paper",
        "typeId": 0,
        "visibility": [
          "string"
        ],
        "stockCode": "string",
        "stockStatus": "string",
        "statusMessage": "string",
        "retailer": "string",
        "printingRequired": true,
        "minimumOrder": 0.1,
        "maximumOrder": 0.1,
        "denominations": [
          0
        ],
        "related": {},
        "instant": true,
        "maxLimit": 0
      }
    }
  ],
  "messages": [
    "string"
  ]
}

Responses

Status Meaning Description Schema
200 OK Successful operation order
403 Forbidden Access to the resource has been denied errorModel
404 Not Found Order was not found errorModel

Apply decision to the queued order

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.rewardgateway.net/decision', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST https://api.rewardgateway.net/decision HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X POST https://api.rewardgateway.net/decision \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/decision',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /decision

This endpoint will approve or reject an order that is in the fraud queue

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning

Example responses

200 Response

{
  "id": 0,
  "date": "string",
  "email": "string",
  "telephone": "string",
  "shippingAddress": "string",
  "amount": 0.1,
  "paid": 0.1,
  "items": [
    {
      "date": "string",
      "logo": "string",
      "name": "string",
      "status": "string",
      "quantity": 0,
      "amount": 0.1,
      "paid": 0.1,
      "vouchers": [
        {
          "transactionId": 0,
          "entityId": 0,
          "date": "string",
          "logo": "string",
          "name": "string",
          "type": "Paper",
          "denomination": 0.1,
          "redeemed": true,
          "archived": true,
          "refundable": true,
          "currency": "string"
        }
      ],
      "instrumentId": 0,
      "product": {
        "id": 0,
        "name": "string",
        "price": 0.1,
        "type": "Paper",
        "typeId": 0,
        "visibility": [
          "string"
        ],
        "stockCode": "string",
        "stockStatus": "string",
        "statusMessage": "string",
        "retailer": "string",
        "printingRequired": true,
        "minimumOrder": 0.1,
        "maximumOrder": 0.1,
        "denominations": [
          0
        ],
        "related": {},
        "instant": true,
        "maxLimit": 0
      }
    }
  ],
  "messages": [
    "string"
  ]
}

Responses

Status Meaning Description Schema
200 OK Successful operation order
403 Forbidden Access to the resource has been denied errorModel
404 Not Found Order was not found errorModel

Get a product by id

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/product/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/product/{id} HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/product/{id} \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/product/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /product/{id}

This endpoint will return information about a particular product

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
id path integer true Product Identifier'

Example responses

200 Response

{
  "id": 0,
  "name": "string",
  "price": 0.1,
  "type": "Paper",
  "typeId": 0,
  "visibility": [
    "string"
  ],
  "stockCode": "string",
  "stockStatus": "string",
  "statusMessage": "string",
  "retailer": "string",
  "printingRequired": true,
  "minimumOrder": 0.1,
  "maximumOrder": 0.1,
  "denominations": [
    0
  ],
  "related": {
    "id": 0,
    "name": "string",
    "price": 0.1,
    "type": "Paper",
    "typeId": 0,
    "visibility": [
      "string"
    ],
    "stockCode": "string",
    "stockStatus": "string",
    "statusMessage": "string",
    "retailer": "string",
    "printingRequired": true,
    "minimumOrder": 0.1,
    "maximumOrder": 0.1,
    "denominations": [
      0
    ],
    "related": {},
    "instant": true,
    "maxLimit": 0
  },
  "instant": true,
  "maxLimit": 0
}

Responses

Status Meaning Description Schema
200 OK Successful operation product
403 Forbidden Access to the resource has been denied errorModel
404 Not Found Product was not found errorModel

Get a list of reloadable cards

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/reloadable', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/reloadable HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/reloadable \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/reloadable',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /reloadable

This endpoint returns a list of reloadable cards based on the filter criteria

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
active query boolean false Filter results by activated status
productId query integer false Filter results by product
sortBy query string false Order results by specific criteria. eg. created, activated

Example responses

200 Response

[
  {
    "id": 0,
    "name": "string",
    "alias": "string",
    "image": "string",
    "pan": "string",
    "offer": {
      "id": 0,
      "typeId": 0,
      "typeName": "string",
      "trackingType": "string",
      "offerDescription": "string",
      "discountRateTitles": [
        "string"
      ],
      "discountRate": "string",
      "discountRatePrefix": "string",
      "discountType": "string",
      "discountValue": 0.1,
      "discountDescription": "string",
      "discountFullTitle": "string",
      "discountNormal": "string",
      "canBeUsedOnline": true,
      "canBeUsedInstore": true,
      "redeemableOnDesktop": true,
      "redeemableOnMobile": true,
      "keyInformation": "string",
      "howItWorks": "string",
      "termsAndConditions": "string",
      "isSpecialOffer": true,
      "isExpiring": true,
      "expiryDate": "string",
      "buttons": [
        {
          "productId": 0,
          "title": "string",
          "handoverUrl": "string",
          "product": null,
          "extras": [
            null
          ],
          "primaryUrl": "string"
        }
      ],
      "additionalInformation": [
        {
          "imageURL": "string",
          "title": "string",
          "description": "string"
        }
      ]
    },
    "pendingAmount": "string",
    "activated": true,
    "expiryDate": "string",
    "expiryAction": "string",
    "expiryMessage": "string"
  }
]

Responses

Status Meaning Description Schema
200 OK Successful operation Inline
400 Bad Request Invalid request errorModel
403 Forbidden Access to the resource has been denied errorModel
404 Not Found Product was not found errorModel

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [reloadableCard] false none none
» id integer true none Reloadable card identifier
» name string true none Reloadable card name
» alias string true none Reloadable card alias
» image string true none Reloadable card image
» pan string true none Reloadable card PAN
» offer offer true none none
»» id integer true none Offer identifier
»» typeId integer true none Offer type identifier
»» typeName string true none Offer type name
»» trackingType string true none Offer tracking type
»» offerDescription string true none Offer description
»» discountRateTitles [string] true none Discount rate prefixes
»» discountRate string true none Discount rate
»» discountRatePrefix string true none Discount rate prefix
»» discountType string true none Discount type
»» discountValue number(float) true none Discount value
»» discountDescription string true none Discount description
»» discountFullTitle string true none Discount full title
»» discountNormal string true none Normal discount rate
»» canBeUsedOnline boolean true none Can be used online?
»» canBeUsedInstore boolean true none Can be used instore?
»» redeemableOnDesktop boolean true none Is redeemable on desktop?
»» redeemableOnMobile boolean true none Is redeemable on mobile?
»» keyInformation string true none Key Information about the offer
»» howItWorks string true none How the Offer works
»» termsAndConditions string true none Terms and conditions
»» isSpecialOffer boolean true none Is this a special offer?
»» isExpiring boolean true none Is the offer expiring?
»» expiryDate string true none Expiry date
»» buttons [offerButton] true none Offer buttons
»»» productId integer true none Product identifier
»»» title string true none Button title
»»» handoverUrl string false none Handover URL
»»» product any false none Product entity
»»» extras [any] false none Code
»»» primaryUrl string false none The offer's retailer primary domain URL
»» additionalInformation [info] true none Additional Information about the offer
»»» imageURL string false none Url to an image
»»» title string true none Title
»»» description string false none Description
» pendingAmount string true none Reloadable card pending amount
» activated boolean false none Activated
» expiryDate string false none Reloadable card expiry date
» expiryAction string false none Reloadable ES card expiry action
» expiryMessage string false none Reloadable ES card message if card is expiring

Get a reloadable card by id

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/reloadable/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/reloadable/{id} HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/reloadable/{id} \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/reloadable/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /reloadable/{id}

This endpoint returns information about a particular reloadable card

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
id path integer true Reloadable card identifier

Example responses

200 Response

{
  "id": 0,
  "name": "string",
  "alias": "string",
  "image": "string",
  "pan": "string",
  "offer": {
    "id": 0,
    "typeId": 0,
    "typeName": "string",
    "trackingType": "string",
    "offerDescription": "string",
    "discountRateTitles": [
      "string"
    ],
    "discountRate": "string",
    "discountRatePrefix": "string",
    "discountType": "string",
    "discountValue": 0.1,
    "discountDescription": "string",
    "discountFullTitle": "string",
    "discountNormal": "string",
    "canBeUsedOnline": true,
    "canBeUsedInstore": true,
    "redeemableOnDesktop": true,
    "redeemableOnMobile": true,
    "keyInformation": "string",
    "howItWorks": "string",
    "termsAndConditions": "string",
    "isSpecialOffer": true,
    "isExpiring": true,
    "expiryDate": "string",
    "buttons": [
      {
        "productId": 0,
        "title": "string",
        "handoverUrl": "string",
        "product": null,
        "extras": [
          null
        ],
        "primaryUrl": "string"
      }
    ],
    "additionalInformation": [
      {
        "imageURL": "string",
        "title": "string",
        "description": "string"
      }
    ]
  },
  "pendingAmount": "string",
  "activated": true,
  "expiryDate": "string",
  "expiryAction": "string",
  "expiryMessage": "string"
}

Responses

Status Meaning Description Schema
200 OK Successful operation reloadableCard
400 Bad Request Invalid request errorModel
403 Forbidden Access to the resource has been denied errorModel
404 Not Found Reloadable card was not found errorModel

Remove a reloadable card

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://api.rewardgateway.net/reloadable/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

DELETE https://api.rewardgateway.net/reloadable/{id} HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X DELETE https://api.rewardgateway.net/reloadable/{id} \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/reloadable/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /reloadable/{id}

This endpoint will remove a member's reloadable card

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
id path integer true Reloadable card identifier

Example responses

204 Response

"string"

Responses

Status Meaning Description Schema
204 No Content Successful operation string
403 Forbidden Access to the resource has been denied errorModel
404 Not Found Reloadable card was not found errorModel

Get a reloadable card's balance by id

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/reloadable/balance/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/reloadable/balance/{id} HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/reloadable/balance/{id} \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/reloadable/balance/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /reloadable/balance/{id}

This endpoint will return information about the balance on a reloadable card

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
id path integer true Reloadable card identifier

Example responses

200 Response

{
  "type": "string",
  "link": "string",
  "balance": "string"
}

Responses

Status Meaning Description Schema
200 OK Successful operation Inline
400 Bad Request Invalid request errorModel
403 Forbidden Access to the resource has been denied errorModel
404 Not Found Reloadable card was not found errorModel

Response Schema

Status Code 200

Name Type Required Restrictions Description
» type string true none none
» link string true none none
» balance string true none none

Get a reloadable card's activation form by id

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/reloadable/{id}/activate', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/reloadable/{id}/activate HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/reloadable/{id}/activate \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/reloadable/{id}/activate',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /reloadable/{id}/activate

This endpoint will return reloadable card activation form fields

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
id path integer true Reloadable card identifier

Example responses

200 Response

{
  "activationBalanceText": "string",
  "activationText": "string",
  "activationMessage": "string",
  "fields": [
    {
      "name": "string",
      "type": "string",
      "label": "string",
      "value": "string",
      "help": "string",
      "info": [
        {
          "imageURL": "string",
          "title": "string",
          "description": "string"
        }
      ],
      "options": [
        "string"
      ],
      "validators": [
        {
          "value": null,
          "type": "string",
          "message": "string"
        }
      ]
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Successful operation Inline
400 Bad Request Invalid request errorModel
403 Forbidden Access to the resource has been denied errorModel
404 Not Found Reloadable card was not found errorModel

Response Schema

Status Code 200

Name Type Required Restrictions Description
» activationBalanceText string true none none
» activationText string true none none
» activationMessage string true none none
» fields [formField] true none none
»» name string true none Field name
»» type string true none Field Type
»» label string true none Field Label
»» value string false none Field value
»» help string false none Field help text
»» info [info] false none Additional Field info
»»» imageURL string false none Url to an image
»»» title string true none Title
»»» description string false none Description
»» options [string] false none Field options
»» validators [fieldValidation] true none Field Validators
»»» value any true none Validate against value
»»» type string true none Validation Type
»»» message string true none Validation message

Activate a reloadable card by id

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.rewardgateway.net/reloadable/{id}/activate', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST https://api.rewardgateway.net/reloadable/{id}/activate HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X POST https://api.rewardgateway.net/reloadable/{id}/activate \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/reloadable/{id}/activate',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /reloadable/{id}/activate

This endpoint will activate a reloadable card by id, or returns appropriate error messages

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
id path integer true Reloadable card identifier

Example responses

200 Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Successful operation errorModel
400 Bad Request Invalid request formErrorResponse
403 Forbidden Access to the resource has been denied errorModel
404 Not Found Reloadable card was not found errorModel

Fetch the EasySaver card replace form fields

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/reloadable/{id}/replace', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/reloadable/{id}/replace HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/reloadable/{id}/replace \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/reloadable/{id}/replace',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /reloadable/{id}/replace

Retrieves the fields and their validation for replacing an EasySaver card

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
id path integer true Reloadable card identifier

Example responses

400 Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Successful operation None
400 Bad Request Invalid request errorModel
403 Forbidden Access to the resource has been denied errorModel
404 Not Found Reloadable card was not found errorModel

Request to replace an EasySaver card

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'multipart/form-data',
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.rewardgateway.net/reloadable/{id}/replace', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST https://api.rewardgateway.net/reloadable/{id}/replace HTTP/1.1
Host: api.rewardgateway.net
Content-Type: multipart/form-data
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X POST https://api.rewardgateway.net/reloadable/{id}/replace \
  -H 'Content-Type: multipart/form-data' \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'

const inputBody = '{
  "sField672": "string",
  "sField682": "string",
  "sField692": "string",
  "sField712": "string",
  "sField732": "string",
  "sField742": "string",
  "sField752": "string",
  "sField652": "string"
}';
const headers = {
  'Content-Type':'multipart/form-data',
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/reloadable/{id}/replace',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /reloadable/{id}/replace

Submit a request for replacing an EasySaver card

Body parameter

sField672: string
sField682: string
sField692: string
sField712: string
sField732: string
sField742: string
sField752: string
sField652: string

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
id path integer true Reloadable card identifier
body body object true none
» sField672 body string false Title
» sField682 body string false Name
» sField692 body string false Surname
» sField712 body string false Street
» sField732 body string false City
» sField742 body string false County
» sField752 body string false Postal code
» sField652 body string false Phone number

Example responses

200 Response

{
  "code": 0,
  "message": "string",
  "details": null
}

Responses

Status Meaning Description Schema
200 OK The request for replacing the card was successful. standardModel
400 Bad Request Invalid request errorModel
403 Forbidden Access to the resource has been denied errorModel
404 Not Found Product was not found errorModel

Fetch the EasySaver card transfer form fields

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/reloadable/{id}/transfer', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/reloadable/{id}/transfer HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/reloadable/{id}/transfer \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/reloadable/{id}/transfer',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /reloadable/{id}/transfer

Retrieves the fields and their validation for transfer and activation for the EasySaver card

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
id path integer true Reloadable card identifier

Example responses

400 Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Successful operation None
400 Bad Request Invalid request errorModel
403 Forbidden Access to the resource has been denied errorModel
404 Not Found Reloadable card was not found errorModel

Transfer balance and activate an EasySaver card

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'multipart/form-data',
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.rewardgateway.net/reloadable/{id}/transfer', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST https://api.rewardgateway.net/reloadable/{id}/transfer HTTP/1.1
Host: api.rewardgateway.net
Content-Type: multipart/form-data
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X POST https://api.rewardgateway.net/reloadable/{id}/transfer \
  -H 'Content-Type: multipart/form-data' \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'

const inputBody = '{
  "sCardName": "string",
  "sField632": "string",
  "sCardNumberRepeat": "string",
  "sField642": "string",
  "sField832": "string",
  "sField702": "string",
  "sField672": "string",
  "sField682": "string",
  "sField692": "string",
  "sField712": "string",
  "sField732": "string",
  "sField742": "string",
  "sField752": "string",
  "sField652": "string"
}';
const headers = {
  'Content-Type':'multipart/form-data',
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/reloadable/{id}/transfer',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /reloadable/{id}/transfer

Transfer the balance from the old card and activate the new EasySaver card

Body parameter

sCardName: string
sField632: string
sCardNumberRepeat: string
sField642: string
sField832: string
sField702: string
sField672: string
sField682: string
sField692: string
sField712: string
sField732: string
sField742: string
sField752: string
sField652: string

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
id path integer true Reloadable card identifier
body body object true none
» sCardName body string false Card name or alias
» sField632 body string false Card number
» sCardNumberRepeat body string false Card number repeat
» sField642 body string false PIN
» sField832 body string false Expiry date
» sField702 body string false Email address
» sField672 body string false Title
» sField682 body string false Name
» sField692 body string false Surname
» sField712 body string false Street
» sField732 body string false City
» sField742 body string false County
» sField752 body string false Postal code
» sField652 body string false Phone number

Example responses

200 Response

{
  "code": 0,
  "message": "string",
  "details": null
}

Responses

Status Meaning Description Schema
200 OK The request for replacing the card was successful. standardModel
400 Bad Request Invalid request errorModel
403 Forbidden Access to the resource has been denied errorModel
404 Not Found Product was not found errorModel

Get a list of retailers

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/retailer', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/retailer HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/retailer \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/retailer',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /retailer

This endpoint returns a list of retailers based on the filter criteria

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
type query string false Value must be one of 'tracking', 'keyword'
q query string false Search query for the type field
category query string false Filter by category (only used with type='tracking')
offer_type query string false Value must be comma-separated combination of 'evoucher', 'egiftcard', cashback', 'instant', 'instore', 'online', 'topup', 'easysaver'
page query integer false Offset the number of results returned
limit query integer false Constraint the number of results returned

Example responses

200 Response

[
  {
    "id": 0,
    "name": "string",
    "description": "string",
    "logo": "string",
    "banner": "string",
    "bestOffer": "string",
    "canBeUsedOnline": true,
    "canBeUsedInstore": true,
    "isFavourite": true,
    "canBeUsedAt": "string",
    "availableOffers": 0,
    "isFeatured": true
  }
]

Responses

Status Meaning Description Schema
200 OK Successful operation Inline
400 Bad Request Invalid request errorModel
403 Forbidden Access to the resource has been denied errorModel

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [retailer] false none none
» id integer true none Retailer identifier
» name string true none Retailer name
» description string true none Retailer Description
» logo string true none Retailer logo
» banner string false none Retailer banner
» bestOffer string true none Best offer description
» canBeUsedOnline boolean false none Can be used online?
» canBeUsedInstore boolean false none Can be used instore?
» isFavourite boolean false none Is it favourite retailer
» canBeUsedAt string false none Offers bought here can be used at
» availableOffers integer false none Available offers for the retailer
» isFeatured boolean false none Is it a featured retailer

Get all retailer categories

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/retailer/categories', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/retailer/categories HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/retailer/categories \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/retailer/categories',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /retailer/categories

This endpoint returns a list of all retailer categories

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning

Example responses

200 Response

[
  {
    "id": 0,
    "parentId": 0,
    "name": "string",
    "weight": 0,
    "version": 0,
    "retailerCount": 0
  }
]

Responses

Status Meaning Description Schema
200 OK Successful operation Inline
403 Forbidden Access to the resource has been denied errorModel
404 Not Found Retailer is not found errorModel

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [retailerCategory] false none none
» id integer true none Category identifier
» parentId integer true none Parent category identifier
» name string true none Category name
» weight integer true none Category weight
» version integer true none Category version
» retailerCount integer true none Category retailers count

Get all favourite retailers

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/retailer/favourites', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/retailer/favourites HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/retailer/favourites \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/retailer/favourites',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /retailer/favourites

This endpoint returns a list of favourite retailers for the current member.

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning

Example responses

200 Response

[
  {
    "id": 0,
    "name": "string",
    "description": "string",
    "logo": "string",
    "banner": "string",
    "bestOffer": "string",
    "canBeUsedOnline": true,
    "canBeUsedInstore": true,
    "isFavourite": true,
    "canBeUsedAt": "string",
    "availableOffers": 0,
    "isFeatured": true
  }
]

Responses

Status Meaning Description Schema
200 OK Successful operation Inline
403 Forbidden Access to the resource has been denied errorModel
404 Not Found Retailer is not found errorModel

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [retailer] false none none
» id integer true none Retailer identifier
» name string true none Retailer name
» description string true none Retailer Description
» logo string true none Retailer logo
» banner string false none Retailer banner
» bestOffer string true none Best offer description
» canBeUsedOnline boolean false none Can be used online?
» canBeUsedInstore boolean false none Can be used instore?
» isFavourite boolean false none Is it favourite retailer
» canBeUsedAt string false none Offers bought here can be used at
» availableOffers integer false none Available offers for the retailer
» isFeatured boolean false none Is it a featured retailer

Set retailer as favourite or remove it from favourites

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'multipart/form-data',
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.rewardgateway.net/retailer/favourites/toggleFavourite', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST https://api.rewardgateway.net/retailer/favourites/toggleFavourite HTTP/1.1
Host: api.rewardgateway.net
Content-Type: multipart/form-data
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X POST https://api.rewardgateway.net/retailer/favourites/toggleFavourite \
  -H 'Content-Type: multipart/form-data' \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'

const inputBody = '{
  "retailerId": 0,
  "isFavourite": 0
}';
const headers = {
  'Content-Type':'multipart/form-data',
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/retailer/favourites/toggleFavourite',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /retailer/favourites/toggleFavourite

This endpoint will add or remove a retailer as favourite from the current member's account

Body parameter

retailerId: 0
isFavourite: 0

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
body body object false none
» retailerId body integer true Valid retailerId
» isFavourite body integer true 1 to add and 0 to remove the retailer from favourites

Example responses

200 Response

{
  "status": "string",
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Successful operation Inline
403 Forbidden Access to the resource has been denied errorModel
404 Not Found Retailer is not found errorModel

Response Schema

Status Code 200

Name Type Required Restrictions Description
» status string true none none
» message string true none none

Get all retailers' promotions

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/retailer/promotions', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/retailer/promotions HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/retailer/promotions \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/retailer/promotions',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /retailer/promotions

This endpoint returns any deals and top offers from retailers

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
offer_type query string false Value must be comma-separated combination of 'evoucher', 'egiftcard', cashback', 'instant', 'instore', 'online'

Example responses

200 Response

[
  {
    "name": "string",
    "items": [
      {
        "id": 0,
        "name": "string",
        "description": "string",
        "logo": "string",
        "banner": "string",
        "bestOffer": "string",
        "canBeUsedOnline": true,
        "canBeUsedInstore": true,
        "isFavourite": true,
        "canBeUsedAt": "string",
        "availableOffers": 0,
        "isFeatured": true
      }
    ]
  }
]

Responses

Status Meaning Description Schema
200 OK Successful operation Inline
403 Forbidden Access to the resource has been denied errorModel
404 Not Found Retailer is not found errorModel

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [retailerPromotion] false none [Class RetailerPromotion]
» name string true none none
» items [retailer] true none none
»» id integer true none Retailer identifier
»» name string true none Retailer name
»» description string true none Retailer Description
»» logo string true none Retailer logo
»» banner string false none Retailer banner
»» bestOffer string true none Best offer description
»» canBeUsedOnline boolean false none Can be used online?
»» canBeUsedInstore boolean false none Can be used instore?
»» isFavourite boolean false none Is it favourite retailer
»» canBeUsedAt string false none Offers bought here can be used at
»» availableOffers integer false none Available offers for the retailer
»» isFeatured boolean false none Is it a featured retailer

Get a retailer's redirect URL

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/retailer/{id}/redirect', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/retailer/{id}/redirect HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/retailer/{id}/redirect \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/retailer/{id}/redirect',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /retailer/{id}/redirect

This endpoint returns the redirect URL for a particular retailer

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
id path integer true Retailer identifier

Example responses

200 Response

{
  "redirect": "https://vip.rewardgateway.co.uk/Merchant?m=1234"
}

Responses

Status Meaning Description Schema
200 OK Successful operation Inline
403 Forbidden Access to the resource has been denied errorModel
404 Not Found Retailer is not found errorModel

Response Schema

Status Code 200

Name Type Required Restrictions Description
» redirect string false none none

Get a retailer by id

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/retailer/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/retailer/{id} HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/retailer/{id} \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/retailer/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /retailer/{id}

This endpoint returns information about a particular retailer

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
id path integer true Retailer identifier

Example responses

200 Response

{
  "id": 0,
  "name": "string",
  "description": "string",
  "logo": "string",
  "banner": "string",
  "bestOffer": "string",
  "canBeUsedOnline": true,
  "canBeUsedInstore": true,
  "isFavourite": true,
  "canBeUsedAt": "string",
  "availableOffers": 0,
  "isFeatured": true
}

Responses

Status Meaning Description Schema
200 OK Successful operation retailer
403 Forbidden Access to the resource has been denied errorModel
404 Not Found Retailer is not found errorModel

Get all domain hashes.

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/retailer/domain/hashes', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/retailer/domain/hashes HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/retailer/domain/hashes \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/retailer/domain/hashes',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /retailer/domain/hashes

This endpoint returns a list of all SHA1 domain hashes that can be matched by calls.

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning

Example responses

200 Response

[
  null
]

Responses

Status Meaning Description Schema
200 OK Successful operation Inline
403 Forbidden Access to the resource has been denied errorModel

Response Schema

Get a retailer by a domain hash

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/retailer/domain/{hash}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/retailer/domain/{hash} HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/retailer/domain/{hash} \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/retailer/domain/{hash}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /retailer/domain/{hash}

This endpoint returns information about a particular retailer based on their domain.

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
hash path string true SHA-1 of retailer domain

Example responses

200 Response

[
  {
    "id": 0,
    "name": "string",
    "description": "string",
    "logo": "string",
    "banner": "string",
    "bestOffer": "string",
    "canBeUsedOnline": true,
    "canBeUsedInstore": true,
    "isFavourite": true,
    "canBeUsedAt": "string",
    "availableOffers": 0,
    "isFeatured": true
  }
]

Responses

Status Meaning Description Schema
200 OK Successful operation Inline
403 Forbidden Access to the resource has been denied errorModel

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [retailer] false none none
» id integer true none Retailer identifier
» name string true none Retailer name
» description string true none Retailer Description
» logo string true none Retailer logo
» banner string false none Retailer banner
» bestOffer string true none Best offer description
» canBeUsedOnline boolean false none Can be used online?
» canBeUsedInstore boolean false none Can be used instore?
» isFavourite boolean false none Is it favourite retailer
» canBeUsedAt string false none Offers bought here can be used at
» availableOffers integer false none Available offers for the retailer
» isFeatured boolean false none Is it a featured retailer

Total number of retailers

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/retailer/count', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/retailer/count HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/retailer/count \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/retailer/count',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /retailer/count

Return the total number of available retailers for a scheme

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning

Example responses

200 Response

[
  {
    "id": 0,
    "name": "string",
    "description": "string",
    "logo": "string",
    "banner": "string",
    "bestOffer": "string",
    "canBeUsedOnline": true,
    "canBeUsedInstore": true,
    "isFavourite": true,
    "canBeUsedAt": "string",
    "availableOffers": 0,
    "isFeatured": true
  }
]

Responses

Status Meaning Description Schema
200 OK Successful operation Inline
403 Forbidden Access to the resource has been denied errorModel

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [retailer] false none none
» id integer true none Retailer identifier
» name string true none Retailer name
» description string true none Retailer Description
» logo string true none Retailer logo
» banner string false none Retailer banner
» bestOffer string true none Best offer description
» canBeUsedOnline boolean false none Can be used online?
» canBeUsedInstore boolean false none Can be used instore?
» isFavourite boolean false none Is it favourite retailer
» canBeUsedAt string false none Offers bought here can be used at
» availableOffers integer false none Available offers for the retailer
» isFeatured boolean false none Is it a featured retailer

Get a list of vouchers

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/voucher', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/voucher HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/voucher \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/voucher',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /voucher

This endpoint returns a list of vouchers matching

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
retailer query integer false Filter results by retailer
fromDate query string false Filter results by date from
toDate query string false Filter results by date to
archived query boolean false Filter results by archival status
sort query string false Value must be one of 'retailer', 'date'
direction query string false Value must be one of 'asc', 'desc'
page query integer false Offset the number of results returned
limit query integer false Constraint the number of results returned

Example responses

200 Response

[
  {
    "transactionId": 0,
    "entityId": 0,
    "date": "string",
    "logo": "string",
    "name": "string",
    "type": "Paper",
    "denomination": 0.1,
    "redeemed": true,
    "archived": true,
    "refundable": true,
    "currency": "string"
  }
]

Responses

Status Meaning Description Schema
200 OK Successful operation Inline
400 Bad Request Invalid request errorModel
403 Forbidden Access to the resource has been denied errorModel

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [minimalVoucher] false none none
» transactionId integer true none Voucher transaction identifier
» entityId integer true none Voucher entity identifier
» date string true none Voucher purchase date (from Order)
» logo string true none Voucher logo (from product/retailer)
» name string true none Voucher name (from product)
» type string true none Voucher product type
» denomination number(float) true none Voucher denomination
» redeemed boolean true none Voucher redemption status
» archived boolean true none Voucher archival status
» refundable boolean false none Is the voucher refundable
» currency string false none Currency

Enumerated Values

Property Value
type Paper
type Electronic
type Card
type Topup
type SMS
type EGiftCard

Get a list of voucher retailers

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/voucher/retailers', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/voucher/retailers HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/voucher/retailers \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/voucher/retailers',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /voucher/retailers

This endpoint retuns a list of retailers the current member has vouchers for

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
q query integer false Filter results by partial retailer name

Example responses

200 Response

[
  {
    "id": 0,
    "name": "string"
  }
]

Responses

Status Meaning Description Schema
200 OK Successful operation Inline
400 Bad Request Invalid request errorModel
403 Forbidden Access to the resource has been denied errorModel

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [retailerMatch] false none none
» id integer(int32) true none none
» name string true none none

Get a voucher by id

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/voucher/{transactionId}/{entityId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/voucher/{transactionId}/{entityId} HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/voucher/{transactionId}/{entityId} \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/voucher/{transactionId}/{entityId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /voucher/{transactionId}/{entityId}

This endpoint returns information about a particular voucher

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
transactionId path integer true Voucher transaction identifier
entityId path integer true Voucher entity identifier

Example responses

200 Response

{
  "transactionId": 0,
  "entityId": 0,
  "type": "Paper",
  "denomination": 0.1,
  "pan": "string",
  "pin": "string",
  "barcode": "string",
  "url": "string",
  "issueDate": "string",
  "expiryDate": "string",
  "redemptionInstructions": "string",
  "cashierNotes": "string",
  "archived": true,
  "redeemed": true,
  "redeemOnline": true,
  "redeemOffline": true,
  "product": {
    "id": 0,
    "name": "string",
    "price": 0.1,
    "type": "Paper",
    "typeId": 0,
    "visibility": [
      "string"
    ],
    "stockCode": "string",
    "stockStatus": "string",
    "statusMessage": "string",
    "retailer": "string",
    "printingRequired": true,
    "minimumOrder": 0.1,
    "maximumOrder": 0.1,
    "denominations": [
      0
    ],
    "related": {},
    "instant": true,
    "maxLimit": 0
  },
  "balance": {
    "type": "string",
    "payload": [
      null
    ]
  },
  "refundable": true
}

Responses

Status Meaning Description Schema
200 OK Successful operation voucher
403 Forbidden Access to the resource has been denied errorModel
404 Not Found Voucher is not found errorModel

Get a voucher balance

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/voucher/balance/{transactionId}/{entityId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/voucher/balance/{transactionId}/{entityId} HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/voucher/balance/{transactionId}/{entityId} \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/voucher/balance/{transactionId}/{entityId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /voucher/balance/{transactionId}/{entityId}

This endpoint will return the balance for a specific voucher

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
transactionId path integer true Voucher transaction identifier
entityId path integer true Voucher entity identifier

Example responses

200 Response

{
  "type": "string",
  "payload": [
    null
  ]
}

Responses

Status Meaning Description Schema
200 OK Successful operation voucherBalance
403 Forbidden Access to the resource has been denied errorModel
404 Not Found Voucher is not found errorModel

Update voucher balance notes

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'multipart/form-data',
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.rewardgateway.net/voucher/balance/{transactionId}/{entityId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST https://api.rewardgateway.net/voucher/balance/{transactionId}/{entityId} HTTP/1.1
Host: api.rewardgateway.net
Content-Type: multipart/form-data
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X POST https://api.rewardgateway.net/voucher/balance/{transactionId}/{entityId} \
  -H 'Content-Type: multipart/form-data' \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'

const inputBody = '{
  "amount": "string"
}';
const headers = {
  'Content-Type':'multipart/form-data',
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/voucher/balance/{transactionId}/{entityId}',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /voucher/balance/{transactionId}/{entityId}

This endpoint will update the voucher balance notes for a specific voucher

Body parameter

amount: string

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
transactionId path integer true Voucher transaction identifier
entityId path integer true Voucher entity identifier
body body object false none
» amount body string true New amount balance

Example responses

403 Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
204 No Content Voucher balance updated successfully None
403 Forbidden Access to the resource has been denied errorModel
404 Not Found Voucher is not found errorModel
500 Internal Server Error Voucher balance could not be updated standardModel

Get a HTML voucher template by id

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/voucher/template/{transactionId}/{entityId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/voucher/template/{transactionId}/{entityId} HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/voucher/template/{transactionId}/{entityId} \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/voucher/template/{transactionId}/{entityId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /voucher/template/{transactionId}/{entityId}

This endpoint returns the approved HTML template for a voucher

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
transactionId path integer true Voucher transaction identifier
entityId path integer true Voucher entity identifier

Example responses

200 Response

{
  "html": "string"
}

Responses

Status Meaning Description Schema
200 OK Voucher template generated Inline
403 Forbidden Access to the resource has been denied errorModel
404 Not Found Voucher is not found errorModel
500 Internal Server Error Could not generate template errorModel

Response Schema

Status Code 200

Name Type Required Restrictions Description
» html string true none none

Archive a voucher by id

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.rewardgateway.net/voucher/archive/{transactionId}/{entityId}/{archive}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST https://api.rewardgateway.net/voucher/archive/{transactionId}/{entityId}/{archive} HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X POST https://api.rewardgateway.net/voucher/archive/{transactionId}/{entityId}/{archive} \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/voucher/archive/{transactionId}/{entityId}/{archive}',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /voucher/archive/{transactionId}/{entityId}/{archive}

This endpoint will archive a voucher based on an voucher id

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
transactionId path integer true Voucher transaction identifier
entityId path integer true Voucher entity identifier
archive path boolean true Archival status to apply

Example responses

403 Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
204 No Content Voucher archival status successfully changed None
403 Forbidden Access to the resource has been denied errorModel
404 Not Found Voucher is not found errorModel
500 Internal Server Error Could not generate template errorModel

Get all payment card information

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/wallet', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/wallet HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/wallet \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/wallet',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /wallet

This endpoint returns a list of saved payment cards for the current member

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
compartment query string false Credit card compartment. Value must be one of 'standard', 'randr', 'cashback', 'gym_discounts', 'all'

Example responses

200 Response

[
  {
    "id": "string",
    "alias": "string",
    "cardExpiry": "string",
    "cardPan": "string",
    "cardType": "string",
    "cardFee": 0.1,
    "isCreditCard": true,
    "isTrusted": true,
    "firstName": "string",
    "lastName": "string",
    "addressLine1": "string",
    "addressLine2": "string",
    "addressLine3": "string",
    "addressLine4": "string",
    "postalCode": "string",
    "country": "string",
    "subscriptionId": "string"
  }
]

Responses

Status Meaning Description Schema
200 OK Successful operation Inline
400 Bad Request Invalid request errorModel
403 Forbidden Access to the resource has been denied errorModel

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [paymentCard] false none none
» id string true none Payment card identifier
» alias string true none Payment card alias
» cardExpiry string true none Payment card expiry
» cardPan string true none Payment card PAN
» cardType string true none Payment card type
» cardFee number(float) true none Credit card fee
» isCreditCard boolean true none Is credit card?
» isTrusted boolean true none Is payment card trusted?
» firstName string true none Payment card billing first name
» lastName string true none Payment card billing last name
» addressLine1 string true none Payment card billing address line 1
» addressLine2 string true none Payment card billing address line 2
» addressLine3 string true none Payment card billing address line 3
» addressLine4 string true none Payment card billing address line 4
» postalCode string true none Payment card billing postal code
» country string true none Payment card billing address country
» subscriptionId string¦null true none Payment card token

Get a particular payment card information

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/wallet/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/wallet/{id} HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/wallet/{id} \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/wallet/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /wallet/{id}

This endpoint returns information about a particular payment card

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
id path string true Payment card identifier

Example responses

200 Response

{
  "id": "string",
  "alias": "string",
  "cardExpiry": "string",
  "cardPan": "string",
  "cardType": "string",
  "cardFee": 0.1,
  "isCreditCard": true,
  "isTrusted": true,
  "firstName": "string",
  "lastName": "string",
  "addressLine1": "string",
  "addressLine2": "string",
  "addressLine3": "string",
  "addressLine4": "string",
  "postalCode": "string",
  "country": "string",
  "subscriptionId": "string"
}

Responses

Status Meaning Description Schema
200 OK Successful operation paymentCard
403 Forbidden Access to the resource has been denied errorModel
404 Not Found Payment card is not found errorModel

Removes a payment card

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://api.rewardgateway.net/wallet/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

DELETE https://api.rewardgateway.net/wallet/{id} HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X DELETE https://api.rewardgateway.net/wallet/{id} \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/wallet/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /wallet/{id}

This endpoint will remove a particular payment card from a member wallet

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
id path integer true Payment card identifier

Example responses

204 Response

"string"

Responses

Status Meaning Description Schema
204 No Content Successful operation string
403 Forbidden Access to the resource has been denied errorModel
404 Not Found Payment card is not found errorModel

Verify a payment card

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'multipart/form-data',
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.rewardgateway.net/wallet/verify', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST https://api.rewardgateway.net/wallet/verify HTTP/1.1
Host: api.rewardgateway.net
Content-Type: multipart/form-data
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X POST https://api.rewardgateway.net/wallet/verify \
  -H 'Content-Type: multipart/form-data' \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'

const inputBody = '{
  "cardNumber": "string"
}';
const headers = {
  'Content-Type':'multipart/form-data',
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/wallet/verify',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /wallet/verify

This endpoint will verify the card number for a new payment card

Body parameter

cardNumber: string

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
body body object false none
» cardNumber body string true Payment card number

Example responses

200 Response

{
  "valid": true,
  "message": "string",
  "cardType": 0,
  "cardFee": 0.1,
  "isCreditCard": true,
  "hasIssueNumber": true
}

Responses

Status Meaning Description Schema
200 OK Card verification complete Inline
400 Bad Request Invalid request errorModel
403 Forbidden Access to the resource has been denied errorModel

Response Schema

Status Code 200

Name Type Required Restrictions Description
» valid boolean true none none
» message string true none none
» cardType integer(int32) true none none
» cardFee number(float) true none none
» isCreditCard boolean true none none
» hasIssueNumber boolean true none none

Recognition & Reward

Endpoints to manage recognition moments. i.e. Send recognition moments, view recognition moments, approve / reject recognition moments.

Get all non-monetary recognition moments

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/ecard', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/ecard HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/ecard \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/ecard',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /ecard

This endpoint will get all non-monetary recognition moments (eCards) for the current member.

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning

Example responses

200 Response

{}

Responses

Status Meaning Description Schema
200 OK Successful operation scheme
403 Forbidden Access to the resource has been denied errorModel
404 Not Found Scheme is not found errorModel

Send a non-monetary recognition moment

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'multipart/form-data',
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.rewardgateway.net/ecard', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST https://api.rewardgateway.net/ecard HTTP/1.1
Host: api.rewardgateway.net
Content-Type: multipart/form-data
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X POST https://api.rewardgateway.net/ecard \
  -H 'Content-Type: multipart/form-data' \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'

const inputBody = '{
  "cardId": 0,
  "categoryId": 0,
  "message": "string",
  "form": "string",
  "recipients": "string",
  "shared": 0
}';
const headers = {
  'Content-Type':'multipart/form-data',
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/ecard',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /ecard

This endpoint will send a non-monetary recognition moment (eCard) on behalf of the current user.

Body parameter

cardId: 0
categoryId: 0
message: string
form: string
recipients: string
shared: 0

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
body body object true none
» cardId body integer false eCard identifier
» categoryId body integer false Category identifier
» message body string false eCard message
» form body string false Request is send from [android,ios]
» recipients body string false List of recipients
» shared body integer false eCard is shared

Example responses

400 Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Successful operation None
400 Bad Request Bad request errorModel
403 Forbidden Access to the resource has been denied errorModel
404 Not Found Scheme is not found errorModel

List all recognition moments that require approval

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/nominations/pending/list', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/nominations/pending/list HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/nominations/pending/list \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/nominations/pending/list',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /nominations/pending/list

This endpoint will return a list of all recognition moments that require approval.

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning

Example responses

200 Response

[
  {
    "id": 0,
    "rrProgramId": 123,
    "rrProgramName": "string",
    "nominees": [
      {
        "id": "string",
        "fullName": "string"
      }
    ],
    "approvers": [
      {
        "id": 0,
        "contactId": 0,
        "fullName": "string",
        "firstName": "string",
        "lastName": "string",
        "registrationQuestions": "string",
        "avatarUrl": "string"
      }
    ],
    "nominator": [
      {
        "id": 0,
        "fullName": "string",
        "isMember": "string"
      }
    ],
    "date": "string",
    "formattedDate": "string",
    "award": [
      {
        "id": 0,
        "title": "string",
        "valueFullName": "string",
        "valueShortName": "string",
        "value": 0.1,
        "alternativeValues": [
          "string"
        ]
      }
    ],
    "awards": [
      {
        "id": 0,
        "title": "string",
        "valueFullName": "string",
        "valueShortName": "string",
        "value": 0.1,
        "alternativeValues": [
          "string"
        ]
      }
    ],
    "reasons": [
      {
        "id": 0,
        "question": "string",
        "answer": "string",
        "type": "string"
      }
    ],
    "editNominee": true,
    "editAwardMessage": true,
    "visibility": "string",
    "actionReason": [
      {
        "id": 0,
        "reason": "string",
        "approverFullName": "string"
      }
    ]
  }
]

Responses

Status Meaning Description Schema
200 OK Successful operation Inline
403 Forbidden Access to the resource has been denied errorModel
404 Not Found Resource is not found errorModel

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [nomination] false none none
» id integer true none Nomination identifier
» rrProgramId integer true none RR Scheme identifier
» rrProgramName string true none RR Program Name
» nominees [nominee] true none Nominee
»» id string true none Nominee Id
»» fullName string true none Full Name
» approvers [approver] true none Approvers
»» id integer true none LicenceId
»» contactId integer true none ContactId
»» fullName string true none Full Name
»» firstName string true none First Name
»» lastName string true none lastName
»» registrationQuestions string¦null true none registrationQuestions
»» avatarUrl string¦null true none avatarUrl
» nominator [nominator] true none Nominator
»» id integer true none Nominee Id
»» fullName string true none Full Name
»» isMember string false none Check if returned nominator is valid member or just placeholder with name.
» date string true none Date of the nomination
» formattedDate string true none Date of the nomination
» award [nominationAwardType] true none Nomination's Award
»» id integer true none Award Id
»» title string true none Title
»» valueFullName string true none Value Full Name
»» valueShortName string true none Value Short Name
»» value number(float) true none Award value
»» alternativeValues [string] true none Alternative value for an award
» awards [nominationAwardType] true none Collection of Awards
» reasons [question] true none Collection of Questions and Answers
»» id integer true none QuestionId
»» question string true none Question
»» answer string true none Answer
»» type string true none Type
» editNominee boolean false none Flag indicating whether a nominee may be changed by reviewer
» editAwardMessage boolean false none Flag indicating whether the award reason may be changed
» visibility string false none Visibility of the nomination
» actionReason [actionReason] false none Collection of Approval Action Reason
»» id integer true none Nomination Id
»» reason string true none Action reason for nomination
»» approverFullName string true none Approver Full Name

Approve or reject a recognition moment

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'string',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.rewardgateway.net/nominations/pending/approveReject', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST https://api.rewardgateway.net/nominations/pending/approveReject HTTP/1.1
Host: api.rewardgateway.net
Content-Type: application/json
Accept: application/json
Authorization: string
Accept: string

# You can also use wget
curl -X POST https://api.rewardgateway.net/nominations/pending/approveReject \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: string'

const inputBody = '{
  "rrProgramId": 0,
  "action": "string",
  "nominations": null
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'string'
};

fetch('https://api.rewardgateway.net/nominations/pending/approveReject',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /nominations/pending/approveReject

This endpoint will allow you to approve or reject a recognition moment that requires approval. Approval will be done on behalf of the current member.

Body parameter

{
  "rrProgramId": 0,
  "action": "string",
  "nominations": null
}

Parameters

Name In Type Required Description
Authorization header string true Valid Bearer access token
Accept header string true none
body body object false none
» rrProgramId body integer false none
» action body string false none
» nominations body any false none

Example responses

200 Response

{
  "status": "string",
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Successful operation Inline
400 Bad Request Bad request errorModel
403 Forbidden Access to the resource has been denied errorModel
404 Not Found Nomination is not found errorModel

Response Schema

Status Code 200

Name Type Required Restrictions Description
» status string true none none
» message string true none none

List the nomination's form

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/nominations/form/{rrSchemeId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/nominations/form/{rrSchemeId} HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/nominations/form/{rrSchemeId} \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/nominations/form/{rrSchemeId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /nominations/form/{rrSchemeId}

This endpoint will return the nomination form for a specific Programme.

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
rrSchemeId path integer true R&R Scheme Id
showSectionBreak query boolean false Include section break

Example responses

200 Response

[
  {
    "id": 0,
    "rrProgramId": 123,
    "rrProgramName": "string",
    "nominees": [
      {
        "id": "string",
        "fullName": "string"
      }
    ],
    "approvers": [
      {
        "id": 0,
        "contactId": 0,
        "fullName": "string",
        "firstName": "string",
        "lastName": "string",
        "registrationQuestions": "string",
        "avatarUrl": "string"
      }
    ],
    "nominator": [
      {
        "id": 0,
        "fullName": "string",
        "isMember": "string"
      }
    ],
    "date": "string",
    "formattedDate": "string",
    "award": [
      {
        "id": 0,
        "title": "string",
        "valueFullName": "string",
        "valueShortName": "string",
        "value": 0.1,
        "alternativeValues": [
          "string"
        ]
      }
    ],
    "awards": [
      {
        "id": 0,
        "title": "string",
        "valueFullName": "string",
        "valueShortName": "string",
        "value": 0.1,
        "alternativeValues": [
          "string"
        ]
      }
    ],
    "reasons": [
      {
        "id": 0,
        "question": "string",
        "answer": "string",
        "type": "string"
      }
    ],
    "editNominee": true,
    "editAwardMessage": true,
    "visibility": "string",
    "actionReason": [
      {
        "id": 0,
        "reason": "string",
        "approverFullName": "string"
      }
    ]
  }
]

Responses

Status Meaning Description Schema
200 OK Successful operation Inline
400 Bad Request User does not belongs to this scheme errorModel
403 Forbidden Access to the resource has been denied errorModel
404 Not Found Program not found errorModel

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [nomination] false none none
» id integer true none Nomination identifier
» rrProgramId integer true none RR Scheme identifier
» rrProgramName string true none RR Program Name
» nominees [nominee] true none Nominee
»» id string true none Nominee Id
»» fullName string true none Full Name
» approvers [approver] true none Approvers
»» id integer true none LicenceId
»» contactId integer true none ContactId
»» fullName string true none Full Name
»» firstName string true none First Name
»» lastName string true none lastName
»» registrationQuestions string¦null true none registrationQuestions
»» avatarUrl string¦null true none avatarUrl
» nominator [nominator] true none Nominator
»» id integer true none Nominee Id
»» fullName string true none Full Name
»» isMember string false none Check if returned nominator is valid member or just placeholder with name.
» date string true none Date of the nomination
» formattedDate string true none Date of the nomination
» award [nominationAwardType] true none Nomination's Award
»» id integer true none Award Id
»» title string true none Title
»» valueFullName string true none Value Full Name
»» valueShortName string true none Value Short Name
»» value number(float) true none Award value
»» alternativeValues [string] true none Alternative value for an award
» awards [nominationAwardType] true none Collection of Awards
» reasons [question] true none Collection of Questions and Answers
»» id integer true none QuestionId
»» question string true none Question
»» answer string true none Answer
»» type string true none Type
» editNominee boolean false none Flag indicating whether a nominee may be changed by reviewer
» editAwardMessage boolean false none Flag indicating whether the award reason may be changed
» visibility string false none Visibility of the nomination
» actionReason [actionReason] false none Collection of Approval Action Reason
»» id integer true none Nomination Id
»» reason string true none Action reason for nomination
»» approverFullName string true none Approver Full Name

It creates nominations

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'string',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.rewardgateway.net/nominations', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST https://api.rewardgateway.net/nominations HTTP/1.1
Host: api.rewardgateway.net
Content-Type: application/json
Accept: application/json
Authorization: string
Accept: string

# You can also use wget
curl -X POST https://api.rewardgateway.net/nominations \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: string'

const inputBody = '{
  "rrSchemeId": 0,
  "bSubmitShare": true,
  "aRecipients": null,
  "rrAwardReason": "string",
  "sAwardType": 0,
  "sIdentity": 0
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'string'
};

fetch('https://api.rewardgateway.net/nominations',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /nominations

It creates nominations

Body parameter

{
  "rrSchemeId": 0,
  "bSubmitShare": true,
  "aRecipients": null,
  "rrAwardReason": "string",
  "sAwardType": 0,
  "sIdentity": 0
}

Parameters

Name In Type Required Description
Authorization header string true Valid Bearer access token
Accept header string true none
body body object false none
» rrSchemeId body integer true none
» bSubmitShare body boolean true none
» aRecipients body any true none
» rrAwardReason body string true none
» sAwardType body integer true none
» sIdentity body integer false none

Example responses

200 Response

{
  "success": true,
  "message": "string",
  "nominationId": 0
}

Responses

Status Meaning Description Schema
200 OK Successful operation Inline
400 Bad Request Bad request errorModel
403 Forbidden Access to the resource has been denied errorModel
404 Not Found Item is not found errorModel

Response Schema

Status Code 200

Name Type Required Restrictions Description
» success boolean true none none
» message string true none none
» nominationId integer true none none

It uploads files on s3

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'multipart/form-data',
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'string',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.rewardgateway.net/nominations/upload', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST https://api.rewardgateway.net/nominations/upload HTTP/1.1
Host: api.rewardgateway.net
Content-Type: multipart/form-data
Accept: application/json
Authorization: string
Accept: string

# You can also use wget
curl -X POST https://api.rewardgateway.net/nominations/upload \
  -H 'Content-Type: multipart/form-data' \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: string'

const inputBody = '{
  "rrSchemeId": 0,
  "file": "string"
}';
const headers = {
  'Content-Type':'multipart/form-data',
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'string'
};

fetch('https://api.rewardgateway.net/nominations/upload',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /nominations/upload

It uploads files on s3

Body parameter

rrSchemeId: 0
file: string

Parameters

Name In Type Required Description
Authorization header string true Valid Bearer access token
Accept header string true none
body body object true none
» rrSchemeId body integer false scheme id of a rrProgramme
» file body string(file) false file

Example responses

200 Response

{
  "success": true,
  "data": {
    "file": "string"
  }
}

Responses

Status Meaning Description Schema
200 OK Successful operation Inline
400 Bad Request Bad request errorModel
403 Forbidden Access to the resource has been denied errorModel
404 Not Found Item is not found errorModel

Response Schema

Status Code 200

Name Type Required Restrictions Description
» success boolean true none none
» data object true none none
»» file string false none none

Lists nominee names and nomination programme names for a scheme

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/nominations/pending/filter', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/nominations/pending/filter HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/nominations/pending/filter \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/nominations/pending/filter',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /nominations/pending/filter

Returns a list of all nominees with pending nominations and the list of all the Programmes.

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning

Example responses

200 Response

[
  {
    "id": 0,
    "rrProgramId": 123,
    "rrProgramName": "string",
    "nominees": [
      {
        "id": "string",
        "fullName": "string"
      }
    ],
    "approvers": [
      {
        "id": 0,
        "contactId": 0,
        "fullName": "string",
        "firstName": "string",
        "lastName": "string",
        "registrationQuestions": "string",
        "avatarUrl": "string"
      }
    ],
    "nominator": [
      {
        "id": 0,
        "fullName": "string",
        "isMember": "string"
      }
    ],
    "date": "string",
    "formattedDate": "string",
    "award": [
      {
        "id": 0,
        "title": "string",
        "valueFullName": "string",
        "valueShortName": "string",
        "value": 0.1,
        "alternativeValues": [
          "string"
        ]
      }
    ],
    "awards": [
      {
        "id": 0,
        "title": "string",
        "valueFullName": "string",
        "valueShortName": "string",
        "value": 0.1,
        "alternativeValues": [
          "string"
        ]
      }
    ],
    "reasons": [
      {
        "id": 0,
        "question": "string",
        "answer": "string",
        "type": "string"
      }
    ],
    "editNominee": true,
    "editAwardMessage": true,
    "visibility": "string",
    "actionReason": [
      {
        "id": 0,
        "reason": "string",
        "approverFullName": "string"
      }
    ]
  }
]

Responses

Status Meaning Description Schema
200 OK Successful operation Inline
403 Forbidden Access to the resource has been denied errorModel

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [nomination] false none none
» id integer true none Nomination identifier
» rrProgramId integer true none RR Scheme identifier
» rrProgramName string true none RR Program Name
» nominees [nominee] true none Nominee
»» id string true none Nominee Id
»» fullName string true none Full Name
» approvers [approver] true none Approvers
»» id integer true none LicenceId
»» contactId integer true none ContactId
»» fullName string true none Full Name
»» firstName string true none First Name
»» lastName string true none lastName
»» registrationQuestions string¦null true none registrationQuestions
»» avatarUrl string¦null true none avatarUrl
» nominator [nominator] true none Nominator
»» id integer true none Nominee Id
»» fullName string true none Full Name
»» isMember string false none Check if returned nominator is valid member or just placeholder with name.
» date string true none Date of the nomination
» formattedDate string true none Date of the nomination
» award [nominationAwardType] true none Nomination's Award
»» id integer true none Award Id
»» title string true none Title
»» valueFullName string true none Value Full Name
»» valueShortName string true none Value Short Name
»» value number(float) true none Award value
»» alternativeValues [string] true none Alternative value for an award
» awards [nominationAwardType] true none Collection of Awards
» reasons [question] true none Collection of Questions and Answers
»» id integer true none QuestionId
»» question string true none Question
»» answer string true none Answer
»» type string true none Type
» editNominee boolean false none Flag indicating whether a nominee may be changed by reviewer
» editAwardMessage boolean false none Flag indicating whether the award reason may be changed
» visibility string false none Visibility of the nomination
» actionReason [actionReason] false none Collection of Approval Action Reason
»» id integer true none Nomination Id
»» reason string true none Action reason for nomination
»» approverFullName string true none Approver Full Name

Get activity points for a member

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/recognition/activity/points', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/recognition/activity/points?identifier=string HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/recognition/activity/points?identifier=string \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/recognition/activity/points?identifier=string',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /recognition/activity/points

This endpoint returns a list of activity points recieved by a specific member

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
identifier query string true Member identifier

Example responses

200 Response

{
  "id": 0,
  "amount": 0,
  "currency": "string",
  "activity": "string",
  "formattedDate": "string",
  "date": "string"
}

Responses

Status Meaning Description Schema
200 OK Successful operation activityPoint
403 Forbidden Access to the resource has been denied errorModel

Get Award details

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/bulkschedule/award/{awardId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/bulkschedule/award/{awardId} HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/bulkschedule/award/{awardId} \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/bulkschedule/award/{awardId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /bulkschedule/award/{awardId}

This endpoint returns details for a specific bulk award

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
awardId path integer true Id of the award

Example responses

403 Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Successful operation None
403 Forbidden Access to the resource has been denied errorModel
404 Not Found BulkAward not found errorModel

List RRScheme Awards

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/bulkschedule/rrScheme/{rrSchemeId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/bulkschedule/rrScheme/{rrSchemeId} HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/bulkschedule/rrScheme/{rrSchemeId} \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/bulkschedule/rrScheme/{rrSchemeId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /bulkschedule/rrScheme/{rrSchemeId}

This endpoint returns a list of awards for the given Reward Recognition Scheme

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
rrSchemeId path integer true RR Scheme Id
page query integer false Result page number
segment query integer false recipient segment id
event query integer false event id

Example responses

403 Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Successful operation None
403 Forbidden Access to the resource has been denied errorModel
404 Not Found RRScheme not found errorModel

Create a Bulk Award

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.rewardgateway.net/bulkschedule', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST https://api.rewardgateway.net/bulkschedule?rrSchemeId=0&AwardValue=string&imageName=string&imageExtension=string&description=string&title=string&recognitionEvent=0&recognitionFrequency=0&message=string&recipients=0 HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X POST https://api.rewardgateway.net/bulkschedule?rrSchemeId=0&AwardValue=string&imageName=string&imageExtension=string&description=string&title=string&recognitionEvent=0&recognitionFrequency=0&message=string&recipients=0 \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/bulkschedule?rrSchemeId=0&AwardValue=string&imageName=string&imageExtension=string&description=string&title=string&recognitionEvent=0&recognitionFrequency=0&message=string&recipients=0',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /bulkschedule

This endpoint creates a Bulk Award

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
rrSchemeId query integer true The id of RRScheme
AwardValue query array[string] true The list of award values
imageName query string true The name of the uploaded image
imageExtension query string true The extension of the uploaded image
description query string true The description of the uploaded image
title query string true The title of the award
recognitionEvent query integer true The id of the recognition event
recognitionFrequency query integer true The id of the recognition frequency
frequencyCustomInterval query integer false The frequency custom interval (award on year)
message query string true The message for the award
recipients query integer true The recipient segment id
date query string false The date for the recognition event (for custom events)
isSharedOnSRW query boolean false A boolean flag for displaying on the Social Recognition Wall

Example responses

403 Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
201 Created Created None
403 Forbidden Access to the resource has been denied errorModel
404 Not Found RRScheme not found errorModel

List RRScheme points and locales

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/rrScheme/{rrSchemeId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/rrScheme/{rrSchemeId} HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/rrScheme/{rrSchemeId} \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/rrScheme/{rrSchemeId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /rrScheme/{rrSchemeId}

This endpoint returns a list of points and locales for an RRScheme

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
rrSchemeId path integer true RR Scheme Id

Example responses

403 Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Successful operation None
403 Forbidden Access to the resource has been denied errorModel
404 Not Found RRScheme not found errorModel

Upload an Image

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'multipart/form-data',
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.rewardgateway.net/bulkschedule/uploadimage', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST https://api.rewardgateway.net/bulkschedule/uploadimage HTTP/1.1
Host: api.rewardgateway.net
Content-Type: multipart/form-data
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X POST https://api.rewardgateway.net/bulkschedule/uploadimage \
  -H 'Content-Type: multipart/form-data' \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'

const inputBody = '{
  "image": "string"
}';
const headers = {
  'Content-Type':'multipart/form-data',
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/bulkschedule/uploadimage',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /bulkschedule/uploadimage

Upload an Image for a Bulk Award

Body parameter

image: string

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
body body object true none
» image body string false Image to uplad

Example responses

403 Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Successful operation None
403 Forbidden Access to the resource has been denied errorModel

Delete award types

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.rewardgateway.net/bulkschedule/delete', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST https://api.rewardgateway.net/bulkschedule/delete?awards=0 HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X POST https://api.rewardgateway.net/bulkschedule/delete?awards=0 \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/bulkschedule/delete?awards=0',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /bulkschedule/delete

This endpoint deletes Award Types by Id

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
awards query array[integer] true List of award IDs to delete

Example responses

403 Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Successful operation None
403 Forbidden Access to the resource has been denied errorModel
404 Not Found RRScheme not found errorModel

Update an Award

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','https://api.rewardgateway.net/bulkschedule/{awardId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

PUT https://api.rewardgateway.net/bulkschedule/{awardId}?AwardValue=string&imageName=string&imageExtension=string&description=string&title=string&recognitionEvent=0&message=string&recipients=0 HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X PUT https://api.rewardgateway.net/bulkschedule/{awardId}?AwardValue=string&imageName=string&imageExtension=string&description=string&title=string&recognitionEvent=0&message=string&recipients=0 \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/bulkschedule/{awardId}?AwardValue=string&imageName=string&imageExtension=string&description=string&title=string&recognitionEvent=0&message=string&recipients=0',
{
  method: 'PUT',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /bulkschedule/{awardId}

Update an Award

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
awardId path integer true The id of the award
AwardValue query array[string] true The list of award values
imageName query string true The name of the uploaded image
imageExtension query string true The extension of the uploaded image
description query string true The description of the uploaded image
title query string true The title of the award
recognitionEvent query integer true The id of the recognition event
recognitionFrequency query integer false The id of the recognition frequency
frequencyCustomInterval query integer false The frequency custom interval (award on year)
message query string true The message for the award
recipients query integer true The recipient segment id
date query string false The date for the recognition event
isSharedOnSRW query boolean false A boolean flag for displaying on the Social Recognition Wall

Example responses

403 Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Successful operation None
403 Forbidden Access to the resource has been denied errorModel

Change status of an award

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.rewardgateway.net/bulkschedule/{awardTypeId}/status', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST https://api.rewardgateway.net/bulkschedule/{awardTypeId}/status?enabled=true HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X POST https://api.rewardgateway.net/bulkschedule/{awardTypeId}/status?enabled=true \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/bulkschedule/{awardTypeId}/status?enabled=true',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /bulkschedule/{awardTypeId}/status

Enable or Disable an Award

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
awardTypeId path integer true The id of the award
enabled query boolean true Boolean true for enabled, false for disabled state

Example responses

403 Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Successful operation None
403 Forbidden Access to the resource has been denied errorModel

Lists batches in a rrscheme (programme)

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/bulkschedule/rrScheme/{schemeId}/batches', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/bulkschedule/rrScheme/{schemeId}/batches HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/bulkschedule/rrScheme/{schemeId}/batches \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/bulkschedule/rrScheme/{schemeId}/batches',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /bulkschedule/rrScheme/{schemeId}/batches

This endpoint will return a list of rrscheme batches

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
schemeId path integer true Id of the scheme to get batches for
offset query integer false The offset for results
limit query integer false The limit for results
dateFrom query string(date-time) false Filter batches based on date. Requires dateTo to be input at the same time.
dateTo query string(date-time) false Filter batches based on date. Requires dateFrom to be input at the same time.

Example responses

403 Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Successful operation None
403 Forbidden Access to the resource has been denied errorModel

Lists awards in a batch

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/bulkschedule/batches/{batchId}/awards', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/bulkschedule/batches/{batchId}/awards HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/bulkschedule/batches/{batchId}/awards \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/bulkschedule/batches/{batchId}/awards',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /bulkschedule/batches/{batchId}/awards

This endpoint will return a list of awards in a batch

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
batchId path integer true Id of a batch to get awards for
offset query integer false The offset for results
limit query integer false The limit for results

Example responses

403 Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Successful operation None
403 Forbidden Access to the resource has been denied errorModel

Mark batch as dispatching

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/bulkschedule/batches/{batchId}/markAsDispatching', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/bulkschedule/batches/{batchId}/markAsDispatching HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/bulkschedule/batches/{batchId}/markAsDispatching \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/bulkschedule/batches/{batchId}/markAsDispatching',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /bulkschedule/batches/{batchId}/markAsDispatching

This endpoint will mark a batch as dispaching

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
batchId path integer true Id of a batch to mark as dispatching

Example responses

403 Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Successful operation None
403 Forbidden Access to the resource has been denied errorModel

Mark batch as cancelled

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.rewardgateway.net/bulkschedule/batches/{batchId}/cancel', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST https://api.rewardgateway.net/bulkschedule/batches/{batchId}/cancel HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X POST https://api.rewardgateway.net/bulkschedule/batches/{batchId}/cancel \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/bulkschedule/batches/{batchId}/cancel',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /bulkschedule/batches/{batchId}/cancel

This endpoint will mark a batch as cancelled

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
batchId path integer true Id of a batch to cancel

Example responses

403 Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Successful operation None
403 Forbidden Access to the resource has been denied errorModel

Cancel batch transactions

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.rewardgateway.net/bulkschedule/batches/transaction/cancel', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST https://api.rewardgateway.net/bulkschedule/batches/transaction/cancel HTTP/1.1
Host: api.rewardgateway.net
Content-Type: application/json
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X POST https://api.rewardgateway.net/bulkschedule/batches/transaction/cancel \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'

const inputBody = '{
  "transactions": [
    0
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/bulkschedule/batches/transaction/cancel',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /bulkschedule/batches/transaction/cancel

This endpoint will cancel transactions in a batch

Body parameter

{
  "transactions": [
    0
  ]
}

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
body body object false none
» transactions body [integer] true none

Example responses

403 Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Successful operation None
403 Forbidden Access to the resource has been denied errorModel

Get a list of scheme segments

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/segments/{schemeId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/segments/{schemeId} HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/segments/{schemeId} \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/segments/{schemeId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /segments/{schemeId}

This endpoint will return a list of scheme segments

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
schemeId path integer true Id of the scheme to get segments for

Example responses

403 Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Successful operation None
403 Forbidden Access to the resource has been denied errorModel

Get award certificates

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/awards/certificates', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/awards/certificates HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/awards/certificates \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/awards/certificates',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /awards/certificates

This endpoint will return award certificates

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
offset query string false The amount to offset the search by
limit query string false The amount of entries to return
recipientUuid query string false Member identifier to filter results by
awardName query string false The award name to filter results by
groupId query string false The group id used for filtering the results by group
optionName query string false The select option name/value for a group when filtering the results by group
startDate query string false The start date to filter results by
endDate query string false The end date to filter results by

Example responses

200 Response

{
  "id": "string",
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "emailVisible": true,
  "summary": "string",
  "timezone": "string",
  "gender": "string",
  "addressLine1": "string",
  "addressLine2": "string",
  "addressLine3": "string",
  "addressLine4": "string",
  "postalCode": "string",
  "country": "string",
  "mobileNumber": "string",
  "mobileNumberVisible": "string",
  "telephoneNumber": "string",
  "avatar": "string",
  "dateOfBirth": "string",
  "dateOfBirthVisible": true,
  "registrationDate": "string",
  "registrationInfo": "string",
  "locale": {
    "id": 0,
    "name": "string",
    "lang": "string",
    "currency": "string",
    "symbol": "string",
    "states": [
      {
        "code": "string",
        "name": "string"
      }
    ],
    "contactFields": [
      null
    ],
    "mappings": {
      "locale": "Locale CDN url",
      "fallback": "Fallback locale CDN url"
    }
  },
  "scheme": {},
  "pushNotifications": true
}

Responses

Status Meaning Description Schema
200 OK Successful operation member
403 Forbidden Access to the resource has been denied errorModel

The endpoint allow to search for list of approvers

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'string',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/nominations/approvers', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/nominations/approvers?page=0&limit=0&rrSchemeId=0 HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: string

# You can also use wget
curl -X GET https://api.rewardgateway.net/nominations/approvers?page=0&limit=0&rrSchemeId=0 \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: string'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'string'
};

fetch('https://api.rewardgateway.net/nominations/approvers?page=0&limit=0&rrSchemeId=0',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /nominations/approvers

The endpoint allow to search for list of approvers. When query is empty it will return all approvers up to default limit of 10 entities

Parameters

Name In Type Required Description
Authorization header string true Valid Bearer access token
Accept header string true none
page query integer true Offset the number of results returned
limit query integer true Constrain the number of results returned
rrSchemeId query integer true R&R Scheme Id
query query string false Contains the string to search approver name

Example responses

200 Response

[
  {
    "id": "string",
    "contactId": 0,
    "firstName": "string",
    "lastName": "string",
    "registrationQuestions": "string",
    "avatarUrl": "string"
  }
]

Responses

Status Meaning Description Schema
200 OK Successful operation Inline
400 Bad Request Bad request errorModel
403 Forbidden Access to the resource has been denied errorModel
404 Not Found Item is not found errorModel

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [searchMember] false none none
» id string true none Member identifier
» contactId integer false none Member contact id
» firstName string true none Member first name
» lastName string true none Member last name
» registrationQuestions string true none Member label based on top 3 discriminatory fields
» avatarUrl string true none Member profile url

Get a specific feed item by id.

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/srw/feed/{feedItemId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/srw/feed/{feedItemId} HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/srw/feed/{feedItemId} \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/srw/feed/{feedItemId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /srw/feed/{feedItemId}

This endpoint will return a specific item in a social recognition feed

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
feedItemId path string true Feed Item Identifier

Example responses

400 Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Successful operation None
400 Bad Request Bad request. errorModel
403 Forbidden Access to the resource has been denied errorModel
404 Not Found Feed was not found. errorModel

Delete a specific feed item by id.

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://api.rewardgateway.net/srw/feed/{feedItemId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

DELETE https://api.rewardgateway.net/srw/feed/{feedItemId} HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X DELETE https://api.rewardgateway.net/srw/feed/{feedItemId} \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/srw/feed/{feedItemId}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /srw/feed/{feedItemId}

This endpoint will soft delete a specific item in a social recognition feed

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
feedItemId path string true Feed Item Identifier

Example responses

400 Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Successful operation None
400 Bad Request Bad request. errorModel
403 Forbidden Access to the resource has been denied errorModel
404 Not Found Feed was not found. errorModel

Get scheme filters for feed

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/srw/filters', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/srw/filters HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/srw/filters \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/srw/filters',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /srw/filters

This endpoint will return allowed list of filters that can be used to filter the social recognition feed

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning

Example responses

400 Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Successful operation None
400 Bad Request Bad request. errorModel
403 Forbidden Access to the resource has been denied errorModel
404 Not Found Feed was not found. errorModel

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.rewardgateway.net/srw/filters', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST https://api.rewardgateway.net/srw/filters HTTP/1.1
Host: api.rewardgateway.net
Content-Type: application/json
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X POST https://api.rewardgateway.net/srw/filters \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'

const inputBody = '{
  "filterName": "Filter name test",
  "people": {
    "writtenBy": true,
    "receivedBy": true,
    "userIds": [
      "8a98e6b3-d556-4654-96ee-30c3830d92eb"
    ]
  },
  "groups": {
    "writtenBy": true,
    "receivedBy": true,
    "segmentIds": [
      12
    ]
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/srw/filters',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /srw/filters

This endpoint will save a filter search for a user

Body parameter

{
  "filterName": "Filter name test",
  "people": {
    "writtenBy": true,
    "receivedBy": true,
    "userIds": [
      "8a98e6b3-d556-4654-96ee-30c3830d92eb"
    ]
  },
  "groups": {
    "writtenBy": true,
    "receivedBy": true,
    "segmentIds": [
      12
    ]
  }
}

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
body body object false none
» filterName body string true none
» people body object false none
»» writtenBy body boolean false none
»» receivedBy body boolean false none
»» userIds body [string] true none
» groups body object false none
»» writtenBy body boolean false none
»» receivedBy body boolean false none
»» segmentIds body [integer] true none

Example responses

200 Response

{
  "success": true,
  "optionName": "string",
  "segmentId": 0,
  "filterUuid": "string",
  "message": "string",
  "subscribed": true
}

Responses

Status Meaning Description Schema
200 OK Successful operation Inline
403 Forbidden Access to the resource has been denied errorModel

Response Schema

Status Code 200

Name Type Required Restrictions Description
» success boolean true none none
» optionName string true none none
» segmentId integer true none none
» filterUuid string false none none
» message string true none none
» subscribed boolean false none none

Get reactions for specific feed item.

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/srw/feed/{feedID}/reactions', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/srw/feed/{feedID}/reactions HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/srw/feed/{feedID}/reactions \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/srw/feed/{feedID}/reactions',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /srw/feed/{feedID}/reactions

This item will return a list of reactions against a specific feed item in the social recognition feed

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
feedID path string true Feed Identifier

Example responses

400 Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Successful operation None
400 Bad Request Bad request. errorModel
403 Forbidden Access to the resource has been denied errorModel
404 Not Found Feed was not found. errorModel

React against a feed item

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.rewardgateway.net/srw/feed/{feedID}/reactions', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST https://api.rewardgateway.net/srw/feed/{feedID}/reactions HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X POST https://api.rewardgateway.net/srw/feed/{feedID}/reactions \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/srw/feed/{feedID}/reactions',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /srw/feed/{feedID}/reactions

This endpoint will react against a specific feed item on behalf of the current member

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
feedID path string true Feed Identifier

Example responses

400 Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Successful operation None
400 Bad Request Bad request. errorModel
403 Forbidden Access to the resource has been denied errorModel
415 Unsupported Media Type Subject type mismatch. errorModel
500 Internal Server Error Could not resolve resource or other internal server error errorModel
510 Unknown FeedItem not found. errorModel
511 Network Authentication Required FeedItem is removed. errorModel
512 Unknown FeedItem is private. errorModel

Get comments for specific feed item.

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/srw/feed/{feedID}/comments', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/srw/feed/{feedID}/comments HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/srw/feed/{feedID}/comments \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/srw/feed/{feedID}/comments',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /srw/feed/{feedID}/comments

This endpoint returns a list of comments that are against a specific feed item in the social recognition feed

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
feedID path string true Feed Identifier

Example responses

400 Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Successful operation None
400 Bad Request Bad request. errorModel
403 Forbidden Access to the resource has been denied errorModel
404 Not Found Feed was not found. errorModel

Post a commnet for specific feed item.

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'multipart/form-data',
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.rewardgateway.net/srw/feed/{feedID}/comments', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST https://api.rewardgateway.net/srw/feed/{feedID}/comments HTTP/1.1
Host: api.rewardgateway.net
Content-Type: multipart/form-data
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X POST https://api.rewardgateway.net/srw/feed/{feedID}/comments \
  -H 'Content-Type: multipart/form-data' \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'

const inputBody = '{
  "message": "string"
}';
const headers = {
  'Content-Type':'multipart/form-data',
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/srw/feed/{feedID}/comments',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /srw/feed/{feedID}/comments

This endpoint will post a comment against a specific feed item on behalf of the current member

Body parameter

message: string

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
feedID path string true Feed Identifier
body body object false none
» message body string true Comment text

Example responses

400 Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Successful operation None
400 Bad Request Bad request. errorModel
403 Forbidden Access to the resource has been denied errorModel
404 Not Found Feed was not found. errorModel

Get replies on a specific comment.

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/srw/feed/{feedID}/comments/{commentId}/replies', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/srw/feed/{feedID}/comments/{commentId}/replies HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/srw/feed/{feedID}/comments/{commentId}/replies \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/srw/feed/{feedID}/comments/{commentId}/replies',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /srw/feed/{feedID}/comments/{commentId}/replies

This endpoint returns a list of replies against a specific comment in thread

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
feedID path string true Feed Identifier
commentId path string true Comment Identifier

Example responses

400 Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Successful operation None
400 Bad Request Bad request. errorModel
403 Forbidden Access to the resource has been denied errorModel
404 Not Found Feed was not found. errorModel

Post a reply on specific comment

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'multipart/form-data',
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.rewardgateway.net/srw/feed/{feedID}/comments/{commentId}/replies', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST https://api.rewardgateway.net/srw/feed/{feedID}/comments/{commentId}/replies HTTP/1.1
Host: api.rewardgateway.net
Content-Type: multipart/form-data
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X POST https://api.rewardgateway.net/srw/feed/{feedID}/comments/{commentId}/replies \
  -H 'Content-Type: multipart/form-data' \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'

const inputBody = '{
  "message": "string"
}';
const headers = {
  'Content-Type':'multipart/form-data',
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/srw/feed/{feedID}/comments/{commentId}/replies',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /srw/feed/{feedID}/comments/{commentId}/replies

This endpoint will post a reply on specific comment

Body parameter

message: string

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
feedID path string true Feed Identifier
commentId path string true Comment Identifier
body body object false none
» message body string true Reply message

Example responses

400 Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Successful operation None
400 Bad Request Bad request. errorModel
403 Forbidden Access to the resource has been denied errorModel
404 Not Found Feed was not found. errorModel

Update a comment or reply

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'multipart/form-data',
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.rewardgateway.net/srw/feed/{feedID}/comments/{commentId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST https://api.rewardgateway.net/srw/feed/{feedID}/comments/{commentId} HTTP/1.1
Host: api.rewardgateway.net
Content-Type: multipart/form-data
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X POST https://api.rewardgateway.net/srw/feed/{feedID}/comments/{commentId} \
  -H 'Content-Type: multipart/form-data' \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'

const inputBody = '{
  "message": "string"
}';
const headers = {
  'Content-Type':'multipart/form-data',
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/srw/feed/{feedID}/comments/{commentId}',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /srw/feed/{feedID}/comments/{commentId}

This endpoint will update a comment or a reply on a comment thread

Body parameter

message: string

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
feedID path string true Feed Identifier
commentId path string true Comment Identifier
body body object false none
» message body string true New message for the comment

Example responses

400 Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Successful operation None
400 Bad Request Bad request. errorModel
403 Forbidden Access to the resource has been denied errorModel
404 Not Found Feed was not found. errorModel
416 Range Not Satisfiable Message required. errorModel

Delete a comment or reply

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://api.rewardgateway.net/srw/feed/{feedID}/comments/{commentId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

DELETE https://api.rewardgateway.net/srw/feed/{feedID}/comments/{commentId} HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X DELETE https://api.rewardgateway.net/srw/feed/{feedID}/comments/{commentId} \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/srw/feed/{feedID}/comments/{commentId}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /srw/feed/{feedID}/comments/{commentId}

This endpoint will delete a comment or a reply on a comment thread

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
feedID path string true Feed Identifier
commentId path string true Comment identifier

Example responses

400 Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Successful operation None
400 Bad Request Bad request. errorModel
403 Forbidden Access to the resource has been denied errorModel
415 Unsupported Media Type Subject type mismatch. errorModel
500 Internal Server Error Could not resolve resource or other internal server error errorModel
510 Unknown FeedItem not found. errorModel
511 Network Authentication Required FeedItem is removed. errorModel
512 Unknown FeedItem is private. errorModel

React on a comment or reply

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'multipart/form-data',
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.rewardgateway.net/srw/feed/{feedID}/comments/{commentId}/reactions', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST https://api.rewardgateway.net/srw/feed/{feedID}/comments/{commentId}/reactions HTTP/1.1
Host: api.rewardgateway.net
Content-Type: multipart/form-data
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X POST https://api.rewardgateway.net/srw/feed/{feedID}/comments/{commentId}/reactions \
  -H 'Content-Type: multipart/form-data' \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'

const inputBody = '{
  "reactionId": 0
}';
const headers = {
  'Content-Type':'multipart/form-data',
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/srw/feed/{feedID}/comments/{commentId}/reactions',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /srw/feed/{feedID}/comments/{commentId}/reactions

This endpoint will react on a comment or a reply on a comment thread

Body parameter

reactionId: 0

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
feedID path string true Feed Identifier
commentId path string true Comment identifier
body body object false none
» reactionId body integer true Reaction identifier

Example responses

400 Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Successful operation None
400 Bad Request Bad request. errorModel
403 Forbidden Access to the resource has been denied errorModel
404 Not Found Feed was not found. errorModel

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','https://api.rewardgateway.net/srw/filters/{filterItemId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

PUT https://api.rewardgateway.net/srw/filters/{filterItemId} HTTP/1.1
Host: api.rewardgateway.net
Content-Type: application/json
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X PUT https://api.rewardgateway.net/srw/filters/{filterItemId} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'

const inputBody = '{
  "subscribe": true
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/srw/filters/{filterItemId}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /srw/filters/{filterItemId}

This endpoint will update which filters the user is subscribed to.

Body parameter

{
  "subscribe": true
}

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
filterItemId path string true Filter Identifier
body body object false none
» subscribe body boolean true none

Example responses

200 Response

{
  "success": true,
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Successful operation Inline
400 Bad Request Bad request. errorModel

Response Schema

Status Code 200

Name Type Required Restrictions Description
» success boolean true none none
» message string true none none

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://api.rewardgateway.net/srw/filters/{filterItemId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

DELETE https://api.rewardgateway.net/srw/filters/{filterItemId} HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X DELETE https://api.rewardgateway.net/srw/filters/{filterItemId} \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/srw/filters/{filterItemId}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /srw/filters/{filterItemId}

This endpoint will delete a filter search for a user

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
filterItemId path string true Filter Identifier

Example responses

200 Response

{
  "success": true,
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Successful operation Inline
400 Bad Request Bad request. errorModel

Response Schema

Status Code 200

Name Type Required Restrictions Description
» success boolean true none none
» message string true none none

Subscribe or unsubscribe a company filter for a user.

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.rewardgateway.net/srw/filters/company', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST https://api.rewardgateway.net/srw/filters/company HTTP/1.1
Host: api.rewardgateway.net
Content-Type: application/json
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X POST https://api.rewardgateway.net/srw/filters/company \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'

const inputBody = '{
  "subscribed": true,
  "filterItemId": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/srw/filters/company',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /srw/filters/company

This endpoint will subscribe or unsubscribe the company filter for a user.

Body parameter

{
  "subscribed": true,
  "filterItemId": "string"
}

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
body body object false none
» subscribed body boolean true none
» filterItemId body string false none

Example responses

200 Response

{
  "success": true,
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Successful operation Inline
400 Bad Request There was an issue subscribing or unsubscribing to this filter. errorModel
404 Not Found Filter does not exist. errorModel

Response Schema

Status Code 200

Name Type Required Restrictions Description
» success boolean true none none
» message string true none none

Get social recognition feed

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/srw/feed', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/srw/feed?count=0 HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/srw/feed?count=0 \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/srw/feed?count=0',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /srw/feed

This endpoint will return the social recognition feed for the current member. These are all recognition moments that are shared.

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
maxId query integer false Identifier of the last max feed record.
count query integer true Count of items per page.

Example responses

400 Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Successful operation None
400 Bad Request Bad request. errorModel
403 Forbidden Access to the resource has been denied errorModel
404 Not Found Feed was not found. errorModel

Helper

Series of helper endpoints to make the REST API usage easier.

Find programmes a member belongs to by an email address.

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/helper/lookup/scheme', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/helper/lookup/scheme?username=string HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/helper/lookup/scheme?username=string \
  -H 'Accept: application/json' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/helper/lookup/scheme?username=string',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /helper/lookup/scheme

A member might belong to multiple programmes. This endpoint will help you resolve which programmes an email address is attached to.

Parameters

Name In Type Required Description
Accept header string true Accept Header with Vendor Versioning
username query string true Email address of the member

Example responses

200 Response

[
  {
    "id": "string",
    "email": "string",
    "scheme": {
      "logo": "string",
      "favicon": "string",
      "colours": {
        "navigationBackground": null,
        "navigationText": null,
        "buttonBackground": null,
        "buttonText": null,
        "pageBackground": null,
        "chevronBackground": null,
        "chevronText": null,
        "unselectedTabBackground": null,
        "unselectedTabText": null,
        "selectedTabBackground": null,
        "selectedTabText": null,
        "offersCarouselBackground": null,
        "offersCarouselText": null,
        "registerButtonBackground": null,
        "registerButtonText": null
      }
    }
  }
]

Responses

Status Meaning Description Schema
200 OK Successful operation Inline
403 Forbidden Product is disabled for programme errorModel
404 Not Found Username not found errorModel

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [minimalMemberv2] false none none
» id string true none Member identifier
» email string true none Member email
» scheme schemeBranding true none none
»» logo string true none none
»» favicon string true none none
»» colours schemeBrandingColours false none none
»»» navigationBackground any true none none
»»» navigationText any true none none
»»» buttonBackground any false none none
»»» buttonText any false none none
»»» pageBackground any false none none
»»» chevronBackground any false none none
»»» chevronText any false none none
»»» unselectedTabBackground any false none none
»»» unselectedTabText any false none none
»»» selectedTabBackground any false none none
»»» selectedTabText any false none none
»»» offersCarouselBackground any false none none
»»» offersCarouselText any false none none
»»» registerButtonBackground any false none none
»»» registerButtonText any false none none

Send an One-time passcode to a member

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'multipart/form-data',
    'Accept' => 'application/json',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.rewardgateway.net/helper/mail/otp', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST https://api.rewardgateway.net/helper/mail/otp HTTP/1.1
Host: api.rewardgateway.net
Content-Type: multipart/form-data
Accept: application/json
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X POST https://api.rewardgateway.net/helper/mail/otp \
  -H 'Content-Type: multipart/form-data' \
  -H 'Accept: application/json' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'

const inputBody = '{
  "username": "string",
  "client_id": "string"
}';
const headers = {
  'Content-Type':'multipart/form-data',
  'Accept':'application/json',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/helper/mail/otp',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /helper/mail/otp

This endpoint will send an One-time passcode to a member. This maybe used for verification purposes.

Body parameter

username: string
client_id: string

Parameters

Name In Type Required Description
Accept header string true Accept Header with Vendor Versioning
body body object false none
» username body string true Member id of the account
» client_id body string true Name of the client connecting to the API

Example responses

204 Response

"string"

Responses

Status Meaning Description Schema
204 No Content Successful operation string
404 Not Found Username is not found errorModel

Returns the current api and app version for os

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/helper/versions', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/helper/versions?os=string&client_id=string&locale=0 HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/helper/versions?os=string&client_id=string&locale=0 \
  -H 'Accept: application/json' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/helper/versions?os=string&client_id=string&locale=0',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /helper/versions

This endpoint returns the current minimum supported api versions for your client id.

Parameters

Name In Type Required Description
Accept header string true Accept Header with Vendor Versioning
os query string true Operating system one of os or android
client_id query string true Client Id
locale query integer true Locale Id

Example responses

200 Response

true

Responses

Status Meaning Description Schema
200 OK Successful operation boolean
400 Bad Request Invalid request errorModel

Check if the current version of the api is supported

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/helper/version/supported', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/helper/version/supported?os=string&app_version=string&client_id=string&locale=0 HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/helper/version/supported?os=string&app_version=string&client_id=string&locale=0 \
  -H 'Accept: application/json' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/helper/version/supported?os=string&app_version=string&client_id=string&locale=0',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /helper/version/supported

This endpoint will check if the api version provided is supported.

Parameters

Name In Type Required Description
Accept header string true Accept Header with Vendor Versioning
os query string true Operating system one of os or android
app_version query string true App version
client_id query string true Client Id
locale query integer true Locale Id

Example responses

200 Response

true

Responses

Status Meaning Description Schema
200 OK Successful operation boolean
400 Bad Request Invalid request errorModel

Get description of all oAuth 2.0 scopes

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/helper/lookup/scopes', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/helper/lookup/scopes?scope=string HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/helper/lookup/scopes?scope=string \
  -H 'Accept: application/json' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/helper/lookup/scopes?scope=string',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /helper/lookup/scopes

This endpoint will return a list of all scopes used within the application and descriptions of what each does.

Parameters

Name In Type Required Description
Accept header string true Accept Header with Vendor Versioning
scope query string true Scope

Example responses

200 Response

[
  {
    "code": 0,
    "message": "string",
    "details": null
  }
]

Responses

Status Meaning Description Schema
200 OK Successful operation Inline
400 Bad Request Invalid request errorModel
404 Not Found No scope match errorModel

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [standardModel] false none none
» code integer(int32) true none none
» message string true none none
» details any true none none

Get programme information from given domain

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/helper/lookup/scheme_alias', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/helper/lookup/scheme_alias?alias=string HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/helper/lookup/scheme_alias?alias=string \
  -H 'Accept: application/json' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/helper/lookup/scheme_alias?alias=string',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /helper/lookup/scheme_alias

This endpoint searches for the domain provided and returns the related programme information if there is a match.

Parameters

Name In Type Required Description
Accept header string true Accept Header with Vendor Versioning
alias query string true Scheme Alias

Example responses

200 Response

[
  {
    "code": 0,
    "message": "string",
    "details": null
  }
]

Responses

Status Meaning Description Schema
200 OK Successful operation Inline
400 Bad Request Invalid request errorModel
404 Not Found No scheme alias match errorModel

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [standardModel] false none none
» code integer(int32) true none none
» message string true none none
» details any true none none

Get description for the client

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/helper/lookup/client_id', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/helper/lookup/client_id?client_id=string&scheme_id=0 HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/helper/lookup/client_id?client_id=string&scheme_id=0 \
  -H 'Accept: application/json' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/helper/lookup/client_id?client_id=string&scheme_id=0',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /helper/lookup/client_id

Get more information and description for the client id

Parameters

Name In Type Required Description
Accept header string true Accept Header with Vendor Versioning
client_id query string true Client ID
scheme_id query integer true Scheme ID

Example responses

200 Response

[
  {
    "code": 0,
    "message": "string",
    "details": null
  }
]

Responses

Status Meaning Description Schema
200 OK Successful operation Inline
400 Bad Request Invalid request errorModel
404 Not Found No client ID match errorModel

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [standardModel] false none none
» code integer(int32) true none none
» message string true none none
» details any true none none

Get programme information from given uuid

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/helper/lookup/scheme_uuid', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/helper/lookup/scheme_uuid?schemeUuid=string HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/helper/lookup/scheme_uuid?schemeUuid=string \
  -H 'Accept: application/json' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/helper/lookup/scheme_uuid?schemeUuid=string',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /helper/lookup/scheme_uuid

This endpoint searches for the uuid provided and returns the related programme information if there is a match.

Parameters

Name In Type Required Description
Accept header string true Accept Header with Vendor Versioning
schemeUuid query string true Scheme Uuid

Example responses

200 Response

[
  {
    "code": 0,
    "message": "string",
    "details": null
  }
]

Responses

Status Meaning Description Schema
200 OK Successful operation Inline
400 Bad Request Invalid request errorModel
404 Not Found No scheme uuid match errorModel

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [standardModel] false none none
» code integer(int32) true none none
» message string true none none
» details any true none none

Localization

Enpoints to manage localization. i.e. Validate phone numbers, postal codes etc.

Validate phone number

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'multipart/form-data',
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.rewardgateway.net/locale/validate/phone', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST https://api.rewardgateway.net/locale/validate/phone HTTP/1.1
Host: api.rewardgateway.net
Content-Type: multipart/form-data
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X POST https://api.rewardgateway.net/locale/validate/phone \
  -H 'Content-Type: multipart/form-data' \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'

const inputBody = '{
  "number": "string",
  "type": "string"
}';
const headers = {
  'Content-Type':'multipart/form-data',
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/locale/validate/phone',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /locale/validate/phone

This endpoint will validate the phone number based on the current member's locale.

Body parameter

number: string
type: string

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
body body object true none
» number body string false Phone number to be validated
» type body string false Type of phone to be validated (mobile

Example responses

400 Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Mobile phone valid None
400 Bad Request Bad request errorModel

Validate postal code

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'multipart/form-data',
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.rewardgateway.net/locale/validate/postalcode', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST https://api.rewardgateway.net/locale/validate/postalcode HTTP/1.1
Host: api.rewardgateway.net
Content-Type: multipart/form-data
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X POST https://api.rewardgateway.net/locale/validate/postalcode \
  -H 'Content-Type: multipart/form-data' \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'

const inputBody = '{
  "postalCode": "string"
}';
const headers = {
  'Content-Type':'multipart/form-data',
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/locale/validate/postalcode',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /locale/validate/postalcode

This endpoint will validate the postal code based on the current member's locale.

Body parameter

postalCode: string

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
body body object true none
» postalCode body string false Postal code to be validated from the member's locale

Example responses

400 Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Mobile phone valid None
400 Bad Request Bad request errorModel

Notification

Endpoints to manage sending notifications to the current member (Currently only supports Push Notifications to registered devices).

Register a device to receive notifications

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'multipart/form-data',
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.rewardgateway.net/notification/device', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST https://api.rewardgateway.net/notification/device HTTP/1.1
Host: api.rewardgateway.net
Content-Type: multipart/form-data
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X POST https://api.rewardgateway.net/notification/device \
  -H 'Content-Type: multipart/form-data' \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'

const inputBody = '{
  "client_id": "string",
  "device_token": "string",
  "device_os": "string"
}';
const headers = {
  'Content-Type':'multipart/form-data',
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/notification/device',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /notification/device

This endpoint will register a member's device to allow it to receive notifications.

Body parameter

client_id: string
device_token: string
device_os: string

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
body body object true none
» client_id body string false Client Identifier of the application
» device_token body string false Device token
» device_os body string false Device OS (IOS, Android)

Example responses

200 Response

[
  {
    "id": 0,
    "deviceOs": 0
  }
]

Responses

Status Meaning Description Schema
200 OK Successful operation Inline
403 Forbidden Access to the resource has been denied errorModel
406 Not Acceptable Request is not acceptable errorModel
500 Internal Server Error Unhandled error while registering device errorModel

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [device] false none none
» id integer true none Device Id
» deviceOs integer true none Device Operating System

Retrieve device information by a device identifier

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/notification/device/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/notification/device/{id} HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/notification/device/{id} \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/notification/device/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /notification/device/{id}

This endpoint will return device information based on a device identifier previously registered.

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
id path string true Identifier of the device

Example responses

200 Response

[
  {
    "id": 0,
    "deviceOs": 0
  }
]

Responses

Status Meaning Description Schema
200 OK Successful operation Inline
403 Forbidden Access to the resource has been denied errorModel
404 Not Found Device is not found errorModel

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [device] false none none
» id integer true none Device Id
» deviceOs integer true none Device Operating System

Remove a registered device

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://api.rewardgateway.net/notification/device/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

DELETE https://api.rewardgateway.net/notification/device/{id} HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X DELETE https://api.rewardgateway.net/notification/device/{id} \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/notification/device/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /notification/device/{id}

This endpoint will remove a device from the list of registered devices for the current member.

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
id path string true Identifier of the device

Example responses

204 Response

"string"

Responses

Status Meaning Description Schema
204 No Content Successful operation string
403 Forbidden Access to the resource has been denied errorModel
404 Not Found Device is not found errorModel

Manage member subscription to notifications

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'multipart/form-data',
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.rewardgateway.net/notification/member/togglePushNotifications', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST https://api.rewardgateway.net/notification/member/togglePushNotifications HTTP/1.1
Host: api.rewardgateway.net
Content-Type: multipart/form-data
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X POST https://api.rewardgateway.net/notification/member/togglePushNotifications \
  -H 'Content-Type: multipart/form-data' \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'

const inputBody = '{
  "toggleValue": true
}';
const headers = {
  'Content-Type':'multipart/form-data',
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/notification/member/togglePushNotifications',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /notification/member/togglePushNotifications

This endpoint sets a member's push notifications settings to on or off

Body parameter

toggleValue: true

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
body body object true none
» toggleValue body boolean false true or false bool value

Example responses

200 Response

{
  "status": "string",
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Successful operation Inline
403 Forbidden Access to the resource has been denied errorModel
404 Not Found Retailer is not found errorModel

Response Schema

Status Code 200

Name Type Required Restrictions Description
» status string true none none
» message string true none none

Get all notification messages

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/notification/messages', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/notification/messages HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/notification/messages \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/notification/messages',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /notification/messages

This endpoint will return all notification messages for the current member.

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
typeId query integer false Identifier of the type of notification page.

Example responses

200 Response

[
  {
    "typeId": 0,
    "typeName": "string",
    "message": "string"
  }
]

Responses

Status Meaning Description Schema
200 OK Successful operation Inline
403 Forbidden Access to the resource has been denied errorModel
404 Not Found The type of notification is not found errorModel

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [notificationMessage] false none none
» typeId integer true none Message type
» typeName string true none Page name for the message
» message string true none Message

Mark notification(s) as read

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'multipart/form-data',
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.rewardgateway.net/notification/read', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST https://api.rewardgateway.net/notification/read HTTP/1.1
Host: api.rewardgateway.net
Content-Type: multipart/form-data
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X POST https://api.rewardgateway.net/notification/read \
  -H 'Content-Type: multipart/form-data' \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'

const inputBody = '{
  "notificationIds": "string"
}';
const headers = {
  'Content-Type':'multipart/form-data',
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/notification/read',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /notification/read

This endpoint will mark a single notification or multiple notifications as read.

Body parameter

notificationIds: string

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
body body object true none
» notificationIds body string false Client Identifier of the application

Example responses

200 Response

[
  {
    "code": 0,
    "message": "string",
    "details": null
  }
]

Responses

Status Meaning Description Schema
200 OK Successful operation Inline
402 Payment Required Bad Request (invalid parameters) errorModel
403 Forbidden Access to the resource has been denied errorModel
500 Internal Server Error Unhandled error errorModel

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [standardModel] false none none
» code integer(int32) true none none
» message string true none none
» details any true none none

Get number of unseen notifications

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/notification/unseen', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/notification/unseen HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/notification/unseen \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/notification/unseen',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /notification/unseen

This endpoint returns the count of all unseen notifications for current member

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning

Example responses

200 Response

[
  {
    "typeId": 0,
    "typeName": "string",
    "message": "string"
  }
]

Responses

Status Meaning Description Schema
200 OK Successful operation Inline
403 Forbidden Access to the resource has been denied errorModel
404 Not Found The type of notification is not found errorModel

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [notificationMessage] false none none
» typeId integer true none Message type
» typeName string true none Page name for the message
» message string true none Message

Mark all notifications as read

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.rewardgateway.net/notification/read/all', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST https://api.rewardgateway.net/notification/read/all HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X POST https://api.rewardgateway.net/notification/read/all \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/notification/read/all',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /notification/read/all

This endpoint marks all notifications for the current member as read

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning

Example responses

200 Response

[
  {
    "typeId": 0,
    "typeName": "string",
    "message": "string"
  }
]

Responses

Status Meaning Description Schema
200 OK Successful operation Inline
403 Forbidden Access to the resource has been denied errorModel
404 Not Found The type of notification is not found errorModel

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [notificationMessage] false none none
» typeId integer true none Message type
» typeName string true none Page name for the message
» message string true none Message

Mark all notifications as seen

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.rewardgateway.net/notification/seen/all', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST https://api.rewardgateway.net/notification/seen/all HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X POST https://api.rewardgateway.net/notification/seen/all \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/notification/seen/all',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /notification/seen/all

This endpoint marks all notifications for the current member as seen

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning

Example responses

200 Response

[
  {
    "typeId": 0,
    "typeName": "string",
    "message": "string"
  }
]

Responses

Status Meaning Description Schema
200 OK Successful operation Inline
403 Forbidden Access to the resource has been denied errorModel
404 Not Found The type of notification is not found errorModel

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [notificationMessage] false none none
» typeId integer true none Message type
» typeName string true none Page name for the message
» message string true none Message

Get a list of all subscribed notifications

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/notification/preferences/status', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/notification/preferences/status HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/notification/preferences/status \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/notification/preferences/status',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /notification/preferences/status

This endpoint will return a list of all enabled/disabled notifications for the current member

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning

Example responses

200 Response

[
  {
    "typeId": 0,
    "typeName": "string",
    "message": "string"
  }
]

Responses

Status Meaning Description Schema
200 OK Successful operation Inline
403 Forbidden Access to the resource has been denied errorModel
404 Not Found The type of notification is not found errorModel

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [notificationMessage] false none none
» typeId integer true none Message type
» typeName string true none Page name for the message
» message string true none Message

Toggle one push notification for member

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.rewardgateway.net/notification/preferences/toggle', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST https://api.rewardgateway.net/notification/preferences/toggle HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X POST https://api.rewardgateway.net/notification/preferences/toggle \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/notification/preferences/toggle',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /notification/preferences/toggle

This endpoint will toggle a single push notification for the current member

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning

Example responses

200 Response

[
  {
    "typeId": 0,
    "typeName": "string",
    "message": "string"
  }
]

Responses

Status Meaning Description Schema
200 OK Successful operation Inline
403 Forbidden Access to the resource has been denied errorModel
404 Not Found The type of notification is not found errorModel

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [notificationMessage] false none none
» typeId integer true none Message type
» typeName string true none Page name for the message
» message string true none Message

Toggle push notifications for all notifications

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.rewardgateway.net/notification/preferences/toggle/all', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST https://api.rewardgateway.net/notification/preferences/toggle/all HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X POST https://api.rewardgateway.net/notification/preferences/toggle/all \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/notification/preferences/toggle/all',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /notification/preferences/toggle/all

This endpoint toggles multiple push notifications for current member for all notifications

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning

Example responses

200 Response

[
  {
    "typeId": 0,
    "typeName": "string",
    "message": "string"
  }
]

Responses

Status Meaning Description Schema
200 OK Successful operation Inline
403 Forbidden Access to the resource has been denied errorModel
404 Not Found The type of notification is not found errorModel

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [notificationMessage] false none none
» typeId integer true none Message type
» typeName string true none Page name for the message
» message string true none Message

Get all notifications

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/notification/alertCenterList', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/notification/alertCenterList HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/notification/alertCenterList \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/notification/alertCenterList',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /notification/alertCenterList

This endpoint returns all notifications for the current member

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning

Example responses

200 Response

[
  {
    "typeId": 0,
    "typeName": "string",
    "message": "string"
  }
]

Responses

Status Meaning Description Schema
200 OK Successful operation Inline
403 Forbidden Access to the resource has been denied errorModel
404 Not Found The type of notification is not found errorModel

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [notificationMessage] false none none
» typeId integer true none Message type
» typeName string true none Page name for the message
» message string true none Message

Programme

Endpoints for getting information related to specific programmes (tenants) within Reward Gateway. You will need special scopes with delegated tokens to be able to use this endpoint.

Get a scheme by id

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/scheme/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/scheme/{id} HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/scheme/{id} \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/scheme/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /scheme/{id}

This endpoint will return information for a specific scheme

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
id path integer true Scheme identifier

Example responses

200 Response

{}

Responses

Status Meaning Description Schema
200 OK Successful operation scheme
403 Forbidden Access to the resource has been denied errorModel
404 Not Found Scheme is not found errorModel

Get all scheme products

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/scheme/{id}/categories/products', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/scheme/{id}/categories/products HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/scheme/{id}/categories/products \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/scheme/{id}/categories/products',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /scheme/{id}/categories/products

This endpoint will return all products that are currently enabled on the programme

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
id path integer true Scheme identifier

Example responses

200 Response

{
  "id": "string",
  "name": "string",
  "products": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "url": "string",
      "icon": "string",
      "enabled": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Successful operation schemeProductCategory
403 Forbidden Access to the resource has been denied errorModel
404 Not Found Scheme is not found errorModel

Get scheme products by status

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/scheme/{id}/products/status/{status}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/scheme/{id}/products/status/{status} HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/scheme/{id}/products/status/{status} \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/scheme/{id}/products/status/{status}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /scheme/{id}/products/status/{status}

This endpoint will return all scheme's products by status

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
id path integer true Scheme identifier
status path integer true Status for the products

Example responses

200 Response

{
  "id": "string",
  "name": "string",
  "description": "string",
  "url": "string",
  "icon": "string",
  "enabled": "string"
}

Responses

Status Meaning Description Schema
200 OK Successful operation schemeProduct
403 Forbidden Access to the resource has been denied errorModel
404 Not Found Scheme is not found errorModel

Employee Communication

Endpoints to manage Employee Communication related functionality. Currently only supports searching for blog articles.

Get all blogs by a tag

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/search/blog/tag/{tagName}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/search/blog/tag/{tagName} HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/search/blog/tag/{tagName} \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/search/blog/tag/{tagName}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /search/blog/tag/{tagName}

This endpoint returns all blogs based on the tag provided

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
tagName path string true Tag Name

Example responses

400 Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK Successful operation None
400 Bad Request Bad request. errorModel
403 Forbidden Access to the resource has been denied errorModel
404 Not Found Feed was not found. errorModel

Employee Surveys

Endpoints to manager employee survey related functionalities. i.e. Find specific surveys, manage members who should recieve a survey etc.

Get a survey by id

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/survey/configuration/{surveyId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/survey/configuration/{surveyId} HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/survey/configuration/{surveyId} \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/survey/configuration/{surveyId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /survey/configuration/{surveyId}

This endpoint returns information about a survey based on the identifier that is passed.

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
surveyId path integer true Survey identifier

Example responses

200 Response

{
  "id": 0,
  "uniqueId": "string",
  "schemeId": "string",
  "title": "string",
  "dateAdded": "string",
  "enabled": true,
  "useLandingPage": true,
  "description": "string"
}

Responses

Status Meaning Description Schema
200 OK Successful operation surveyConfiguration

Create a new survey setup

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'multipart/form-data',
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.rewardgateway.net/survey/configuration', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST https://api.rewardgateway.net/survey/configuration HTTP/1.1
Host: api.rewardgateway.net
Content-Type: multipart/form-data
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X POST https://api.rewardgateway.net/survey/configuration \
  -H 'Content-Type: multipart/form-data' \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'

const inputBody = '{
  "title": "string",
  "schemeId": "string"
}';
const headers = {
  'Content-Type':'multipart/form-data',
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/survey/configuration',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /survey/configuration

This endpoint will create a survey setup. This is needed before you can proceed to creating a specific survey. These settings will be unified across all surveys created.

Body parameter

title: string
schemeId: string

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
body body object false none
» title body string true Name of the survey
» schemeId body string true Scheme identifier

Example responses

201 Response

[
  {
    "id": 0,
    "uniqueId": "string",
    "schemeId": "string",
    "title": "string",
    "dateAdded": "string",
    "enabled": true,
    "useLandingPage": true,
    "description": "string"
  }
]

Responses

Status Meaning Description Schema
201 Created Created Inline

Response Schema

Status Code 201

Name Type Required Restrictions Description
anonymous [surveyConfiguration] false none none
» id integer true none Survey Id
» uniqueId string true none Unique Id for the Survey
» schemeId string true none Scheme Id
» title string true none Survey Title
» dateAdded string true none Date Added
» enabled boolean true none Survey Enabled
» useLandingPage boolean true none Use Landing Page
» description string true none Survey Description

Add fields to a survey

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'multipart/form-data',
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.rewardgateway.net/survey/profilefields', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST https://api.rewardgateway.net/survey/profilefields HTTP/1.1
Host: api.rewardgateway.net
Content-Type: multipart/form-data
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X POST https://api.rewardgateway.net/survey/profilefields \
  -H 'Content-Type: multipart/form-data' \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'

const inputBody = '{
  "title": "string",
  "pulseConfigurationId": "string"
}';
const headers = {
  'Content-Type':'multipart/form-data',
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/survey/profilefields',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /survey/profilefields

This endpoint will add a new set of profile fields, exclusive to a survey. These can be used in reporting.

Body parameter

title: string
pulseConfigurationId: string

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
body body object false none
» title body string true Name of the survey
» pulseConfigurationId body string true Scheme identifier

Example responses

201 Response

{
  "id": "string",
  "name": "string"
}

Responses

Status Meaning Description Schema
201 Created Created surveyProfileField

Adds questions to a survey

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'multipart/form-data',
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.rewardgateway.net/survey/questions', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST https://api.rewardgateway.net/survey/questions HTTP/1.1
Host: api.rewardgateway.net
Content-Type: multipart/form-data
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X POST https://api.rewardgateway.net/survey/questions \
  -H 'Content-Type: multipart/form-data' \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'

const inputBody = '{
  "type": "string",
  "name": "string"
}';
const headers = {
  'Content-Type':'multipart/form-data',
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/survey/questions',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /survey/questions

This endpoint will create a new set of questions, tied to the survey.

Body parameter

type: string
name: string

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
body body object false none
» type body string true Type of the question
» name body string true Question text

Example responses

201 Response

{
  "id": "string",
  "name": "string"
}

Responses

Status Meaning Description Schema
201 Created Created surveyProfileField

Create a new wave of the survey

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'multipart/form-data',
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.rewardgateway.net/survey/period', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST https://api.rewardgateway.net/survey/period HTTP/1.1
Host: api.rewardgateway.net
Content-Type: multipart/form-data
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X POST https://api.rewardgateway.net/survey/period \
  -H 'Content-Type: multipart/form-data' \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'

const inputBody = '{
  "pulseConfigurationId": "string",
  "startDate": "string",
  "endDate": "string",
  "listId": "string"
}';
const headers = {
  'Content-Type':'multipart/form-data',
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/survey/period',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /survey/period

This endpoint will create a new wave of the current survey.

Body parameter

pulseConfigurationId: string
startDate: string
endDate: string
listId: string

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
body body object false none
» pulseConfigurationId body string true Survey identifier
» startDate body string true Start Date
» endDate body string true End Date
» listId body string true List Identifier

Example responses

201 Response

{
  "id": 0
}

Responses

Status Meaning Description Schema
201 Created Created surveyPeriod

Add a new recipient to a survey

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'multipart/form-data',
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.rewardgateway.net/survey/recipient', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST https://api.rewardgateway.net/survey/recipient HTTP/1.1
Host: api.rewardgateway.net
Content-Type: multipart/form-data
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X POST https://api.rewardgateway.net/survey/recipient \
  -H 'Content-Type: multipart/form-data' \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'

const inputBody = '{
  "dateCreated": "string",
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "listId": "string",
  "surveyId": 0
}';
const headers = {
  'Content-Type':'multipart/form-data',
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/survey/recipient',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /survey/recipient

This endpoint will add a new recipient to receive a particular survey

Body parameter

dateCreated: string
firstName: string
lastName: string
email: string
listId: string
surveyId: 0

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
body body object false none
» dateCreated body string true Date Created
» firstName body string true First Name
» lastName body string true Last Name
» email body string true Email
» listId body string true List Identifier
» surveyId body integer false List Identifier

Example responses

200 Response

{
  "referenceId": 0,
  "active": true,
  "dateCreated": "string",
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "listId": 0
}

Responses

Status Meaning Description Schema
200 OK Ok surveyRecipient

Save an answer for a recipient

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'multipart/form-data',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.rewardgateway.net/survey/recipient/answers', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST https://api.rewardgateway.net/survey/recipient/answers HTTP/1.1
Host: api.rewardgateway.net
Content-Type: multipart/form-data

Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X POST https://api.rewardgateway.net/survey/recipient/answers \
  -H 'Content-Type: multipart/form-data' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'

const inputBody = '{
  "surveyId": 0,
  "periodId": 0,
  "recipientReferenceId": 0
}';
const headers = {
  'Content-Type':'multipart/form-data',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/survey/recipient/answers',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /survey/recipient/answers

This endpoint will save a particular answer for a specific question on behalf of a user

Body parameter

surveyId: 0
periodId: 0
recipientReferenceId: 0

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
body body object false none
» surveyId body integer true Survey identifier
» periodId body integer true Period Date
» recipientReferenceId body integer true Recipient reference Identifier

Responses

Status Meaning Description Schema
201 Created Created None

Get a list of recipient collections available

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/recipient/list', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/recipient/list HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/recipient/list \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/recipient/list',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /recipient/list

This endpoint returns a list of available recipient collections. A recipient collection is merely a list of recipients that were added together.

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning

Example responses

200 Response

[
  {
    "id": 0,
    "name": "string",
    "scheme": {}
  }
]

Responses

Status Meaning Description Schema
200 OK Successful operation Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [recipientList] false none none
» id integer true none Recipient List
» name string true none Recipient List Name
» scheme object true none none

Create a recipient colleciton

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'multipart/form-data',
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.rewardgateway.net/recipient/list', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST https://api.rewardgateway.net/recipient/list HTTP/1.1
Host: api.rewardgateway.net
Content-Type: multipart/form-data
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X POST https://api.rewardgateway.net/recipient/list \
  -H 'Content-Type: multipart/form-data' \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'

const inputBody = '{
  "name": true
}';
const headers = {
  'Content-Type':'multipart/form-data',
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/recipient/list',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /recipient/list

This endpoint creates a recipient collection. Recipient collections can be used to make it easier to send out surveys to a bulk set of users.

Body parameter

name: true

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
body body object false none
» name body boolean true Name of the recipient List

Example responses

201 Response

{
  "id": 0,
  "name": "string",
  "scheme": {}
}

Responses

Status Meaning Description Schema
201 Created Created recipientList
403 Forbidden Access to the resource has been denied errorModel
406 Not Acceptable Required paramaters are not found errorModel

Get a recipient collection

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/recipient/list/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/recipient/list/{id} HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/recipient/list/{id} \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/recipient/list/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /recipient/list/{id}

This endpoint returns a recipient collection

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
id path string true Identifier of list

Example responses

200 Response

{
  "id": 0,
  "name": "string",
  "scheme": {}
}

Responses

Status Meaning Description Schema
200 OK Successful operation recipientList
401 Unauthorized Access to the resource has been denied errorModel
404 Not Found Resource could not be found errorModel

User

Endpoints to manage user information within a programme. We recommend you use SCIM API for complex user provisioning and data manipulation.

Get current member information

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/user/me', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/user/me HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/user/me \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/user/me',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /user/me

This endpoint returns information about the current member

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning

Example responses

200 Response

{
  "id": "string",
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "emailVisible": true,
  "summary": "string",
  "timezone": "string",
  "gender": "string",
  "addressLine1": "string",
  "addressLine2": "string",
  "addressLine3": "string",
  "addressLine4": "string",
  "postalCode": "string",
  "country": "string",
  "mobileNumber": "string",
  "mobileNumberVisible": "string",
  "telephoneNumber": "string",
  "avatar": "string",
  "dateOfBirth": "string",
  "dateOfBirthVisible": true,
  "registrationDate": "string",
  "registrationInfo": "string",
  "locale": {
    "id": 0,
    "name": "string",
    "lang": "string",
    "currency": "string",
    "symbol": "string",
    "states": [
      {
        "code": "string",
        "name": "string"
      }
    ],
    "contactFields": [
      null
    ],
    "mappings": {
      "locale": "Locale CDN url",
      "fallback": "Fallback locale CDN url"
    }
  },
  "scheme": {},
  "pushNotifications": true
}

Responses

Status Meaning Description Schema
200 OK Successful operation member
403 Forbidden Access to the resource has been denied errorModel

Get a specific member

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/user/{identifier}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/user/{identifier} HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/user/{identifier} \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/user/{identifier}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /user/{identifier}

This endpoint will return a member based on a member id, payroll number or email hash

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
identifier path string true Member identifier

Example responses

200 Response

{
  "id": "string",
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "emailVisible": true,
  "summary": "string",
  "timezone": "string",
  "avatar": "string",
  "dateOfBirth": "string",
  "dateOfBirthVisible": true,
  "registrationDate": "string",
  "registrationInfo": "string",
  "locale": {
    "id": 0,
    "name": "string",
    "lang": "string",
    "currency": "string",
    "symbol": "string",
    "states": [
      {
        "code": "string",
        "name": "string"
      }
    ],
    "contactFields": [
      null
    ],
    "mappings": {
      "locale": "Locale CDN url",
      "fallback": "Fallback locale CDN url"
    }
  },
  "scheme": {},
  "pushNotifications": true,
  "authenticatedClients": [
    "string"
  ],
  "registrationQuestionsAnswers": "string"
}

Responses

Status Meaning Description Schema
200 OK Successful operation privatemember
403 Forbidden Access to the resource has been denied errorModel

Get a list of members based on identifiers

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/user/bulk/{hash}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/user/bulk/{hash} HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/user/bulk/{hash} \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/user/bulk/{hash}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /user/bulk/{hash}

This endpoint returns a list of members based on identifiers

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
hash path string true Base 64 encoded hash of comma separated list of member identifiers

Example responses

200 Response

{
  "id": "string",
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "emailVisible": true,
  "summary": "string",
  "timezone": "string",
  "avatar": "string",
  "dateOfBirth": "string",
  "dateOfBirthVisible": true,
  "registrationDate": "string",
  "registrationInfo": "string",
  "locale": {
    "id": 0,
    "name": "string",
    "lang": "string",
    "currency": "string",
    "symbol": "string",
    "states": [
      {
        "code": "string",
        "name": "string"
      }
    ],
    "contactFields": [
      null
    ],
    "mappings": {
      "locale": "Locale CDN url",
      "fallback": "Fallback locale CDN url"
    }
  },
  "scheme": {},
  "pushNotifications": true,
  "authenticatedClients": [
    "string"
  ],
  "registrationQuestionsAnswers": "string"
}

Responses

Status Meaning Description Schema
200 OK Successful operation privatemember
403 Forbidden Access to the resource has been denied errorModel

Get hierarchy for specific member

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/user/{identifier}/hierarchy', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/user/{identifier}/hierarchy HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/user/{identifier}/hierarchy \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/user/{identifier}/hierarchy',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /user/{identifier}/hierarchy

This endpoint will return the hierarchy for specific members based on their member id, payroll number, email hash

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
identifier path integer true Member identifier

Example responses

200 Response

{
  "id": "string",
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "emailVisible": true,
  "summary": "string",
  "timezone": "string",
  "gender": "string",
  "addressLine1": "string",
  "addressLine2": "string",
  "addressLine3": "string",
  "addressLine4": "string",
  "postalCode": "string",
  "country": "string",
  "mobileNumber": "string",
  "mobileNumberVisible": "string",
  "telephoneNumber": "string",
  "avatar": "string",
  "dateOfBirth": "string",
  "dateOfBirthVisible": true,
  "registrationDate": "string",
  "registrationInfo": "string",
  "locale": {
    "id": 0,
    "name": "string",
    "lang": "string",
    "currency": "string",
    "symbol": "string",
    "states": [
      {
        "code": "string",
        "name": "string"
      }
    ],
    "contactFields": [
      null
    ],
    "mappings": {
      "locale": "Locale CDN url",
      "fallback": "Fallback locale CDN url"
    }
  },
  "scheme": {},
  "pushNotifications": true
}

Responses

Status Meaning Description Schema
200 OK Successful operation member
403 Forbidden Access to the resource has been denied errorModel

Get a specific member's information

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/user/{identifier}/details', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/user/{identifier}/details HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/user/{identifier}/details \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/user/{identifier}/details',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /user/{identifier}/details

This endpoint will return information about a specific member

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
identifier path integer true User identifier

Example responses

200 Response

{
  "id": "string",
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "emailVisible": true,
  "summary": "string",
  "timezone": "string",
  "gender": "string",
  "addressLine1": "string",
  "addressLine2": "string",
  "addressLine3": "string",
  "addressLine4": "string",
  "postalCode": "string",
  "country": "string",
  "mobileNumber": "string",
  "mobileNumberVisible": "string",
  "telephoneNumber": "string",
  "avatar": "string",
  "dateOfBirth": "string",
  "dateOfBirthVisible": true,
  "registrationDate": "string",
  "registrationInfo": "string",
  "locale": {
    "id": 0,
    "name": "string",
    "lang": "string",
    "currency": "string",
    "symbol": "string",
    "states": [
      {
        "code": "string",
        "name": "string"
      }
    ],
    "contactFields": [
      null
    ],
    "mappings": {
      "locale": "Locale CDN url",
      "fallback": "Fallback locale CDN url"
    }
  },
  "scheme": {},
  "pushNotifications": true
}

Responses

Status Meaning Description Schema
200 OK Successful operation member
403 Forbidden Access to the resource has been denied errorModel

Update current member information

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'multipart/form-data',
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.rewardgateway.net/user/update', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST https://api.rewardgateway.net/user/update HTTP/1.1
Host: api.rewardgateway.net
Content-Type: multipart/form-data
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X POST https://api.rewardgateway.net/user/update \
  -H 'Content-Type: multipart/form-data' \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'

const inputBody = '{
  "firstName": "string",
  "lastName": "string",
  "addressLine1": "string",
  "addressLine2": "string",
  "addressLine3": "string",
  "addressLine4": "string",
  "postalCode": "string",
  "daytimePhone": "string",
  "mobilePhone": "string"
}';
const headers = {
  'Content-Type':'multipart/form-data',
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/user/update',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /user/update

This endpoint will update information about the current member

Body parameter

firstName: string
lastName: string
addressLine1: string
addressLine2: string
addressLine3: string
addressLine4: string
postalCode: string
daytimePhone: string
mobilePhone: string

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
body body object false none
» firstName body string true First name
» lastName body string true Last name
» addressLine1 body string true Address line 1
» addressLine2 body string false Address line 2
» addressLine3 body string true Address line 3 - town,city
» addressLine4 body string false Address line 4 - county
» postalCode body string false Postal code
» daytimePhone body string false Home phone number
» mobilePhone body string false Mobile phone number

Example responses

200 Response

{
  "id": "string",
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "emailVisible": true,
  "summary": "string",
  "timezone": "string",
  "gender": "string",
  "addressLine1": "string",
  "addressLine2": "string",
  "addressLine3": "string",
  "addressLine4": "string",
  "postalCode": "string",
  "country": "string",
  "mobileNumber": "string",
  "mobileNumberVisible": "string",
  "telephoneNumber": "string",
  "avatar": "string",
  "dateOfBirth": "string",
  "dateOfBirthVisible": true,
  "registrationDate": "string",
  "registrationInfo": "string",
  "locale": {
    "id": 0,
    "name": "string",
    "lang": "string",
    "currency": "string",
    "symbol": "string",
    "states": [
      {
        "code": "string",
        "name": "string"
      }
    ],
    "contactFields": [
      null
    ],
    "mappings": {
      "locale": "Locale CDN url",
      "fallback": "Fallback locale CDN url"
    }
  },
  "scheme": {},
  "pushNotifications": true
}

Responses

Status Meaning Description Schema
200 OK Successful operation member
400 Bad Request Bad request errorModel
403 Forbidden Access to the resource has been denied errorModel

Get current member's savings

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/user/savings', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/user/savings HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/user/savings \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/user/savings',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /user/savings

This endpoint returns the savings statistics about the current member

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning

Example responses

200 Response

{
  "cashback": 0,
  "instore": 0,
  "total": 0
}

Responses

Status Meaning Description Schema
200 OK Savings statistics Inline
403 Forbidden Access to the resource has been denied errorModel

Response Schema

Status Code 200

Name Type Required Restrictions Description
» cashback number true none none
» instore number true none none
» total number true none none

Get current member's cashback balance

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/user/cashback/balance', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/user/cashback/balance HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/user/cashback/balance \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/user/cashback/balance',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /user/cashback/balance

This endpoint returns the cashback balance for the current member

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning

Example responses

200 Response

{
  "totalBalance": 0,
  "confirmedBalance": 0
}

Responses

Status Meaning Description Schema
200 OK Cashback balance available Inline
401 Unauthorized Invalid credentials errorModel

Response Schema

Status Code 200

Name Type Required Restrictions Description
» totalBalance number true none none
» confirmedBalance number true none none

Get current member's cashback statement

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/user/cashback/statement', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/user/cashback/statement HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/user/cashback/statement \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/user/cashback/statement',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /user/cashback/statement

This endpoint returns the cashback statement for the current member

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
page query integer false Offset the number of results returned
limit query integer false Constraint the number of results returned

Example responses

200 Response

[
  {
    "date": "string",
    "type": "string",
    "spent": 0.1,
    "cashback": 0.1,
    "status": "string"
  }
]

Responses

Status Meaning Description Schema
200 OK Successful operation Inline
400 Bad Request Invalid request errorModel
403 Forbidden Access to the resource has been denied errorModel

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [cashbackTransaction] false none none
» date string true none Transaction date
» type string true none Transaction type
» spent number(float) true none Amount spent
» cashback number(float) true none Cashback earned
» status string true none Transaction status

Search members by first and last name.

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/user/search', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/user/search?q=string HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/user/search?q=string \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/user/search?q=string',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /user/search

This endpoint returns a list of members based on search criteria for first and last name.

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
q query string true Search string

Example responses

200 Response

{
  "id": "string",
  "contactId": 0,
  "firstName": "string",
  "lastName": "string",
  "registrationQuestions": "string",
  "avatarUrl": "string"
}

Responses

Status Meaning Description Schema
200 OK Successful operation searchMember
403 Forbidden Access to the resource has been denied errorModel

Search specific member activity.

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/user/{identifier}/activity', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/user/{identifier}/activity HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/user/{identifier}/activity \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/user/{identifier}/activity',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /user/{identifier}/activity

This endpoint will search for specific members activity.

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
identifier path integer true Member identifier

Example responses

200 Response

{
  "id": 0,
  "activityType": "string",
  "iconURL": "string",
  "activityTimestamp": "string",
  "actionContact": {
    "id": "string",
    "firstName": "string",
    "lastName": "string",
    "email": "string",
    "emailVisible": true,
    "summary": "string",
    "timezone": "string",
    "gender": "string",
    "addressLine1": "string",
    "addressLine2": "string",
    "addressLine3": "string",
    "addressLine4": "string",
    "postalCode": "string",
    "country": "string",
    "mobileNumber": "string",
    "mobileNumberVisible": "string",
    "telephoneNumber": "string",
    "avatar": "string",
    "dateOfBirth": "string",
    "dateOfBirthVisible": true,
    "registrationDate": "string",
    "registrationInfo": "string",
    "locale": {
      "id": 0,
      "name": "string",
      "lang": "string",
      "currency": "string",
      "symbol": "string",
      "states": [
        {
          "code": "string",
          "name": "string"
        }
      ],
      "contactFields": [
        null
      ],
      "mappings": {
        "locale": "Locale CDN url",
        "fallback": "Fallback locale CDN url"
      }
    },
    "scheme": {},
    "pushNotifications": true
  },
  "feedItem": {
    "feedId": 0,
    "feedTitle": "string",
    "feedDescription": "string",
    "feedTimestamp": "string",
    "feedSubjectType": "string",
    "feedSubjectId": 0,
    "feedSegmentId": 0,
    "feedItemId": "string",
    "groupingId": "string",
    "feedSender": null,
    "feedContent": "string",
    "feedSummaryContent": null,
    "feedIsShared": true,
    "feedImage": "string",
    "feedRecipients": [
      0
    ],
    "feedComments": 0,
    "feedCommentData": [
      "string"
    ],
    "feedReactions": [
      null
    ],
    "feedReactionData": [
      null
    ],
    "feedUserReactionId": 0,
    "feedFirstUserToReact": [
      null
    ],
    "downloadUrl": [
      null
    ],
    "certificateUrl": [
      null
    ],
    "canDelete": true,
    "usersReactions": [
      null
    ],
    "reactionsTotals": [
      null
    ],
    "itemId": "string",
    "translationKeys": [
      "string"
    ],
    "canLike": true,
    "canComment": true
  }
}

Responses

Status Meaning Description Schema
200 OK Successful operation memberactivity
403 Forbidden Access to the resource has been denied errorModel

Get all supported stats for specific member

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'string',
    'Accept' => 'application/vnd.rewardgateway+json; version=2.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/user/{identifier}/stats', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/user/{identifier}/stats HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: string
Accept: application/vnd.rewardgateway+json; version=2.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/user/{identifier}/stats \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'Accept: application/vnd.rewardgateway+json; version=2.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'Accept':'application/vnd.rewardgateway+json; version=2.0'
};

fetch('https://api.rewardgateway.net/user/{identifier}/stats',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /user/{identifier}/stats

This endpoint returns all supported stats for specific member by member id, payroll number, email hash

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
identifier path integer true Member identifier

Example responses

200 Response

{
  "id": "string",
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "emailVisible": true,
  "summary": "string",
  "timezone": "string",
  "gender": "string",
  "addressLine1": "string",
  "addressLine2": "string",
  "addressLine3": "string",
  "addressLine4": "string",
  "postalCode": "string",
  "country": "string",
  "mobileNumber": "string",
  "mobileNumberVisible": "string",
  "telephoneNumber": "string",
  "avatar": "string",
  "dateOfBirth": "string",
  "dateOfBirthVisible": true,
  "registrationDate": "string",
  "registrationInfo": "string",
  "locale": {
    "id": 0,
    "name": "string",
    "lang": "string",
    "currency": "string",
    "symbol": "string",
    "states": [
      {
        "code": "string",
        "name": "string"
      }
    ],
    "contactFields": [
      null
    ],
    "mappings": {
      "locale": "Locale CDN url",
      "fallback": "Fallback locale CDN url"
    }
  },
  "scheme": {},
  "pushNotifications": true
}

Responses

Status Meaning Description Schema
200 OK Successful operation member
403 Forbidden Access to the resource has been denied errorModel

Schemas

retailerMatch

{
  "id": 0,
  "name": "string"
}

Properties

Name Type Required Restrictions Description
id integer(int32) true none none
name string true none none

authResponse

{
  "access_token": "string",
  "refresh_token": "string",
  "token_type": "string",
  "expires_in": 0
}

Properties

Name Type Required Restrictions Description
access_token string true none none
refresh_token string true none none
token_type string true none none
expires_in integer(int32) true none none

standardModel

{
  "code": 0,
  "message": "string",
  "details": null
}

Properties

Name Type Required Restrictions Description
code integer(int32) true none none
message string true none none
details any true none none

errorModel

{
  "code": 0,
  "message": "string"
}

Properties

Name Type Required Restrictions Description
code integer(int32) true none none
message string true none none

formErrorResponse

{
  "code": 0,
  "message": "string",
  "formFieldErrors": [
    {
      "fieldName": "string",
      "message": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
code integer(int32) true none none
message string true none none
formFieldErrors [formFieldError] true none none

basket

{
  "basketId": "string",
  "currency": "string",
  "total": 0.1,
  "subtotal": 0.1,
  "saving": 0.1,
  "items": [
    {
      "id": 0,
      "type": "string",
      "productId": 0,
      "productType": "string",
      "name": "string",
      "image": "string",
      "currency": "string",
      "price": 0.1,
      "cost": 0.1,
      "tax": 0.1,
      "saving": 0.1,
      "quantity": 0.1,
      "termsAndConditions": "string",
      "adjustments": [
        null
      ]
    }
  ],
  "messages": [
    null
  ]
}

Properties

Name Type Required Restrictions Description
basketId string true none Basket identifier
currency string true none Basket currency code
total number(float) true none Basket total
subtotal number(float) true none Basket subtotal
saving number(float) true none Basket saving
items [BasketItem] true none Basket items
messages [any] true none Basket messages

BasketItem

{
  "id": 0,
  "type": "string",
  "productId": 0,
  "productType": "string",
  "name": "string",
  "image": "string",
  "currency": "string",
  "price": 0.1,
  "cost": 0.1,
  "tax": 0.1,
  "saving": 0.1,
  "quantity": 0.1,
  "termsAndConditions": "string",
  "adjustments": [
    null
  ]
}

Properties

Name Type Required Restrictions Description
id integer false none Item's identifier
type string true none Item's type
productId integer false none Item's product identifier
productType string false none Item's product type
name string true none Item name
image string true none Item image
currency string true none Item currency
price number(float) true none Item price
cost number(float) true none Item cost
tax number(float) true none Item tax
saving number(float) true none Item discount
quantity number(float) true none Item quantity
termsAndConditions string true none Item terms & conditions
adjustments [any] false none none

blogfeed

{
  "feedId": 0,
  "feedTitle": "string",
  "feedTimestamp": "string",
  "feedSubjectType": "string",
  "feedSubjectId": 0,
  "feedSegmentId": 0,
  "feedItemId": "string",
  "groupingId": "string",
  "feedAuthor": [
    0
  ],
  "sender": [
    0
  ],
  "feedTimeToRead": "string",
  "feedViewsCount": 0,
  "feedTags": [
    "string"
  ],
  "feedIsShared": true,
  "feedContent": "string",
  "feedSummaryContent": null,
  "feedImage": "string",
  "feedComments": 0,
  "feedCommentData": [
    "string"
  ],
  "feedReactions": [
    "string"
  ],
  "feedReactionData": [
    "string"
  ],
  "feedUserReactionId": 0,
  "usersReactions": [
    "string"
  ],
  "reactionsTotals": [
    "string"
  ],
  "firstUserToReact": [
    0
  ],
  "canLike": true,
  "canComment": true,
  "itemId": "string",
  "blogName": "string",
  "recipients": [
    0
  ],
  "downloadUrl": "string",
  "certificateUrl": "string",
  "canDelete": true,
  "translationKeys": [
    "string"
  ]
}

Properties

Name Type Required Restrictions Description
feedId integer true none Feed item identifier
feedTitle string true none Feed title
feedTimestamp string false none Feed timestamp
feedSubjectType string true none Feed subject type
feedSubjectId integer true none Feed subject id
feedSegmentId integer false none Feed segment id
feedItemId string false none FeedItem identifier
groupingId string¦null false none Grouping identifier
feedAuthor [integer] false none Feed blog author
sender [integer] false none Feed blog sender
feedTimeToRead string false none Feed blog time to read
feedViewsCount integer false none Feed views count
feedTags [string] false none Feed content
feedIsShared boolean false none Feed isShared
feedContent string false none Feed blog content
feedSummaryContent any false none Feed blog summary content
feedImage string false none Feed image
feedComments integer false none Feed number of comments
feedCommentData [string] false none Feed comments
feedReactions [string] false none All reactions on feed item
feedReactionData [string] false none All reactions on feed item from all members
feedUserReactionId integer false none User reaction on feed item
usersReactions [string] false none All reactions on feed item
reactionsTotals [string] false none Stats about reactions on feed item
firstUserToReact [integer] false none First user to react to feed
canLike boolean false none Do you have permissions to like this feedItem
canComment boolean false none Do you have permissions to comment this feedItem
itemId string false none Item identifier
blogName string false none Name of the blog this post belongs to
recipients [integer] false none Feed recipients
downloadUrl string false none Relative download URL for the feedItem
certificateUrl string false none Relative certificate URL for the feedItem
canDelete boolean false none Do you have permissions to delete this feedItem
translationKeys [string] false none Mapping from phrase to translated phrase

cashbackTransaction

{
  "date": "string",
  "type": "string",
  "spent": 0.1,
  "cashback": 0.1,
  "status": "string"
}

Properties

Name Type Required Restrictions Description
date string true none Transaction date
type string true none Transaction type
spent number(float) true none Amount spent
cashback number(float) true none Cashback earned
status string true none Transaction status

customerNominationEntity

{
  "success": true,
  "message": "string",
  "errors": null,
  "nominationId": 0,
  "nominationFeedItem": [
    {
      "feedId": 0,
      "feedTitle": "string",
      "feedDescription": "string",
      "feedTimestamp": "string",
      "feedSubjectType": "string",
      "feedSubjectId": 0,
      "feedSegmentId": 0,
      "feedItemId": "string",
      "groupingId": "string",
      "feedSender": null,
      "feedContent": "string",
      "feedSummaryContent": null,
      "feedIsShared": true,
      "feedImage": "string",
      "feedRecipients": [
        0
      ],
      "feedComments": 0,
      "feedCommentData": [
        "string"
      ],
      "feedReactions": [
        null
      ],
      "feedReactionData": [
        null
      ],
      "feedUserReactionId": 0,
      "feedFirstUserToReact": [
        null
      ],
      "downloadUrl": [
        null
      ],
      "certificateUrl": [
        null
      ],
      "canDelete": true,
      "usersReactions": [
        null
      ],
      "reactionsTotals": [
        null
      ],
      "itemId": "string",
      "translationKeys": [
        "string"
      ],
      "canLike": true,
      "canComment": true
    }
  ]
}

Class NominationEntity

Properties

Name Type Required Restrictions Description
success boolean true none none
message string true none none
errors any true none none
nominationId integer true none none
nominationFeedItem [srwfeed] false none none

device

{
  "id": 0,
  "deviceOs": 0
}

Properties

Name Type Required Restrictions Description
id integer true none Device Id
deviceOs integer true none Device Operating System

fvdmerchant

{
  "id": 0,
  "name": "string",
  "description": "string",
  "website": "string",
  "logo": "string",
  "phone": "string",
  "cuisine": "string"
}

Class FVDMerchant

Properties

Name Type Required Restrictions Description
id integer true none none
name string true none none
description string true none none
website string true none none
logo string true none none
phone string true none none
cuisine string false none none

fvdoffer

{
  "id": 0,
  "title": "string",
  "numericPriceRange": 0,
  "priceRange": "string",
  "priceFrom": 0,
  "priceTo": 0,
  "dateCreated": "string",
  "dateUpdated": "string",
  "dateRedeemed": "string",
  "category": "string",
  "status": "string",
  "disclaimer": "string",
  "merchant": {
    "id": 0,
    "name": "string",
    "description": "string",
    "website": "string",
    "logo": "string",
    "phone": "string",
    "cuisine": "string"
  },
  "venue": {
    "id": 0,
    "lat": "string",
    "lon": "string",
    "address": "string",
    "suburb": "string",
    "state": "string",
    "postcode": "string",
    "regioncode": "string",
    "region": "string"
  }
}

Class FVDOffer

Properties

Name Type Required Restrictions Description
id integer true none none
title string true none none
numericPriceRange integer false none none
priceRange string false none none
priceFrom integer false none none
priceTo integer false none none
dateCreated string false none none
dateUpdated string false none none
dateRedeemed string false none none
category string false none none
status string false none none
disclaimer string false none none
merchant fvdmerchant true none Class FVDMerchant
venue fvdvenue false none Class FVDVenue

fvdvenue

{
  "id": 0,
  "lat": "string",
  "lon": "string",
  "address": "string",
  "suburb": "string",
  "state": "string",
  "postcode": "string",
  "regioncode": "string",
  "region": "string"
}

Class FVDVenue

Properties

Name Type Required Restrictions Description
id integer true none none
lat string true none none
lon string true none none
address string true none none
suburb string true none none
state string true none none
postcode string true none none
regioncode string true none none
region string true none none

formFieldError

{
  "fieldName": "string",
  "message": "string"
}

Properties

Name Type Required Restrictions Description
fieldName string true none none
message string true none none

formField

{
  "name": "string",
  "type": "string",
  "label": "string",
  "value": "string",
  "help": "string",
  "info": [
    {
      "imageURL": "string",
      "title": "string",
      "description": "string"
    }
  ],
  "options": [
    "string"
  ],
  "validators": [
    {
      "value": null,
      "type": "string",
      "message": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
name string true none Field name
type string true none Field Type
label string true none Field Label
value string false none Field value
help string false none Field help text
info [info] false none Additional Field info
options [string] false none Field options
validators [fieldValidation] true none Field Validators

fieldValidation

{
  "value": null,
  "type": "string",
  "message": "string"
}

Properties

Name Type Required Restrictions Description
value any true none Validate against value
type string true none Validation Type
message string true none Validation message

info

{
  "imageURL": "string",
  "title": "string",
  "description": "string"
}

Properties

Name Type Required Restrictions Description
imageURL string false none Url to an image
title string true none Title
description string false none Description

locale

{
  "id": 0,
  "name": "string",
  "lang": "string",
  "currency": "string",
  "symbol": "string",
  "states": [
    {
      "code": "string",
      "name": "string"
    }
  ],
  "contactFields": [
    null
  ],
  "mappings": {
    "locale": "Locale CDN url",
    "fallback": "Fallback locale CDN url"
  }
}

Properties

Name Type Required Restrictions Description
id integer true none Locale identifier
name string true none Locale name
lang string true none Locale language
currency string true none Locale currency
symbol string true none Locale currency symbol
states [state] true none Locale state list
contactFields [any] true none List of translated contact fields
mappings object false none none
» locale string false none Mappings to download jsons for React apps
» fallback string false none none

member

{
  "id": "string",
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "emailVisible": true,
  "summary": "string",
  "timezone": "string",
  "gender": "string",
  "addressLine1": "string",
  "addressLine2": "string",
  "addressLine3": "string",
  "addressLine4": "string",
  "postalCode": "string",
  "country": "string",
  "mobileNumber": "string",
  "mobileNumberVisible": "string",
  "telephoneNumber": "string",
  "avatar": "string",
  "dateOfBirth": "string",
  "dateOfBirthVisible": true,
  "registrationDate": "string",
  "registrationInfo": "string",
  "locale": {
    "id": 0,
    "name": "string",
    "lang": "string",
    "currency": "string",
    "symbol": "string",
    "states": [
      {
        "code": "string",
        "name": "string"
      }
    ],
    "contactFields": [
      null
    ],
    "mappings": {
      "locale": "Locale CDN url",
      "fallback": "Fallback locale CDN url"
    }
  },
  "scheme": {},
  "pushNotifications": true
}

Properties

Name Type Required Restrictions Description
id string true none Member identifier
firstName string true none Member first name
lastName string true none Member last name
email string true none Member email address
emailVisible boolean false none Member email address visibility
summary string false none Member's summary
timezone string false none Member's timezone
gender string true none Member gender
addressLine1 string true none Member address line 1
addressLine2 string true none Member address line 2
addressLine3 string true none Member address line 3
addressLine4 string true none Member address line 4
postalCode string true none Member postal code
country string true none Member country
mobileNumber string true none Member mobile number
mobileNumberVisible string false none Member mobile number visibility
telephoneNumber string true none Member telephone number
avatar string true none Member avatar
dateOfBirth string false none Member's date of birth
dateOfBirthVisible boolean false none Member's date of birth visibility
registrationDate string false none Member's registration date
registrationInfo string false none Member registration info
locale locale false none none
scheme scheme false none none
pushNotifications boolean false none none

memberactivity

{
  "id": 0,
  "activityType": "string",
  "iconURL": "string",
  "activityTimestamp": "string",
  "actionContact": {
    "id": "string",
    "firstName": "string",
    "lastName": "string",
    "email": "string",
    "emailVisible": true,
    "summary": "string",
    "timezone": "string",
    "gender": "string",
    "addressLine1": "string",
    "addressLine2": "string",
    "addressLine3": "string",
    "addressLine4": "string",
    "postalCode": "string",
    "country": "string",
    "mobileNumber": "string",
    "mobileNumberVisible": "string",
    "telephoneNumber": "string",
    "avatar": "string",
    "dateOfBirth": "string",
    "dateOfBirthVisible": true,
    "registrationDate": "string",
    "registrationInfo": "string",
    "locale": {
      "id": 0,
      "name": "string",
      "lang": "string",
      "currency": "string",
      "symbol": "string",
      "states": [
        {
          "code": "string",
          "name": "string"
        }
      ],
      "contactFields": [
        null
      ],
      "mappings": {
        "locale": "Locale CDN url",
        "fallback": "Fallback locale CDN url"
      }
    },
    "scheme": {},
    "pushNotifications": true
  },
  "feedItem": {
    "feedId": 0,
    "feedTitle": "string",
    "feedDescription": "string",
    "feedTimestamp": "string",
    "feedSubjectType": "string",
    "feedSubjectId": 0,
    "feedSegmentId": 0,
    "feedItemId": "string",
    "groupingId": "string",
    "feedSender": null,
    "feedContent": "string",
    "feedSummaryContent": null,
    "feedIsShared": true,
    "feedImage": "string",
    "feedRecipients": [
      0
    ],
    "feedComments": 0,
    "feedCommentData": [
      "string"
    ],
    "feedReactions": [
      null
    ],
    "feedReactionData": [
      null
    ],
    "feedUserReactionId": 0,
    "feedFirstUserToReact": [
      null
    ],
    "downloadUrl": [
      null
    ],
    "certificateUrl": [
      null
    ],
    "canDelete": true,
    "usersReactions": [
      null
    ],
    "reactionsTotals": [
      null
    ],
    "itemId": "string",
    "translationKeys": [
      "string"
    ],
    "canLike": true,
    "canComment": true
  }
}

Properties

Name Type Required Restrictions Description
id integer true none Member identifier
activityType string true none Activity type
iconURL string false none Activity icon URL
activityTimestamp string true none Activity timestamp
actionContact member true none none
feedItem srwfeed true none none

localeMinimal

{
  "id": 0
}

Properties

Name Type Required Restrictions Description
id integer true none Locale identifier

minimalMemberv2

{
  "id": "string",
  "email": "string",
  "scheme": {
    "logo": "string",
    "favicon": "string",
    "colours": {
      "navigationBackground": null,
      "navigationText": null,
      "buttonBackground": null,
      "buttonText": null,
      "pageBackground": null,
      "chevronBackground": null,
      "chevronText": null,
      "unselectedTabBackground": null,
      "unselectedTabText": null,
      "selectedTabBackground": null,
      "selectedTabText": null,
      "offersCarouselBackground": null,
      "offersCarouselText": null,
      "registerButtonBackground": null,
      "registerButtonText": null
    }
  }
}

Properties

Name Type Required Restrictions Description
id string true none Member identifier
email string true none Member email
scheme schemeBranding true none none

schemeMinimal

{
  "id": 0,
  "name": "string",
  "companyName": "string",
  "url": "string",
  "hasUsernameEndpoint": true,
  "locale": {
    "id": 0
  },
  "branding": {
    "logo": "string",
    "favicon": "string",
    "colours": {
      "navigationBackground": null,
      "navigationText": null,
      "buttonBackground": null,
      "buttonText": null,
      "pageBackground": null,
      "chevronBackground": null,
      "chevronText": null,
      "unselectedTabBackground": null,
      "unselectedTabText": null,
      "selectedTabBackground": null,
      "selectedTabText": null,
      "offersCarouselBackground": null,
      "offersCarouselText": null,
      "registerButtonBackground": null,
      "registerButtonText": null
    }
  }
}

Properties

Name Type Required Restrictions Description
id integer true none Programme identifier
name string true none Programme name
companyName string true none Programme company name
url string true none Programme URL
hasUsernameEndpoint boolean true none Programme's username endpoint
locale localeMinimal true none none
branding schemeBranding false none none

schemeBranding

{
  "logo": "string",
  "favicon": "string",
  "colours": {
    "navigationBackground": null,
    "navigationText": null,
    "buttonBackground": null,
    "buttonText": null,
    "pageBackground": null,
    "chevronBackground": null,
    "chevronText": null,
    "unselectedTabBackground": null,
    "unselectedTabText": null,
    "selectedTabBackground": null,
    "selectedTabText": null,
    "offersCarouselBackground": null,
    "offersCarouselText": null,
    "registerButtonBackground": null,
    "registerButtonText": null
  }
}

Properties

Name Type Required Restrictions Description
logo string true none none
favicon string true none none
colours schemeBrandingColours false none none

minimalVoucher

{
  "transactionId": 0,
  "entityId": 0,
  "date": "string",
  "logo": "string",
  "name": "string",
  "type": "Paper",
  "denomination": 0.1,
  "redeemed": true,
  "archived": true,
  "refundable": true,
  "currency": "string"
}

Properties

Name Type Required Restrictions Description
transactionId integer true none Voucher transaction identifier
entityId integer true none Voucher entity identifier
date string true none Voucher purchase date (from Order)
logo string true none Voucher logo (from product/retailer)
name string true none Voucher name (from product)
type string true none Voucher product type
denomination number(float) true none Voucher denomination
redeemed boolean true none Voucher redemption status
archived boolean true none Voucher archival status
refundable boolean false none Is the voucher refundable
currency string false none Currency

Enumerated Values

Property Value
type Paper
type Electronic
type Card
type Topup
type SMS
type EGiftCard

actionReason

{
  "id": 0,
  "reason": "string",
  "approverFullName": "string"
}

Properties

Name Type Required Restrictions Description
id integer true none Nomination Id
reason string true none Action reason for nomination
approverFullName string true none Approver Full Name

approver

{
  "id": 0,
  "contactId": 0,
  "fullName": "string",
  "firstName": "string",
  "lastName": "string",
  "registrationQuestions": "string",
  "avatarUrl": "string"
}

Properties

Name Type Required Restrictions Description
id integer true none LicenceId
contactId integer true none ContactId
fullName string true none Full Name
firstName string true none First Name
lastName string true none lastName
registrationQuestions string¦null true none registrationQuestions
avatarUrl string¦null true none avatarUrl

nomination

{
  "id": 0,
  "rrProgramId": 123,
  "rrProgramName": "string",
  "nominees": [
    {
      "id": "string",
      "fullName": "string"
    }
  ],
  "approvers": [
    {
      "id": 0,
      "contactId": 0,
      "fullName": "string",
      "firstName": "string",
      "lastName": "string",
      "registrationQuestions": "string",
      "avatarUrl": "string"
    }
  ],
  "nominator": [
    {
      "id": 0,
      "fullName": "string",
      "isMember": "string"
    }
  ],
  "date": "string",
  "formattedDate": "string",
  "award": [
    {
      "id": 0,
      "title": "string",
      "valueFullName": "string",
      "valueShortName": "string",
      "value": 0.1,
      "alternativeValues": [
        "string"
      ]
    }
  ],
  "awards": [
    {
      "id": 0,
      "title": "string",
      "valueFullName": "string",
      "valueShortName": "string",
      "value": 0.1,
      "alternativeValues": [
        "string"
      ]
    }
  ],
  "reasons": [
    {
      "id": 0,
      "question": "string",
      "answer": "string",
      "type": "string"
    }
  ],
  "editNominee": true,
  "editAwardMessage": true,
  "visibility": "string",
  "actionReason": [
    {
      "id": 0,
      "reason": "string",
      "approverFullName": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
id integer true none Nomination identifier
rrProgramId integer true none RR Scheme identifier
rrProgramName string true none RR Program Name
nominees [nominee] true none Nominee
approvers [approver] true none Approvers
nominator [nominator] true none Nominator
date string true none Date of the nomination
formattedDate string true none Date of the nomination
award [nominationAwardType] true none Nomination's Award
awards [nominationAwardType] true none Collection of Awards
reasons [question] true none Collection of Questions and Answers
editNominee boolean false none Flag indicating whether a nominee may be changed by reviewer
editAwardMessage boolean false none Flag indicating whether the award reason may be changed
visibility string false none Visibility of the nomination
actionReason [actionReason] false none Collection of Approval Action Reason

nominationAwardType

{
  "id": 0,
  "title": "string",
  "valueFullName": "string",
  "valueShortName": "string",
  "value": 0.1,
  "alternativeValues": [
    "string"
  ]
}

Properties

Name Type Required Restrictions Description
id integer true none Award Id
title string true none Title
valueFullName string true none Value Full Name
valueShortName string true none Value Short Name
value number(float) true none Award value
alternativeValues [string] true none Alternative value for an award

nominator

{
  "id": 0,
  "fullName": "string",
  "isMember": "string"
}

Properties

Name Type Required Restrictions Description
id integer true none Nominee Id
fullName string true none Full Name
isMember string false none Check if returned nominator is valid member or just placeholder with name.

nominee

{
  "id": "string",
  "fullName": "string"
}

Properties

Name Type Required Restrictions Description
id string true none Nominee Id
fullName string true none Full Name

question

{
  "id": 0,
  "question": "string",
  "answer": "string",
  "type": "string"
}

Properties

Name Type Required Restrictions Description
id integer true none QuestionId
question string true none Question
answer string true none Answer
type string true none Type

Notification

{
  "senderContact": [
    null
  ],
  "recipientContact": [
    null
  ],
  "actionContact": [
    null
  ],
  "notificationId": 0,
  "notificationType": "string",
  "feedItemId": "string",
  "commentId": 0,
  "isRead": true,
  "createdDate": "string",
  "subjectId": 0,
  "subjectType": "string",
  "subjectTitle": "string",
  "iconUrl": "string"
}

Class Notification

Properties

Name Type Required Restrictions Description
senderContact [any] false none Sender Contact
recipientContact [any] false none Recipient Contact
actionContact [any] false none Action Contact
notificationId integer false none Notification Id
notificationType string false none Notification Type
feedItemId string false none Feed Item Id
commentId integer false none Comment Id
isRead boolean false none Notification isRead
createdDate string false none Notification created timestamp
subjectId integer false none Notification Subject id
subjectType string false none Notification subject type
subjectTitle string false none Feed subject title
iconUrl string false none Feed subject type

notificationMessage

{
  "typeId": 0,
  "typeName": "string",
  "message": "string"
}

Properties

Name Type Required Restrictions Description
typeId integer true none Message type
typeName string true none Page name for the message
message string true none Message

offer

{
  "id": 0,
  "typeId": 0,
  "typeName": "string",
  "trackingType": "string",
  "offerDescription": "string",
  "discountRateTitles": [
    "string"
  ],
  "discountRate": "string",
  "discountRatePrefix": "string",
  "discountType": "string",
  "discountValue": 0.1,
  "discountDescription": "string",
  "discountFullTitle": "string",
  "discountNormal": "string",
  "canBeUsedOnline": true,
  "canBeUsedInstore": true,
  "redeemableOnDesktop": true,
  "redeemableOnMobile": true,
  "keyInformation": "string",
  "howItWorks": "string",
  "termsAndConditions": "string",
  "isSpecialOffer": true,
  "isExpiring": true,
  "expiryDate": "string",
  "buttons": [
    {
      "productId": 0,
      "title": "string",
      "handoverUrl": "string",
      "product": null,
      "extras": [
        null
      ],
      "primaryUrl": "string"
    }
  ],
  "additionalInformation": [
    {
      "imageURL": "string",
      "title": "string",
      "description": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
id integer true none Offer identifier
typeId integer true none Offer type identifier
typeName string true none Offer type name
trackingType string true none Offer tracking type
offerDescription string true none Offer description
discountRateTitles [string] true none Discount rate prefixes
discountRate string true none Discount rate
discountRatePrefix string true none Discount rate prefix
discountType string true none Discount type
discountValue number(float) true none Discount value
discountDescription string true none Discount description
discountFullTitle string true none Discount full title
discountNormal string true none Normal discount rate
canBeUsedOnline boolean true none Can be used online?
canBeUsedInstore boolean true none Can be used instore?
redeemableOnDesktop boolean true none Is redeemable on desktop?
redeemableOnMobile boolean true none Is redeemable on mobile?
keyInformation string true none Key Information about the offer
howItWorks string true none How the Offer works
termsAndConditions string true none Terms and conditions
isSpecialOffer boolean true none Is this a special offer?
isExpiring boolean true none Is the offer expiring?
expiryDate string true none Expiry date
buttons [offerButton] true none Offer buttons
additionalInformation [info] true none Additional Information about the offer

offerButton

{
  "productId": 0,
  "title": "string",
  "handoverUrl": "string",
  "product": null,
  "extras": [
    null
  ],
  "primaryUrl": "string"
}

Properties

Name Type Required Restrictions Description
productId integer true none Product identifier
title string true none Button title
handoverUrl string false none Handover URL
product any false none Product entity
extras [any] false none Code
primaryUrl string false none The offer's retailer primary domain URL

order

{
  "id": 0,
  "date": "string",
  "email": "string",
  "telephone": "string",
  "shippingAddress": "string",
  "amount": 0.1,
  "paid": 0.1,
  "items": [
    {
      "date": "string",
      "logo": "string",
      "name": "string",
      "status": "string",
      "quantity": 0,
      "amount": 0.1,
      "paid": 0.1,
      "vouchers": [
        {
          "transactionId": 0,
          "entityId": 0,
          "date": "string",
          "logo": "string",
          "name": "string",
          "type": "Paper",
          "denomination": 0.1,
          "redeemed": true,
          "archived": true,
          "refundable": true,
          "currency": "string"
        }
      ],
      "instrumentId": 0,
      "product": {
        "id": 0,
        "name": "string",
        "price": 0.1,
        "type": "Paper",
        "typeId": 0,
        "visibility": [
          "string"
        ],
        "stockCode": "string",
        "stockStatus": "string",
        "statusMessage": "string",
        "retailer": "string",
        "printingRequired": true,
        "minimumOrder": 0.1,
        "maximumOrder": 0.1,
        "denominations": [
          0
        ],
        "related": {},
        "instant": true,
        "maxLimit": 0
      }
    }
  ],
  "messages": [
    "string"
  ]
}

Properties

Name Type Required Restrictions Description
id integer true none Order identifier
date string true none Order date
email string true none Order email address
telephone string true none Order telephone number
shippingAddress string true none Order shipping address
amount number(float) true none Order amount
paid number(float) true none Order paid
items [orderItem] false none Order items
messages [string] false none Order messages

orderItem

{
  "date": "string",
  "logo": "string",
  "name": "string",
  "status": "string",
  "quantity": 0,
  "amount": 0.1,
  "paid": 0.1,
  "vouchers": [
    {
      "transactionId": 0,
      "entityId": 0,
      "date": "string",
      "logo": "string",
      "name": "string",
      "type": "Paper",
      "denomination": 0.1,
      "redeemed": true,
      "archived": true,
      "refundable": true,
      "currency": "string"
    }
  ],
  "instrumentId": 0,
  "product": {
    "id": 0,
    "name": "string",
    "price": 0.1,
    "type": "Paper",
    "typeId": 0,
    "visibility": [
      "string"
    ],
    "stockCode": "string",
    "stockStatus": "string",
    "statusMessage": "string",
    "retailer": "string",
    "printingRequired": true,
    "minimumOrder": 0.1,
    "maximumOrder": 0.1,
    "denominations": [
      0
    ],
    "related": {},
    "instant": true,
    "maxLimit": 0
  }
}

Properties

Name Type Required Restrictions Description
date string true none Order date
logo string true none Order item logo
name string true none Order item name
status string false none Order item status
quantity integer false none Order item quantity
amount number(float) true none Order item amount
paid number(float) true none Order item paid
vouchers [minimalVoucher] true none Order item Vouchers
instrumentId integer false none Instrument identifier
product product true none none

paymentCard

{
  "id": "string",
  "alias": "string",
  "cardExpiry": "string",
  "cardPan": "string",
  "cardType": "string",
  "cardFee": 0.1,
  "isCreditCard": true,
  "isTrusted": true,
  "firstName": "string",
  "lastName": "string",
  "addressLine1": "string",
  "addressLine2": "string",
  "addressLine3": "string",
  "addressLine4": "string",
  "postalCode": "string",
  "country": "string",
  "subscriptionId": "string"
}

Properties

Name Type Required Restrictions Description
id string true none Payment card identifier
alias string true none Payment card alias
cardExpiry string true none Payment card expiry
cardPan string true none Payment card PAN
cardType string true none Payment card type
cardFee number(float) true none Credit card fee
isCreditCard boolean true none Is credit card?
isTrusted boolean true none Is payment card trusted?
firstName string true none Payment card billing first name
lastName string true none Payment card billing last name
addressLine1 string true none Payment card billing address line 1
addressLine2 string true none Payment card billing address line 2
addressLine3 string true none Payment card billing address line 3
addressLine4 string true none Payment card billing address line 4
postalCode string true none Payment card billing postal code
country string true none Payment card billing address country
subscriptionId string¦null true none Payment card token

privatemember

{
  "id": "string",
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "emailVisible": true,
  "summary": "string",
  "timezone": "string",
  "avatar": "string",
  "dateOfBirth": "string",
  "dateOfBirthVisible": true,
  "registrationDate": "string",
  "registrationInfo": "string",
  "locale": {
    "id": 0,
    "name": "string",
    "lang": "string",
    "currency": "string",
    "symbol": "string",
    "states": [
      {
        "code": "string",
        "name": "string"
      }
    ],
    "contactFields": [
      null
    ],
    "mappings": {
      "locale": "Locale CDN url",
      "fallback": "Fallback locale CDN url"
    }
  },
  "scheme": {},
  "pushNotifications": true,
  "authenticatedClients": [
    "string"
  ],
  "registrationQuestionsAnswers": "string"
}

PrivateMember API class

Properties

Name Type Required Restrictions Description
id string true none Member identifier
firstName string true none Member first name
lastName string true none Member last name
email string true none Member email address
emailVisible boolean false none Member email address visibility
summary string false none Member's summary
timezone string false none Member's timezone
avatar string true none Member avatar
dateOfBirth string false none Member's date of birth
dateOfBirthVisible boolean false none Member's date of birth visibility
registrationDate string false none Member's registration date
registrationInfo string false none Member registration info
locale locale false none none
scheme scheme false none none
pushNotifications boolean false none Push notifications status
authenticatedClients [string] false none Authenticated clients
registrationQuestionsAnswers string false none Answers for discriminator registration questions

product

{
  "id": 0,
  "name": "string",
  "price": 0.1,
  "type": "Paper",
  "typeId": 0,
  "visibility": [
    "string"
  ],
  "stockCode": "string",
  "stockStatus": "string",
  "statusMessage": "string",
  "retailer": "string",
  "printingRequired": true,
  "minimumOrder": 0.1,
  "maximumOrder": 0.1,
  "denominations": [
    0
  ],
  "related": {
    "id": 0,
    "name": "string",
    "price": 0.1,
    "type": "Paper",
    "typeId": 0,
    "visibility": [
      "string"
    ],
    "stockCode": "string",
    "stockStatus": "string",
    "statusMessage": "string",
    "retailer": "string",
    "printingRequired": true,
    "minimumOrder": 0.1,
    "maximumOrder": 0.1,
    "denominations": [
      0
    ],
    "related": {},
    "instant": true,
    "maxLimit": 0
  },
  "instant": true,
  "maxLimit": 0
}

Properties

Name Type Required Restrictions Description
id integer true none Product identifier
name string true none Product name
price number(float) true none Product price
type string true none Product type
typeId integer true none Product type id
visibility [string] true none Product visibility
stockCode string true none Product stock code
stockStatus string true none Product stock status
statusMessage string true none Product status message
retailer string false none Product retailer`s name
printingRequired boolean true none Product requires printing
minimumOrder number(float) true none Product minimum order amount
maximumOrder number(float) true none Product maximum order amount
denominations [number] true none Product denominations
related product false none none
instant boolean false none Is product instant (Available only for Top Up Product)
maxLimit integer false none Max Card Limit (Available only for Top Up Card Product)

Enumerated Values

Property Value
type Paper
type Electronic
type Card
type Topup
type SMS
type EGiftCard

activityPoint

{
  "id": 0,
  "amount": 0,
  "currency": "string",
  "activity": "string",
  "formattedDate": "string",
  "date": "string"
}

Class ActivityPoint

Properties

Name Type Required Restrictions Description
id integer true none amount
amount integer true none amount
currency string true none currency
activity string true none activity
formattedDate string true none formattedDate
date string true none date

reloadableCard

{
  "id": 0,
  "name": "string",
  "alias": "string",
  "image": "string",
  "pan": "string",
  "offer": {
    "id": 0,
    "typeId": 0,
    "typeName": "string",
    "trackingType": "string",
    "offerDescription": "string",
    "discountRateTitles": [
      "string"
    ],
    "discountRate": "string",
    "discountRatePrefix": "string",
    "discountType": "string",
    "discountValue": 0.1,
    "discountDescription": "string",
    "discountFullTitle": "string",
    "discountNormal": "string",
    "canBeUsedOnline": true,
    "canBeUsedInstore": true,
    "redeemableOnDesktop": true,
    "redeemableOnMobile": true,
    "keyInformation": "string",
    "howItWorks": "string",
    "termsAndConditions": "string",
    "isSpecialOffer": true,
    "isExpiring": true,
    "expiryDate": "string",
    "buttons": [
      {
        "productId": 0,
        "title": "string",
        "handoverUrl": "string",
        "product": null,
        "extras": [
          null
        ],
        "primaryUrl": "string"
      }
    ],
    "additionalInformation": [
      {
        "imageURL": "string",
        "title": "string",
        "description": "string"
      }
    ]
  },
  "pendingAmount": "string",
  "activated": true,
  "expiryDate": "string",
  "expiryAction": "string",
  "expiryMessage": "string"
}

Properties

Name Type Required Restrictions Description
id integer true none Reloadable card identifier
name string true none Reloadable card name
alias string true none Reloadable card alias
image string true none Reloadable card image
pan string true none Reloadable card PAN
offer offer true none none
pendingAmount string true none Reloadable card pending amount
activated boolean false none Activated
expiryDate string false none Reloadable card expiry date
expiryAction string false none Reloadable ES card expiry action
expiryMessage string false none Reloadable ES card message if card is expiring

retailer

{
  "id": 0,
  "name": "string",
  "description": "string",
  "logo": "string",
  "banner": "string",
  "bestOffer": "string",
  "canBeUsedOnline": true,
  "canBeUsedInstore": true,
  "isFavourite": true,
  "canBeUsedAt": "string",
  "availableOffers": 0,
  "isFeatured": true
}

Properties

Name Type Required Restrictions Description
id integer true none Retailer identifier
name string true none Retailer name
description string true none Retailer Description
logo string true none Retailer logo
banner string false none Retailer banner
bestOffer string true none Best offer description
canBeUsedOnline boolean false none Can be used online?
canBeUsedInstore boolean false none Can be used instore?
isFavourite boolean false none Is it favourite retailer
canBeUsedAt string false none Offers bought here can be used at
availableOffers integer false none Available offers for the retailer
isFeatured boolean false none Is it a featured retailer

retailerCategory

{
  "id": 0,
  "parentId": 0,
  "name": "string",
  "weight": 0,
  "version": 0,
  "retailerCount": 0
}

Properties

Name Type Required Restrictions Description
id integer true none Category identifier
parentId integer true none Parent category identifier
name string true none Category name
weight integer true none Category weight
version integer true none Category version
retailerCount integer true none Category retailers count

retailerPromotion

{
  "name": "string",
  "items": [
    {
      "id": 0,
      "name": "string",
      "description": "string",
      "logo": "string",
      "banner": "string",
      "bestOffer": "string",
      "canBeUsedOnline": true,
      "canBeUsedInstore": true,
      "isFavourite": true,
      "canBeUsedAt": "string",
      "availableOffers": 0,
      "isFeatured": true
    }
  ]
}

Class RetailerPromotion

Properties

Name Type Required Restrictions Description
name string true none none
items [retailer] true none none

srwcomments

{
  "id": 0,
  "comment": "string",
  "commentHtml": "string",
  "dateAdded": "string",
  "subjectType": 0,
  "subjectId": "string",
  "schemeId": 0,
  "segmentId": 0,
  "isDeleted": true,
  "user": [
    0
  ],
  "numberOfReactions": 0,
  "commentReplies": [
    "string"
  ],
  "repliesCount": 0,
  "reactionsTotals": [
    "string"
  ],
  "usersReactions": [
    null
  ],
  "canEdit": true,
  "canDelete": true
}

Properties

Name Type Required Restrictions Description
id integer true none Comment identifier
comment string true none Comment text
commentHtml string false none Comment HTML
dateAdded string false none Comment date added
subjectType integer true none Comment subject type
subjectId string true none Comment subject identifier
schemeId integer false none Scheme identifier
segmentId integer false none Segment identifier
isDeleted boolean false none Comment is deleted
user [integer] false none Comment creator
numberOfReactions integer false none Comment number of reactions
commentReplies [string] false none Comment replies
repliesCount integer false none Comment replies count
reactionsTotals [string] false none A count of each reaction type
usersReactions [any] false none Users who reacted
canEdit boolean false none Do you have permissions to edit this comment
canDelete boolean false none Do you have permissions to delete this comment

srwreply

{
  "id": 0,
  "comment": "string",
  "commentHTML": "string",
  "dateAdded": "string",
  "subjectType": 0,
  "subjectId": 0,
  "schemeId": 0,
  "segmentId": 0,
  "isDeleted": true,
  "user": [
    0
  ],
  "numberOfReactions": 0,
  "replies": [
    null
  ],
  "repliesCount": 0,
  "reactionsTotals": [
    null
  ],
  "usersReactions": [
    null
  ],
  "canEdit": true,
  "canDelete": true
}

Properties

Name Type Required Restrictions Description
id integer true none Comment identifier
comment string true none Comment text
commentHTML string false none Comment HTML
dateAdded string false none Comment date added
subjectType integer true none Comment subject type
subjectId integer true none Comment subject identifier
schemeId integer false none Scheme identifier
segmentId integer false none Segment identifier
isDeleted boolean false none Comment is deleted
user [integer] false none Comment creator
numberOfReactions integer false none Comment number of reactions
replies [any] false none Comment replies
repliesCount integer false none Comment replies count
reactionsTotals [any] false none A count of each reaction type
usersReactions [any] false none Users who reacted
canEdit boolean false none Do you have permissions to edit this reply
canDelete boolean false none Do you have permissions to delete this reply

teamMembers

{
  "fullName": null,
  "firstName": null,
  "lastName": null,
  "email": null,
  "cc": [
    "string"
  ],
  "image": null,
  "location": null,
  "description": null,
  "role": null,
  "id": 0,
  "uuid": "string",
  "name": "string",
  "companyName": "string",
  "url": "string",
  "hasUsernameEndpoint": true,
  "team": [
    {
      "fullName": null,
      "firstName": null,
      "lastName": null,
      "email": null,
      "cc": [
        "string"
      ],
      "image": null,
      "location": null,
      "description": null,
      "role": null,
      "id": 0,
      "uuid": "string",
      "name": "string",
      "companyName": "string",
      "url": "string",
      "hasUsernameEndpoint": true,
      "team": [],
      "branding": {
        "logo": "string",
        "favicon": "string",
        "colours": {
          "navigationBackground": null,
          "navigationText": null,
          "buttonBackground": null,
          "buttonText": null,
          "pageBackground": null,
          "chevronBackground": null,
          "chevronText": null,
          "unselectedTabBackground": null,
          "unselectedTabText": null,
          "selectedTabBackground": null,
          "selectedTabText": null,
          "offersCarouselBackground": null,
          "offersCarouselText": null,
          "registerButtonBackground": null,
          "registerButtonText": null
        }
      },
      "locale": {
        "id": 0,
        "name": "string",
        "lang": "string",
        "currency": "string",
        "symbol": "string",
        "states": [
          {
            "code": "string",
            "name": "string"
          }
        ],
        "contactFields": [
          null
        ],
        "mappings": {
          "locale": "Locale CDN url",
          "fallback": "Fallback locale CDN url"
        }
      },
      "programmeTypes": [
        null
      ],
      "enabledConfigurations": [
        null
      ],
      "addressLine1": "265 Tottenham Court Rd",
      "addressLine2": "Street Details",
      "addressLine3": "London",
      "addressLine4": "Fitzrovia",
      "postalCode": "W1T 7RQ",
      "status": 0
    }
  ],
  "branding": {
    "logo": "string",
    "favicon": "string",
    "colours": {
      "navigationBackground": null,
      "navigationText": null,
      "buttonBackground": null,
      "buttonText": null,
      "pageBackground": null,
      "chevronBackground": null,
      "chevronText": null,
      "unselectedTabBackground": null,
      "unselectedTabText": null,
      "selectedTabBackground": null,
      "selectedTabText": null,
      "offersCarouselBackground": null,
      "offersCarouselText": null,
      "registerButtonBackground": null,
      "registerButtonText": null
    }
  },
  "locale": {
    "id": 0,
    "name": "string",
    "lang": "string",
    "currency": "string",
    "symbol": "string",
    "states": [
      {
        "code": "string",
        "name": "string"
      }
    ],
    "contactFields": [
      null
    ],
    "mappings": {
      "locale": "Locale CDN url",
      "fallback": "Fallback locale CDN url"
    }
  },
  "programmeTypes": [
    null
  ],
  "enabledConfigurations": [
    null
  ],
  "addressLine1": "265 Tottenham Court Rd",
  "addressLine2": "Street Details",
  "addressLine3": "London",
  "addressLine4": "Fitzrovia",
  "postalCode": "W1T 7RQ",
  "status": 0
}

Properties

Name Type Required Restrictions Description
fullName any true none none
firstName any true none none
lastName any true none none
email any true none none
cc [string] true none none
image any true none none
location any true none none
description any true none none
role any true none none
id integer false none Programme identifier
uuid string false none Programme UUID
name string false none Programme name
companyName string false none Programme company name
url string false none Programme URL
hasUsernameEndpoint boolean false none Programme's username endpoint
team [teamMembers] false none Programme's team
branding schemeBranding false none none
locale locale false none none
programmeTypes [any] false none Programme types for the scheme
enabledConfigurations [any] false none none
addressLine1 string false none Street Name 1
addressLine2 string false none Street Name 2
addressLine3 string false none City / Town
addressLine4 string false none County / State
postalCode string false none none
status integer false none 0 = Implementation, 1 = Live, 2 = Closing, 3 = Closed, 4 = Live Demo

Enumerated Values

Property Value
status 0
status 1
status 2
status 3
status 4

schemeBrandingColours

{
  "navigationBackground": null,
  "navigationText": null,
  "buttonBackground": null,
  "buttonText": null,
  "pageBackground": null,
  "chevronBackground": null,
  "chevronText": null,
  "unselectedTabBackground": null,
  "unselectedTabText": null,
  "selectedTabBackground": null,
  "selectedTabText": null,
  "offersCarouselBackground": null,
  "offersCarouselText": null,
  "registerButtonBackground": null,
  "registerButtonText": null
}

Properties

Name Type Required Restrictions Description
navigationBackground any true none none
navigationText any true none none
buttonBackground any false none none
buttonText any false none none
pageBackground any false none none
chevronBackground any false none none
chevronText any false none none
unselectedTabBackground any false none none
unselectedTabText any false none none
selectedTabBackground any false none none
selectedTabText any false none none
offersCarouselBackground any false none none
offersCarouselText any false none none
registerButtonBackground any false none none
registerButtonText any false none none

scheme

{}

Properties

None

schemeProduct

{
  "id": "string",
  "name": "string",
  "description": "string",
  "url": "string",
  "icon": "string",
  "enabled": "string"
}

Properties

Name Type Required Restrictions Description
id string true none The product identifier
name string true none The product name
description string true none The product description
url string true none The product url
icon string true none The product icon
enabled string true none The product status

schemeProductCategory

{
  "id": "string",
  "name": "string",
  "products": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "url": "string",
      "icon": "string",
      "enabled": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
id string true none The product identifier
name string true none The product name
products [schemeProduct] true none The product description

searchMember

{
  "id": "string",
  "contactId": 0,
  "firstName": "string",
  "lastName": "string",
  "registrationQuestions": "string",
  "avatarUrl": "string"
}

Properties

Name Type Required Restrictions Description
id string true none Member identifier
contactId integer false none Member contact id
firstName string true none Member first name
lastName string true none Member last name
registrationQuestions string true none Member label based on top 3 discriminatory fields
avatarUrl string true none Member profile url

srwfeed

{
  "feedId": 0,
  "feedTitle": "string",
  "feedDescription": "string",
  "feedTimestamp": "string",
  "feedSubjectType": "string",
  "feedSubjectId": 0,
  "feedSegmentId": 0,
  "feedItemId": "string",
  "groupingId": "string",
  "feedSender": null,
  "feedContent": "string",
  "feedSummaryContent": null,
  "feedIsShared": true,
  "feedImage": "string",
  "feedRecipients": [
    0
  ],
  "feedComments": 0,
  "feedCommentData": [
    "string"
  ],
  "feedReactions": [
    null
  ],
  "feedReactionData": [
    null
  ],
  "feedUserReactionId": 0,
  "feedFirstUserToReact": [
    null
  ],
  "downloadUrl": [
    null
  ],
  "certificateUrl": [
    null
  ],
  "canDelete": true,
  "usersReactions": [
    null
  ],
  "reactionsTotals": [
    null
  ],
  "itemId": "string",
  "translationKeys": [
    "string"
  ],
  "canLike": true,
  "canComment": true
}

Properties

Name Type Required Restrictions Description
feedId integer true none Feed item identifier
feedTitle string true none Feed title
feedDescription string false none Feed description
feedTimestamp string false none Feed timestamp
feedSubjectType string true none Feed subject type
feedSubjectId integer true none Feed subject id
feedSegmentId integer false none Feed segment id
feedItemId string false none FeedItem identifier
groupingId string¦null false none Grouping identifier
feedSender any false none Feed sender
feedContent string false none Feed content
feedSummaryContent any false none Feed summary content
feedIsShared boolean false none Feed isShared
feedImage string false none Feed image
feedRecipients [integer] false none Feed recipients
feedComments integer false none Feed number of comments
feedCommentData [string] false none Feed comments
feedReactions [any] false none All reactions on feed item
feedReactionData [any] false none All reactions on feed item from all members
feedUserReactionId integer false none User reaction on feed item
feedFirstUserToReact [any] false none First user to react to feed
downloadUrl [any] false none Relative download URL for the feedItem
certificateUrl [any] false none Relative certificate URL for the feedItem
canDelete boolean false none Do you have permissions to delete this feedItem
usersReactions [any] false none All reactions on feed item
reactionsTotals [any] false none Stats about reactions on feed item
itemId string false none Item identifier
translationKeys [string] false none Mapping from phrase to translated phrase
canLike boolean false none Do you have permissions to like this feedItem
canComment boolean false none Do you have permissions to comment this feedItem

state

{
  "code": "string",
  "name": "string"
}

Properties

Name Type Required Restrictions Description
code string true none State code
name string true none State name

surveyConfiguration

{
  "id": 0,
  "uniqueId": "string",
  "schemeId": "string",
  "title": "string",
  "dateAdded": "string",
  "enabled": true,
  "useLandingPage": true,
  "description": "string"
}

Properties

Name Type Required Restrictions Description
id integer true none Survey Id
uniqueId string true none Unique Id for the Survey
schemeId string true none Scheme Id
title string true none Survey Title
dateAdded string true none Date Added
enabled boolean true none Survey Enabled
useLandingPage boolean true none Use Landing Page
description string true none Survey Description

surveyPeriod

{
  "id": 0
}

Properties

Name Type Required Restrictions Description
id integer true none Period Id

surveyProfileField

{
  "id": "string",
  "name": "string"
}

Properties

Name Type Required Restrictions Description
id string true none Id
name string true none Name

surveyRecipient

{
  "referenceId": 0,
  "active": true,
  "dateCreated": "string",
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "listId": 0
}

Properties

Name Type Required Restrictions Description
referenceId integer true none Recipient Reference Id
active boolean true none Active
dateCreated string true none Date Created
firstName string true none First name
lastName string true none Last name
email string true none Email
listId integer true none List Id

recipientList

{
  "id": 0,
  "name": "string",
  "scheme": {}
}

Properties

Name Type Required Restrictions Description
id integer true none Recipient List
name string true none Recipient List Name
scheme scheme true none none

voucher

{
  "transactionId": 0,
  "entityId": 0,
  "type": "Paper",
  "denomination": 0.1,
  "pan": "string",
  "pin": "string",
  "barcode": "string",
  "url": "string",
  "issueDate": "string",
  "expiryDate": "string",
  "redemptionInstructions": "string",
  "cashierNotes": "string",
  "archived": true,
  "redeemed": true,
  "redeemOnline": true,
  "redeemOffline": true,
  "product": {
    "id": 0,
    "name": "string",
    "price": 0.1,
    "type": "Paper",
    "typeId": 0,
    "visibility": [
      "string"
    ],
    "stockCode": "string",
    "stockStatus": "string",
    "statusMessage": "string",
    "retailer": "string",
    "printingRequired": true,
    "minimumOrder": 0.1,
    "maximumOrder": 0.1,
    "denominations": [
      0
    ],
    "related": {},
    "instant": true,
    "maxLimit": 0
  },
  "balance": {
    "type": "string",
    "payload": [
      null
    ]
  },
  "refundable": true
}

Properties

Name Type Required Restrictions Description
transactionId integer true none Voucher transaction identifier
entityId integer true none Voucher entity identifier
type string true none Voucher product type
denomination number(float) true none Voucher denomination
pan string true none Voucher PAN
pin string true none Voucher PIN
barcode string true none Voucher barcode
url string true none Voucher URL
issueDate string true none Voucher issue date
expiryDate string true none Voucher expiry date
redemptionInstructions string true none Voucher redemption instructions
cashierNotes string true none Voucher cashier notes
archived boolean true none Voucher Archival Status
redeemed boolean true none Voucher Redeemed Status
redeemOnline boolean true none Voucher redeemable online
redeemOffline boolean true none Voucher redeemable offline
product product false none none
balance voucherBalance false none Class VoucherBalance
refundable boolean false none Is the voucher refundable

Enumerated Values

Property Value
type Paper
type Electronic
type Card
type Topup
type SMS
type EGiftCard

voucherBalance

{
  "type": "string",
  "payload": [
    null
  ]
}

Class VoucherBalance

Properties

Name Type Required Restrictions Description
type string true none none
payload [any] false none none