Difference between revisions of "NATS5 REST API Payment GET payvia-rules"
From TMM Wiki
Jump to navigationJump to search| (4 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | {{ | + | {{NATS5 Manual |
| − | | | + | | show_api_admin_payment_section = true |
}} | }} | ||
== '''GET /payment/payvia-rules''' == | == '''GET /payment/payvia-rules''' == | ||
| + | |||
'''Description''' | '''Description''' | ||
| 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''']] |
*GET | *GET | ||
'''Response Format''' | '''Response Format''' | ||
*JSON | *JSON | ||
| − | '''[[ | + | '''[[NATS5_REST_API_Overview#Authentication|Authentication]]''' |
*HTTP headers | *HTTP headers | ||
| Line 21: | Line 22: | ||
'''''Parameters can be sent as url encoded params | '''''Parameters can be sent as url encoded params | ||
| − | * ''' | + | * '''payviaid''' |
** type: digit | ** type: digit | ||
** required | ** required | ||
| Line 34: | Line 35: | ||
** optional | ** optional | ||
| + | == '''Example Request''' == | ||
| + | Method: '''GET'''<br/> | ||
| + | URL: <nowiki>http://domain/api/payment/payvia-rules</nowiki><br/> | ||
| + | Query String: <nowiki>payvia_type_id=11&country=USA&rule_types%5B0%5D=1&rule_types%5B1%5D=2</nowiki><br/> | ||
| + | |||
| + | Response: | ||
| + | <pre> | ||
| + | { | ||
| + | "success": true, | ||
| + | "payvia_rules": [ | ||
| + | { | ||
| + | "payvia_type_id": "11", | ||
| + | "rule_type": "1", | ||
| + | "identid": "8", | ||
| + | "start_time": "1565382567", | ||
| + | "end_time": "1907294400", | ||
| + | "start_nice": "2019-08-09 16:29:27", | ||
| + | "end_nice": "2030-06-10 00:00:00", | ||
| + | "rule_status": 1, | ||
| + | "advanced": 1, | ||
| + | "override_identifier_id": [ | ||
| + | "8" | ||
| + | ], | ||
| + | "ruleid": "1565382567:1907294400:1", | ||
| + | "rule_type_nice": "ENABLE", | ||
| + | "login": [ | ||
| + | { | ||
| + | "id": 0, | ||
| + | "name": "ALL" | ||
| + | } | ||
| + | ], | ||
| + | "country": [ | ||
| + | { | ||
| + | "id": "EU", | ||
| + | "name": "Europe *" | ||
| + | } | ||
| + | ] | ||
| + | } | ||
| + | ] | ||
| + | } | ||
| + | </pre> | ||
| + | |||
| + | |||
| + | |||
== '''Example Code''' == | == '''Example Code''' == | ||
| Line 47: | Line 92: | ||
$url = 'http://yourdomain.com'; //set your NATS URL here | $url = 'http://yourdomain.com'; //set your NATS URL here | ||
| − | $data = array( | + | $data = Array( |
| − | + | 'payvia_type_id' => 11, | |
| + | 'country' => 'USA', | ||
| + | 'rule_types' => array ( | ||
| + | 0 => 1, | ||
| + | 1 => 2, | ||
| + | ), | ||
); | ); | ||
| Line 90: | Line 140: | ||
</pre> | </pre> | ||
| − | [[Category: | + | [[Category:NATS5_REST_APIs]] |
| − | [[Category: | + | [[Category:NATS5_REST_payment_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 --> | ||
Latest revision as of 16:00, 9 August 2019
GET /payment/payvia-rules
Description
Resource URL
- http://domain/api/payment/payvia-rules
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- payviaid
- type: digit
- required
- rule_types
- type: digit_list (Either a comma-separated string of digits, or a JSON array of digits)
- optional (default value: Array)
- login
- optional
- country
- optional
- text_search
- optional
Example Request
Method: GET
URL: http://domain/api/payment/payvia-rules
Query String: payvia_type_id=11&country=USA&rule_types%5B0%5D=1&rule_types%5B1%5D=2
Response:
{
"success": true,
"payvia_rules": [
{
"payvia_type_id": "11",
"rule_type": "1",
"identid": "8",
"start_time": "1565382567",
"end_time": "1907294400",
"start_nice": "2019-08-09 16:29:27",
"end_nice": "2030-06-10 00:00:00",
"rule_status": 1,
"advanced": 1,
"override_identifier_id": [
"8"
],
"ruleid": "1565382567:1907294400:1",
"rule_type_nice": "ENABLE",
"login": [
{
"id": 0,
"name": "ALL"
}
],
"country": [
{
"id": "EU",
"name": "Europe *"
}
]
}
]
}
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(
'payvia_type_id' => 11,
'country' => 'USA',
'rule_types' => array (
0 => 1,
1 => 2,
),
);
$request = Array(
'method' => 'GET',
'path' => 'v1/payment/payvia-rules',
'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);
?>
