Void A Transaction

/*
ProPay provides the following code "AS IS." 
ProPay makes no warranties and ProPay disclaims all warranties and conditions, express, implied or statutory, 
including without limitation the implied warranties of title, non-infringement, merchantability, and fitness for a particular purpose. 
ProPay does not warrant that the code will be uninterrupted or error free, 
nor does ProPay make any warranty as to the performance or any results that may be obtained by use of the code.
*/

<?php
class ProtectPayApi
{

    /* change this to the production url for going live after testing https://api.propay.com */
    private $_apiBaseUrl = 'https://xmltestapi.propay.com';

    /* credentials that would normally be set from database values or a config value */
    private $_billerId;
    private $_authToken;

    /* for processing a payment method transaction void */
    private $_paymentMethodTransactionVoidData;
    private $_paymentMethodTransactionVoidInfo;

    /**
     * @param string $billerId
     * @return $this
     */
    public function setBillerId($billerId) {
        $this->_billerId = $billerId;
        return $this;
    }

    /**
     * @param string $authToken
     * @return $this
     */
    public function setAuthToken($authToken) {
        $this->_authToken = $authToken;
        return $this;
    }

    /**
     * @return string
     */
    private function _getAuth() {
        return $this->_billerId . ':' . $this->_authToken;
    }

    /**
     * @return $this
     * success result is something like
     * {"Transaction":{"AVSCode":"NotPresent","AuthorizationCode":null,"CurrencyConversionRate":1.0,"CurrencyConvertedAmount":0,"CurrencyConvertedCurrencyCode":"Unsupported","ResultCode":{"ResultValue":"SUCCESS","ResultCode":"00","ResultMessage":""},"TransactionHistoryId":"0","TransactionId":"603","TransactionResult":"Success","CVVResponseCode":"NotPresent","GrossAmt":null,"NetAmt":null,"PerTransFee":null,"Rate":null,"GrossAmtLessNetAmt":null},"RequestResult":{"ResultValue":"SUCCESS","ResultCode":"00","ResultMessage":""}}
     */
    public function processPaymentMethodTransactionVoid() {
        $data_string = json_encode($this->_paymentMethodTransactionVoidData);

        $ch = curl_init($this->_apiBaseUrl . '/ProtectPay/VoidedTransactions');
        curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PUT");
        curl_setopt($ch, CURLOPT_POSTFIELDS, $data_string);
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
        curl_setopt($ch, CURLOPT_USERPWD, $this->_getAuth());
        curl_setopt($ch, CURLOPT_HTTPHEADER, array(
            'Content-Type: application/json',
            'Content-Length: ' . strlen($data_string)
        ));

        $this->_paymentMethodTransactionVoidInfo = curl_exec($ch);
        return $this;
    }

    /**
     * @param array $paymentMethodTransactionVoidData
     * @return $this
     */
    public function setPaymentMethodTransactionVoidData($paymentMethodTransactionVoidData) {
        $this->_paymentMethodTransactionVoidData = $paymentMethodTransactionVoidData;
        return $this;
    }

    /**
     * @return mixed
     */
    public function getPaymentMethodTransactionVoidInfo() {
        return $this->_paymentMethodTransactionVoidInfo;
    }
}

$data = [
    "OriginalTransactionId" => "2",
    "TransactionHistoryId" => 0,
    "MerchantProfileId" => null,
    "Comment1" => "Void Comment 1",
    "Comment2" => "Void Comment 2"
];

// Void a transaction
$protectPayAPI = new ProtectPayApi();
$result = $protectPayAPI->setBillerId('9999986379225246')
    ->setAuthToken('16dfe8d7-889b-4380-925f-9c2c6ea4d930')
    ->setPaymentMethodTransactionVoidData($data)
    ->processPaymentMethodTransactionVoid()
    ->getPaymentMethodTransactionVoidInfo();

/*
ProPay provides the following code “AS IS.” 
ProPay makes no warranties and ProPay disclaims all warranties and conditions, express, implied or statutory, 
including without limitation the implied warranties of title, non-infringement, merchantability, and fitness for a particular purpose. 
ProPay does not warrant that the code will be uninterrupted or error free, 
nor does ProPay make any warranty as to the performance or any results that may be obtained by use of the code.
*/
package com.propay.protectpay.rest;

