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: Support 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 Survey Endpoints
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,
  "subtotal": 0,
  "saving": 0,
  "items": [
    {
      "id": 0,
      "type": "string",
      "productId": 0,
      "productType": "string",
      "name": "string",
      "image": "string",
      "currency": "string",
      "price": 0,
      "cost": 0,
      "tax": 0,
      "saving": 0,
      "quantity": 0,
      "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 true none
» productId body integer true Product Identifier
» amount body number 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"
}';
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

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
» 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

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": [
      null
    ],
    "discountRate": "string",
    "discountRatePrefix": "string",
    "discountType": "string",
    "discountValue": 0,
    "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 [any] 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": [
    null
  ],
  "discountRate": "string",
  "discountRatePrefix": "string",
  "discountType": "string",
  "discountValue": 0,
  "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 true 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,
    "paid": 0,
    "items": [
      {
        "date": "string",
        "logo": "string",
        "name": "string",
        "status": "string",
        "quantity": 0,
        "amount": 0,
        "paid": 0,
        "vouchers": [
          {
            "transactionId": 0,
            "entityId": 0,
            "date": "string",
            "logo": "string",
            "name": "string",
            "type": "Paper",
            "denomination": 0,
            "redeemed": true,
            "archived": true,
            "refundable": true
          }
        ],
        "product": {
          "id": 0,
          "name": "string",
          "price": 0,
          "type": "Paper",
          "typeId": 0,
          "visibility": [
            "string"
          ],
          "stockCode": "string",
          "stockStatus": "string",
          "statusMessage": "string",
          "retailer": "string",
          "printingRequired": true,
          "minimumOrder": 0,
          "maximumOrder": 0,
          "denominations": [
            0
          ],
          "related": {},
          "instant": true,
          "maxLimit": 0
        }
      }
    ],
    "messages": {}
  }
]

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
»» product object 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 object 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 object 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,
  "paid": 0,
  "items": [
    {
      "date": "string",
      "logo": "string",
      "name": "string",
      "status": "string",
      "quantity": 0,
      "amount": 0,
      "paid": 0,
      "vouchers": [
        {
          "transactionId": 0,
          "entityId": 0,
          "date": "string",
          "logo": "string",
          "name": "string",
          "type": "Paper",
          "denomination": 0,
          "redeemed": true,
          "archived": true,
          "refundable": true
        }
      ],
      "product": {
        "id": 0,
        "name": "string",
        "price": 0,
        "type": "Paper",
        "typeId": 0,
        "visibility": [
          "string"
        ],
        "stockCode": "string",
        "stockStatus": "string",
        "statusMessage": "string",
        "retailer": "string",
        "printingRequired": true,
        "minimumOrder": 0,
        "maximumOrder": 0,
        "denominations": [
          0
        ],
        "related": {},
        "instant": true,
        "maxLimit": 0
      }
    }
  ],
  "messages": {}
}

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,
  "paid": 0,
  "items": [
    {
      "date": "string",
      "logo": "string",
      "name": "string",
      "status": "string",
      "quantity": 0,
      "amount": 0,
      "paid": 0,
      "vouchers": [
        {
          "transactionId": 0,
          "entityId": 0,
          "date": "string",
          "logo": "string",
          "name": "string",
          "type": "Paper",
          "denomination": 0,
          "redeemed": true,
          "archived": true,
          "refundable": true
        }
      ],
      "product": {
        "id": 0,
        "name": "string",
        "price": 0,
        "type": "Paper",
        "typeId": 0,
        "visibility": [
          "string"
        ],
        "stockCode": "string",
        "stockStatus": "string",
        "statusMessage": "string",
        "retailer": "string",
        "printingRequired": true,
        "minimumOrder": 0,
        "maximumOrder": 0,
        "denominations": [
          0
        ],
        "related": {},
        "instant": true,
        "maxLimit": 0
      }
    }
  ],
  "messages": {}
}

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,
  "type": "Paper",
  "typeId": 0,
  "visibility": [
    "string"
  ],
  "stockCode": "string",
  "stockStatus": "string",
  "statusMessage": "string",
  "retailer": "string",
  "printingRequired": true,
  "minimumOrder": 0,
  "maximumOrder": 0,
  "denominations": [
    0
  ],
  "related": {
    "id": 0,
    "name": "string",
    "price": 0,
    "type": "Paper",
    "typeId": 0,
    "visibility": [
      "string"
    ],
    "stockCode": "string",
    "stockStatus": "string",
    "statusMessage": "string",
    "retailer": "string",
    "printingRequired": true,
    "minimumOrder": 0,
    "maximumOrder": 0,
    "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

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": [
        null
      ],
      "discountRate": "string",
      "discountRatePrefix": "string",
      "discountType": "string",
      "discountValue": 0,
      "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 object 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 [any] 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": [
      null
    ],
    "discountRate": "string",
    "discountRatePrefix": "string",
    "discountType": "string",
    "discountValue": 0,
    "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": [
        null
      ],
      "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 [any] 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 true Title
