NATS5 REST API Payment PATCH payvia-rule
From TMM Wiki
Revision as of 15:19, 9 August 2019 by TMMJoe (talk | contribs) (TMMJoe moved page NATS4 REST API Payment PATCH payvia-rule to NATS5 REST API Payment PATCH payvia-rule: Renaming NATS5 API pages)
PATCH /payment/payvia-rule
Description
- Edit payvia rule
Resource URL
- http://domain/api/payment/payvia-rule
- Replace domain with the nats domain
- PATCH
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- payviaid
- type: digit
- required
- ruleid
- type: string
- required
- rule_type
- type: trinary_digit (0, 1, or 2)
- required
- login
- type: digit_list (Either a comma-separated string of digits, or a JSON array of digits)
- optional
- country
- type: string_list (Either a comma-separated string of strings, or a JSON array of strings)
- optional
- start_time
- type: string
- optional (default value: NOW)
- end_time
- type: string
- optional (default value: FOREVER)
Example Request
Method: PATCH
URL: http://domain/api/payment/payvia-rule
Form Data:
- payviaid: 14
- ruleid: 1562601276:1907294400:1
- rule_type: 1
- login: [1]
- country: USA
- start_time: 2019-06-10
- end_time: 2030-06-10
Response:
{
"success": true,
"result": "Payvia rule edited"
}
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(
'payviaid' => 14,
'ruleid' => '1562601276:1907294400:1',
'rule_type' => 1,
'login' => '[1]',
'country' => 'USA',
'start_time' => '2019-06-10',
'end_time' => '2030-06-10',
);
$request = Array(
'method' => 'PATCH',
'path' => 'v1/payment/payvia-rule',
'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);
?>
