/api/biller/cascade‑step

post

Add new cascade step

Authorizations

api-key & api-username

api-keystringRequired

api-usernamestringRequired

Query parameters

cascadeidintegerRequired

step_typestringRequired

billeridintegerOptionalDefault: 0

specialstringOptional

typestringOptional

targetstringOptional

nontargetstringOptional

prependstringOptionalDefault: 0

Responses

200

success

text/phpapplication/jsonapplication/xml

successbooleanOptionalExample: true

post

/api/biller/cascade-step

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(
		'cascadeid' => 1,
		'step_type' => 'biller',
		'billerid' => 2,
		'type' => 'cc',
		'target' => 'USA',
		'nontarget' => 'AX',
		'prepend' => 0
	);

$request = array(
	'method' => 'POST',
	'path' => 'biller/cascade-step',
	'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,
  "result": "Added cascade step 2",
  "cascade_item_id": 2
}

delete

Delete cascade step

Authorizations

api-key & api-username

api-keystringRequired

api-usernamestringRequired

Query parameters

cascadeidintegerRequired

cascade_item_idintegerRequired

Responses

200

success

text/phpapplication/jsonapplication/xml

successbooleanOptionalExample: true

delete

/api/biller/cascade-step

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(
		'cascadeid' => 1,
		'cascade_item_id' => 1
	);

$request = array(
	'method' => 'DELETE',
	'path' => 'biller/cascade-step',
	'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,
  "result": "cascade step deleted"
}

patch

Edit cascade step

Authorizations

api-key & api-username

api-keystringRequired

api-usernamestringRequired

Query parameters

cascadeidintegerRequired

cascade_item_idintegerRequired

specialstringOptional

typestringOptional

targetstringOptional

nontargetstringOptional

Responses

200

success

text/phpapplication/jsonapplication/xml

successbooleanOptionalExample: true

patch

/api/biller/cascade-step

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(
		'cascadeid' => 1,
		'cascade_item_id' => 1,
		'type' => 'check',
		'target' => 'USA',
		'nontarget' => 'EU'
	);

$request = array(
	'method' => 'PATCH',
	'path' => 'biller/cascade-step',
	'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,
  "result": "updated cascade step"
}