Difference between revisions of "NATS5 REST API Payment PATCH payout-period"
From TMM Wiki
Jump to navigationJump to search| Line 1: | Line 1: | ||
{{NATS5 Manual | {{NATS5 Manual | ||
| − | | | + | | show_api_admin_payment_section = true |
}} | }} | ||
== '''PATCH /payment/payout-period''' == | == '''PATCH /payment/payout-period''' == | ||
Latest revision as of 16:00, 9 August 2019
PATCH /payment/payout-period
Description
- Edit payout period
Resource URL
- http://domain/api/payment/payout-period
- Replace domain with the nats domain
- PATCH
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- payout_period_id
- type: digit
- required
- description
- type: string
- optional
- configuration_type
- type: string
- optional
- configuration_days
- type: digit_list (Either a comma-separated string of digits, or a JSON array of digits)
- optional
- projection_type
- type: string
- optional
- projection_days
- type: digit_list (Either a comma-separated string of digits, or a JSON array of digits)
- optional
- projection_padding
- type: digit
- optional
- delay
- type: digit
- optional
- positive_pay_delay
- type: digit
- optional
- negative_pay_delay
- type: digit
- optional
- enabled
- type: boolean_digit (0 or 1)
- optional
Example Request
Method: PATCH
URL: http://domain/api/payment/payout-period
Form Data:
- payout_period_id: 1000
- description: test payout period description
- delay: 1
- enabled: 1
Response:
{
"success": true,
"result": "Payout period updated"
}
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,
'description' => 'test payout period description',
'delay' => 1,
'enabled' => 1,
);
$request = Array(
'method' => 'PATCH',
'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);
?>
