/api/external‑transaction/initial
post
NOTICE: NATS Pro is required to use this API.
Record an Initial Transaction
Authorizations
api-keystringRequired
api-usernamestringRequired
Query parameters
natscodestringRequired
billeridintegerRequired
amountstringRequired
currencystringRequired
memberidxstringRequired
transactionidxstringRequired
usernamestringOptional
passwordstringOptional
emailstringOptional
billing_firstnamestringOptional
billing_lastnamestringOptional
billing_phonestringOptional
billing_address1stringOptional
billing_address2stringOptional
billing_citystringOptional
billing_statestringOptional
billing_zipcodestringOptional
billing_countrystringOptional
shipping_firstnamestringOptional
shipping_lastnamestringOptional
shipping_address1stringOptional
shipping_address2stringOptional
shipping_zipstringOptional
shipping_citystringOptional
shipping_countrystringOptional
shipping_statestringOptional
option_identifierstringOptional
ipstringOptional
countrystringOptional
landing_page_urlstringOptional
referring_urlstringOptional
ptypestringOptional
custom1stringOptional
custom2stringOptional
custom3stringOptional
custom4stringOptional
custom5stringOptional
custom6stringOptional
custom7stringOptional
custom8stringOptional
custom9stringOptional
custom10stringOptional
transaction_passthrough1stringOptional
transaction_passthrough2stringOptional
transaction_passthrough3stringOptional
transaction_passthrough4stringOptional
transaction_passthrough5stringOptional
memberidintegerOptional
optionidintegerOptional
custom_lookup_idintegerOptional
landing_page_lookup_idintegerOptional
refurl_lookup_idintegerOptional
loginidintegerOptional
programidintegerOptional
siteidintegerOptional
touridintegerOptional
campaignidintegerOptional
adtoolidintegerOptional
subid1integerOptional
subid2integerOptional
promotionalidintegerOptional
timeintegerOptional
expire_timeintegerOptional
Responses
200
success
successbooleanOptionalExample:
truepost/api/external-transaction/initial
PHP (cURL)<?php
$headers = array( //set your username and API key here
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: tmm1phrvezsbu'
);
$url = 'https://yourdomain.com'; //set your NATS URL here
$data = array();
$request = array(
'method' => 'POST',
'path' => 'external-transaction/initial',
'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);
?>200
success
{
"success": true
}Last updated
Was this helpful?