» sField682 body string true Name
» sField692 body string true Surname
» sField712 body string true Street
» sField732 body string true City
» sField742 body string true County
» sField752 body string true Postal code
» sField652 body string true 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 true Card name or alias
» sField632 body string true Card number
» sCardNumberRepeat body string true Card number repeat
» sField642 body string true PIN
» sField832 body string true Expiry date
» sField702 body string true Email address
» sField672 body string true Title
» sField682 body string true Name
» sField692 body string true Surname
» sField712 body string true Street
» sField732 body string true City
» sField742 body string true County
» sField752 body string true Postal code
» sField652 body string true 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 true 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 none
» 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 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,
    "redeemed": true,
    "archived": true,
    "refundable": 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 [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

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,
  "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,
    "type": "Paper",
    "typeId": 0,
    "visibility": [
      "string"
    ],
    "stockCode": "string",
    "stockStatus": "string",
    "statusMessage": "string",
    "retailer": "string",
    "printingRequired": true,
    "minimumOrder": 0,
    "maximumOrder": 0,
    "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 true 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 Voucher archival status not changed standardModel

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', 'golden_ticket', 'gym_discounts', 'all'

Example responses

200 Response

[
  {
    "id": "string",
    "alias": "string",
    "cardExpiry": "string",
    "cardPan": "string",
    "cardType": "string",
    "cardFee": 0,
    "isCreditCard": true,
    "firstName": "string",
    "lastName": "string",
    "addressLine1": "string",
    "addressLine2": "string",
    "addressLine3": "string",
    "addressLine4": "string",
    "postalCode": "string",
    "country": "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?
» 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

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,
  "isCreditCard": true,
  "firstName": "string",
  "lastName": "string",
  "addressLine1": "string",
  "addressLine2": "string",
  "addressLine3": "string",
  "addressLine4": "string",
  "postalCode": "string",
  "country": "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 true none
» cardNumber body string true Payment card number

Example responses

200 Response

{
  "valid": true,
  "message": "string",
  "cardType": 0,
  "cardFee": 0,
  "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

{
  "id": 0,
  "uuid": "string",
  "name": "string",
  "companyName": "string",
  "url": "string",
  "hasUsernameEndpoint": true,
  "team": [
    {
      "fullName": "string",
      "firstName": "string",
      "lastName": "string",
      "email": "string",
      "cc": [
        "string"
      ],
      "image": "string",
      "location": "string",
      "description": "string",
      "role": "string"
    }
  ],
  "branding": {
    "logo": "string",
    "favicon": "string",
    "colours": {
      "navigationBackground": "string",
      "navigationText": "string",
      "buttonBackground": "string",
      "buttonText": "string",
      "pageBackground": "string",
      "chevronBackground": "string",
      "chevronText": "string",
      "unselectedTabBackground": "string",
      "unselectedTabText": "string",
      "selectedTabBackground": "string",
      "selectedTabText": "string",
      "offersCarouselBackground": "string",
      "offersCarouselText": "string",
      "registerButtonBackground": "string",
      "registerButtonText": "string"
    },
    "id": 0,
    "name": "string",
    "companyName": "string",
    "url": "string",
    "hasUsernameEndpoint": true,
    "locale": {
      "id": 0
    },
    "branding": {}
  },
  "locale": {
    "id": 0,
    "name": "string",
    "lang": "string",
    "currency": "string",
    "symbol": "string",
    "states": [
      {
        "code": "string",
        "name": "string"
      }
    ],
    "contactFields": [
      null
    ]
  },
  "programmeTypes": [
    null
  ],
  "enabledConfigurations": [
    null
  ],
  "addressLine1": "265 Tottenham Court Rd",
  "addressLine2": "Street Details",
  "addressLine3": "London",
  "addressLine4": "Fitzrovia",
  "postalCode": "W1T 7RQ",
  "status": 0
}

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 true eCard identifier
» categoryId body integer true Category identifier
» message body string true Ecard message
» form body string true Request is send from [android,ios]
» recipients body string true List of recipients
» shared body integer false eCard is shared

Example responses

200 Response

{
  "id": 0,
  "uuid": "string",
  "name": "string",
  "companyName": "string",
  "url": "string",
  "hasUsernameEndpoint": true,
  "team": [
    {
      "fullName": "string",
      "firstName": "string",
      "lastName": "string",
      "email": "string",
      "cc": [
        "string"
      ],
      "image": "string",
      "location": "string",
      "description": "string",
      "role": "string"
    }
  ],
  "branding": {
    "logo": "string",
    "favicon": "string",
    "colours": {
      "navigationBackground": "string",
      "navigationText": "string",
      "buttonBackground": "string",
      "buttonText": "string",
      "pageBackground": "string",
      "chevronBackground": "string",
      "chevronText": "string",
      "unselectedTabBackground": "string",
      "unselectedTabText": "string",
      "selectedTabBackground": "string",
      "selectedTabText": "string",
      "offersCarouselBackground": "string",
      "offersCarouselText": "string",
      "registerButtonBackground": "string",
      "registerButtonText": "string"
    },
    "id": 0,
    "name": "string",
    "companyName": "string",
    "url": "string",
    "hasUsernameEndpoint": true,
    "locale": {
      "id": 0
    },
    "branding": {}
  },
  "locale": {
    "id": 0,
    "name": "string",
    "lang": "string",
    "currency": "string",
    "symbol": "string",
    "states": [
      {
        "code": "string",
        "name": "string"
      }
    ],
    "contactFields": [
      null
    ]
  },
  "programmeTypes": [
    null
  ],
  "enabledConfigurations": [
    null
  ],
  "addressLine1": "265 Tottenham Court Rd",
  "addressLine2": "Street Details",
  "addressLine3": "London",
  "addressLine4": "Fitzrovia",
  "postalCode": "W1T 7RQ",
  "status": 0
}

Responses

Status Meaning Description Schema
200 OK Successful operation scheme
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,
        "fullName": "string"
      }
    ],
    "nominator": [
      {
        "id": 0,
        "fullName": "string",
        "isMember": "string"
      }
    ],
    "date": "string",
    "formattedDate": "string",
    "award": [
      {
        "id": 0,
        "title": "string",
        "valueFullName": "string",
        "valueShortName": "string",
        "value": 0,
        "alternativeValues": [
          null
        ]
      }
    ],
    "awards": [
      {
        "id": 0,
        "title": "string",
        "valueFullName": "string",
        "valueShortName": "string",
        "value": 0,
        "alternativeValues": [
          null
        ]
      }
    ],
    "reasons": [
      {
        "id": 0,
        "question": "string",
        "answer": "string",
        "type": "string"
      }
    ],
    "editNominee": true,
    "editAwardMessage": true
  }
]

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
»» fullName string true none Full Name
» 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 [any] 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

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 true 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

