NATS4 REST API Get Suggested Cancel Offers
From TMM Wiki
Jump to navigationJump to searchThe printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.
GET /suggestedcanceloffers
Description
- NATS4 supports an API resource to get a list of suggested cancel offers for a given subscription
- **NOTE** This requires the IGM module
Resource URL
- http://domain/api/suggestedcanceloffers
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
Paremeters can be sent as url encoded params..
- memberidx: the biller subscription id
- type: string
- required
Example Request
GET
http://domain/api/suggestedcanceloffers
- Response on success:
[ { "cancel_offer_id": 62, "cancel_offer_step_id":150, "rebill":0,"flat":0, "percent":2000, "loyalty_discount_eligible":0, "next_rebill_amount":240, "currency":"USD" } ]
Example Code
PHP
<?php $curl = curl_init(); $data = array( 'memberidx' => 'SALLY:1426181342RZJLAALEZ4PJVN2BJAMWGW', ); $data_string = http_build_query($data); $url = 'http://domain/api/suggestedcanceloffers?'.$data_string; $headers = array( 'api-key: 44b5498dbcb481a0d00b404c0169af62', 'api-username: tmm1phrvezsbu' ); curl_setopt($curl, CURLOPT_HTTPHEADER, $headers); curl_setopt($curl, CURLOPT_RETURNTRANSFER, true); curl_setopt($curl, CURLOPT_URL, $url); $resp = curl_exec($curl); //dumps an associative array representation of the json var_dump(json_decode($resp, true)); // Close request to clear up some resources curl_close($curl); ?>
Python
- This example requires pip and the request library which can be installed via pip by: 'pip install requests'
import requests url = 'http://domain/api/suggestedcanceloffers' params = { 'memberidx': 'SALLY:1426181342RZJLAALEZ4PJVN2BJAMWGW' } headers = { 'api-key': '44b5498dbcb481a0d00b404c0169af62', 'api-username': 'tmm1phrvezsbu' } res = requests.get(url, params=params, headers=headers) print res.json()
node.js
- This example requires npm and the request module which can be installed via npm by: 'npm install request'
var request = require('request'); var options = { url: 'http://domain/api/suggestedcanceloffers', method: 'GET', qs: { 'memberidx': 'SALLY:1426181342RZJLAALEZ4PJVN2BJAMWGW' }, json: true, headers: { 'api-key': '44b5498dbcb481a0d00b404c0169af62', 'api-username': 'tmm1phrvezsbu' } }; function callback(error, response, body) { if (!error && response.statusCode == 200) { console.log(body); } else{ console.log(body); } } request(options, callback);
Curl
curl -X GET 'http://domain/api/suggestedcanceloffers?memberidx=SALLY:1426181342RZJLAALEZ4PJVN2BJAMWGW' -H "api-key: 44b5498dbcb481a0d00b404c0169af62" -H "api-username: tmm1phrvezsbu"