com.mypos.myposcheckout.ipc.request

Class MandateManagement

java.lang.Object

com.mypos.myposcheckout.ipc.request.Request

com.mypos.myposcheckout.ipc.request.MandateManagement

public class MandateManagement
extends Request

Process IPC method: MandateManagement. This method is used by the merchant to register a mandate reference for direct withdrawal transactions (Request money) from a client’s myPOS account or to cancel a previously registered mandate reference. The merchant can register more than one mandate reference for each client. All mandate references are registered to a specific merchant’s myPOS account.

Field Summary

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

config, outputFormat

Constructor Summary

Constructors

Constructor and Description
MandateManagement(Config config)

Method Summary

Modifier and Type	Method and Description
MandateAction	getAction()
java.lang.String	getCustomerWalletNumber()
java.lang.String	getMandateReference()
java.lang.String	getMandateText()
BasicResponse	process() Gather all request parameters needed to make an API call, and make one.
void	setAction(MandateAction action)
void	setCustomerWalletNumber(java.lang.String customerWalletNumber)
void	setMandateReference(java.lang.String mandateReference)
void	setMandateText(java.lang.String mandateText)
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

MandateManagement

public MandateManagement(Config config)

Method Detail

getMandateReference

public java.lang.String getMandateReference()

setMandateReference

public void setMandateReference(java.lang.String mandateReference)

getCustomerWalletNumber

public java.lang.String getCustomerWalletNumber()

setCustomerWalletNumber

public void setCustomerWalletNumber(java.lang.String customerWalletNumber)

getAction

public MandateAction getAction()

setAction

public void setAction(MandateAction action)

getMandateText

public java.lang.String getMandateText()

setMandateText

public void setMandateText(java.lang.String mandateText)

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 BasicResponse process()
                      throws IPCException

Gather all request parameters needed to make an API call, and make one.

Returns:

the decoded API response

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.