NATS5 REST API Payment GET payout-periods
From TMM Wiki
Revision as of 15:19, 9 August 2019 by TMMJoe (talk | contribs) (TMMJoe moved page NATS4 REST API Payment GET payout-periods to NATS5 REST API Payment GET payout-periods: Renaming NATS5 API pages)
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
- optional
Example Request
Method: GET
URL: http://domain/api/payment/payout-periods
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": "0",
"positive_pay_delay": "0",
"negative_pay_delay": "0",
"enabled": "0",
"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(
// Add API parameters here
);
$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);
?>
