NATS5 REST API Payment PATCH payviarule
From TMM Wiki
Jump to navigationJump to search
PATCH /payment/payviarule
Note: This is an autogenerated wiki page for the NATS5 API. There may be additional descriptions or examples available on the NATS 4 API wiki for this API.
Description
- Create/Modify rules for payvia types
Resource URL
- http://domain/api/payment/payviarule
- Replace domain with the nats domain
- PATCH
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- loginid
- required
- action
- required
- type
- required
- payvia_rule_id
- optional
- payvia_type_id
- optional
- country
- optional
- start_time
- optional
- end_time
- optional
Example Request
Method: PATCH
URL: http://domain/api/payment/payviarule
Form Data:
- loginid: 1
- action: add
- type: enabled
- payvia_type_id: 4
- payvia_rule_id: 3
Response:
{
"result": "TRUE",
"params": {
"payviaid": 4,
"rule_type": 1,
"login": [
"productsupport"
],
"end_time": "NEVER",
"payvia_rule_id": 3
}
}
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(
'loginid' => 1,
'action' => 'add',
'type' => 'enabled',
'payvia_type_id' => 4,
'payvia_rule_id' => 3,
);
$request = Array(
'method' => 'PATCH',
'path' => 'v1/payment/payviarule',
'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);
?>