Example responses

200 Response

[
  {
    "id": 0,
    "rrProgramId": 123,
    "rrProgramName": "string",
    "nominees": [
      {
        "id": "string",
        "fullName": "string"
      }
    ],
    "approvers": [
      {
        "id": 0,
        "fullName": "string"
      }
    ],
    "nominator": [
      {
        "id": 0,
        "fullName": "string",
        "isMember": "string"
      }
    ],
    "date": "string",
    "formattedDate": "string",
    "award": [
      {
        "id": 0,
        "title": "string",
        "valueFullName": "string",
        "valueShortName": "string",
        "value": 0,
        "alternativeValues": [
          null
        ]
      }
    ],
    "awards": [
      {
        "id": 0,
        "title": "string",
        "valueFullName": "string",
        "valueShortName": "string",
        "value": 0,
        "alternativeValues": [
          null
        ]
      }
    ],
    "reasons": [
      {
        "id": 0,
        "question": "string",
        "answer": "string",
        "type": "string"
      }
    ],
    "editNominee": true,
    "editAwardMessage": true
  }
]

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
»» fullName string true none Full Name
» 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 [any] 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

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

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' => '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/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: application/json
Accept: application/json
Authorization: string
Accept: string

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

const inputBody = '{
  "rrSchemeId": 0
}';
const headers = {
  'Content-Type':'application/json',
  '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
}

Parameters

Name In Type Required Description
Authorization header string true Valid Bearer access token
Accept header string true none
body body object false none

Example responses

200 Response

{
  "success": true,
  "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
» nominationId integer 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,
        "fullName": "string"
      }
    ],
    "nominator": [
      {
        "id": 0,
        "fullName": "string",
        "isMember": "string"
      }
    ],
    "date": "string",
    "formattedDate": "string",
    "award": [
      {
        "id": 0,
        "title": "string",
        "valueFullName": "string",
        "valueShortName": "string",
        "value": 0,
        "alternativeValues": [
          null
        ]
      }
    ],
    "awards": [
      {
        "id": 0,
        "title": "string",
        "valueFullName": "string",
        "valueShortName": "string",
        "value": 0,
        "alternativeValues": [
          null
        ]
      }
    ],
    "reasons": [
      {
        "id": 0,
        "question": "string",
        "answer": "string",
        "type": "string"
      }
    ],
    "editNominee": true,
    "editAwardMessage": 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 [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
»» fullName string true none Full Name
» 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 [any] 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

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

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&imageName=string&imageExtension=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&imageName=string&imageExtension=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&imageName=string&imageExtension=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[any] 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
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)

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 true Image to upload

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

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} 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} \
  -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}',
{
  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[any] 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
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

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 an award type

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/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());
 }

 // ...

