NATS5 REST API Biller GET cascades
From TMM Wiki
GET /biller/cascades
Description
- Get cascades
Resource URL
- http://domain/api/biller/cascades
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- natscode
- required
- surferip
- optional (ipv4, ipv6)
- country
- optional
Example Request
Method: GET
URL: http://domain/api/biller/cascades
Query String: natscode=MC4wLjEuMS4wLjAuMC4wLjA&country=US
Response:
{
"payment_options": {
"1": "Join by Credit Card"
},
"payment_options_section": {
"1": {
"cascadeid": "1",
"networkid": "0",
"name": "default",
"description": "Join by Credit Card",
"weight": "50",
"deleted": "0",
"target": "",
"nontarget": "",
"active": "0"
}
},
"automatic_cascade": 0,
"allowed_cascades": [
"1"
],
"first_cascade": 1,
"gateway_onestep": false
}
Example Code
PHP
<?php
$headers = array( //set your username and API key here
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: tmm1phrvezsbu'
);
$url = 'http://yourdomain.com'; //set your NATS URL here
$data = Array(
'natscode' => 'MC4wLjEuMS4wLjAuMC4wLjA',
'country' => 'US',
);
$request = Array(
'method' => 'GET',
'path' => 'v1/biller/cascades',
'data' => $data
);
/*code below is the same for (almost) every API call */
$curl = curl_init();
$url = $url.'/api/'.$request['path'];
$query = http_build_query($request['data']);
if($request['method'] == 'GET'){
//add query string parameters to the end of the url
$url = $url.'?'.$query;
}else{
//send parameters as POST fields
curl_setopt($curl, CURLOPT_POST, 1);
curl_setopt($curl, CURLOPT_POSTFIELDS, $query);
if($request['method'] != 'POST'){
$headers[] ='X-HTTP-Method: '.$request['method']; //send custom request method
}
}
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
$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);
?>
