Difference between revisions of "NATS5 REST API Biller GET available"
From TMM Wiki
Jump to navigationJump to search| (2 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | {{ | + | {{NATS5 Manual |
| − | | | + | | show_api_admin_biller_section = true |
}} | }} | ||
== '''GET /biller/available''' == | == '''GET /biller/available''' == | ||
| + | |||
'''Description''' | '''Description''' | ||
* Get available billers | * Get available billers | ||
| 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 582: | Line 583: | ||
</pre> | </pre> | ||
| − | [[Category: | + | [[Category:NATS5_REST_APIs]] |
| − | [[Category: | + | [[Category:NATS5_REST_biller_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 --> | ||
Latest revision as of 15:58, 9 August 2019
GET /biller/available
Description
- Get available billers
Resource URL
- http://domain/api/biller/available
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
None
Example Request
Method: GET
URL: http://domain/api/biller/available
Response:
[
{
"nice": "A1Payments",
"nice_short": "A1Payments",
"short": "A1PAYMENTS"
},
{
"nice": "Aconti Payment Service",
"nice_short": "Aconti",
"short": "ACONTI"
},
{
"nice": "Adult Empire Billing",
"nice_short": "Adult Empire Billing",
"short": "AEBILL"
},
{
"nice": "Allopass",
"nice_short": "Allopass",
"short": "ALLOPASS"
},
{
"nice": "AltoBilling",
"nice_short": "AltoBilling",
"short": "ALTO"
},
{
"nice": "Argus Payments",
"nice_short": "Argus",
"short": "ARGUS"
},
{
"nice": "Authorize.Net (ARB)",
"nice_short": "AuthorizeARB",
"short": "AUTHORIZEARB"
},
{
"nice": "Bill1st Gateway",
"nice_short": "Bill1st",
"short": "BILL1ST"
},
{
"nice": "Billapay",
"nice_short": "Billapay",
"short": "BILLAPAY"
},
{
"nice": "Billing Revolution",
"nice_short": "Billing Revolution",
"short": "BILLINGREV"
},
{
"nice": "BitPay",
"nice_short": "BitPay",
"short": "BITPAY"
},
{
"nice": "Boa Compra",
"nice_short": "BoaCompra",
"short": "BOA"
},
{
"nice": "Braintree Payments",
"nice_short": "Braintree",
"short": "BRAINTREE"
},
{
"nice": "C2Bill",
"nice_short": "C2Bill",
"short": "C2BILL"
},
{
"nice": "CardFlex",
"nice_short": "CardFlex",
"short": "CARDFLEX"
},
{
"nice": "Connect Billing",
"nice_short": "Connect Billing",
"short": "CBILLING"
},
{
"nice": "CCBill Web900 (standalone)",
"nice_short": "CCBill Web900",
"short": "CCB900"
},
{
"nice": "CCBill",
"nice_short": "CCBill",
"short": "CCBILL"
},
{
"nice": "CCBILL FlexForms",
"nice_short": "CCBILL FlexForms",
"short": "CCBILLFF"
},
{
"nice": "Centili",
"nice_short": "Centili",
"short": "CENTILI"
},
{
"nice": "Centrobill",
"nice_short": "Centrobill",
"short": "CENTROBILL"
},
{
"nice": "CommerceGate",
"nice_short": "CGate",
"short": "CGATE"
},
{
"nice": "ClearCard",
"nice_short": "ClearCard",
"short": "CLEARCARD"
},
{
"nice": "Click And Buy",
"nice_short": "Click & Buy",
"short": "CLICKANDBUY"
},
{
"nice": "CurePay Gateway",
"nice_short": "CurePay",
"short": "CUREPAY"
},
{
"nice": "Dimoco",
"nice_short": "Dimoco",
"short": "DIMOCO"
},
{
"nice": "eGatePay",
"nice_short": "eGatePay",
"short": "EGP"
},
{
"nice": "eMerchantPay Gateway (Server-to-server)",
"nice_short": "eMerchPayGate",
"short": "EMERCHPAYGATE"
},
{
"nice": "eMPPay.com",
"nice_short": "eMPPay",
"short": "EMPNATIVE"
},
{
"nice": "Epoch Systems",
"nice_short": "Epoch",
"short": "EPOCH"
},
{
"nice": "Escalion",
"nice_short": "Escalion",
"short": "ESCALION"
},
{
"nice": "EuroBill",
"nice_short": "EuroBill",
"short": "EUROBILL"
},
{
"nice": "EPGBILL.com",
"nice_short": "EPGBILL.com",
"short": "EUROPAY"
},
{
"nice": "Focal Payments",
"nice_short": "Focal Payments",
"short": "FOCAL"
},
{
"nice": "Fxbilling",
"nice_short": "Fxbilling",
"short": "FXBILLING"
},
{
"nice": "Fxbilling Native",
"nice_short": "Fxbilling Native",
"short": "FXNATIVE"
},
{
"nice": "Greta 11 Billing",
"nice_short": "G11Bill",
"short": "G11BILL"
},
{
"nice": "Global Access",
"nice_short": "GACCESS",
"short": "GACCESS"
},
{
"nice": "GigaDat",
"nice_short": "GigaDat",
"short": "GIGADAT"
},
{
"nice": "Global Charge",
"nice_short": "Global Charge",
"short": "GLOBALC"
},
{
"nice": "Global DPS",
"nice_short": "GLOBALDPS",
"short": "GLOBALDPS"
},
{
"nice": "GoCoin",
"nice_short": "GoCoin",
"short": "GOCOIN"
},
{
"nice": "GTBill",
"nice_short": "GTBill",
"short": "GTBILL"
},
{
"nice": "GTBill Gateway",
"nice_short": "GTBill Gateway",
"short": "GTBILLGATEWAY"
},
{
"nice": "ICN Ltd.",
"nice_short": "ICN Ltd.",
"short": "ICN"
},
{
"nice": "Itelebill",
"nice_short": "ITELEBILL",
"short": "ITELEBILL"
},
{
"nice": "Jettis International Gateway",
"nice_short": "Jettis Inter Gateway",
"short": "JETINTGATE"
},
{
"nice": "Jettis International",
"nice_short": "Jettis International",
"short": "JETTISINTL"
},
{
"nice": "MerlinBill",
"nice_short": "MerlinBill",
"short": "MBILL"
},
{
"nice": "MobiusPay",
"nice_short": "MobiusPay",
"short": "MOBIUS"
},
{
"nice": "NETbilling Native",
"nice_short": "NBNative",
"short": "NBNATIVE"
},
{
"nice": "NETbilling",
"nice_short": "NETbilling",
"short": "NETBILLING"
},
{
"nice": "NetCash",
"nice_short": "NetCash",
"short": "NETCASH"
},
{
"nice": "Net Mobile",
"nice_short": "Net Mobile",
"short": "NETMOBILE"
},
{
"nice": "Netpay International",
"nice_short": "Netpay Intl.",
"short": "NETPAY"
},
{
"nice": "NoCreditCard.com",
"nice_short": "NOCC",
"short": "NOCC"
},
{
"nice": "Orbitalpay",
"nice_short": "Orbitalpay",
"short": "ORBPAY"
},
{
"nice": "Pay4",
"nice_short": "Pay4",
"short": "PAY4"
},
{
"nice": "Pay900",
"nice_short": "Pay900",
"short": "PAY900"
},
{
"nice": "Paygarden",
"nice_short": "Paygarden",
"short": "PAYGARDEN"
},
{
"nice": "Payment Network",
"nice_short": "Payment Network",
"short": "PAYNET"
},
{
"nice": "PayPal Standard",
"nice_short": "PayPal",
"short": "PAYPAL"
},
{
"nice": "Payspace",
"nice_short": "Payspace",
"short": "PAYSPACE"
},
{
"nice": "Payspace Gateway",
"nice_short": "Payspace Gateway",
"short": "PAYSPACEGATEWAY"
},
{
"nice": "PasswordByPhone",
"nice_short": "PBP",
"short": "PBP"
},
{
"nice": "Paysite Cash",
"nice_short": "Paysite Cash",
"short": "PCASH"
},
{
"nice": "Plug'n Pay",
"nice_short": "PnP",
"short": "PLUGNPAY"
},
{
"nice": "Prime Orange",
"nice_short": "Prime Orange",
"short": "PORANGE"
},
{
"nice": "Probiller",
"nice_short": "Probiller",
"short": "PROBILLER"
},
{
"nice": "Rocketgate Native",
"nice_short": "Rocketgate Native",
"short": "RGNATIVE"
},
{
"nice": "RocketGate",
"nice_short": "RocketGate",
"short": "ROCKETGATE"
},
{
"nice": "RSBilling",
"nice_short": "RSBilling",
"short": "RSBILLING"
},
{
"nice": "RSBNative",
"nice_short": "RSBNative",
"short": "RSBNATIVE"
},
{
"nice": "SafeCharge",
"nice_short": "SafeCharge",
"short": "SAFECHARGE"
},
{
"nice": "Secure Billing Worldwide",
"nice_short": "SBW",
"short": "SBW"
},
{
"nice": "Secure Billing Worldwide Gateway",
"nice_short": "SBWGATEWAY",
"short": "SBWGATEWAY"
},
{
"nice": "SafeCharge Native",
"nice_short": "SafeCharge Native",
"short": "SCNATIVE"
},
{
"nice": "SegPay",
"nice_short": "SegPay",
"short": "SEGPAY"
},
{
"nice": "SegPay Gateway",
"nice_short": "SegPay Gateway",
"short": "SEGPAYGATEWAY"
},
{
"nice": "Shopping Cart",
"nice_short": "Shopping Cart",
"short": "SHOP"
},
{
"nice": "SOFORTdauerauftrag",
"nice_short": "SOFORTdauerauftrag",
"short": "SOFORTABO"
},
{
"nice": "Sonic Bill",
"nice_short": "Sonic Bill",
"short": "SONICBILL"
},
{
"nice": "StandardBill",
"nice_short": "StandardBill",
"short": "STBILL"
},
{
"nice": "Secure Trading",
"nice_short": "Secure Trading",
"short": "STRADING"
},
{
"nice": "Telecom",
"nice_short": "Telecom",
"short": "TELECOM"
},
{
"nice": "2000Charge",
"nice_short": "2000Charge",
"short": "TWOCHARGE"
},
{
"nice": "2000Charge Gateway",
"nice_short": "2000Charge Gateway",
"short": "TWOCHARGEGATE"
},
{
"nice": "Ukash",
"nice_short": "UKASH",
"short": "UKASH"
},
{
"nice": "Vendo",
"nice_short": "Vendo",
"hidden": 1,
"short": "VENDO"
},
{
"nice": "Verotel Pro",
"nice_short": "Verotel",
"short": "VEROTEL"
},
{
"nice": "Voxtel",
"nice_short": "Voxtel",
"short": "VOXTEL"
},
{
"nice": "Vendo Services",
"nice_short": "Vendo Services",
"short": "VSERVICES"
},
{
"nice": "VXSBill",
"nice_short": "VXS",
"short": "VXS"
},
{
"nice": "WebBilling",
"nice_short": "WebBilling",
"short": "WEBBILL"
},
{
"nice": "Wispay",
"nice_short": "Wispay",
"short": "WISPAY"
},
{
"nice": "Worldline",
"nice_short": "Worldline",
"short": "WORLDLINE"
},
{
"nice": "WTS\/ACHBill",
"nice_short": "WTS",
"short": "WTS"
},
{
"nice": "WTSeu",
"nice_short": "WTSeu",
"short": "WTSEU"
},
{
"nice": "Zombaio",
"nice_short": "Zombaio",
"short": "ZOMBAIO"
}
]
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/biller/available',
'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);
?>
