Difference between revisions of "NATS5 REST API Payment GET dump-formats"
From TMM Wiki
Jump to navigationJump to search| Line 1: | Line 1: | ||
{{NATS5 Manual | {{NATS5 Manual | ||
| − | | | + | | show_api_admin_payment_section = true |
}} | }} | ||
== '''GET /payment/dump-formats''' == | == '''GET /payment/dump-formats''' == | ||
Latest revision as of 16:00, 9 August 2019
GET /payment/dump-formats
Description
- Get dump formats available for payvias
Resource URL
- http://domain/api/payment/dump-formats
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- active_only
- type: boolean_digit (0 or 1)
- optional
- payvia_type_id
- type: digit
- optional
Example Request
Method: GET
URL: http://domain/api/payment/dump-formats
Query String: active_only=1&payvia_type_id=2
Response:
{
"success": true,
"dumps": [
{
"dumpid": 17,
"name": "Check CSV Default",
"custom": 0,
"payvia_types": [
{
"payvia_type_id": "2",
"name": "Inteca"
}
],
"payvia_active": 1
}
]
}
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(
'active_only' => 1,
'payvia_type_id' => 2,
);
$request = Array(
'method' => 'GET',
'path' => 'v1/payment/dump-formats',
'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);
?>
