Difference between revisions of "NATS5 REST API Payment GET payout-periods"
From TMM Wiki
Jump to navigationJump to searchm (TMMJoe moved page NATS4 REST API Payment GET payout-periods to NATS5 REST API Payment GET payout-periods: Renaming NATS5 API pages) |
|||
| Line 1: | Line 1: | ||
| − | {{ | + | {{NATS5 Manual |
| show_api_admin_section = true | | show_api_admin_section = true | ||
}} | }} | ||
== '''GET /payment/payout-periods''' == | == '''GET /payment/payout-periods''' == | ||
| + | |||
'''Description''' | '''Description''' | ||
* Get payout periods | * Get payout periods | ||
| 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 28: | Line 29: | ||
** optional | ** optional | ||
* '''deleted''' | * '''deleted''' | ||
| − | ** type: boolean_digit | + | ** type: boolean_digit (0 or 1) |
** optional | ** optional | ||
| Line 34: | Line 35: | ||
Method: '''GET'''<br/> | Method: '''GET'''<br/> | ||
URL: <nowiki>http://domain/api/payment/payout-periods</nowiki><br/> | URL: <nowiki>http://domain/api/payment/payout-periods</nowiki><br/> | ||
| + | Query String: <nowiki>loginid=1&deleted=1</nowiki><br/> | ||
Response: | Response: | ||
| Line 66: | Line 68: | ||
"description": "test payout period description", | "description": "test payout period description", | ||
"configuration": "w0", | "configuration": "w0", | ||
| − | "delay": " | + | "delay": "1", |
"positive_pay_delay": "0", | "positive_pay_delay": "0", | ||
"negative_pay_delay": "0", | "negative_pay_delay": "0", | ||
| − | "enabled": " | + | "enabled": "1", |
"main": "0", | "main": "0", | ||
"deleted": "0", | "deleted": "0", | ||
| Line 100: | Line 102: | ||
$url = 'http://yourdomain.com'; //set your NATS URL here | $url = 'http://yourdomain.com'; //set your NATS URL here | ||
| − | $data = | + | $data = Array( |
| − | + | 'loginid' => 1, | |
| + | 'deleted' => 1, | ||
); | ); | ||
| Line 143: | Line 146: | ||
</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 --> | [[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:45, 9 August 2019
GET /payment/payout-periods
Description
- Get payout periods
Resource URL
- http://domain/api/payment/payout-periods
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- loginid
- type: digit
- optional
- username
- type: string
- optional
- deleted
- type: boolean_digit (0 or 1)
- optional
Example Request
Method: GET
URL: http://domain/api/payment/payout-periods
Query String: loginid=1&deleted=1
Response:
{
"success": true,
"payout_periods": [
{
"payout_period_id": "1",
"description": "Twice a Month",
"configuration": "1,16",
"delay": "0",
"positive_pay_delay": "0",
"negative_pay_delay": "0",
"enabled": "1",
"main": "1",
"deleted": "0",
"projection": "",
"projection_padding": "0",
"configuration_details": {
"type": "month",
"days": [
"1",
"16"
],
"string": "Every 1st and 16th of the month"
},
"error": 0
},
{
"payout_period_id": "1000",
"description": "test payout period description",
"configuration": "w0",
"delay": "1",
"positive_pay_delay": "0",
"negative_pay_delay": "0",
"enabled": "1",
"main": "0",
"deleted": "0",
"projection": "",
"projection_padding": "0",
"configuration_details": {
"type": "week",
"days": "0",
"string": "Every Sunday"
},
"error": 0
}
]
}
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,
'deleted' => 1,
);
$request = Array(
'method' => 'GET',
'path' => 'v1/payment/payout-periods',
'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);
?>