import java.io.IOException;

import com.fasterxml.jackson.core.JsonProcessingException;
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.ObjectMapper;
import com.mashape.unirest.http.Unirest;
import com.mashape.unirest.http.exceptions.UnirestException;
import com.mashape.unirest.request.HttpRequest;
import com.mashape.unirest.request.HttpRequestWithBody;
import com.propay.protectpay.rest.request.VoidTransactionRequest;
import com.propay.protectpay.rest.response.Result;
import com.propay.protectpay.rest.response.Transaction;
import com.propay.protectpay.rest.response.VoidTransactionResponse;

public class VoidTransactionSample {
	/**
	 * This URL would normally come from some configuration file or database.
	 */
	String baseUrl = "https://xmltestapi.propay.com/protectpay";

	public static void main(String[] args) {
		configureObjectMapper();

		VoidTransactionSample program = new VoidTransactionSample();

		VoidTransactionResponse response = program.voidTransaction();

		Result requestResult = response.getRequestResult();
		
		System.out.println("Result: " + requestResult.getResultValue());
		System.out.println("Result code: " + requestResult.getResultCode());
		System.out.println("Result message: " + requestResult.getResultMessage());

		Transaction transactionDetail = response.getTransaction();
		if (transactionDetail != null) {
			Result transactionResult = transactionDetail.getResultCode();
			System.out.println("Transaction Result: " + transactionResult.getResultValue());
			System.out.println("Transaction Result code: " + transactionResult.getResultCode());

			System.out.println("Transaction History Id: " + transactionDetail.getTransactionHistoryId());
			System.out.println("Authorization Code: " + transactionDetail.getAuthorizationCode());
			System.out.println("AVS Code: " + transactionDetail.getAvsCode());
			System.out.println("Currency Converted Amount: " + transactionDetail.getCurrencyConvertedAmount());
			System.out.println("Currency Converted Currency Code: " + transactionDetail.getCurrencyConvertedCurrencyCode());
			System.out.println("Currency Conversion Rate: " + transactionDetail.getCurrencyConversionRate());
			System.out.println("Gross Amount: " + transactionDetail.getGrossAmount());
			System.out.println("Gross Amount Less Net Amount: " + transactionDetail.getGrossAmountLessNetAmount());
			System.out.println("Net Amount: " + transactionDetail.getNetAmount());
			System.out.println("Per Transaction Fee: " + transactionDetail.getPerTransactionFee());
			System.out.println("Rate: " + transactionDetail.getRate());
			System.out.println("Transaction Id: " + transactionDetail.getTransactionId());
			System.out.println("Transaction Result: " + transactionDetail.getTransactionResult());
		}
	}

	/**
	 * Creates a payment method.
	 * 
	 * @return The payment method response.
	 */
	private VoidTransactionResponse voidTransaction() {

		VoidTransactionRequest voidRequest = this.buildRequest();

		HttpRequestWithBody request = this.createRequest(baseUrl + "/VoidedTransactions/");

		request.body(voidRequest);

		return this.executeRequest(request, VoidTransactionResponse.class);
	}

	/**
	 * Gets the authentication token. This would normally be in a configuration
	 * file or database.
	 * 
	 * @return The authentication token.
	 */
	private String getAuthToken() {
		return "79e6778a-40f3-4617-94be-28378f77b4f8";
	}

	/**
	 * Gets the biller's id. This would normally be in a configuration file or
	 * database.
	 * 
	 * @return
	 */
	private String getBillerId() {
		return "5099972215471530";
	}

	/**
	 * Gets the transaction history id.
	 * 
	 * This would normally be in a database or generated as a result of an
	 * earlier call, see ProtectPay API Manual sections "PaymentMethodId
	 * Processing Authorization Methods" or "PaymentMethodId Processing Capture
	 * Methods".
	 */
	private String getTransactionHistoryId() {
		return "10391";
	}
	
