public class RefundRequest extends Object implements ITimeoutRequest, ICoreRequest, IPaymentMethod, IPreviousTransaction, IRequestAmount, ISignatureRequest, ISubtotals, ITerminalReference
Constructor and Description |
---|
RefundRequest() |
Modifier and Type | Method and Description |
---|---|
String |
getAddress()
Gets the cardholder address for use with address verification.
|
String |
getAmount()
Gets the requested amount.
|
String |
getCardholderName()
Gets the cardholder name.
|
CardType |
getCardType()
Gets designates categories of cards: credit, debit, EBT.
|
String |
getCurrencyCode()
Gets the transaction currency code.
|
String |
getCvv()
Gets the card CVV for use with PAN based transactions.
|
String |
getDestinationAccount()
Gets the settlement account for merchants with split settlements.
|
String |
getExpMonth()
Gets the card expiration month for use with PAN based transactions.
|
String |
getExpYear()
Gets the card expiration year for use with PAN based transactions.
|
Healthcare |
getHealthcare()
Gets details for HSA/FSA transactions.
|
String |
getKsn()
Gets the key serial number used for DUKPT encryption.
|
String |
getOrderRef()
Gets an identifier from an external point of sale system.
|
String |
getPan()
Gets the primary account number.
|
String |
getPaymentType()
Gets designates brands of payment methods: Visa, Discover, etc.
|
String |
getPinBlock()
Gets the encrypted pin block.
|
String |
getPostalCode()
Gets the cardholder postal code for use with address verification.
|
String |
getRoutingNumber()
Gets the ACH routing number for ACH transactions.
|
String |
getSigFile()
Gets a location on the filesystem which a customer signature should be written to.
|
SignatureFormat |
getSigFormat()
Gets the image format to be used for returning signatures.
|
int |
getSigWidth()
Gets the width that the signature image should be scaled to, preserving the aspect
ratio.
|
String |
getTaxAmount()
Gets the tax amount.
|
String |
getTerminalName()
Gets the name of the target payment terminal.
|
int |
getTimeout()
Gets the request timeout in seconds.
|
String |
getTipAmount()
Gets the tip amount.
|
String |
getToken()
Gets the payment token to be used for this transaction.
|
String |
getTrack1()
Gets track 1 magnetic stripe data.
|
String |
getTrack2()
Gets track 2 magnetic stripe data.
|
String |
getTransactionId()
Gets the ID of the previous transaction being referenced.
|
String |
getTransactionRef()
Gets a user-assigned reference that can be used to recall or reverse transactions.
|
boolean |
isAsync()
Gets defers the response to the transaction and returns immediately.
|
boolean |
isCashDiscount()
Gets a flag that applies a discount to negate the surcharge for debit transactions
or other surcharge ineligible payment methods.
|
boolean |
isDisableSignature()
Gets whether or not signature prompt should be skipped on the terminal.
|
boolean |
isForce()
Gets override any in-progress transactions.
|
boolean |
isManualEntry()
Gets that the payment entry method is a manual keyed transaction.
|
boolean |
isQueue()
Gets adds the transaction to the queue and returns immediately.
|
boolean |
isSurcharge()
Gets a flag to add a surcharge to the transaction to cover credit card fees, if
permitted.
|
boolean |
isTaxExempt()
Gets that the request is tax exempt.
|
boolean |
isTest()
Gets whether or not to route transaction to the test gateway.
|
boolean |
isWaitForRemovedCard()
Gets whether or not the request should block until all cards have been removed from
the card reader.
|
void |
setAddress(String value)
Sets the cardholder address for use with address verification.
|
void |
setAmount(String value)
Sets the requested amount.
|
void |
setAsync(boolean value)
Sets defers the response to the transaction and returns immediately.
|
void |
setCardholderName(String value)
Sets the cardholder name.
|
void |
setCardType(CardType value)
Sets designates categories of cards: credit, debit, EBT.
|
void |
setCashDiscount(boolean value)
Sets a flag that applies a discount to negate the surcharge for debit transactions
or other surcharge ineligible payment methods.
|
void |
setCurrencyCode(String value)
Sets the transaction currency code.
|
void |
setCvv(String value)
Sets the card CVV for use with PAN based transactions.
|
void |
setDestinationAccount(String value)
Sets the settlement account for merchants with split settlements.
|
void |
setDisableSignature(boolean value)
Sets whether or not signature prompt should be skipped on the terminal.
|
void |
setExpMonth(String value)
Sets the card expiration month for use with PAN based transactions.
|
void |
setExpYear(String value)
Sets the card expiration year for use with PAN based transactions.
|
void |
setForce(boolean value)
Sets override any in-progress transactions.
|
void |
setHealthcare(Healthcare value)
Sets details for HSA/FSA transactions.
|
void |
setKsn(String value)
Sets the key serial number used for DUKPT encryption.
|
void |
setManualEntry(boolean value)
Sets that the payment entry method is a manual keyed transaction.
|
void |
setOrderRef(String value)
Sets an identifier from an external point of sale system.
|
void |
setPan(String value)
Sets the primary account number.
|
void |
setPaymentType(String value)
Sets designates brands of payment methods: Visa, Discover, etc.
|
void |
setPinBlock(String value)
Sets the encrypted pin block.
|
void |
setPostalCode(String value)
Sets the cardholder postal code for use with address verification.
|
void |
setQueue(boolean value)
Sets adds the transaction to the queue and returns immediately.
|
void |
setRoutingNumber(String value)
Sets the ACH routing number for ACH transactions.
|
void |
setSigFile(String value)
Sets a location on the filesystem which a customer signature should be written to.
|
void |
setSigFormat(SignatureFormat value)
Sets the image format to be used for returning signatures.
|
void |
setSigWidth(int value)
Sets the width that the signature image should be scaled to, preserving the aspect
ratio.
|
void |
setSurcharge(boolean value)
Sets a flag to add a surcharge to the transaction to cover credit card fees, if
permitted.
|
void |
setTaxAmount(String value)
Sets the tax amount.
|
void |
setTaxExempt(boolean value)
Sets that the request is tax exempt.
|
void |
setTerminalName(String value)
Sets the name of the target payment terminal.
|
void |
setTest(boolean value)
Sets whether or not to route transaction to the test gateway.
|
void |
setTimeout(int value)
Sets the request timeout in seconds.
|
void |
setTipAmount(String value)
Sets the tip amount.
|
void |
setToken(String value)
Sets the payment token to be used for this transaction.
|
void |
setTrack1(String value)
Sets track 1 magnetic stripe data.
|
void |
setTrack2(String value)
Sets track 2 magnetic stripe data.
|
void |
setTransactionId(String value)
Sets the ID of the previous transaction being referenced.
|
void |
setTransactionRef(String value)
Sets a user-assigned reference that can be used to recall or reverse transactions.
|
void |
setWaitForRemovedCard(boolean value)
Sets whether or not the request should block until all cards have been removed from
the card reader.
|
public void setTimeout(int value)
value
- the request timeout in seconds.public int getTimeout()
getTimeout
in interface ITimeoutRequest
public void setTest(boolean value)
value
- whether or not to route transaction to the test gateway.public boolean isTest()
isTest
in interface ITimeoutRequest
public void setTransactionRef(String value)
value
- a user-assigned reference that can be used to recall or reverse
transactions.public String getTransactionRef()
getTransactionRef
in interface ICoreRequest
public void setAsync(boolean value)
value
- defers the response to the transaction and returns immediately.
Callers should retrive the transaction result using the Transaction Status API.public boolean isAsync()
isAsync
in interface ICoreRequest
public void setQueue(boolean value)
value
- adds the transaction to the queue and returns immediately. Callers
should retrive the transaction result using the Transaction Status API.public boolean isQueue()
isQueue
in interface ICoreRequest
public void setWaitForRemovedCard(boolean value)
value
- whether or not the request should block until all cards have been
removed from the card reader.public boolean isWaitForRemovedCard()
isWaitForRemovedCard
in interface ICoreRequest
public void setForce(boolean value)
value
- override any in-progress transactions.public boolean isForce()
isForce
in interface ICoreRequest
public void setOrderRef(String value)
value
- an identifier from an external point of sale system.public String getOrderRef()
getOrderRef
in interface ICoreRequest
public void setDestinationAccount(String value)
value
- the settlement account for merchants with split settlements.public String getDestinationAccount()
getDestinationAccount
in interface ICoreRequest
public void setToken(String value)
value
- the payment token to be used for this transaction. This should be used
for recurring transactions.public String getToken()
getToken
in interface IPaymentMethod
public void setTrack1(String value)
value
- track 1 magnetic stripe data.public String getTrack1()
getTrack1
in interface IPaymentMethod
public void setTrack2(String value)
value
- track 2 magnetic stripe data.public String getTrack2()
getTrack2
in interface IPaymentMethod
public void setPan(String value)
value
- the primary account number. We recommend using the terminal or
e-commerce tokenization libraries instead of passing account numbers in
directly, as this would put your application in PCI scope.public String getPan()
getPan
in interface IPaymentMethod
public void setRoutingNumber(String value)
value
- the ACH routing number for ACH transactions.public String getRoutingNumber()
getRoutingNumber
in interface IPaymentMethod
public void setCardholderName(String value)
value
- the cardholder name. Only required if the request includes a primary
account number or track data.public String getCardholderName()
getCardholderName
in interface IPaymentMethod
public void setExpMonth(String value)
value
- the card expiration month for use with PAN based transactions.public String getExpMonth()
getExpMonth
in interface IPaymentMethod
public void setExpYear(String value)
value
- the card expiration year for use with PAN based transactions.public String getExpYear()
getExpYear
in interface IPaymentMethod
public void setCvv(String value)
value
- the card CVV for use with PAN based transactions.public String getCvv()
getCvv
in interface IPaymentMethod
public void setAddress(String value)
value
- the cardholder address for use with address verification.public String getAddress()
getAddress
in interface IPaymentMethod
public void setPostalCode(String value)
value
- the cardholder postal code for use with address verification.public String getPostalCode()
getPostalCode
in interface IPaymentMethod
public void setManualEntry(boolean value)
value
- that the payment entry method is a manual keyed transaction. If this is
true, no other payment method will be accepted.public boolean isManualEntry()
isManualEntry
in interface IPaymentMethod
public void setKsn(String value)
value
- the key serial number used for DUKPT encryption.public String getKsn()
getKsn
in interface IPaymentMethod
public void setPinBlock(String value)
value
- the encrypted pin block.public String getPinBlock()
getPinBlock
in interface IPaymentMethod
public void setCardType(CardType value)
value
- designates categories of cards: credit, debit, EBT.public CardType getCardType()
getCardType
in interface IPaymentMethod
public void setPaymentType(String value)
value
- designates brands of payment methods: Visa, Discover, etc.public String getPaymentType()
getPaymentType
in interface IPaymentMethod
public void setTransactionId(String value)
value
- the ID of the previous transaction being referenced.public String getTransactionId()
getTransactionId
in interface IPreviousTransaction
public void setCurrencyCode(String value)
value
- the transaction currency code.public String getCurrencyCode()
getCurrencyCode
in interface IRequestAmount
public void setAmount(String value)
value
- the requested amount.public String getAmount()
getAmount
in interface IRequestAmount
public void setTaxExempt(boolean value)
value
- that the request is tax exempt. Only required for tax exempt level 2
processing.public boolean isTaxExempt()
isTaxExempt
in interface IRequestAmount
public void setSurcharge(boolean value)
value
- a flag to add a surcharge to the transaction to cover credit card fees,
if permitted.public boolean isSurcharge()
isSurcharge
in interface IRequestAmount
public void setCashDiscount(boolean value)
value
- a flag that applies a discount to negate the surcharge for debit
transactions or other surcharge ineligible payment methods.public boolean isCashDiscount()
isCashDiscount
in interface IRequestAmount
public void setSigFile(String value)
value
- a location on the filesystem which a customer signature should be
written to.public String getSigFile()
getSigFile
in interface ISignatureRequest
public void setSigFormat(SignatureFormat value)
value
- the image format to be used for returning signatures.public SignatureFormat getSigFormat()
getSigFormat
in interface ISignatureRequest
public void setSigWidth(int value)
value
- the width that the signature image should be scaled to, preserving the
aspect ratio. If not provided, the signature is returned in the terminal's max
resolution.public int getSigWidth()
getSigWidth
in interface ISignatureRequest
public void setDisableSignature(boolean value)
value
- whether or not signature prompt should be skipped on the terminal. The
terminal will indicate whether or not a signature is required by the card in the
receipt suggestions response.public boolean isDisableSignature()
isDisableSignature
in interface ISignatureRequest
public void setTipAmount(String value)
value
- the tip amount.public String getTipAmount()
getTipAmount
in interface ISubtotals
public void setTaxAmount(String value)
value
- the tax amount.public String getTaxAmount()
getTaxAmount
in interface ISubtotals
public void setTerminalName(String value)
value
- the name of the target payment terminal.public String getTerminalName()
getTerminalName
in interface ITerminalReference
public void setHealthcare(Healthcare value)
value
- details for HSA/FSA transactions.public Healthcare getHealthcare()
Copyright © 2022 BlockChyp, Inc.. All rights reserved.