Class ReceiptOptions


  • public class ReceiptOptions
    extends Object
    ReceiptOptions
    • Constructor Detail

      • ReceiptOptions

        public ReceiptOptions()
    • Method Detail

      • 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
      • 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 -
      • getPromptBeforePrinting

        public Boolean getPromptBeforePrinting()
        Indicates whether a screen appears asking if you want to print the shopper receipt.
        Returns:
        promptBeforePrinting
      • setPromptBeforePrinting

        public void setPromptBeforePrinting​(Boolean promptBeforePrinting)
        Indicates whether a screen appears asking if you want to print the shopper receipt.
        Parameters:
        promptBeforePrinting -
      • 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
      • 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 -
      • 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
      • 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