java.lang.Object
- com.adyen.model.management.ReceiptOptions

public class ReceiptOptions
extends Object

ReceiptOptions

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`JSON_PROPERTY_HEADER_LINE1`
`static String`	`JSON_PROPERTY_HEADER_LINE2`
`static String`	`JSON_PROPERTY_LOGO`
`static String`	`JSON_PROPERTY_PROMPT_BEFORE_PRINTING`
`static String`	`JSON_PROPERTY_QR_CODE_DATA`

Constructor Summary

Constructors
Constructor Description

ReceiptOptions()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object o)`	Return true if this ReceiptOptions object is equal to o.
`static ReceiptOptions`	`fromJson(String jsonString)`	Create an instance of ReceiptOptions given an JSON string
`Map<String,Object>`	`getExplicitNulls()`	Returns a map of properties to be merged into the JSON payload as explicit null values.
`String`	`getHeaderLine1()`	The text of the first header line to be shown on the receipt.
`String`	`getHeaderLine2()`	The text of the second header line to be shown on the receipt.
`String`	`getLogo()`	The receipt logo converted to a Base64-encoded string.
`Boolean`	`getPromptBeforePrinting()`	Indicates whether a screen appears asking if you want to print the shopper receipt.
`String`	`getQrCodeData()`	Data to print on the receipt as a QR code.
`int`	`hashCode()`
`ReceiptOptions`	`headerLine1(String headerLine1)`	The text of the first header line to be shown on the receipt.
`ReceiptOptions`	`headerLine2(String headerLine2)`	The text of the second header line to be shown on the receipt.
`ReceiptOptions`	`includeNullValues(boolean includeNullValues)`	Configures whether null values are explicitly serialized in the JSON payload.
`boolean`	`isIncludeNullValues()`	Returns whether null values are explicitly serialized in the JSON payload.
`ReceiptOptions`	`logo(String logo)`	The receipt logo converted to a Base64-encoded string.
`ReceiptOptions`	`promptBeforePrinting(Boolean promptBeforePrinting)`	Indicates whether a screen appears asking if you want to print the shopper receipt.
`ReceiptOptions`	`qrCodeData(String qrCodeData)`	Data to print on the receipt as a QR code.
`void`	`setHeaderLine1(String headerLine1)`	The text of the first header line to be shown on the receipt.
`void`	`setHeaderLine2(String headerLine2)`	The text of the second header line to be shown on the receipt.
`void`	`setIncludeNullValues(boolean includeNullValues)`	Sets whether null values should be explicitly serialized in the JSON payload.
`void`	`setLogo(String logo)`	The receipt logo converted to a Base64-encoded string.
`void`	`setPromptBeforePrinting(Boolean promptBeforePrinting)`	Indicates whether a screen appears asking if you want to print the shopper receipt.
`void`	`setQrCodeData(String qrCodeData)`	Data to print on the receipt as a QR code.
`String`	`toJson()`	Convert an instance of ReceiptOptions to an JSON string
`String`	`toString()`

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

- Field Detail
  - JSON_PROPERTY_HEADER_LINE1
```
public static final String JSON_PROPERTY_HEADER_LINE1
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_HEADER_LINE2
```
public static final String JSON_PROPERTY_HEADER_LINE2
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_LOGO
```
public static final String JSON_PROPERTY_LOGO
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_PROMPT_BEFORE_PRINTING
```
public static final String JSON_PROPERTY_PROMPT_BEFORE_PRINTING
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_QR_CODE_DATA
```
public static final String JSON_PROPERTY_QR_CODE_DATA
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ReceiptOptions
```
public ReceiptOptions()
```
- Method Detail
  - headerLine1
```
public ReceiptOptions headerLine1(String headerLine1)
```
    The text of the first header line to be shown on the receipt.
    
    Parameters:
    
    headerLine1 - The text of the first header line to be shown on the receipt.
    
    Returns:
    
    the current ReceiptOptions instance, allowing for method chaining
  - getHeaderLine1
```
public String getHeaderLine1()
```
    The text of the first header line to be shown on the receipt.
    
    Returns:
    
    headerLine1 The text of the first header line to be shown on the receipt.
  - setHeaderLine1
```
public void setHeaderLine1(String headerLine1)
```
    The text of the first header line to be shown on the receipt.
    
    Parameters:
    
    headerLine1 - The text of the first header line to be shown on the receipt.
  - headerLine2
```
public ReceiptOptions headerLine2(String headerLine2)
```
    The text of the second header line to be shown on the receipt.
    
    Parameters:
    
    headerLine2 - The text of the second header line to be shown on the receipt.
    
    Returns:
    
    the current ReceiptOptions instance, allowing for method chaining
  - getHeaderLine2
```
public String getHeaderLine2()
```
    The text of the second header line to be shown on the receipt.
    
    Returns:
    
    headerLine2 The text of the second header line to be shown on the receipt.
  - setHeaderLine2
```
public void setHeaderLine2(String headerLine2)
```
    The text of the second header line to be shown on the receipt.
    
    Parameters:
    
    headerLine2 - The text of the second header line to be shown on the receipt.
  - logo
```
public ReceiptOptions logo(String logo)
```
    The receipt logo converted to a Base64-encoded string. The image must be a .bmp file of < 256 KB, dimensions 240 (H) x 384 (W) px.
    
    Parameters:
    
    logo - The receipt logo converted to a Base64-encoded string. The image must be a .bmp file of < 256 KB, dimensions 240 (H) x 384 (W) px.
    
    Returns:
    
    the current ReceiptOptions instance, allowing for method chaining
  - getLogo
