Difference between revisions of "NATS5 REST API Payment GET payvias"
From TMM Wiki
Jump to navigationJump to search (Created page with "{{NATS4 Manual | show_api_admin_section = true }} == '''GET /payment/payvias''' == '''Description''' * Get payvia types '''Resource URL''' *<nowiki>http://domain/api/payment...") |
|||
(4 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
− | {{ | + | {{NATS5 Manual |
− | | | + | | show_api_admin_payment_section = true |
}} | }} | ||
== '''GET /payment/payvias''' == | == '''GET /payment/payvias''' == | ||
+ | |||
'''Description''' | '''Description''' | ||
* Get payvia types | * Get payvia types | ||
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''']] |
*GET | *GET | ||
'''Response Format''' | '''Response Format''' | ||
*JSON | *JSON | ||
− | '''[[ | + | '''[[NATS5_REST_API_Overview#Authentication|Authentication]]''' |
*HTTP headers | *HTTP headers | ||
Line 20: | Line 21: | ||
None | None | ||
− | [[Category: | + | == '''Example Request''' == |
− | [[Category: | + | Method: '''GET'''<br/> |
+ | URL: <nowiki>http://domain/api/payment/payvias</nowiki><br/> | ||
+ | |||
+ | Response: | ||
+ | <pre> | ||
+ | { | ||
+ | "success": true, | ||
+ | "payvia_types": [ | ||
+ | { | ||
+ | "payvia_type_id": "1", | ||
+ | "name": "Check", | ||
+ | "description": "Check By Mail", | ||
+ | "dumpid": "8", | ||
+ | "minimum": "50,100,250,500,1000,2500", | ||
+ | "enabled": "1", | ||
+ | "cost": "0", | ||
+ | "protection": "1", | ||
+ | "deleted": "0", | ||
+ | "dump_name": "Check Default", | ||
+ | "lang_name": "Check", | ||
+ | "cost_nice": "$0.00", | ||
+ | "cost_dec": "0.00", | ||
+ | "affiliate_count": "4" | ||
+ | }, | ||
+ | { | ||
+ | "payvia_type_id": "4", | ||
+ | "name": "Domestic Wire", | ||
+ | "description": "Domestic Bank Wire", | ||
+ | "dumpid": "6", | ||
+ | "minimum": "50,100,250,500,1000,2500", | ||
+ | "enabled": "1", | ||
+ | "cost": "0", | ||
+ | "protection": "1", | ||
+ | "deleted": "0", | ||
+ | "dump_name": "US Wire Default", | ||
+ | "lang_name": "Domestic Wire", | ||
+ | "cost_nice": "$0.00", | ||
+ | "cost_dec": "0.00", | ||
+ | "affiliate_count": 0 | ||
+ | }, | ||
+ | { | ||
+ | "payvia_type_id": "6", | ||
+ | "name": "EMC2\/IPAYOUT", | ||
+ | "description": "EMC2\/IPAYOUT Payment", | ||
+ | "dumpid": "32", | ||
+ | "minimum": "50,100,250,500,1000,2500", | ||
+ | "enabled": "0", | ||
+ | "cost": "0", | ||
+ | "protection": "1", | ||
+ | "deleted": "0", | ||
+ | "dump_name": "EMP2\/IPAYOUT CSV", | ||
+ | "lang_name": "EMC2\/IPAYOUT", | ||
+ | "cost_nice": "$0.00", | ||
+ | "cost_dec": "0.00", | ||
+ | "affiliate_count": 0 | ||
+ | }, | ||
+ | { | ||
+ | "payvia_type_id": "3", | ||
+ | "name": "ePassporte", | ||
+ | "description": "ePassporte Payment", | ||
+ | "dumpid": "5", | ||
+ | "minimum": "50,100,250,500,1000,2500", | ||
+ | "enabled": "0", | ||
+ | "cost": "0", | ||
+ | "protection": "1", | ||
+ | "deleted": "0", | ||
+ | "dump_name": "Epassporte", | ||
+ | "lang_name": "ePassporte", | ||
+ | "cost_nice": "$0.00", | ||
+ | "cost_dec": "0.00", | ||
+ | "affiliate_count": 0 | ||
+ | }, | ||
+ | { | ||
+ | "payvia_type_id": "10", | ||
+ | "name": "ePayService", | ||
+ | "description": "ePayService", | ||
+ | "dumpid": "35", | ||
+ | "minimum": "100,200,300,400,500", | ||
+ | "enabled": "0", | ||
+ | "cost": "0", | ||
+ | "protection": "1", | ||
+ | "deleted": "0", | ||
+ | "dump_name": "ePayService", | ||
+ | "lang_name": "ePayService", | ||
+ | "cost_nice": "$0.00", | ||
+ | "cost_dec": "0.00", | ||
+ | "affiliate_count": 0 | ||
+ | }, | ||
+ | { | ||
+ | "payvia_type_id": "7", | ||
+ | "name": "FirstChoice Pay", | ||
+ | "description": "FirstChoice Pay", | ||
+ | "dumpid": "33", | ||
+ | "minimum": "100,200,300,400,500", | ||
+ | "enabled": "0", | ||
+ | "cost": "0", | ||
+ | "protection": "1", | ||
+ | "deleted": "0", | ||
+ | "dump_name": "FirstChoice Pay", | ||
+ | "lang_name": "FirstChoice Pay", | ||
+ | "cost_nice": "$0.00", | ||
+ | "cost_dec": "0.00", | ||
+ | "affiliate_count": 0 | ||
+ | }, | ||
+ | { | ||
+ | "payvia_type_id": "2", | ||
+ | "name": "Inteca", | ||
+ | "description": "Inteca Payout", | ||
+ | "dumpid": "17", | ||
+ | "minimum": "50,100,250,500,1000,2500", | ||
+ | "enabled": "0", | ||
+ | "cost": "0", | ||
+ | "protection": "1", | ||
+ | "deleted": "0", | ||
+ | "dump_name": "Check CSV Default", | ||
+ | "lang_name": "Inteca", | ||
+ | "cost_nice": "$0.00", | ||
+ | "cost_dec": "0.00", | ||
+ | "affiliate_count": 0 | ||
+ | }, | ||
+ | { | ||
+ | "payvia_type_id": "13", | ||
+ | "name": "Intercash Check", | ||
+ | "description": "Pay by Check via Intercash", | ||
+ | "dumpid": "38", | ||
+ | "minimum": "100,200,300,400,500", | ||
+ | "enabled": "0", | ||
+ | "cost": "0", | ||
+ | "protection": "1", | ||
+ | "deleted": "0", | ||
+ | "dump_name": "Intercash Check", | ||
+ | "lang_name": "Intercash Check", | ||
+ | "cost_nice": "$0.00", | ||
+ | "cost_dec": "0.00", | ||
+ | "affiliate_count": 0 | ||
+ | }, | ||
+ | { | ||
+ | "payvia_type_id": "12", | ||
+ | "name": "Intercash Prepaid Card", | ||
+ | "description": "Pay by Prepaid Card via Intercash", | ||
+ | "dumpid": "37", | ||
+ | "minimum": "100,200,300,400,500", | ||
+ | "enabled": "0", | ||
+ | "cost": "0", | ||
+ | "protection": "1", | ||
+ | "deleted": "0", | ||
+ | "dump_name": "Intercash Prepaid Card", | ||
+ | "lang_name": "Intercash Prepaid Card", | ||
+ | "cost_nice": "$0.00", | ||
+ | "cost_dec": "0.00", | ||
+ | "affiliate_count": 0 | ||
+ | }, | ||
+ | { | ||
+ | "payvia_type_id": "5", | ||
+ | "name": "International Wire", | ||
+ | "description": "International Bank Wire", | ||
+ | "dumpid": "3", | ||
+ | "minimum": "50,100,250,500,1000,2500", | ||
+ | "enabled": "1", | ||
+ | "cost": "0", | ||
+ | "protection": "1", | ||
+ | "deleted": "0", | ||
+ | "dump_name": "International Wire Default", | ||
+ | "lang_name": "International Wire", | ||
+ | "cost_nice": "$0.00", | ||
+ | "cost_dec": "0.00", | ||
+ | "affiliate_count": 0 | ||
+ | }, | ||
+ | { | ||
+ | "payvia_type_id": "9", | ||
+ | "name": "Paxum", | ||
+ | "description": "Paxum Payment", | ||
+ | "dumpid": "34", | ||
+ | "minimum": "100,200,300,400,500", | ||
+ | "enabled": "0", | ||
+ | "cost": "0", | ||
+ | "protection": "1", | ||
+ | "deleted": "0", | ||
+ | "dump_name": "Paxum CSV", | ||
+ | "lang_name": "Paxum", | ||
+ | "cost_nice": "$0.00", | ||
+ | "cost_dec": "0.00", | ||
+ | "affiliate_count": 0 | ||
+ | }, | ||
+ | { | ||
+ | "payvia_type_id": "8", | ||
+ | "name": "Paypal", | ||
+ | "description": "Paypal", | ||
+ | "dumpid": "7", | ||
+ | "minimum": "50,100,250,500,1000,2500", | ||
+ | "enabled": "0", | ||
+ | "cost": "0", | ||
+ | "protection": "1", | ||
+ | "deleted": "0", | ||
+ | "dump_name": "Paypal Default", | ||
+ | "lang_name": "Paypal", | ||
+ | "cost_nice": "$0.00", | ||
+ | "cost_dec": "0.00", | ||
+ | "affiliate_count": 0 | ||
+ | }, | ||
+ | { | ||
+ | "payvia_type_id": "11", | ||
+ | "name": "Payza", | ||
+ | "description": "Payza", | ||
+ | "dumpid": "36", | ||
+ | "minimum": "100,200,300,400,500", | ||
+ | "enabled": "0", | ||
+ | "cost": "0", | ||
+ | "protection": "1", | ||
+ | "deleted": "0", | ||
+ | "dump_name": "Payza", | ||
+ | "lang_name": "Payza", | ||
+ | "cost_nice": "$0.00", | ||
+ | "cost_dec": "0.00", | ||
+ | "affiliate_count": 0 | ||
+ | }, | ||
+ | { | ||
+ | "payvia_type_id": "14", | ||
+ | "name": "Red Pass", | ||
+ | "description": "Payvia through Zombaio", | ||
+ | "dumpid": "39", | ||
+ | "minimum": "100,200,300,400,500", | ||
+ | "enabled": "0", | ||
+ | "cost": "0", | ||
+ | "protection": "1", | ||
+ | "deleted": "0", | ||
+ | "dump_name": "Red Pass", | ||
+ | "lang_name": "Red Pass", | ||
+ | "cost_nice": "$0.00", | ||
+ | "cost_dec": "0.00", | ||
+ | "affiliate_count": 0 | ||
+ | }, | ||
+ | { | ||
+ | "payvia_type_id": "1000", | ||
+ | "name": "test payvia", | ||
+ | "description": "", | ||
+ | "dumpid": "0", | ||
+ | "minimum": "50", | ||
+ | "enabled": "0", | ||
+ | "cost": "0", | ||
+ | "protection": "0", | ||
+ | "deleted": "0", | ||
+ | "dump_name": "", | ||
+ | "lang_name": "test payvia", | ||
+ | "cost_nice": "$0.00", | ||
+ | "cost_dec": "0.00", | ||
+ | "affiliate_count": 0 | ||
+ | } | ||
+ | ] | ||
+ | } | ||
+ | </pre> | ||
+ | |||
+ | |||
+ | |||
+ | |||
+ | == '''Example Code''' == | ||
+ | |||
+ | '''PHP''' | ||
+ | <pre> | ||
+ | <?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(); | ||
+ | |||
+ | $request = Array( | ||
+ | 'method' => 'GET', | ||
+ | 'path' => 'v1/payment/payvias', | ||
+ | '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); | ||
+ | ?> | ||
+ | </pre> | ||
+ | |||
+ | [[Category:NATS5_REST_APIs]] | ||
+ | [[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 --> |
Latest revision as of 16:00, 9 August 2019
GET /payment/payvias
Description
- Get payvia types
Resource URL
- http://domain/api/payment/payvias
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
None
Example Request
Method: GET
URL: http://domain/api/payment/payvias
Response:
{ "success": true, "payvia_types": [ { "payvia_type_id": "1", "name": "Check", "description": "Check By Mail", "dumpid": "8", "minimum": "50,100,250,500,1000,2500", "enabled": "1", "cost": "0", "protection": "1", "deleted": "0", "dump_name": "Check Default", "lang_name": "Check", "cost_nice": "$0.00", "cost_dec": "0.00", "affiliate_count": "4" }, { "payvia_type_id": "4", "name": "Domestic Wire", "description": "Domestic Bank Wire", "dumpid": "6", "minimum": "50,100,250,500,1000,2500", "enabled": "1", "cost": "0", "protection": "1", "deleted": "0", "dump_name": "US Wire Default", "lang_name": "Domestic Wire", "cost_nice": "$0.00", "cost_dec": "0.00", "affiliate_count": 0 }, { "payvia_type_id": "6", "name": "EMC2\/IPAYOUT", "description": "EMC2\/IPAYOUT Payment", "dumpid": "32", "minimum": "50,100,250,500,1000,2500", "enabled": "0", "cost": "0", "protection": "1", "deleted": "0", "dump_name": "EMP2\/IPAYOUT CSV", "lang_name": "EMC2\/IPAYOUT", "cost_nice": "$0.00", "cost_dec": "0.00", "affiliate_count": 0 }, { "payvia_type_id": "3", "name": "ePassporte", "description": "ePassporte Payment", "dumpid": "5", "minimum": "50,100,250,500,1000,2500", "enabled": "0", "cost": "0", "protection": "1", "deleted": "0", "dump_name": "Epassporte", "lang_name": "ePassporte", "cost_nice": "$0.00", "cost_dec": "0.00", "affiliate_count": 0 }, { "payvia_type_id": "10", "name": "ePayService", "description": "ePayService", "dumpid": "35", "minimum": "100,200,300,400,500", "enabled": "0", "cost": "0", "protection": "1", "deleted": "0", "dump_name": "ePayService", "lang_name": "ePayService", "cost_nice": "$0.00", "cost_dec": "0.00", "affiliate_count": 0 }, { "payvia_type_id": "7", "name": "FirstChoice Pay", "description": "FirstChoice Pay", "dumpid": "33", "minimum": "100,200,300,400,500", "enabled": "0", "cost": "0", "protection": "1", "deleted": "0", "dump_name": "FirstChoice Pay", "lang_name": "FirstChoice Pay", "cost_nice": "$0.00", "cost_dec": "0.00", "affiliate_count": 0 }, { "payvia_type_id": "2", "name": "Inteca", "description": "Inteca Payout", "dumpid": "17", "minimum": "50,100,250,500,1000,2500", "enabled": "0", "cost": "0", "protection": "1", "deleted": "0", "dump_name": "Check CSV Default", "lang_name": "Inteca", "cost_nice": "$0.00", "cost_dec": "0.00", "affiliate_count": 0 }, { "payvia_type_id": "13", "name": "Intercash Check", "description": "Pay by Check via Intercash", "dumpid": "38", "minimum": "100,200,300,400,500", "enabled": "0", "cost": "0", "protection": "1", "deleted": "0", "dump_name": "Intercash Check", "lang_name": "Intercash Check", "cost_nice": "$0.00", "cost_dec": "0.00", "affiliate_count": 0 }, { "payvia_type_id": "12", "name": "Intercash Prepaid Card", "description": "Pay by Prepaid Card via Intercash", "dumpid": "37", "minimum": "100,200,300,400,500", "enabled": "0", "cost": "0", "protection": "1", "deleted": "0", "dump_name": "Intercash Prepaid Card", "lang_name": "Intercash Prepaid Card", "cost_nice": "$0.00", "cost_dec": "0.00", "affiliate_count": 0 }, { "payvia_type_id": "5", "name": "International Wire", "description": "International Bank Wire", "dumpid": "3", "minimum": "50,100,250,500,1000,2500", "enabled": "1", "cost": "0", "protection": "1", "deleted": "0", "dump_name": "International Wire Default", "lang_name": "International Wire", "cost_nice": "$0.00", "cost_dec": "0.00", "affiliate_count": 0 }, { "payvia_type_id": "9", "name": "Paxum", "description": "Paxum Payment", "dumpid": "34", "minimum": "100,200,300,400,500", "enabled": "0", "cost": "0", "protection": "1", "deleted": "0", "dump_name": "Paxum CSV", "lang_name": "Paxum", "cost_nice": "$0.00", "cost_dec": "0.00", "affiliate_count": 0 }, { "payvia_type_id": "8", "name": "Paypal", "description": "Paypal", "dumpid": "7", "minimum": "50,100,250,500,1000,2500", "enabled": "0", "cost": "0", "protection": "1", "deleted": "0", "dump_name": "Paypal Default", "lang_name": "Paypal", "cost_nice": "$0.00", "cost_dec": "0.00", "affiliate_count": 0 }, { "payvia_type_id": "11", "name": "Payza", "description": "Payza", "dumpid": "36", "minimum": "100,200,300,400,500", "enabled": "0", "cost": "0", "protection": "1", "deleted": "0", "dump_name": "Payza", "lang_name": "Payza", "cost_nice": "$0.00", "cost_dec": "0.00", "affiliate_count": 0 }, { "payvia_type_id": "14", "name": "Red Pass", "description": "Payvia through Zombaio", "dumpid": "39", "minimum": "100,200,300,400,500", "enabled": "0", "cost": "0", "protection": "1", "deleted": "0", "dump_name": "Red Pass", "lang_name": "Red Pass", "cost_nice": "$0.00", "cost_dec": "0.00", "affiliate_count": 0 }, { "payvia_type_id": "1000", "name": "test payvia", "description": "", "dumpid": "0", "minimum": "50", "enabled": "0", "cost": "0", "protection": "0", "deleted": "0", "dump_name": "", "lang_name": "test payvia", "cost_nice": "$0.00", "cost_dec": "0.00", "affiliate_count": 0 } ] }
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(); $request = Array( 'method' => 'GET', 'path' => 'v1/payment/payvias', '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); ?>