NATS5 REST API Payment POST payvia-field
From TMM Wiki
(Redirected from NATS4 REST API Payment POST payvia-field)
Jump to navigationJump to searchThe printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.
POST /payment/payvia-field
Description
- Add new payvia field
Resource URL
- http://domain/api/payment/payvia-field
- Replace domain with the nats domain
- POST
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- payvia_type_id
- type: digit
- required
- name
- type: string
- required
- type
- type: boolean_digit (0 or 1)
- required
- required
- type: boolean_digit (0 or 1)
- optional
- min
- type: digit
- optional
- max
- type: digit
- optional
- is_unique
- type: boolean_digit (0 or 1)
- optional
- check_function
- type: string
- optional
Example Request
Method: POST
URL: http://domain/api/payment/payvia-field
Form Data:
- payvia_type_id: 1000
- name: test payvia field
- type: 1
- required: 1
- is_unique: 1
- min: 0
- max: 0
Response:
{ "success": true, "result": "Payvia field added" }
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( 'payvia_type_id' => 1000, 'name' => 'test payvia field', 'type' => 1, 'required' => 1, 'is_unique' => 1, 'min' => 0, 'max' => 0, ); $request = Array( 'method' => 'POST', 'path' => 'v1/payment/payvia-field', '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); ?>