	/**
	 * Create the request instance. This ensures that the authentication header
	 * is attached to each request.
	 * 
	 * @param resourceUrl
	 *            The URL of the REST resource.
	 * @return The GetRequest instance.
	 */
	private HttpRequestWithBody createRequest(String resourceUrl) {
		String authToken = this.getAuthToken();
		String billerId = this.getBillerId();

		HttpRequestWithBody restRequest = Unirest.put(resourceUrl).basicAuth(billerId, authToken)
				.header("accept", "application/json").header("Content-Type", "application/json");

		return restRequest;
	}

	/**
	 * Builds the request data.
	 * 
	 * @returns The request data.
	 */
	private VoidTransactionRequest buildRequest() {
		String transactionHistoryId = this.getTransactionHistoryId();
//		int merchantProfileId = this.getMerchantProfile();

		VoidTransactionRequest voidRequest = new VoidTransactionRequest();
		voidRequest.setTransactionHistoryId(transactionHistoryId);
		voidRequest.setComment1("Product back ordered");
		voidRequest.setComment2("Customer good will");

		return voidRequest;
	}

	/**
	 * Execute a REST request.
	 * 
	 * @param request
	 *            The request to perform.
	 * @param responseClass
	 *            The type instance of the return type.
	 * @return An instance of type T or null if there was an error.
	 */
	private <T> T executeRequest(HttpRequest request, Class<T> responseClass) {
		try {
			System.out.println(request.toString());
			HttpResponse<T> response = request.asObject(responseClass);
			if (response.getStatus() != 200) { // HTTP OK response code
				System.out.println(response.getStatusText());
				return null;
			}

			return response.getBody();
		} catch (UnirestException e) {
			e.printStackTrace();
		}

		return null;
	}

	/**
	 * Configures the mapping between JSON and Classes.
	 * 
	 * This is boilerplate Unirest & Jackson configuration. It should only need
	 * to be done once in a full solution.
	 */
	private static void configureObjectMapper() {
		Unirest.setObjectMapper(new ObjectMapper() {
			private com.fasterxml.jackson.databind.ObjectMapper jacksonObjectMapper = new com.fasterxml.jackson.databind.ObjectMapper();

			public <T> T readValue(String value, Class<T> valueType) {
				try {
					return jacksonObjectMapper.readValue(value, valueType);
				} catch (IOException e) {
					throw new RuntimeException(e);
				}
			}

			public String writeValue(Object value) {
				try {
					return jacksonObjectMapper.writeValueAsString(value);
				} catch (JsonProcessingException e) {
					throw new RuntimeException(e);
				}
			}
		});
	}
}

// ------------------------------------------------------------------------------------------------------- //
// Object Files

// com.propay.protectpay.rest.request.VoidTransactionRequest.java

/*
ProPay provides the following code “AS IS.” 
ProPay makes no warranties and ProPay disclaims all warranties and conditions, express, implied or statutory, 
including without limitation the implied warranties of title, non-infringement, merchantability, and fitness for a particular purpose. 
ProPay does not warrant that the code will be uninterrupted or error free, 
nor does ProPay make any warranty as to the performance or any results that may be obtained by use of the code.
*/
package com.propay.protectpay.rest.request;

/**
 * A request to void a transaction.
 *
 */
public class VoidTransactionRequest {
	/**
	 * The transaction history id in the ProPay system.
	 */
	public String transactionHistoryId;

	/**
	 * The id of the merchant processing profile to use.
	 * 
	 * Important if the account has multiple processing gateways, e.g. for
	 * different countries.
	 * 
	 */
	public int merchantProfileId;

	/**
	 * Optional comment 1.
	 */
	public String comment1;

	/**
	 * Optional comment 2
	 */
	public String comment2;
}


// ------------------------------------------------------------------------------------------------------- //
// com.propay.protectpay.rest.response.VoidTransactionResponse.java

/*
ProPay provides the following code “AS IS.” 
ProPay makes no warranties and ProPay disclaims all warranties and conditions, express, implied or statutory, 
including without limitation the implied warranties of title, non-infringement, merchantability, and fitness for a particular purpose. 
ProPay does not warrant that the code will be uninterrupted or error free, 
nor does ProPay make any warranty as to the performance or any results that may be obtained by use of the code.
*/
package com.propay.protectpay.rest.response;

