Difference between revisions of "NATS5 REST API Biller GET cascades"
From TMM Wiki
Jump to navigationJump to searchm (TMMJoe moved page NATS4 REST API Biller GET cascades to NATS5 REST API Biller GET cascades: Renaming NATS5 API pages) |
Tmmguillermo (talk | contribs) |
||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | {{ | + | {{NATS5 Manual |
| − | | | + | | show_api_admin_biller_section = true |
}} | }} | ||
== '''GET /biller/cascades''' == | == '''GET /biller/cascades''' == | ||
| + | |||
'''Description''' | '''Description''' | ||
* Get cascades | * Get cascades | ||
| Line 9: | Line 10: | ||
*Replace domain with the nats domain | *Replace domain with the nats domain | ||
| − | '''[[ | + | '''[[NATS5_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']] |
*GET | *GET | ||
'''Response Format''' | '''Response Format''' | ||
*JSON | *JSON | ||
| − | '''[[ | + | '''[[NATS5_REST_API_Overview#Authentication|Authentication]]''' |
*HTTP headers | *HTTP headers | ||
| Line 23: | Line 24: | ||
* '''natscode''' | * '''natscode''' | ||
** required | ** required | ||
| + | * '''surferip''' | ||
| + | ** optional (ipv4, ipv6) | ||
* '''country''' | * '''country''' | ||
** optional | ** optional | ||
| Line 29: | Line 32: | ||
Method: '''GET'''<br/> | Method: '''GET'''<br/> | ||
URL: <nowiki>http://domain/api/biller/cascades</nowiki><br/> | URL: <nowiki>http://domain/api/biller/cascades</nowiki><br/> | ||
| − | Query String: <nowiki>natscode=MC4wLjEuMS4wLjAuMC4wLjA</nowiki><br/> | + | Query String: <nowiki>natscode=MC4wLjEuMS4wLjAuMC4wLjA&country=US</nowiki><br/> |
Response: | Response: | ||
| Line 76: | Line 79: | ||
$data = Array( | $data = Array( | ||
'natscode' => 'MC4wLjEuMS4wLjAuMC4wLjA', | 'natscode' => 'MC4wLjEuMS4wLjAuMC4wLjA', | ||
| + | 'country' => 'US', | ||
); | ); | ||
| Line 117: | Line 121: | ||
</pre> | </pre> | ||
| − | [[Category: | + | [[Category:NATS5_REST_APIs]] |
| − | [[Category: | + | [[Category:NATS5_REST_biller_Collection]] |
[[Category:Autogenerated_Wiki_Article]]<!-- Remove this tag when customizing a wiki article. The article will no longer be automatically updated --> | [[Category:Autogenerated_Wiki_Article]]<!-- Remove this tag when customizing a wiki article. The article will no longer be automatically updated --> | ||
[[Category:Autogenerated_Rest_Sample]]<!-- This article has a generated REST API Sample from our unit testing system. Also remove if customizing the wiki article --> | [[Category:Autogenerated_Rest_Sample]]<!-- This article has a generated REST API Sample from our unit testing system. Also remove if customizing the wiki article --> | ||
Latest revision as of 13:42, 15 October 2024
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);
?>
