Velocity Developer Resources

REST

Note: In situations where the service configuration does not support Adjust, adjustments can still be made at the time of settlement by setting the new transaction amount on the Rest.Capture DifferenceData object.

Note: The HTTP Authorization Header must contain the required sessionToken value.

Operation

Parameters

Message Body Type

Return Type

Exceptions

For additional details about each fault, refer to Transaction Processing Faults in the CWS Developer API Reference.

C# Code Sample

public Response Adjust(string sessionToken, Adjust adjust, string applicationProfileId, string workflowId)
{
	var isJson = string.Equals(_msgFormat, MessageFormat.JSON.ToString());
	var requestString = RestBaseUri + "/" + workflowId + "/" + adjust.TransactionId;
	var restAdjust = new schemas.nabcommerce.com.CWS.v2._0.Transactions.Rest.Adjust();
	restAdjust.ApplicationProfileId = applicationProfileId;
	restAdjust.DifferenceData = Utilities.SwapObjectsNamespace(adjust);
 
	var request = RestHelper.CreateRestRequest(restAdjust, requestString, HttpMethod.PUT, sessionToken, isJson);
	try
	{
		if (isJson)
			return RestHelper.GetResponse(request, isJson);
		// For XML and Adjust we do not know the specific type we will be getting back from the server. 
		// For this we can get the string response back determine what type it is from this response 
		// and then turn it into the desired object. 
		var strResponse = RestHelper.GetResponse(request, isJson, false);
		if (strResponse.Contains("BankcardTransactionResponsePro"))
			return RestHelper.GetCWSObjectFromXml(strResponse);
		if (strResponse.Contains("ElectronicCheckingTransactionResponse"))
			return RestHelper.GetCWSObjectFromXml(strResponse);
		if (strResponse.Contains("StoredValueTransactionResponse"))
			return RestHelper.GetCWSObjectFromXml(strResponse);
	}
	catch (Exception ex)
	{

		RestFaultHandler.HandleFaultException(ex, isJson); 
	}
}

REST

Note:The HTTP Authorization Header must contain the required sessionToken value.

Operation

Parameters

Message Body Type

Return Type

Exceptions

For additional details about each fault, refer to Transaction Processing Faults in the CWS Developer API Reference.

• PHP
• C#

/* NOTE: Use this function to void an authorized transaction
 * $transactionID is the known transaction ID of a previous transaction*/
 
public function undo( $transactionID, $creds = null, $txnType = null )
{
	if (! $this->signOn ())
		return false;
 
	$UndoType = '"$type":"Undo,http://schemas.nabcommerce.com/CWS/v2.0/Transactions/Rest",';
 
	if ($this->svc instanceof BankcardService || $txnType == "BCP")
	{
		$DifferenceData = new BankcardUndo();
		$DifferenceData->PINDebitReason = 'NotSet';
		$DifferenceData->ForceVoid = false;
		$DiffType = '"$type":"BankcardUndo,http://schemas.nabcommerce.com/CWS/v2.0/Transactions/Bankcard",';
	}
	if ($this->svc instanceof ElectronicCheckingService || $txnType == "ECK")
	{
		$DifferenceData = new UndoDifferenceData();
		$DiffType = '"$type":"DifferenceData,http://schemas.nabcommerce.com/CWS/v2.0/Transactions",';
	}
 
	$DifferenceData->TransactionId = $transactionID;
	if ($creds != null)
	{
		$DifferenceData->Addendum = new Addendum ();
		$DifferenceData->Addendum->Unmanaged = new Unmanaged ();
		$DifferenceData->Addendum->Unmanaged->Any = new Any ();
		$DifferenceData->Addendum->Unmanaged->Any->string = $creds;
	}
 
	// Build Capture
	$msgBody = new Rest_Undo ();
	$msgBody->ApplicationProfileId = $this->appProfileID;
	$msgBody->DifferenceData = $DifferenceData;
 
	$action = 'PUT';
	$url = $this->txn.'/'.$this->workflowId.'/'.$transactionID;
 
	// Format the message
	$diffString = '"DifferenceData":{';
	$msgBody = (string)json_encode($msgBody);
	$msgBody = str_replace('{"ApplicationProfileId"', '{'.$UndoType.'"ApplicationProfileId"', $msgBody);
	$msgBody = str_replace($diffString, $diffString.$DiffType, $msgBody);
	$msgBody = str_replace(' ', '', $msgBody); // Make sure no spaces remain in the body.
	$response = curl_json($msgBody, $url, $action, $this->session_token);
	if(isset($response->body->ErrorId))
	{
		handleRestFault($response);
		return false;
	}
	if(isset($response[2]))
		return $response[2];
}

public Response Undo(string sessionToken, Undo undo, string applicationProfileId, string workflowId)
{
	var isJson = string.Equals(_msgFormat, MessageFormat.JSON.ToString());
	var requestString = RestBaseUri + "/" + workflowId + "/" + undo.TransactionId;
	var restUndo = new schemas.nabcommerce.com.CWS.v2._0.Transactions.Rest.Undo();
	restUndo.ApplicationProfileId = applicationProfileId;
 
	if(undo.GetType() == typeof(BankcardUndo))
		restUndo.DifferenceData = Utilities.SwapObjectsNamespace(undo);
	else
		restUndo.DifferenceData = Utilities.SwapObjectsNamespace(undo);
 
	var request = RestHelper.CreateRestRequest(restUndo, requestString, HttpMethod.PUT, sessionToken, isJson);
	try
	{
		if (isJson)
			return RestHelper.GetResponse(request, isJson);
		// For XML and Undo we do not know the specific type we will be getting back from the server. 
		// For this we can get the string response back determine what type it is from this response 
		// and then turn it into the desired object. 
		var strResponse = RestHelper.GetResponse(request, isJson, false);
		if (strResponse.Contains("BankcardTransactionResponsePro"))
			return RestHelper.GetCWSObjectFromXml(strResponse);
		if (strResponse.Contains("ElectronicCheckingTransactionResponse"))
			return RestHelper.GetCWSObjectFromXml(strResponse);
		if (strResponse.Contains("StoredValueTransactionResponse"))
			return RestHelper.GetCWSObjectFromXml(strResponse);
	}
	catch (Exception ex)
	{
		RestFaultHandler.HandleFaultException(ex, isJson);
	}
}