NATS5 REST API Biller GET process types
From TMM Wiki
(Redirected from NATS4 REST API Biller GET process types)
Jump to navigationJump to searchGET /biller/process_types
Description
- Get available process types for a biller
Resource URL
- http://domain/api/biller/process_types
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- billerid
- type: digit
- optional
Example Request
Method: GET
URL: http://domain/api/biller/process_types
Query String: billerid=2
Response:
[
{
"ptype": -1,
"ptype_nice": "All"
},
{
"ptype": 0,
"ptype_nice": "cc",
"ptype_nicer": "Credit Cards"
},
{
"ptype": 1,
"ptype_nice": "check",
"ptype_nicer": "Check (ACH)"
},
{
"ptype": 7,
"ptype_nice": "900",
"ptype_nicer": "Web 900"
},
{
"ptype": 14,
"ptype_nice": "dp",
"ptype_nicer": "Direct Pay"
},
{
"ptype": 3,
"ptype_nice": "elv",
"ptype_nicer": "ELV\/EU Debit"
}
]
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(
'billerid' => 2,
);
$request = Array(
'method' => 'GET',
'path' => 'v1/biller/process_types',
'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);
?>
