com.mypos.myposcheckout.ipc.request

Class Reversal

java.lang.Object

com.mypos.myposcheckout.ipc.request.Request

com.mypos.myposcheckout.ipc.request.Reversal

public class Reversal
extends Request

Process IPC method: IPСReversal. This method is used by Merchant to initiate a reversal (void) of previously executed payment.

Field Summary

Fields inherited from class com.mypos.myposcheckout.ipc.request.Request

config, outputFormat

Constructor Summary

Constructors

Constructor and Description
Reversal(Config config)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getTrnRef()
boolean	process() Gather all request parameters needed to make an API call, and make one.
void	setTrnRef(java.lang.String trnRef)
boolean	validate() Checks if the class members are valid API request parameter values.

Methods inherited from class com.mypos.myposcheckout.ipc.request.Request

addRequestParam, addRequestParam, addRequestParam, addRequestParam, addRequestParam, addStandardParams, clearRequestParams, createApiCallFormHtml, createApiCallFormHtml, createApiCallFormHtml, createSignature, getConfig, getOutputFormat, getSignedRequestParams, processApiCall, removeRequestParam, setConfig, setOutputFormat

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Reversal

public Reversal(Config config)

Method Detail

getTrnRef

public java.lang.String getTrnRef()

setTrnRef

public void setTrnRef(java.lang.String trnRef)

validate

public boolean validate()
                 throws IPCException

Checks if the class members are valid API request parameter values.

Returns:

true if all members can be used as valid API request parameters

Throws:

IPCException - If there are values which are missing, or invalid API request parameters.

process

public boolean process()
                throws IPCException

Gather all request parameters needed to make an API call, and make one. Checks the API response if the transaction reference, amount and currency, are matching the ones from the purchase request.

Returns:

true if all parameters and configurations are valid, or false if the transaction reference does not match the one provided from the client.

Throws:

IPCException - If there are invalid or missing parameters, or configuration values. If there were errors while making the call to the API, or decoding it's response.