NATS5 REST API Biller PATCH fee
From TMM Wiki
Revision as of 15:17, 9 August 2019 by TMMJoe (talk | contribs) (TMMJoe moved page NATS4 REST API Biller PATCH fee to NATS5 REST API Biller PATCH fee: Renaming NATS5 API pages)
PATCH /biller/fee
Description
- Setup fee for biller
Resource URL
- http://domain/api/biller/fee
- Replace domain with the nats domain
- PATCH
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- billerid
- type: digit
- required
- trans_type_id
- type: digit (negative numbers allowed)
- required
- ptype
- type: numeric
- required
- charge_amount
- type: numeric
- optional
- charge_perc
- type: numeric
- optional
- charge_deduct
- type: digit
- optional
- return_fee
- type: boolean_digit
- optional
- deduction
- type: boolean_digit
- optional
Example Request
Method: PATCH
URL: http://domain/api/biller/fee
Form Data:
- billerid: 2
- trans_type_id: -1
- ptype: 0
Response:
{
"success": true,
"result": "biller fees updated"
}
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,
'trans_type_id' => -1,
'ptype' => 0,
);
$request = Array(
'method' => 'PATCH',
'path' => 'v1/biller/fee',
'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);
?>
