Class PaymentAttributes


  • public class PaymentAttributes
    extends java.lang.Object
    This class holds any additional attributes that can be applied while creating PaymentRequest.

    Attributes include:

    • themeId: A string representing the theme ID to be applied.
    • transactionType: The type of transaction. Accepted values are:
      • "OTP_ONLY" - Allow One Time Payment Only (DEFAULT)
      • "OTP_TAB" - Accept OTP and TAB payment
    • manualEntryScreenTimeout: Timeout for screen inactive threshold timeout. If there is no user activity for a configurable time, the passenger will be prompted to re-enter the data. Applies to CC# Manual entry screen only. Default is 60s.
    • cvvRequired: A boolean flag to indicate whether to show or hide CVV in Manual Entry screen. Default is false.
    • fulfillmentType: A string specifying what type of fulfillment will apply for the goods or services being paid for. Accepted values are:
      • "onboard" - Goods or services being paid for will be fulfilled on-board (DEFAULT)
      • "offboard" - Goods or services being paid for will be fulfilled off-board
    • fulfillmentDelay: A string specifying the initial fulfillment state for the transaction. Accepted values are:
      • "immediate" - The goods or services being paid for will be immediately fulfilled (DEFAULT)
      • "pending" - The goods or services being paid for will be fulfilled at a later time explicitly
    • cardholderEmail: The email address of the cardholder.
    • appId: The application ID. Possible values are:
      • "SHOP"
      • "HOSP"
      • "PPV"
    • fontPath: Specifies the path and name of the font file for the language displaying on the manual entry payment screens. If not specified, the default Android font is used. Example: fontPath: "/tmp/pluginshare/Altis_Book.otf";
    • cardTypesImagePath: Specifies the path and name of the card types image to be loaded on the manual entry payment screens. If not specified, the manual entry payment screens will be displayed without the credit card icons. Example: cardTypesImagePath: "/tmp/pluginshare/cc_type.png";
    • extraData: A JSON format string which contains other custom fields. This attribute is optional. Supported key:
      • "boardingPassSeatNum" - Capture the boarding pass seat number in the payment transactions
      Example: extraData: "{\"boardingPassSeatNum\":\"12A\"}";
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getApplicationId()
      This method returns the application ID.
      java.lang.String getCardholderEmail()
      This method returns the cardholder email.
      java.lang.String getCardTypesImagePath()
      This method returns the card types image path for the payment screen.
      java.lang.String getExtraData()
      This method returns the extra data that can be used during the payment process.
      java.lang.String getFontPath()
      This method returns the font path for the payment screen.
      FulfillmentDelay getFulfillmentDelay()
      This method returns the fulfillment delay for the payment.
      FulfillmentType getFulfillmentType()
      This method returns the fulfillment type for the payment.
      int getManualEntryScreenTimeout()
      This method returns the Manual Entry screen timeout.
      java.lang.String getThemeId()
      This method returns the themeId.
      TransactionType getTransactionType()
      This method returns the transaction type for the payment.
      boolean isCvvRequired()
      This method returns whether CVV is required.
      void setApplicationId​(java.lang.String applicationId)
      This method sets the application ID.
      void setCardholderEmail​(java.lang.String cardholderEmail)
      This method sets the cardholder email.
      void setCardTypesImagePath​(java.lang.String cardTypesImagePath)
      This method sets the card types image path for the payment screen.
      void setCvvRequired​(boolean cvvRequired)
      This method sets the CVV required flag of the PaymentRequest.
      void setExtraData​(java.lang.String extraData)
      This method sets the extra data that can be used during the payment process.
      void setFontPath​(java.lang.String fontPath)
      This method sets the font path for the payment screen.
      void setFulfillmentDelay​(FulfillmentDelay fulfillmentDelay)
      This method sets the fulfillment delay for the payment.
      void setFulfillmentType​(FulfillmentType fulfillmentType)
      This method sets the fulfillment type for the payment.
      void setManualEntryScreenTimeout​(int manualEntryScreenTimeout)
      This method sets the screen inactive threshold timeout.
      void setThemeId​(java.lang.String themeId)
      This method sets the themeId.
      void setTransactionType​(TransactionType transactionType)
      This method sets the transaction type for the payment.
      java.lang.String toString()  
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • PaymentAttributes

        public PaymentAttributes()
    • Method Detail

      • getTransactionType

        public TransactionType getTransactionType()
        This method returns the transaction type for the payment.
        Returns:
        TransactionType
      • setTransactionType

        public void setTransactionType​(TransactionType transactionType)
        This method sets the transaction type for the payment.
        Parameters:
        transactionType - TransactionType
      • getFulfillmentType

        public FulfillmentType getFulfillmentType()
        This method returns the fulfillment type for the payment.
        Returns:
        FulfillmentType
      • setFulfillmentType

        public void setFulfillmentType​(FulfillmentType fulfillmentType)
        This method sets the fulfillment type for the payment.
        Parameters:
        fulfillmentType - FulfillmentType
      • getFulfillmentDelay

        public FulfillmentDelay getFulfillmentDelay()
        This method returns the fulfillment delay for the payment.
        Returns:
        FulfillmentDelay
      • setFulfillmentDelay

        public void setFulfillmentDelay​(FulfillmentDelay fulfillmentDelay)
        This method sets the fulfillment delay for the payment.
        Parameters:
        fulfillmentDelay - FulfillmentDelay
      • getFontPath

        public java.lang.String getFontPath()
        This method returns the font path for the payment screen.
        Returns:
        String
      • setFontPath

        public void setFontPath​(java.lang.String fontPath)
        This method sets the font path for the payment screen.
        Parameters:
        fontPath - String
      • getCardTypesImagePath

        public java.lang.String getCardTypesImagePath()
        This method returns the card types image path for the payment screen.
        Returns:
        String
      • setCardTypesImagePath

        public void setCardTypesImagePath​(java.lang.String cardTypesImagePath)
        This method sets the card types image path for the payment screen.
        Parameters:
        cardTypesImagePath - String
      • getExtraData

        public java.lang.String getExtraData()
        This method returns the extra data that can be used during the payment process.
        Returns:
        String
      • setExtraData

        public void setExtraData​(java.lang.String extraData)
        This method sets the extra data that can be used during the payment process.
        Parameters:
        extraData - String
      • getThemeId

        public java.lang.String getThemeId()
        This method returns the themeId.
        Returns:
        String
      • setThemeId

        public void setThemeId​(java.lang.String themeId)
        This method sets the themeId.
        Parameters:
        themeId - String
      • getManualEntryScreenTimeout

        public int getManualEntryScreenTimeout()
        This method returns the Manual Entry screen timeout.
        Returns:
        Integer
      • setManualEntryScreenTimeout

        public void setManualEntryScreenTimeout​(int manualEntryScreenTimeout)
        This method sets the screen inactive threshold timeout. If there is no user activity for a configurable time, the passenger will be prompted to re-enter the data. Default is 60s.
        Parameters:
        manualEntryScreenTimeout - int
      • isCvvRequired

        public boolean isCvvRequired()
        This method returns whether CVV is required.
        Returns:
        boolean
      • setCvvRequired

        public void setCvvRequired​(boolean cvvRequired)
        This method sets the CVV required flag of the PaymentRequest. This boolean flag indicates whether to show or hide CVV in Manual Entry screen. Default is false.
        Parameters:
        cvvRequired - boolean
      • getApplicationId

        public java.lang.String getApplicationId()
        This method returns the application ID.
        Returns:
        String
      • setApplicationId

        public void setApplicationId​(java.lang.String applicationId)
        This method sets the application ID.
        Parameters:
        applicationId - String
      • getCardholderEmail

        public java.lang.String getCardholderEmail()
        This method returns the cardholder email.
        Returns:
        String
      • setCardholderEmail

        public void setCardholderEmail​(java.lang.String cardholderEmail)
        This method sets the cardholder email.
        Parameters:
        cardholderEmail - String
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object