Difference between revisions of "NATS5 REST API Payment POST payout-period"
From TMM Wiki
Jump to navigationJump to searchm (TMMJoe moved page NATS4 REST API Payment POST payout-period to NATS5 REST API Payment POST payout-period: Renaming NATS5 API pages) |
|||
| Line 1: | Line 1: | ||
| − | {{ | + | {{NATS5 Manual |
| show_api_admin_section = true | | show_api_admin_section = true | ||
}} | }} | ||
== '''POST /payment/payout-period''' == | == '''POST /payment/payout-period''' == | ||
| + | |||
'''Description''' | '''Description''' | ||
* Add new payout period | * Add new payout period | ||
| 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''']] |
*POST | *POST | ||
'''Response Format''' | '''Response Format''' | ||
*JSON | *JSON | ||
| − | '''[[ | + | '''[[NATS5_REST_API_Overview#Authentication|Authentication]]''' |
*HTTP headers | *HTTP headers | ||
| Line 49: | Line 50: | ||
** optional | ** optional | ||
* '''enabled''' | * '''enabled''' | ||
| − | ** type: boolean_digit | + | ** type: boolean_digit (0 or 1) |
** optional | ** optional | ||
| Line 60: | Line 61: | ||
* configuration_days: 0 | * configuration_days: 0 | ||
* projection_type: none | * projection_type: none | ||
| + | * projection_days: Array | ||
| + | * delay: 1 | ||
| + | * enabled: 1 | ||
Response: | Response: | ||
| Line 90: | Line 94: | ||
'configuration_days' => 0, | 'configuration_days' => 0, | ||
'projection_type' => 'none', | 'projection_type' => 'none', | ||
| + | 'projection_days' => array ( | ||
| + | 0 => 2, | ||
| + | 1 => 4, | ||
| + | ), | ||
| + | 'delay' => 1, | ||
| + | 'enabled' => 1, | ||
); | ); | ||
| Line 131: | Line 141: | ||
</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:46, 9 August 2019
POST /payment/payout-period
Description
- Add new payout period
Resource URL
- http://domain/api/payment/payout-period
- Replace domain with the nats domain
- POST
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- description
- type: string
- required
- configuration_type
- type: string
- required
- configuration_days
- type: digit_list (Either a comma-separated string of digits, or a JSON array of digits)
- required
- projection_type
- type: string
- required
- 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: POST
URL: http://domain/api/payment/payout-period
Form Data:
- description: test payout period description
- configuration_type: week
- configuration_days: 0
- projection_type: none
- projection_days: Array
- delay: 1
- enabled: 1
Response:
{
"success": true,
"result": "Payout period added",
"payout_period_id": 1000
}
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(
'description' => 'test payout period description',
'configuration_type' => 'week',
'configuration_days' => 0,
'projection_type' => 'none',
'projection_days' => array (
0 => 2,
1 => 4,
),
'delay' => 1,
'enabled' => 1,
);
$request = Array(
'method' => 'POST',
'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);
?>