```
public String getLogo()
```
    The receipt logo converted to a Base64-encoded string. The image must be a .bmp file of < 256 KB, dimensions 240 (H) x 384 (W) px.
    
    Returns:
    
    logo The receipt logo converted to a Base64-encoded string. The image must be a .bmp file of < 256 KB, dimensions 240 (H) x 384 (W) px.
  - setLogo
```
public void setLogo(String logo)
```
    The receipt logo converted to a Base64-encoded string. The image must be a .bmp file of < 256 KB, dimensions 240 (H) x 384 (W) px.
    
    Parameters:
    
    logo - The receipt logo converted to a Base64-encoded string. The image must be a .bmp file of < 256 KB, dimensions 240 (H) x 384 (W) px.
  - promptBeforePrinting
```
public ReceiptOptions promptBeforePrinting(Boolean promptBeforePrinting)
```
    Indicates whether a screen appears asking if you want to print the shopper receipt.
    
    Parameters:
    
    promptBeforePrinting - Indicates whether a screen appears asking if you want to print the shopper receipt.
    
    Returns:
    
    the current ReceiptOptions instance, allowing for method chaining
  - getPromptBeforePrinting
```
public Boolean getPromptBeforePrinting()
```
    Indicates whether a screen appears asking if you want to print the shopper receipt.
    
    Returns:
    
    promptBeforePrinting Indicates whether a screen appears asking if you want to print the shopper receipt.
  - setPromptBeforePrinting
```
public void setPromptBeforePrinting(Boolean promptBeforePrinting)
```
    Indicates whether a screen appears asking if you want to print the shopper receipt.
    
    Parameters:
    
    promptBeforePrinting - Indicates whether a screen appears asking if you want to print the shopper receipt.
  - qrCodeData
```
public ReceiptOptions qrCodeData(String qrCodeData)
```
    Data to print on the receipt as a QR code. This can include static text and the following variables: - `${merchantreference}`: the merchant reference of the transaction. - `${pspreference}`: the PSP reference of the transaction. For example, **http://www.example.com/order/${pspreference}/${merchantreference}**.
    
    Parameters:
    
    qrCodeData - Data to print on the receipt as a QR code. This can include static text and the following variables: - `${merchantreference}`: the merchant reference of the transaction. - `${pspreference}`: the PSP reference of the transaction. For example, **http://www.example.com/order/${pspreference}/${merchantreference}**.
    
    Returns:
    
    the current ReceiptOptions instance, allowing for method chaining
  - getQrCodeData
```
public String getQrCodeData()
```
    Data to print on the receipt as a QR code. This can include static text and the following variables: - `${merchantreference}`: the merchant reference of the transaction. - `${pspreference}`: the PSP reference of the transaction. For example, **http://www.example.com/order/${pspreference}/${merchantreference}**.
    
    Returns:
    
    qrCodeData Data to print on the receipt as a QR code. This can include static text and the following variables: - `${merchantreference}`: the merchant reference of the transaction. - `${pspreference}`: the PSP reference of the transaction. For example, **http://www.example.com/order/${pspreference}/${merchantreference}**.
  - setQrCodeData
```
public void setQrCodeData(String qrCodeData)
```
    Data to print on the receipt as a QR code. This can include static text and the following variables: - `${merchantreference}`: the merchant reference of the transaction. - `${pspreference}`: the PSP reference of the transaction. For example, **http://www.example.com/order/${pspreference}/${merchantreference}**.
    
    Parameters:
    
    qrCodeData - Data to print on the receipt as a QR code. This can include static text and the following variables: - `${merchantreference}`: the merchant reference of the transaction. - `${pspreference}`: the PSP reference of the transaction. For example, **http://www.example.com/order/${pspreference}/${merchantreference}**.
  - includeNullValues
```
public ReceiptOptions includeNullValues(boolean includeNullValues)
```
    Configures whether null values are explicitly serialized in the JSON payload. Default is false.
  - isIncludeNullValues
```
public boolean isIncludeNullValues()
```
    Returns whether null values are explicitly serialized in the JSON payload.
  - setIncludeNullValues
```
public void setIncludeNullValues(boolean includeNullValues)
```
    Sets whether null values should be explicitly serialized in the JSON payload. Default is false.
  - equals
```
public boolean equals(Object o)
```
    Return true if this ReceiptOptions object is equal to o.
    
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getExplicitNulls
```
public Map<String,Object> getExplicitNulls()
```
    Returns a map of properties to be merged into the JSON payload as explicit null values.
  - fromJson
```
public static ReceiptOptions fromJson(String jsonString)
                               throws com.fasterxml.jackson.core.JsonProcessingException
```
    Create an instance of ReceiptOptions given an JSON string
    
    Parameters:
    
    jsonString - JSON string
    
    Returns:
    
    An instance of ReceiptOptions
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to ReceiptOptions
  - toJson
```
public String toJson()
              throws com.fasterxml.jackson.core.JsonProcessingException
```
    Convert an instance of ReceiptOptions to an JSON string
    
    Returns:
    
    JSON string
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException

Class ReceiptOptions

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JSON_PROPERTY_HEADER_LINE1

JSON_PROPERTY_HEADER_LINE2

JSON_PROPERTY_LOGO

JSON_PROPERTY_PROMPT_BEFORE_PRINTING

JSON_PROPERTY_QR_CODE_DATA

Constructor Detail

ReceiptOptions

Method Detail

headerLine1

getHeaderLine1

setHeaderLine1

headerLine2

getHeaderLine2

setHeaderLine2

logo

getLogo

setLogo

promptBeforePrinting

getPromptBeforePrinting

setPromptBeforePrinting

qrCodeData

getQrCodeData

setQrCodeData

includeNullValues

isIncludeNullValues

setIncludeNullValues

equals

hashCode

toString

getExplicitNulls

fromJson

toJson