CaptureRequest (com.blockchyp:blockchyp-java 2.9.2 API)

java.lang.Object
- com.blockchyp.client.dto.CaptureRequest

All Implemented Interfaces:

ICoreRequest, IPreviousTransaction, IRequestAmount, ISubtotals
```
public class CaptureRequest
extends Object
implements ICoreRequest, IPreviousTransaction, IRequestAmount, ISubtotals
```
The information needed to capture a preauth.

Constructor Summary

Constructors
Constructor and Description

CaptureRequest()

Constructors
Constructor and Description
`CaptureRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getAmount()` Gets the requested amount.
`String`	`getCurrencyCode()` Gets the transaction currency code.
`String`	`getDestinationAccount()` Gets the settlement account for merchants with split settlements.
`String`	`getEbtEligibleAmount()` Gets the amount of the transaction that should be charged to an EBT card.
`String`	`getFsaEligibleAmount()` Gets the amount of the transaction that should be charged to an FSA card.
`String`	`getHsaEligibleAmount()` Gets the amount of the transaction that should be charged to an HSA card.
`String`	`getOrderRef()` Gets an identifier from an external point of sale system.
`String`	`getTaxAmount()` Gets the tax amount.
`int`	`getTimeout()` Gets the request timeout in seconds.
`String`	`getTipAmount()` Gets the tip amount.
`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`	`isForce()` Gets override any in-progress transactions.
`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`	`setAmount(String value)` Sets the requested amount.
`void`	`setAsync(boolean value)` Sets defers the response to the transaction and returns immediately.
`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`	`setDestinationAccount(String value)` Sets the settlement account for merchants with split settlements.
`void`	`setEbtEligibleAmount(String value)` Sets the amount of the transaction that should be charged to an EBT card.
`void`	`setForce(boolean value)` Sets override any in-progress transactions.
`void`	`setFsaEligibleAmount(String value)` Sets the amount of the transaction that should be charged to an FSA card.
`void`	`setHsaEligibleAmount(String value)` Sets the amount of the transaction that should be charged to an HSA card.
`void`	`setOrderRef(String value)` Sets an identifier from an external point of sale system.
`void`	`setQueue(boolean value)` Sets adds the transaction to the queue and returns immediately.
`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`	`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`	`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.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CaptureRequest
```
public CaptureRequest()
```
- Method Detail
  - setTransactionRef
```
public void setTransactionRef(String value)
```
    Sets a user-assigned reference that can be used to recall or reverse transactions.
    
    Parameters:
    
    value - a user-assigned reference that can be used to recall or reverse transactions.
  - getTransactionRef
```
public String getTransactionRef()
```
    Gets a user-assigned reference that can be used to recall or reverse transactions.
    
    Specified by:
    
    getTransactionRef in interface ICoreRequest
    
    Returns:
    
    a user-assigned reference that can be used to recall or reverse transactions.
  - setAsync
```
public void setAsync(boolean value)
```
    Sets defers the response to the transaction and returns immediately.
    
    Parameters:
    
    value - defers the response to the transaction and returns immediately. Callers should retrive the transaction result using the Transaction Status API.
  - isAsync
```
public boolean isAsync()
```
    Gets defers the response to the transaction and returns immediately.
    
    Specified by:
    
    isAsync in interface ICoreRequest
    
    Returns:
    
    defers the response to the transaction and returns immediately. Callers should retrive the transaction result using the Transaction Status API.
  - setQueue
```
public void setQueue(boolean value)
```
    Sets adds the transaction to the queue and returns immediately.
    
    Parameters:
    
    value - adds the transaction to the queue and returns immediately. Callers should retrive the transaction result using the Transaction Status API.
  - isQueue
```
public boolean isQueue()
```
    Gets adds the transaction to the queue and returns immediately.
    
    Specified by:
    
    isQueue in interface ICoreRequest
    
    Returns:
    
    adds the transaction to the queue and returns immediately. Callers should retrive the transaction result using the Transaction Status API.
  - setWaitForRemovedCard
```
public void setWaitForRemovedCard(boolean value)
```
    Sets whether or not the request should block until all cards have been removed from the card reader.
    
    Parameters:
    
    value - whether or not the request should block until all cards have been removed from the card reader.
  - isWaitForRemovedCard
```
public boolean isWaitForRemovedCard()
```
    Gets whether or not the request should block until all cards have been removed from the card reader.
    
    Specified by:
    
    isWaitForRemovedCard in interface ICoreRequest
    
    Returns:
    
    whether or not the request should block until all cards have been removed from the card reader.
  - setForce
```
public void setForce(boolean value)
```
    Sets override any in-progress transactions.
    
    Parameters:
    
    value - override any in-progress transactions.
  - isForce
```
public boolean isForce()
```
    Gets override any in-progress transactions.
    
    Specified by:
    
    isForce in interface ICoreRequest
    
    Returns:
    
    override any in-progress transactions.
  - setOrderRef
```
public void setOrderRef(String value)
```
    Sets an identifier from an external point of sale system.
    
    Parameters:
    
    value - an identifier from an external point of sale system.
  - getOrderRef
```
public String getOrderRef()
```
    Gets an identifier from an external point of sale system.
    
    Specified by:
    
    getOrderRef in interface ICoreRequest
    
    Returns:
    
    an identifier from an external point of sale system.
  - setDestinationAccount
```
public void setDestinationAccount(String value)
```
    Sets the settlement account for merchants with split settlements.
    
    Parameters:
    
    value - the settlement account for merchants with split settlements.
  - getDestinationAccount
```
public String getDestinationAccount()
```
    Gets the settlement account for merchants with split settlements.
    
    Specified by:
    
    getDestinationAccount in interface ICoreRequest
    
    Returns:
    
    the settlement account for merchants with split settlements.
  - setTest
```
public void setTest(boolean value)
```
    Sets whether or not to route transaction to the test gateway.
    
    Parameters:
    
    value - whether or not to route transaction to the test gateway.
  - isTest
```
public boolean isTest()
```
    Gets whether or not to route transaction to the test gateway.
    
    Specified by:
    
    isTest in interface ICoreRequest
    
    Returns:
    
    whether or not to route transaction to the test gateway.
  - setTimeout
```
public void setTimeout(int value)
```
    Sets the request timeout in seconds.
    
    Parameters:
    
    value - the request timeout in seconds.
  - getTimeout
```
public int getTimeout()
```
    Gets the request timeout in seconds.
    
    Specified by:
    
    getTimeout in interface ICoreRequest
    
    Returns:
    
    the request timeout in seconds.
  - setTransactionId
```
public void setTransactionId(String value)
```
    Sets the ID of the previous transaction being referenced.
    
    Parameters:
    
    value - the ID of the previous transaction being referenced.
  - getTransactionId
```
public String getTransactionId()
```
    Gets the ID of the previous transaction being referenced.
    
    Specified by:
    
    getTransactionId in interface IPreviousTransaction
    
    Returns:
    
    the ID of the previous transaction being referenced.
  - setCurrencyCode
```
public void setCurrencyCode(String value)
```
    Sets the transaction currency code.
    
    Parameters:
    
    value - the transaction currency code.
  - getCurrencyCode
```
public String getCurrencyCode()
```
    Gets the transaction currency code.
    
    Specified by:
    
    getCurrencyCode in interface IRequestAmount
    
    Returns:
    
    the transaction currency code.
  - setAmount
```
public void setAmount(String value)
```
    Sets the requested amount.
    
    Parameters:
    
    value - the requested amount.
  - getAmount
```
public String getAmount()
```
    Gets the requested amount.
    
    Specified by:
    
    getAmount in interface IRequestAmount
    
    Returns:
    
    the requested amount.
  - setTaxExempt
```
public void setTaxExempt(boolean value)
```
    Sets that the request is tax exempt.
    
    Parameters:
    
    value - that the request is tax exempt. Only required for tax exempt level 2 processing.
  - isTaxExempt
```
public boolean isTaxExempt()
```
    Gets that the request is tax exempt.
    
    Specified by:
    
    isTaxExempt in interface IRequestAmount
    
    Returns:
    
    that the request is tax exempt. Only required for tax exempt level 2 processing.
  - setSurcharge
```
public void setSurcharge(boolean value)
```
    Sets a flag to add a surcharge to the transaction to cover credit card fees, if permitted.
    
    Parameters:
    
    value - a flag to add a surcharge to the transaction to cover credit card fees, if permitted.
  - isSurcharge
```
public boolean isSurcharge()
```
    Gets a flag to add a surcharge to the transaction to cover credit card fees, if permitted.
    
    Specified by:
    
    isSurcharge in interface IRequestAmount
    
    Returns:
    
    a flag to add a surcharge to the transaction to cover credit card fees, if permitted.
  - setCashDiscount
```
public void setCashDiscount(boolean value)
```
    Sets a flag that applies a discount to negate the surcharge for debit transactions or other surcharge ineligible payment methods.
    
    Parameters:
    
    value - a flag that applies a discount to negate the surcharge for debit transactions or other surcharge ineligible payment methods.
  - isCashDiscount
```
public boolean isCashDiscount()
```
    Gets a flag that applies a discount to negate the surcharge for debit transactions or other surcharge ineligible payment methods.
    
    Specified by:
    
    isCashDiscount in interface IRequestAmount
    
    Returns:
    
    a flag that applies a discount to negate the surcharge for debit transactions or other surcharge ineligible payment methods.
  - setTipAmount
```
public void setTipAmount(String value)
```
    Sets the tip amount.
    
    Parameters:
    
    value - the tip amount.
  - getTipAmount
```
public String getTipAmount()
```
    Gets the tip amount.
    
    Specified by:
    
    getTipAmount in interface ISubtotals
    
    Returns:
    
    the tip amount.
  - setTaxAmount
```
public void setTaxAmount(String value)
```
    Sets the tax amount.
    
    Parameters:
    
    value - the tax amount.
  - getTaxAmount
```
public String getTaxAmount()
```
    Gets the tax amount.
    
    Specified by:
    
    getTaxAmount in interface ISubtotals
    
    Returns:
    
    the tax amount.
  - setFsaEligibleAmount
```
public void setFsaEligibleAmount(String value)
```
    Sets the amount of the transaction that should be charged to an FSA card.
    
    Parameters:
    
    value - the amount of the transaction that should be charged to an FSA card. This amount may be less than the transaction total, in which case only this amount will be charged if an FSA card is presented. If the FSA amount is paid on an FSA card, then the FSA amount authorized will be indicated on the response.
  - getFsaEligibleAmount
```
public String getFsaEligibleAmount()
```
    Gets the amount of the transaction that should be charged to an FSA card.
    
    Specified by:
    
    getFsaEligibleAmount in interface ISubtotals
    
    Returns:
    
    the amount of the transaction that should be charged to an FSA card. This amount may be less than the transaction total, in which case only this amount will be charged if an FSA card is presented. If the FSA amount is paid on an FSA card, then the FSA amount authorized will be indicated on the response.
  - setHsaEligibleAmount
```
public void setHsaEligibleAmount(String value)
```
    Sets the amount of the transaction that should be charged to an HSA card.
    
    Parameters:
    
    value - the amount of the transaction that should be charged to an HSA card.
  - getHsaEligibleAmount
```
public String getHsaEligibleAmount()
```
    Gets the amount of the transaction that should be charged to an HSA card.
    
    Specified by:
    
    getHsaEligibleAmount in interface ISubtotals
    
    Returns:
    
    the amount of the transaction that should be charged to an HSA card.
  - setEbtEligibleAmount
```
public void setEbtEligibleAmount(String value)
```
    Sets the amount of the transaction that should be charged to an EBT card.
    
    Parameters:
    
    value - the amount of the transaction that should be charged to an EBT card.
  - getEbtEligibleAmount
```
public String getEbtEligibleAmount()
```
    Gets the amount of the transaction that should be charged to an EBT card.
    
    Specified by:
    
    getEbtEligibleAmount in interface ISubtotals
    
    Returns:
    
    the amount of the transaction that should be charged to an EBT card.

Class CaptureRequest

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CaptureRequest

Method Detail

setTransactionRef

getTransactionRef

setAsync

isAsync

setQueue

isQueue

setWaitForRemovedCard

isWaitForRemovedCard

setForce

isForce

setOrderRef

getOrderRef

setDestinationAccount

getDestinationAccount

setTest

isTest

setTimeout

getTimeout

setTransactionId

getTransactionId

setCurrencyCode

getCurrencyCode

setAmount

getAmount

setTaxExempt

isTaxExempt

setSurcharge

isSurcharge

setCashDiscount

isCashDiscount

setTipAmount

getTipAmount

setTaxAmount

getTaxAmount

setFsaEligibleAmount

getFsaEligibleAmount

setHsaEligibleAmount

getHsaEligibleAmount

setEbtEligibleAmount

getEbtEligibleAmount