import com.fasterxml.jackson.annotation.JsonProperty;

/**
 * The value returned from call to void a transaction.
 *
 */
public class VoidTransactionResponse {
	/**
	 * The transaction details
	 */
	private Transaction transaction;

	/**
	 * The result of the request.
	 */
	private Result requestResult;
}

// ------------------------------------------------------------------------------------------------------- //
// com.propay.protectpay.rest.response.Transaction.java

/*
ProPay provides the following code “AS IS.” 
ProPay makes no warranties and ProPay disclaims all warranties and conditions, express, implied or statutory, 
including without limitation the implied warranties of title, non-infringement, merchantability, and fitness for a particular purpose. 
ProPay does not warrant that the code will be uninterrupted or error free, 
nor does ProPay make any warranty as to the performance or any results that may be obtained by use of the code.
*/
package com.propay.protectpay.rest.response;

import java.math.BigDecimal;

import com.fasterxml.jackson.annotation.JsonProperty;

/**
 * Transaction details.
 * 
 */
public class Transaction {
	/**
	 * The transaction history id in the ProPay system.
	 */
	private String transactionHistoryId;

	/**
	 * The transaction authorization code from the issuing bank.
	 */
	private String authorizationCode;

	/**
	 * The address verification system (AVS) code.
	 * 
	 * Only present if billing information is present on payment method, or in
	 * the request.
	 */
	private String avsCode;

	/**
	 * The card verification value (CVV) response code.
	 */
	private String cvvResponseCode;
	
	/**
	 * The amount in the settled currency.
	 */
	private int currencyConvertedAmount;

	/**
	 * The settled currency code.
	 */
	private String currencyConvertedCurrencyCode;

	/**
	 * The conversion rate from the requested currency to the settled currency.
	 * e.g. USD to USD = 1, JPY to USD = 0.0090 (as of 5/17/2017)
	 */
	private BigDecimal currencyConversionRate;

	/**
	 * The gross amount in the settled currency.
	 */
	private Integer grossAmount;

	/**
	 * The gross amount less net amount in the settled currency.
	 */
	private Integer grossAmountLessNetAmount;

	/**
	 * The net amount in the settled currency.
	 */
	private Integer netAmount;

	/**
	 * The per transaction fee in the settled currency.
	 */
	private Integer perTransactionFee;

	/**
	 * The percentage fee, if any.
	 */
	private BigDecimal rate;

	/**
	 * Result information from the transaction.
	 */
	private Result resultCode;

	/**
	 * The transaction number assigned by the processor.
	 */
	private String transactionId;

	/**
	 * The transaction result as reported by the processor.
	 */
	private String transactionResult;
}

// ------------------------------------------------------------------------------------------------------- //
// com.propay.protectpay.rest.response.Result.java

/*
ProPay provides the following code “AS IS.” 
ProPay makes no warranties and ProPay disclaims all warranties and conditions, express, implied or statutory, 
including without limitation the implied warranties of title, non-infringement, merchantability, and fitness for a particular purpose. 
ProPay does not warrant that the code will be uninterrupted or error free, 
nor does ProPay make any warranty as to the performance or any results that may be obtained by use of the code.
*/
package com.propay.protectpay.rest.response;

import com.fasterxml.jackson.annotation.JsonProperty;

/**
 * The result of the call.
 */
public class Result
{
    /**
     * The result of the transaction
     * 
     * Will always be SUCCESS or FAILURE
     */
	private String ResultValue;

    /**
     * The result code of the transaction
     *
     *
     * Will be a two-digit string with only numbers. Allows "00" as a response.
     */
	private String ResultCode;

    /**
     * The English-text message of what went wrong (if anything)
     *
     *
     * The documentation shows the empty string being returned in the success cases.
     */
	private String ResultMessage;
}

/>_ C/C++ coming soon...

/>_ C/C++ coming soon...

/>_ Client-side coming soon...

/>_ Python 2.7 coming soon...

/>_ Ruby 2.3 coming soon...

/>_ PERL 5.5 coming soon...