PaymentLinkRequest (com.blockchyp:blockchyp-java 2.13.3 API)

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

All Implemented Interfaces:: ICoreRequest, IRequestAmount, ITerminalReference, ITimeoutRequest

public class PaymentLinkRequest
extends Object
implements ITimeoutRequest, ICoreRequest, IRequestAmount, ITerminalReference

Creates a payment link.

Constructor Summary

Constructors
Constructor and Description

PaymentLinkRequest()

Constructors
Constructor and Description
`PaymentLinkRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getAmount()` Gets the requested amount.
`String`	`getCallbackUrl()` Gets optional callback url to which transaction responses for this link will be posted.
`String`	`getCryptocurrency()` Gets that the transaction should be a cryptocurrency transaction.
`String`	`getCryptoNetwork()` Gets an optional parameter that can be used to force a crypto transaction onto a level one or level two network.
`String`	`getCryptoReceiveAddress()` Gets can be used to specify a specific receive address for a crypto transaction.
`String`	`getCurrencyCode()` Gets the transaction currency code.
`Customer`	`getCustomer()` Gets customer information.
`String`	`getDescription()` Gets description explaining the transaction for display to the user.
`String`	`getDestinationAccount()` Gets the settlement account for merchants with split settlements.
`String`	`getOrderRef()` Gets an identifier from an external point of sale system.
`String`	`getPaymentRequestLabel()` Gets can optionally add a label to the payment request if the target cryptocurrency supports labels.
`String`	`getPaymentRequestMessage()` Gets can optionally add a message to the payment request if the target cryptocurrency supports labels.
`String`	`getSubject()` Gets subject of the payment email.
`String`	`getTcAlias()` Gets an alias for a Terms and Conditions template configured in the BlockChyp dashboard.
`String`	`getTcContent()` Gets the content of the terms and conditions that will be presented to the user.
`String`	`getTcName()` Gets the name of the Terms and Conditions the user is accepting.
`String`	`getTerminalName()` Gets the name of the target payment terminal.
`int`	`getTimeout()` Gets the request timeout in seconds.
`TransactionDisplayTransaction`	`getTransaction()` Gets transaction details for display on the payment email.
`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`	`isAutoSend()` Gets automatically send the link via an email.
`boolean`	`isCashDiscount()` Gets a flag that applies a discount to negate the surcharge for debit transactions or other surcharge ineligible payment methods.
`boolean`	`isCashier()` Gets flags the payment link as cashier facing.
`boolean`	`isEnroll()` Gets that the payment method should be added to the token vault alongside the authorization.
`boolean`	`isEnrollOnly()` Gets that the link should be used to enroll a token only.
`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`	`setAutoSend(boolean value)` Sets automatically send the link via an email.
`void`	`setCallbackUrl(String value)` Sets optional callback url to which transaction responses for this link will be posted.
`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`	`setCashier(boolean value)` Sets flags the payment link as cashier facing.
`void`	`setCryptocurrency(String value)` Sets that the transaction should be a cryptocurrency transaction.
`void`	`setCryptoNetwork(String value)` Sets an optional parameter that can be used to force a crypto transaction onto a level one or level two network.
`void`	`setCryptoReceiveAddress(String value)` Sets can be used to specify a specific receive address for a crypto transaction.
`void`	`setCurrencyCode(String value)` Sets the transaction currency code.
`void`	`setCustomer(Customer value)` Sets customer information.
`void`	`setDescription(String value)` Sets description explaining the transaction for display to the user.
`void`	`setDestinationAccount(String value)` Sets the settlement account for merchants with split settlements.
`void`	`setEnroll(boolean value)` Sets that the payment method should be added to the token vault alongside the authorization.
`void`	`setEnrollOnly(boolean value)` Sets that the link should be used to enroll a token only.
`void`	`setForce(boolean value)` Sets override any in-progress transactions.
`void`	`setOrderRef(String value)` Sets an identifier from an external point of sale system.
`void`	`setPaymentRequestLabel(String value)` Sets can optionally add a label to the payment request if the target cryptocurrency supports labels.
`void`	`setPaymentRequestMessage(String value)` Sets can optionally add a message to the payment request if the target cryptocurrency supports labels.
`void`	`setQueue(boolean value)` Sets adds the transaction to the queue and returns immediately.
`void`	`setSubject(String value)` Sets subject of the payment email.
`void`	`setSurcharge(boolean value)` Sets a flag to add a surcharge to the transaction to cover credit card fees, if permitted.
`void`	`setTaxExempt(boolean value)` Sets that the request is tax exempt.
`void`	`setTcAlias(String value)` Sets an alias for a Terms and Conditions template configured in the BlockChyp dashboard.
`void`	`setTcContent(String value)` Sets the content of the terms and conditions that will be presented to the user.
`void`	`setTcName(String value)` Sets the name of the Terms and Conditions the user is accepting.
`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`	`setTransaction(TransactionDisplayTransaction value)` Sets transaction details for display on the payment email.
`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
  - PaymentLinkRequest
```
public PaymentLinkRequest()
```
- Method Detail
  - 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 ITimeoutRequest
    
    Returns:
    
    the request timeout in seconds.
  - 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 ITimeoutRequest
    
    Returns:
    
    whether or not to route transaction to the test gateway.
  - 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.
  - 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.
  - setTerminalName
```
public void setTerminalName(String value)
```
    Sets the name of the target payment terminal.
    
    Parameters:
    
    value - the name of the target payment terminal.
  - getTerminalName
```
public String getTerminalName()
```
    Gets the name of the target payment terminal.
    
    Specified by:
    
    getTerminalName in interface ITerminalReference
    
    Returns:
    
    the name of the target payment terminal.
  - setAutoSend
```
public void setAutoSend(boolean value)
```
    Sets automatically send the link via an email.
    
    Parameters:
    
    value - automatically send the link via an email.
  - isAutoSend
```
public boolean isAutoSend()
```
    Gets automatically send the link via an email.
    
    Returns:
    
    automatically send the link via an email.
  - setEnroll
```
public void setEnroll(boolean value)
```
    Sets that the payment method should be added to the token vault alongside the authorization.
    
    Parameters:
    
    value - that the payment method should be added to the token vault alongside the authorization.
  - isEnroll
```
public boolean isEnroll()
```
    Gets that the payment method should be added to the token vault alongside the authorization.
    
    Returns:
    
    that the payment method should be added to the token vault alongside the authorization.
  - setEnrollOnly
```
public void setEnrollOnly(boolean value)
```
    Sets that the link should be used to enroll a token only.
    
    Parameters:
    
    value - that the link should be used to enroll a token only. Can only be used in cashier mode.
  - isEnrollOnly
```
public boolean isEnrollOnly()
```
    Gets that the link should be used to enroll a token only.
    
    Returns:
    
    that the link should be used to enroll a token only. Can only be used in cashier mode.
  - setCashier
```
public void setCashier(boolean value)
```
    Sets flags the payment link as cashier facing.
    
    Parameters:
    
    value - flags the payment link as cashier facing.
  - isCashier
```
public boolean isCashier()
```
    Gets flags the payment link as cashier facing.
    
    Returns:
    
    flags the payment link as cashier facing.
  - setDescription
```
public void setDescription(String value)
```
    Sets description explaining the transaction for display to the user.
    
    Parameters:
    
    value - description explaining the transaction for display to the user.
  - getDescription
```
public String getDescription()
```
    Gets description explaining the transaction for display to the user.
    
    Returns:
    
    description explaining the transaction for display to the user.
  - setSubject
```
public void setSubject(String value)
```
    Sets subject of the payment email.
    
    Parameters:
    
    value - subject of the payment email.
  - getSubject
```
public String getSubject()
```
    Gets subject of the payment email.
    
    Returns:
    
    subject of the payment email.
  - setTransaction
```
public void setTransaction(TransactionDisplayTransaction value)
```
    Sets transaction details for display on the payment email.
    
    Parameters:
    
    value - transaction details for display on the payment email.
  - getTransaction
```
public TransactionDisplayTransaction getTransaction()
```
    Gets transaction details for display on the payment email.
    
    Returns:
    
    transaction details for display on the payment email.
  - setCustomer
```
public void setCustomer(Customer value)
```
    Sets customer information.
    
    Parameters:
    
    value - customer information.
  - getCustomer
```
public Customer getCustomer()
```
    Gets customer information.
    
    Returns:
    
    customer information.
  - setCallbackUrl
```
public void setCallbackUrl(String value)
```
    Sets optional callback url to which transaction responses for this link will be posted.
    
    Parameters:
    
    value - optional callback url to which transaction responses for this link will be posted.
  - getCallbackUrl
```
public String getCallbackUrl()
```
    Gets optional callback url to which transaction responses for this link will be posted.
    
    Returns:
    
    optional callback url to which transaction responses for this link will be posted.
  - setTcAlias
```
public void setTcAlias(String value)
```
    Sets an alias for a Terms and Conditions template configured in the BlockChyp dashboard.
    
    Parameters:
    
    value - an alias for a Terms and Conditions template configured in the BlockChyp dashboard.
  - getTcAlias
```
public String getTcAlias()
```
    Gets an alias for a Terms and Conditions template configured in the BlockChyp dashboard.
    
    Returns:
    
    an alias for a Terms and Conditions template configured in the BlockChyp dashboard.
  - setTcName
```
public void setTcName(String value)
```
    Sets the name of the Terms and Conditions the user is accepting.
    
    Parameters:
    
    value - the name of the Terms and Conditions the user is accepting.
  - getTcName
```
public String getTcName()
```
    Gets the name of the Terms and Conditions the user is accepting.
    
    Returns:
    
    the name of the Terms and Conditions the user is accepting.
  - setTcContent
```
public void setTcContent(String value)
```
    Sets the content of the terms and conditions that will be presented to the user.
    
    Parameters:
    
    value - the content of the terms and conditions that will be presented to the user.
  - getTcContent
```
public String getTcContent()
```
    Gets the content of the terms and conditions that will be presented to the user.
    
    Returns:
    
    the content of the terms and conditions that will be presented to the user.
  - setCryptocurrency
```
public void setCryptocurrency(String value)
```
    Sets that the transaction should be a cryptocurrency transaction.
    
    Parameters:
    
    value - that the transaction should be a cryptocurrency transaction. Value should be a crypto currency code (ETH, BTC) or ANY to prompt the user to choose from supported cryptocurrencies.
  - getCryptocurrency
```
public String getCryptocurrency()
```
    Gets that the transaction should be a cryptocurrency transaction.
    
    Returns:
    
    that the transaction should be a cryptocurrency transaction. Value should be a crypto currency code (ETH, BTC) or ANY to prompt the user to choose from supported cryptocurrencies.
  - setCryptoNetwork
```
public void setCryptoNetwork(String value)
```
    Sets an optional parameter that can be used to force a crypto transaction onto a level one or level two network.
    
    Parameters:
    
    value - an optional parameter that can be used to force a crypto transaction onto a level one or level two network. Valid values are L1 and L2. Defaults to L1.
  - getCryptoNetwork
```
public String getCryptoNetwork()
```
    Gets an optional parameter that can be used to force a crypto transaction onto a level one or level two network.
    
    Returns:
    
    an optional parameter that can be used to force a crypto transaction onto a level one or level two network. Valid values are L1 and L2. Defaults to L1.
  - setCryptoReceiveAddress
```
public void setCryptoReceiveAddress(String value)
```
    Sets can be used to specify a specific receive address for a crypto transaction.
    
    Parameters:
    
    value - can be used to specify a specific receive address for a crypto transaction. Disabled by default. This should only be used by sophisticated users with access to properly configured hot wallets.
  - getCryptoReceiveAddress
```
public String getCryptoReceiveAddress()
```
    Gets can be used to specify a specific receive address for a crypto transaction.
    
    Returns:
    
    can be used to specify a specific receive address for a crypto transaction. Disabled by default. This should only be used by sophisticated users with access to properly configured hot wallets.
  - setPaymentRequestLabel
```
public void setPaymentRequestLabel(String value)
```
    Sets can optionally add a label to the payment request if the target cryptocurrency supports labels.
    
    Parameters:
    
    value - can optionally add a label to the payment request if the target cryptocurrency supports labels. Defaults to the merchant's DBA Name.
  - getPaymentRequestLabel
```
public String getPaymentRequestLabel()
```
    Gets can optionally add a label to the payment request if the target cryptocurrency supports labels.
    
    Returns:
    
    can optionally add a label to the payment request if the target cryptocurrency supports labels. Defaults to the merchant's DBA Name.
  - setPaymentRequestMessage
```
public void setPaymentRequestMessage(String value)
```
    Sets can optionally add a message to the payment request if the target cryptocurrency supports labels.
    
    Parameters:
    
    value - can optionally add a message to the payment request if the target cryptocurrency supports labels. Defaults to empty.
  - getPaymentRequestMessage
```
public String getPaymentRequestMessage()
```
    Gets can optionally add a message to the payment request if the target cryptocurrency supports labels.
    
    Returns:
    
    can optionally add a message to the payment request if the target cryptocurrency supports labels. Defaults to empty.

Class PaymentLinkRequest

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PaymentLinkRequest

Method Detail

setTimeout

getTimeout

setTest

isTest

setTransactionRef

getTransactionRef

setAsync

isAsync

setQueue

isQueue

setWaitForRemovedCard

isWaitForRemovedCard

setForce

isForce

setOrderRef

getOrderRef

setDestinationAccount

getDestinationAccount

setCurrencyCode

getCurrencyCode

setAmount

getAmount

setTaxExempt

isTaxExempt

setSurcharge

isSurcharge

setCashDiscount

isCashDiscount

setTerminalName

getTerminalName

setAutoSend

isAutoSend

setEnroll

isEnroll

setEnrollOnly

isEnrollOnly

setCashier

isCashier

setDescription

getDescription

setSubject

getSubject

setTransaction

getTransaction

setCustomer

getCustomer

setCallbackUrl

getCallbackUrl

setTcAlias

getTcAlias

setTcName

getTcName

setTcContent

getTcContent

setCryptocurrency

getCryptocurrency

setCryptoNetwork

getCryptoNetwork

setCryptoReceiveAddress

getCryptoReceiveAddress

setPaymentRequestLabel

getPaymentRequestLabel

setPaymentRequestMessage

getPaymentRequestMessage