Difference between revisions of "NATS5 REST API Payment GET payout-period"
From TMM Wiki
Jump to navigationJump to search| (3 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | {{ | + | {{NATS5 Manual |
| − | | | + | | show_api_admin_payment_section = true |
}} | }} | ||
== '''GET /payment/payout-period''' == | == '''GET /payment/payout-period''' == | ||
| + | |||
'''Description''' | '''Description''' | ||
* Get payout period details | * Get payout period details | ||
| 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 25: | Line 26: | ||
** required | ** required | ||
| + | == '''Example Request''' == | ||
| + | Method: '''GET'''<br/> | ||
| + | URL: <nowiki>http://domain/api/payment/payout-period</nowiki><br/> | ||
| + | Query String: <nowiki>payout_period_id=1000</nowiki><br/> | ||
| + | |||
| + | Response: | ||
| + | <pre> | ||
| + | { | ||
| + | "success": true, | ||
| + | "payout_period": { | ||
| + | "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 | ||
| + | } | ||
| + | } | ||
| + | </pre> | ||
| + | |||
| + | |||
| + | |||
== '''Example Code''' == | == '''Example Code''' == | ||
| Line 38: | Line 72: | ||
$url = 'http://yourdomain.com'; //set your NATS URL here | $url = 'http://yourdomain.com'; //set your NATS URL here | ||
| − | $data = | + | $data = Array( |
| − | + | 'payout_period_id' => 1000, | |
); | ); | ||
| Line 81: | Line 115: | ||
</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/payout-period
Description
- Get payout period details
Resource URL
- http://domain/api/payment/payout-period
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- payout_period_id
- type: digit
- required
Example Request
Method: GET
URL: http://domain/api/payment/payout-period
Query String: payout_period_id=1000
Response:
{
"success": true,
"payout_period": {
"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(
'payout_period_id' => 1000,
);
$request = Array(
'method' => 'GET',
'path' => 'v1/payment/payout-period',
'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);
?>