DELETE https://api.rewardgateway.net/bulkschedule/{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 DELETE https://api.rewardgateway.net/bulkschedule/{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/{awardId}',
{
  method: 'DELETE',

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

DELETE /bulkschedule/{awardId}

This endpoint deletes an Award Type 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
awardId path integer true Award Id 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

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

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

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(
    '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
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 '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/transaction/cancel',
{
  method: 'POST',

  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

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
transactions query array[any] true List of transaction ids 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

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
    ]
  },
  "scheme": {
    "id": 0,
    "uuid": "string",
    "name": "string",
    "companyName": "string",
    "url": "string",
    "hasUsernameEndpoint": true,
    "team": [
      {
        "fullName": "string",
        "firstName": "string",
        "lastName": "string",
        "email": "string",
        "cc": [
          "string"
        ],
        "image": "string",
        "location": "string",
        "description": "string",
        "role": "string"
      }
    ],
    "branding": {
      "logo": "string",
      "favicon": "string",
      "colours": {
        "navigationBackground": "string",
        "navigationText": "string",
        "buttonBackground": "string",
        "buttonText": "string",
        "pageBackground": "string",
        "chevronBackground": "string",
        "chevronText": "string",
        "unselectedTabBackground": "string",
        "unselectedTabText": "string",
        "selectedTabBackground": "string",
        "selectedTabText": "string",
        "offersCarouselBackground": "string",
        "offersCarouselText": "string",
        "registerButtonBackground": "string",
        "registerButtonText": "string"
      },
      "id": 0,
      "name": "string",
      "companyName": "string",
      "url": "string",
      "hasUsernameEndpoint": true,
      "locale": {
        "id": 0
      },
      "branding": {}
    },
    "locale": {
      "id": 0,
      "name": "string",
      "lang": "string",
      "currency": "string",
      "symbol": "string",
      "states": [
        {
          "code": "string",
          "name": "string"
        }
      ],
      "contactFields": [
        null
      ]
    },
    "programmeTypes": [
      null
    ],
    "enabledConfigurations": [
      null
    ],
    "addressLine1": "265 Tottenham Court Rd",
    "addressLine2": "Street Details",
    "addressLine3": "London",
    "addressLine4": "Fitzrovia",
    "postalCode": "W1T 7RQ",
    "status": 0
  },
  "pushNotifications": true
}

Responses

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

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=25 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=25 \
  -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=25',
{
  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.
flt query array[any] false filter

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 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

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
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 true 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 true none
» message body string true Reply 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

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 true 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
510 Unknown FeedItem not found. errorModel
511 Network Authentication Required FeedItem is removed. errorModel
512 Unknown FeedItem is private. errorModel
513 Unknown Comment not found. 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 true 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

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

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

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": "string",
        "navigationText": "string",
        "buttonBackground": "string",
        "buttonText": "string",
        "pageBackground": "string",
        "chevronBackground": "string",
        "chevronText": "string",
        "unselectedTabBackground": "string",
        "unselectedTabText": "string",
        "selectedTabBackground": "string",
        "selectedTabText": "string",
        "offersCarouselBackground": "string",
        "offersCarouselText": "string",
        "registerButtonBackground": "string",
        "registerButtonText": "string"
      },
      "id": 0,
      "name": "string",
      "companyName": "string",
      "url": "string",
      "hasUsernameEndpoint": true,
      "locale": {
        "id": 0
      },
      "branding": {}
    }
  }
]

Responses

Status Meaning Description Schema
200 OK Successful operation Inline
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 object true none none
»» logo string true none none
»» favicon string true none none
»» colours object false none none
»»» navigationBackground string true none none
»»» navigationText string true none none
»»» buttonBackground string false none none
»»» buttonText string false none none
»»» pageBackground string false none none
»»» chevronBackground string false none none
»»» chevronText string false none none
»»» unselectedTabBackground string false none none
»»» unselectedTabText string false none none
»»» selectedTabBackground string false none none
»»» selectedTabText string false none none
»»» offersCarouselBackground string false none none
»»» offersCarouselText string false none none
»»» registerButtonBackground string false none none
»»» registerButtonText string false none none
»» id integer false none Programme identifier
»» 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
»» locale object false none none
»»» id integer true none Locale identifier
»» branding object 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 true 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 true Phone number to be validated
» type body string true 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 true 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 true Client Identifier of the application
» device_token body string true Device Token
» device_os body string true Device OS (IOS, Android)

Example responses

200 Response

[
  {
    "id": 0,
    "deviceOs": 0
  }
]

Responses

Status Meaning Description Schema
200