Difference between revisions of "NATS5 REST API Biller PATCH fee"
From TMM Wiki
Jump to navigationJump to searchm (TMMJoe moved page NATS4 REST API Biller PATCH fee to NATS5 REST API Biller PATCH fee: Renaming NATS5 API pages) |
|||
| Line 1: | Line 1: | ||
| − | {{ | + | {{NATS5 Manual |
| show_api_admin_section = true | | show_api_admin_section = true | ||
}} | }} | ||
== '''PATCH /biller/fee''' == | == '''PATCH /biller/fee''' == | ||
| + | |||
'''Description''' | '''Description''' | ||
* Setup fee for biller | * Setup fee for biller | ||
| 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''']] |
*PATCH | *PATCH | ||
'''Response Format''' | '''Response Format''' | ||
*JSON | *JSON | ||
| − | '''[[ | + | '''[[NATS5_REST_API_Overview#Authentication|Authentication]]''' |
*HTTP headers | *HTTP headers | ||
| Line 40: | Line 41: | ||
** optional | ** optional | ||
* '''return_fee''' | * '''return_fee''' | ||
| − | ** type: boolean_digit | + | ** type: boolean_digit (0 or 1) |
** optional | ** optional | ||
* '''deduction''' | * '''deduction''' | ||
| − | ** type: boolean_digit | + | ** type: boolean_digit (0 or 1) |
** optional | ** optional | ||
| Line 122: | Line 123: | ||
</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 --> | ||
Revision as of 15:44, 9 August 2019
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 (0 or 1)
- optional
- deduction
- type: boolean_digit (0 or 1)
- 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);
?>
