Package io.electrum.suv.api.models

Class RefundRequest

java.lang.Object

io.electrum.vas.model.Transaction

io.electrum.suv.api.models.RefundRequest

All Implemented Interfaces:

VoucherTransaction, io.electrum.vas.model.VasMessage

public final class RefundRequest
extends io.electrum.vas.model.Transaction
implements VoucherTransaction

Field Summary

Fields inherited from class io.electrum.vas.model.Transaction

basketRef, client, destAccType, id, originator, receiver, rrn, settlementEntity, slipData, srcAccType, stan, thirdPartyIdentifiers, time, tranType

Constructor Summary

Constructors

Constructor	Description
RefundRequest()

Method Summary

Modifier and Type	Method	Description
RefundRequest	amounts(io.electrum.vas.model.Amounts amounts)
boolean	equals(Object o)
io.electrum.vas.model.Amounts	getAmounts()	Indicates the amount for which the voucher should be refunded in the requestAmount field.
io.electrum.vas.model.PosInfo	getPosInfo()
String	getReceiverTransactionRef()	Carries the value of the receiver's transaction reference for the original redemption
String	getRedemptionId()	Carries the value of the id field of the RedemptionRequest which is being refunded
Voucher	getVoucher()	The voucher to be refunded.
int	hashCode()
RefundRequest	posInfo(io.electrum.vas.model.PosInfo posInfo)	Information about the status of the POS/terminal used in the transaction.
RefundRequest	receiverTransactionRef(String receiverTransactionRef)
RefundRequest	redemptionId(String redemptionId)
void	setAmounts(io.electrum.vas.model.Amounts amounts)
void	setPosInfo(io.electrum.vas.model.PosInfo posInfo)
void	setReceiverTransactionRef(String receiverTransactionRef)
void	setRedemptionId(String redemptionId)
void	setVoucher(Voucher voucher)
String	toString()
RefundRequest	voucher(Voucher voucher)

Methods inherited from class io.electrum.vas.model.Transaction

basketRef, client, destAccType, getBasketRef, getClient, getDestAccType, getId, getOriginator, getReceiver, getRrn, getSettlementEntity, getSlipData, getSrcAccType, getStan, getThirdPartyIdentifiers, getTime, getTranType, id, originator, receiver, rrn, setBasketRef, setClient, setDestAccType, setId, setOriginator, setReceiver, setRrn, setSettlementEntity, setSlipData, setSrcAccType, setStan, setThirdPartyIdentifiers, setTime, settlementEntity, setTranType, slipData, srcAccType, stan, thirdPartyIdentifiers, time, tranType

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RefundRequest

public RefundRequest()

Method Detail

amounts

public RefundRequest amounts(io.electrum.vas.model.Amounts amounts)

Specified by:

amounts in interface VoucherTransaction

getAmounts

public io.electrum.vas.model.Amounts getAmounts()

Indicates the amount for which the voucher should be refunded in the requestAmount field. If requestAmount is not populated then a full refund is to be assumed.

Specified by:

getAmounts in interface VoucherTransaction

Returns:

amounts

setAmounts

public void setAmounts(io.electrum.vas.model.Amounts amounts)

Specified by:

setAmounts in interface VoucherTransaction

voucher

public RefundRequest voucher(Voucher voucher)

Specified by:

voucher in interface VoucherTransaction

getVoucher

@NotNull
public Voucher getVoucher()

The voucher to be refunded.

Specified by:

getVoucher in interface VoucherTransaction

Returns:

voucher

setVoucher

public void setVoucher(Voucher voucher)

Specified by:

setVoucher in interface VoucherTransaction

redemptionId

public RefundRequest redemptionId(String redemptionId)

getRedemptionId

public String getRedemptionId()

Carries the value of the id field of the RedemptionRequest which is being refunded

Use of this field is encouraged if the refund request is submitted to the same system which processed the original redemption.

Returns:

redemptionId

setRedemptionId

public void setRedemptionId(String redemptionId)

receiverTransactionRef

public RefundRequest receiverTransactionRef(String receiverTransactionRef)

getReceiverTransactionRef

public String getReceiverTransactionRef()

Carries the value of the receiver's transaction reference for the original redemption

Use of this field allows a refund to pass through systems which did not process the original redemption. If the original voucher alone is not enough to facilitate a refund then the receiver may use this field to identify the original redemption to be refunded. Therefore, use of this field is strongly encouraged to aid processing of a refund request.

Returns:

receiverTransactionRef

setReceiverTransactionRef

public void setReceiverTransactionRef(String receiverTransactionRef)

posInfo

public RefundRequest posInfo(io.electrum.vas.model.PosInfo posInfo)

Information about the status of the POS/terminal used in the transaction.

Specified by:

posInfo in interface VoucherTransaction

Returns:

Since:

v1.14.0

getPosInfo

public io.electrum.vas.model.PosInfo getPosInfo()

Specified by:

getPosInfo in interface VoucherTransaction

Returns:

setPosInfo

public void setPosInfo(io.electrum.vas.model.PosInfo posInfo)

Specified by:

setPosInfo in interface VoucherTransaction

equals

public boolean equals(Object o)

Overrides:

equals in class io.electrum.vas.model.Transaction

hashCode

public int hashCode()

Overrides:

hashCode in class io.electrum.vas.model.Transaction

toString

public String toString()

Overrides:

toString in class io.electrum.vas.model.Transaction