PaymentRequest (com.blockchyp:blockchyp-java 1.0.0 API)

java.lang.Object
- com.blockchyp.client.dto.CoreRequest
- - com.blockchyp.client.dto.AmountRequest
  - - com.blockchyp.client.dto.PaymentRequest

All Implemented Interfaces:

ITerminalReference

Direct Known Subclasses:

AuthorizationRequest, RefundRequest
```
public class PaymentRequest
extends AmountRequest
implements ITerminalReference
```
Models requests that include payment method information. We recommend that you never use PAN and track data as this would put you in PCI scope.

Constructor Summary

Constructors
Constructor and Description

PaymentRequest()

Constructors
Constructor and Description
`PaymentRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getAddress()` Gets the address for use with address verification.
`String`	`getCardholderName()` Gets the cardholder name for use with PAN based transaction authorization.
`String`	`getCvv()` Gets the CVV for use with PAN based transaction authorization.
`String`	`getExpMonth()` Gets the card expiration month for use with PAN based transaction authorization.
`String`	`getExpYear()` Gets the card expiration year for use with PAN based transaction authorization.
`String`	`getPan()` Gets the primary account number (PAN).
`String`	`getPostalCode()` Gets the postal code for use with address verification.
`String`	`getRoutingNumber()` Sets the ACH routing number if this is an ACH transaction.
`String`	`getSigFile()` Sets the desired output location of a signature image file, if there is one.
`String`	`getSigFormat()` Gets the preferred output format for signature images.
`int`	`getSigWidth()` Gets the maximum width of the signature image in pixels.
`String`	`getTerminalName()` Sets the target terminal name to which the transaction will be routed.
`String`	`getToken()` Gets the payment token to be used with this transaction.
`String`	`getTrack1()` Gets track 1 data.
`String`	`getTrack2()` Gets track 2 data.
`boolean`	`isManualEntry()` Gets manual entry mode.
`void`	`setAddress(String address)` Sets the address for use with address verification.
`void`	`setCardholderName(String cardholderName)` Sets the cardholder name for use with PAN based transaction authorization.
`void`	`setCvv(String cvv)` Sets the CVV for use with PAN based transaction authorization.
`void`	`setExpMonth(String expMonth)` Sets the card expiration month for use with PAN based transaction authorization.
`void`	`setExpYear(String expYear)` Sets the card expiration year for use with PAN based transaction authorization.
`void`	`setManualEntry(boolean manualEntry)` Sets manual entry mode.
`void`	`setPan(String pan)` Sets the primary account number (PAN).
`void`	`setPostalCode(String postalCode)` Sets the postal code for use with address verification.
`void`	`setRoutingNumber(String routingNumber)` Sets the ACH routing number if this is an ACH transaction.
`void`	`setSigFile(String sigFile)` Sets the desired output location of a signature image file, if there is one.
`void`	`setSigFormat(String sigFormat)` Sets the preferred output format for signature images.
`void`	`setSigWidth(int sigWidth)` Sets the maximum width of the signature image in pixels.
`void`	`setTerminalName(String terminalName)` Sets the target terminal name to which the transaction will be routed.
`void`	`setToken(String token)` Sets the payment token to be used with this transaction.
`void`	`setTrack1(String track1)` Sets track 1 data.
`void`	`setTrack2(String track2)` Sets track 2 data.

Methods inherited from class com.blockchyp.client.dto.AmountRequest
getAmount, getCurrencyCode, getTaxAmount, getTipAmount, isTaxExempt, setAmount, setCurrencyCode, setTaxAmount, setTaxExempt, setTipAmount

Methods inherited from class com.blockchyp.client.dto.CoreRequest
getDestinationAccount, getTimeout, getTransactionRef, isTest, setDestinationAccount, setTest, setTimeout, setTransactionRef

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

- Constructor Detail
  - PaymentRequest
```
public PaymentRequest()
```
- Method Detail
  - getTerminalName
```
public String getTerminalName()
```
    Sets the target terminal name to which the transaction will be routed.
    
    Specified by:
    
    getTerminalName in interface ITerminalReference
    
    Returns:
    
    terminal name assigned to the terminal upon activation.
  - setTerminalName
```
public void setTerminalName(String terminalName)
```
    Sets the target terminal name to which the transaction will be routed.
    
    Parameters:
    
    terminalName - terminal name assigned to the terminal upon activation.
  - getToken
```
public String getToken()
```
    Gets the payment token to be used with this transaction.
    
    Returns:
    
    recurring payment token.
  - setToken
```
public void setToken(String token)
```
    Sets the payment token to be used with this transaction. Recommended for recurring payment transactions.
    
    Parameters:
    
    token - recurring payment token.
  - getTrack1
```
public String getTrack1()
```
    Gets track 1 data.
    
    Returns:
    
    the first track of a payment card's magnetic stripe.
  - setTrack1
```
public void setTrack1(String track1)
```
    Sets track 1 data. This is only provided as a fall back for developers who have to integrate legacy MSR support.
    
    Parameters:
    
    track1 - the first track of a payment card's magnetic stripe.
  - getTrack2
```
public String getTrack2()
```
    Gets track 2 data.
    
    Returns:
    
    the second track of a payment card's magnetic stripe.
  - setTrack2
```
public void setTrack2(String track2)
```
    Sets track 2 data. This is only provided as a fall back for developers who have to integrate legacy MSR support.
    
    Parameters:
    
    track2 - the second track of a payment card's magnetic stripe.
  - getPan
```
public String getPan()
```
    Gets the primary account number (PAN).
    
    Returns:
    
    Primary Account Number.
  - setPan
