NATS5 REST API Payment GET dump-format
From TMM Wiki
Revision as of 16:19, 9 August 2019 by TMMJoe (talk | contribs) (TMMJoe moved page NATS4 REST API Payment GET dump-format to NATS5 REST API Payment GET dump-format: Renaming NATS5 API pages)
GET /payment/dump-format
Description
- Get dump format
Resource URL
- http://domain/api/payment/dump-format
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- dumpid
- type: digit
- required
Example Request
Method: GET
URL: http://domain/api/payment/dump-format
Query String: dumpid=1000
Response:
{ "success": true, "dump": { "dumpid": "1000", "name": "test name", "header": "", "entryheader": "", "entry": "", "entryfooter": "", "footer": "", "custom": 1, "payvia_active": 0, "payvia_types": [] } }
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( 'dumpid' => 1000, ); $request = Array( 'method' => 'GET', 'path' => 'v1/payment/dump-format', '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); ?>