```
public void setPan(String pan)
```
    Sets the primary account number (PAN). We recommend using the terminal or e-commerce tokenization libraries instead of passing account numbers in directly as it will put your application in PCI scope.
    
    Parameters:
    
    pan - Primary Account Number.
  - getRoutingNumber
```
public String getRoutingNumber()
```
    Sets the ACH routing number if this is an ACH transaction.
    
    Returns:
    
    nine digit ACH routing number
  - setRoutingNumber
```
public void setRoutingNumber(String routingNumber)
```
    Sets the ACH routing number if this is an ACH transaction.
    
    Parameters:
    
    routingNumber - nine digit ACH routing number.
  - getCardholderName
```
public String getCardholderName()
```
    Gets the cardholder name for use with PAN based transaction authorization.
    
    Returns:
    
    cardholder's name.
  - setCardholderName
```
public void setCardholderName(String cardholderName)
```
    Sets the cardholder name for use with PAN based transaction authorization. Only needed if you're sending a PAN or track data, which you really shouldn't do because it will put you in PCI scope.
    
    Parameters:
    
    cardholderName - cardholder's name.
  - getExpMonth
```
public String getExpMonth()
```
    Gets the card expiration month for use with PAN based transaction authorization.
    
    Returns:
    
    card expiration month.
  - setExpMonth
```
public void setExpMonth(String expMonth)
```
    Sets the card expiration month for use with PAN based transaction authorization. Only needed if you're sending a PAN or track data, which you really shouldn't do because it will put you in PCI scope.
    
    Parameters:
    
    expMonth - card expiration month. Leading zeros preferred for january through september.
  - getExpYear
```
public String getExpYear()
```
    Gets the card expiration year for use with PAN based transaction authorization.
    
    Returns:
    
    card expiration year.
  - setExpYear
```
public void setExpYear(String expYear)
```
    Sets the card expiration year for use with PAN based transaction authorization. Only needed if you're sending a PAN or track data, which you really shouldn't do because it will put you in PCI scope.
    
    Parameters:
    
    expYear - card expiration year. 2 or 4 digit values accepted, but 4 is recommended.
  - getCvv
```
public String getCvv()
```
    Gets the CVV for use with PAN based transaction authorization.
    
    Returns:
    
    cardholder verification code.
  - setCvv
```
public void setCvv(String cvv)
```
    Sets the CVV for use with PAN based transaction authorization. Only needed if you're sending a PAN or track data, which you really shouldn't do because it will put you in PCI scope.
    
    Parameters:
    
    cvv - cardholder verification code.
  - getAddress
```
public String getAddress()
```
    Gets the address for use with address verification.
    
    Returns:
    
    cardholder's street address.
  - setAddress
```
public void setAddress(String address)
```
    Sets the address for use with address verification. Only needed if you're sending a PAN or track data, which you really shouldn't do because it will put you in PCI scope.
    
    Parameters:
    
    address - cardholder's street address.
  - getPostalCode
```
public String getPostalCode()
```
    Gets the postal code for use with address verification.
    
    Returns:
    
    cardholder's postal code.
  - setPostalCode
```
public void setPostalCode(String postalCode)
```
    Sets the postal code for use with address verification. Only needed if you're sending a PAN or track data, which you really shouldn't do because it will put you in PCI scope.
    
    Parameters:
    
    postalCode - cardholder's postal code.
  - isManualEntry
```
public boolean isManualEntry()
```
    Gets manual entry mode.
    
    Returns:
    
    true if manual entry mode is enabled.
  - setManualEntry
```
public void setManualEntry(boolean manualEntry)
```
    Sets manual entry mode. If true, the terminal will prompt for manual PAN entry instead of the standard present card flow.
    
    Parameters:
    
    manualEntry - boolean
  - getSigFormat
```
public String getSigFormat()
```
    Gets the preferred output format for signature images.
    
    Returns:
    
    signature file format (PNG, JPEG, etc)
  - setSigFormat
```
public void setSigFormat(String sigFormat)
```
    Sets the preferred output format for signature images. As of this writing, PNG and JPEG are supported. Case insensitive.
    
    Parameters:
    
    sigFormat - signature file format (PNG, JPEG, etc)
  - getSigWidth
```
public int getSigWidth()
```
    Gets the maximum width of the signature image in pixels.
    
    Returns:
    
    max width of the image in pixels.
  - setSigWidth
```
public void setSigWidth(int sigWidth)
```
    Sets the maximum width of the signature image in pixels. The aspect ratio of the original image will be preserved.
    
    Parameters:
    
    sigWidth - max width of the image in pixels.
  - getSigFile
```
public String getSigFile()
```
    Sets the desired output location of a signature image file, if there is one.
    
    Returns:
    
    local file path
  - setSigFile
```
public void setSigFile(String sigFile)
```
    Sets the desired output location of a signature image file, if there is one.
    
    Parameters:
    
    sigFile - local file path

Class PaymentRequest

Constructor Summary

Method Summary

Methods inherited from class com.blockchyp.client.dto.AmountRequest

Methods inherited from class com.blockchyp.client.dto.CoreRequest

Methods inherited from class java.lang.Object

Constructor Detail

PaymentRequest

Method Detail

getTerminalName

setTerminalName

getToken

setToken

getTrack1

setTrack1

getTrack2

setTrack2

getPan

setPan

getRoutingNumber

setRoutingNumber

getCardholderName

setCardholderName

getExpMonth

setExpMonth

getExpYear

setExpYear

getCvv

setCvv

getAddress

setAddress

getPostalCode

setPostalCode

isManualEntry

setManualEntry

getSigFormat

setSigFormat

getSigWidth

setSigWidth

getSigFile

setSigFile