Package paypal.payflow

Class Invoice

java.lang.Object
paypal.payflow.Invoice
public class Invoice extends Object
Used as the Purchase Invoice class. All the purchase related information can be stored in this class. *

Following transactions do require invoice object:

  1. Sale Transaction
  2. Authorization Transaction
  3. Voice Authorization Transaction
  4. Primary Credit Transaction
  5. Recurring Transaction : Action -- Add, Payment

However, Invoice information can also be passed in the following transactions:

  1. Delayed Capture Transaction
  2. Credit Transaction
  3. Void Authorization Transaction
  4. Reference Credit Transaction

................. // Create a new Invoice data object with the Amount, Billing Address etc. details. Invoice inv = new Invoice(); // Set Amount. Currency amt = new Currency(new decimal(25.12)); inv.setAmt(amt); inv.setPoNum("PO12345"); inv.setInvNum("INV12345"); inv.setAltTaxAmt(new Currency(new decimal(25.14))); // Set the Billing Address details. BillTo bill = new BillTo(); bill.setBillToStreet("123 Main St."); bill.setBillToZip("12345"); inv.setBillTo (Bill); .................

  • Constructor Details

    • Invoice

      public Invoice()
      Constructor.This is a default constructor which does not take any parameters. *

  • Method Details

    • addLineItem

      public void addLineItem(LineItem item)
      Adds a line item to line item list.
      Parameters:
      item - Lineitem object

      Use this method to add a line item in the purchase order.

      Line item data describes the details of the item purchased and can be can be passed for each transaction. The convention for passing line item data in name/value pairs is that each name/value starts with L_ and ends with n where n is the line item number. For example L_QTY0=1 is the quantity for line item 0 and is equal to 1, with n starting at 0

      Following example shows how to use line item.

      ................. //inv is the Invoice object. ................. // Create a line item. LineItem item = new LineItem(); // Add first item. Currency lnamt = new Currency(new Double(8.95), "USD"); item.setAmt(lnamt); item.setDesc("Line 1"); item.setQty(1); item.setItemNumber("1"); // Add line item to invoice. inv.addLineItem(item); // Create a line item. LineItem item1 = new LineItem(); // Add second item. Currency lnamt1 = new Currency(new Double(5.25), "USD"); item1.setAmt(lnamt); item1.setDesc("Line 2"); item1.setQty(2); item1.setItemNumber("2"); // Add line item to invoice. inv.addLineItem(item1); .................

    • removeLineItem

      public void removeLineItem(int index)
      Removes a line item from line item list.
      Parameters:
      index - Index of lineitem to be removed.

      Use this method to remove a line item at a particular index in the purchase order.

      ................. // Inv is the Invoice object ................. // Remove item at index 0 inv.removeLineItem(0); .................

    • removeAllLineItems

      public void removeAllLineItems()
      Clears the line item list.

      Use this method to clear all the line items added to the purchase order.

      ................. // inv is the Invoice object ................. // Remove all line items. inv.removeAllLineItems(); .................

    • addAdviceDetailItem

      public void addAdviceDetailItem(AdviceDetail item)
      Adds a advice detail item to the list.
      Parameters:
      item - AdviceDetail object

      This class holds the advice detail related information. Detail of a charge where *n* is a value from 1 - 5. Use for additional breakdown of the amount. For example ADDLAMT1=1 is the amount for the additional amount for advice detail item 1 and is equal to 1,

      Following example shows how to use advice detail.

      ................. //inv is the Invoice object. ................. // Create a advice detail item. AdviceDetail addDetail1 = new AdviceDetail(); addDetail1.setAddLAmt("1"); addDetail1.setAddLAmtType("1"); inv.addAdviceDetailItem(addDetail1); // To add another item, just do the same as above but increment the value of AddDetail to 2: AddDetail2 ..................

    • removeAdviceDetailItem

      public void removeAdviceDetailItem(int index)
      Removes a advice detail item from the list.
      Parameters:
      index - Index of the AdviceDetailItem to be removed.

      Use this method to remove a advice detail item at a particular index in the purchase order.

      ................. // Inv is the Invoice object ................. // Remove item at index 2 inv.removeAdviceDetailItem(2); .................

    • removeAllAdviceDetailItem

      public void removeAllAdviceDetailItem()
      Clears the advice detail item list.

      Use this method to clear all the items added to the purchase order.

      ................. // inv is the Invoice object ................. // Remove all advice detail items. inv.removeAllAdviceDetailItem(); .................

    • generateRequest

      protected void generateRequest()

    • getAltTaxAmt

      public Currency getAltTaxAmt()
      Gets the AltTaxAmount

      Alternate Tax Amount. Amount should always be a decimal. Exact amount to the cent (34.00, not 34). Do not include comma separators. Use 1199.95 instead of 1,199.95.

      Returns:
      Currency

      Maps to Payflow Parameter: ALTTAXAMT

    • setAltTaxAmt

      public void setAltTaxAmt(Currency altTaxAmt)
      Sets the AltTaxAmount

      Alternate Tax Amount. Amount should always be a decimal. Exact amount to the cent (34.00, not 34). Do not include comma separators. Use 1199.95 instead of 1,199.95.

      Parameters:
      altTaxAmt - Currency

      Maps to Payflow Parameter: ALTTAXAMT

    • getAmt

      public Currency getAmt()
      Gets the Amount

      Amount (US Dollars) U.S. based currency. Specify the exact amount to the cent using a decimal point'use 34.00, not 34. Do not include comma separators'use 1199.95 not 1,199.95.

      Your processor and/or Internet merchant account provider may stipulate a maximum amount.

      Returns:
      Currency

      Maps to Payflow Parameter: AMT

      ................. // inv is the Invoice object ................. // Set the Amount for the invoice. // A valid amount is a two decimal value. Currency amt = new Currency(new decimal(25.12)) //For values which have more than two decimal places Currency amt = new Currency(new decimal(25.1214)); amt.setNoOfDecimalDigits (2); //If the NoOfDecimalDigits property is used then it is mandatory to set one of the following properties to true. amt.setRound (true); amt.setTruncate (true); inv.setAmt (Amt);

    • setAmt

      public void setAmt(Currency amt)
      Sets the Amount

      Amount (US Dollars) U.S. based currency. Specify the exact amount to the cent using a decimal point'use 34.00, not 34. Do not include comma separators'use 1199.95 not 1,199.95.

      Your processor and/or Internet merchant account provider may stipulate a maximum amount.

      Parameters:
      amt - Currency

      Maps to Payflow Parameter: AMT

      ................. // inv is the Invoice object ................. // Set the Amount for the invoice. // A valid amount is a two decimal value. Currency amt = new Currency(new decimal(25.12)) //For values which have more than two decimal places Currency amt = new Currency(new decimal(25.1214)); amt.setNoOfDecimalDigits (2); //If the NoOfDecimalDigits property is used then it is mandatory to set one of the following properties to true. amt.setRound (true); amt.setTruncate (true); inv.setAmt (Amt);

    • getBillTo

      public BillTo getBillTo()
      Gets the BillTo Object

      Use this method to get the billing addresses of the purchase order.

      Returns:
      BillTo

    • setBillTo

      public void setBillTo(BillTo billTo)
      Sets the BillTo Object

      Use this method to set the billing addresses of the purchase order.

      Parameters:
      billTo - BillTo

      ................. // inv is the Invoice object ................. // Set the Billing Address details. BillTo bill = New BillTo(); bill.setBillToStreet("123 Main St."); bill.setBillToZip("12345"); inv.setBillTo (bill); .................

    • getBrowserInfo

      public BrowserInfo getBrowserInfo()
      Gets the BrowserInfo Object

      Use this method to get the browser related information of the purchase order.

      Returns:
      BrowserInfo

    • setBrowserInfo

      public void setBrowserInfo(BrowserInfo browserInfo)
      Sets the BrowserInfo Object

      Use this method to set the browser related information of the purchase order.

      Parameters:
      browserInfo - BrowserInfo

      ................. // inv is the Invoice object ................. // Set the Browser Info details. BrowserInfo browser = New BrowserInfo(); browser.setBrowserCountryCode ("USA"); browser.setBrowserUserAgent ("IE 6.0"); inv.setBrowserInfo (browser); .................

    • getCommCode

      public String getCommCode()
      Gets the CommCode

      Use this method to get the Commodity Code for the purchase order.

      Returns:
      String

      Maps to Payflow Parameter: COMMCODE

    • setCommCode

      public void setCommCode(String commCode)
      Sets the CommCode

      Use this method to set the Commodity Code for the purchase order.

      Parameters:
      commCode - String

      Maps to Payflow Parameter: COMMCODE

    • getComment1

      public String getComment1()
      Gets Comment1

      Merchant-defined value for reporting and auditing purposes.

      Returns:
      String

      Maps to Payflow Parameter: COMMENT1

    • setComment1

      public void setComment1(String comment1)
      Sets Comment1

      Merchant-defined value for reporting and auditing purposes.

      Parameters:
      comment1 - String

      Maps to Payflow Parameter: COMMENT1

    • getComment2

      public String getComment2()
      Gets Comment2

      Merchant-defined value for reporting and auditing purposes.

      Returns:
      String

      Maps to Payflow Parameter: COMMENT2

    • setComment2

      public void setComment2(String comment2)
      Sets Comment2

      Merchant-defined value for reporting and auditing purposes.

      Parameters:
      comment2 - String

      Maps to Payflow Parameter: COMMENT2

    • getCustomerInfo

      public CustomerInfo getCustomerInfo()
      Gets the CustomerInfo Object

      Use this method to get the customer related information of the purchase order.

      Returns:
      CustomerInfo

    • setCustomerInfo

      public void setCustomerInfo(CustomerInfo customerInfo)
      Sets the CustomerInfo Object

      Use this method to set the customer related information of the purchase order.

      Parameters:
      customerInfo - CustomerInfo

      ................. // inv is the Invoice object ................. // Set the Customer Info details. CustomerInfo cust = New CustomerInfo(); cust.setCustCode ("CustXXXXX"); cust.setCustIP ("255.255.255.255"); inv.setCustomerInfo (Cust); .................

    • setMerchantInfo

      public void setMerchantInfo(MerchantInfo merchantInfo)
      Sets the MerchantInfo Object

      Use this method to set the merchant related information of the purchase order.

      Parameters:
      merchantInfo - MerchantInfo

      ................. // inv is the Invoice object ................. // Set the Merchant Info details. MerchantInfo merchant = new MerchantInfo(); merchant.setMerchantName("MerchantXXXXX"); merchant.setMerchantCity("Somewhere"); inv.setMerchantInfo (merchant); .................

    • setDevices

      public void setDevices(Devices devices)
      Sets the Devices Object

      Use this method to set the devices the cardholder used.

      Parameters:
      devices - Devices

      ................. // inv is the Invoice object ................. // Set the Devices details. Devices devices = new Devices(); devices.setCatType("3"); devices.setContactLess("RFD"); inv.set .................

    • getUserItem

      public UserItem getUserItem()
      Gets the UserItem Object

      Use this method to get the User items.

      Returns:
      UserItem

    • setUserItem

      public void setUserItem(UserItem userItem)
      Sets the UserItem Object

      Use this method to set the User Items.

      Parameters:
      userItem - UserItem

      ................. // inv is the Invoice object ................. // Set the User Item details. UserItem nUser = new UserItem(); nUser.setUserItem1("TUSER1"); nUser.setUserItem2("TUSER2"); inv.setUserItem(nUser); .................

    • getCustRef

      public String getCustRef()
      Gets the custref

      Merchant-defined identifier for reporting and auditing purposes.

      You can use CUSTREF when performing Inquiry transactions. To ensure that you can always access the correct transaction when performing an Inquiry, you must provide a unique CUSTREF when submitting any transaction, including retries.

      Returns:
      String

      Maps to Payflow Parameter: CUSTREF

    • setCustRef

      public void setCustRef(String custRef)
      Sets the CommCode

      Merchant-defined identifier for reporting and auditing purposes.

      You can use CUSTREF when performing Inquiry transactions. To ensure that you can always access the correct transaction when performing an Inquiry, you must provide a unique CUSTREF when submitting any transaction, including retries.

      Parameters:
      custRef - String

      Maps to Payflow Parameter: CUSTREF

    • getDesc

      public String getDesc()
      Gets the description

      General description of the transaction.

      Returns:
      String

      Maps to Payflow Parameter: DESC

    • setDesc

      public void setDesc(String desc)
      Sets the description

      General description of the transaction.

      Parameters:
      desc - String

      Maps to Payflow Parameter: DESC

    • getDesc1

      public String getDesc1()
      Gets the description1

      Up to 4 lines of additional description of the charge.

      Returns:
      String

      Maps to Payflow Parameter: DESC1

    • setDesc1

      public void setDesc1(String desc1)
      Sets the description1

      Up to 4 lines of additional description of the charge.

      Parameters:
      desc1 - String

      Maps to Payflow Parameter: DESC1

    • getDesc2

      public String getDesc2()
      Gets the description2

      Up to 4 lines of additional description of the charge.

      Returns:
      String

      Maps to Payflow Parameter: DESC2

    • setDesc2

      public void setDesc2(String desc2)
      Sets the description2

      Up to 4 lines of additional description of the charge.

      Parameters:
      desc2 - String

      Maps to Payflow Parameter: DESC2

    • getDesc3

      public String getDesc3()
      Gets the description3

      Up to 4 lines of additional description of the charge.

      Returns:
      String

      Maps to Payflow Parameter: DESC3

    • setDesc3

      public void setDesc3(String desc3)
      Sets the description3

      Up to 4 lines of additional description of the charge.

      Parameters:
      desc3 - String

      Maps to Payflow Parameter: DESC3

    • getDesc4

      public String getDesc4()
      Gets the description4

      Up to 4 lines of additional description of the charge.

      Returns:
      String

      Maps to Payflow Parameter: DESC4

    • setDesc4

      public void setDesc4(String desc4)
      Sets the description4

      Up to 4 lines of additional description of the charge.

      Parameters:
      desc4 - String

      Maps to Payflow Parameter: DESC4

    • getDiscount

      public Currency getDiscount()
      Gets the Discount

      Discount amount on total sale. Amount should always be a decimal. Exact amount to the cent (34.00, not 34). Do not include comma separators. Use 1199.95 instead of 1,199.95.

      Returns:
      Currency

      Maps to Payflow Parameter: DISCOUNT

    • setDiscount

      public void setDiscount(Currency discount)
      Sets the Discount

      Discount amount on total sale. Amount should always be a decimal. Exact amount to the cent (34.00, not 34). Do not include comma separators. Use 1199.95 instead of 1,199.95.

      Parameters:
      discount - Currency

      Maps to Payflow Parameter: DISCOUNT

    • getDutyAmt

      public Currency getDutyAmt()
      Gets the DutyAmount

      Sometimes called import tax. Amount should always be a decimal. Exact amount to the cent (34.00, not 34). Do not include comma separators. Use 1199.95 instead of 1,199.95.

      Returns:
      Currency

      Maps to Payflow Parameter: DUTYAMT

    • setDutyAmt

      public void setDutyAmt(Currency dutyAmt)
      Sets the DutyAmount

      Sometimes called import tax. Amount should always be a decimal. Exact amount to the cent (34.00, not 34). Do not include comma separators. Use 1199.95 instead of 1,199.95.

      Parameters:
      dutyAmt - Currency

      Maps to Payflow Parameter: DUTYAMT

    • getEndTime

      public String getEndTime()
      Gets the EndTime

      ENDTIME specifies the end of the time period during which the transaction specified by the CUSTREF occurred.

      ENDTIME must be less than 30 days after STARTTIME. An inquiry cannot be performed across a date range greater than 30 days.

      If you set ENDTIME, and not STARTTIME, then STARTTIME is defaulted to 30 days before ENDTIME. If neither STARTTIME nor ENDTIME is specified, then the system searches the last 30 days.

      Format: yyyymmddhhmmss

      yyyy - Year, mm - Month dd - Day, hh - Hours, mm - Minutes ss - Seconds.

      Returns:
      String

      Maps to Payflow Parameter: ENDTIME

    • setEndTime

      public void setEndTime(String endTime)
      Sets the EndTime

      ENDTIME specifies the end of the time period during which the transaction specified by the CUSTREF occurred.

      ENDTIME must be less than 30 days after STARTTIME. An inquiry cannot be performed across a date range greater than 30 days.

      If you set ENDTIME, and not STARTTIME, then STARTTIME is defaulted to 30 days before ENDTIME. If neither STARTTIME nor ENDTIME is specified, then the system searches the last 30 days.

      Format: yyyymmddhhmmss

      yyyy - Year, mm - Month dd - Day, hh - Hours, mm - Minutes ss - Seconds.

      Parameters:
      endTime - String

      Maps to Payflow Parameter: ENDTIME

    • getFreightAmt

      public Currency getFreightAmt()
      Gets the Freight Amount

      Freight Amount should always be a decimal. Exact amount to the cent (34.00, not 34). Do not include comma separators. Use 1199.95 instead of 1,199.95.

      Returns:
      Currency

      Maps to Payflow Parameter: FREIGHTAMT

    • setFreightAmt

      public void setFreightAmt(Currency freightAmt)
      Sets the Freight Amount

      Freight Amount should always be a decimal. Exact amount to the cent (34.00, not 34). Do not include comma separators. Use 1199.95 instead of 1,199.95.

      Parameters:
      freightAmt - Currency

      Maps to Payflow Parameter: FREIGHTAMT

    • getHandlingAmt

      public Currency getHandlingAmt()
      Gets the Handling Amount

      Handling Amount. Amount should always be a decimal. Exact amount to the cent (34.00, not 34). Do not include comma separators. Use 1199.95 instead of 1,199.95.

      Returns:
      Currency

      Maps to Payflow Parameter: HANDLINGAMT

    • setHandlingAmt

      public void setHandlingAmt(Currency handlingAmt)
      Sets the Handling Amount

      UHandling Amount. Amount should always be a decimal. Exact amount to the cent (34.00, not 34). Do not include comma separators. Use 1199.95 instead of 1,199.95.

      Parameters:
      handlingAmt - Currency

      Maps to Payflow Parameter: HANDLINGAMT

    • getInvNum

      public String getInvNum()
      Gets the InvNum

      Merchant invoice number. This reference number (PNREF'generated by PayPal) is used for authorizations and settlements. The Acquirer decides if this information will appear on the merchant's bank reconciliation statement.

      Returns:
      String

      Maps to Payflow Parameter: INVNUM

    • setInvNum

      public void setInvNum(String invNum)
      Sets the InvNum

      Merchant invoice number. This reference number (PNREF'generated by PayPal) is used for authorizations and settlements. The Acquirer decides if this information will appear on the merchant's bank reconciliation statement.

      Parameters:
      invNum - String

      Maps to Payflow Parameter: INVNUM

    • getInvoiceDate

      public String getInvoiceDate()
      Gets the Invoice Date

      Transaction Date.

      Format: yyyymmdd.

      yyyy - Year, mm - Month, dd - Day.

      Returns:
      String

      Maps to Payflow Parameter: INVOICEDATE

    • setInvoiceDate

      public void setInvoiceDate(String invoiceDate)
      Sets the Invoice Date

      Transaction Date.

      Format: yyyymmdd.

      yyyy - Year, mm - Month, dd - Day.
      Parameters:
      invoiceDate - String

      Maps to Payflow Parameter: INVOICEDATE

    • getLocalTaxAmt

      public Currency getLocalTaxAmt()
      Gets the Local Tax Amount.

      Local Tax Amount. Amount should always be a decimal. Exact amount to the cent (34.00, not 34). Do not include comma separators. Use 1199.95 instead of 1,199.95.

      Returns:
      Currency

      Maps to Payflow Parameter: LOCALTAXAMT

    • setLocalTaxAmt

      public void setLocalTaxAmt(Currency localTaxAmt)
      Sets the Local Tax Amount.

      Local Tax Amount. Amount should always be a decimal. Exact amount to the cent (34.00, not 34). Do not include comma separators. Use 1199.95 instead of 1,199.95.

      Parameters:
      localTaxAmt - Currency

      Maps to Payflow Parameter: LOCALTAXAMT

    • getNationalTaxAmt

      public Currency getNationalTaxAmt()
      Gets the National Tax Amount

      National Tax Amount. Amount should always be a decimal. Exact amount to the cent (34.00, not 34). Do not include comma separators. Use 1199.95 instead of 1,199.95.

      Returns:
      Currency

      Maps to Payflow Parameter: NATIONALTAXAMT

    • setNationalTaxAmt

      public void setNationalTaxAmt(Currency nationalTaxAmt)
      Sets the National Tax Amount.

      National Tax Amount. Amount should always be a decimal. Exact amount to the cent (34.00, not 34). Do not include comma separators. Use 1199.95 instead of 1,199.95.

      Parameters:
      nationalTaxAmt - Currency

      Maps to Payflow Parameter: NATIONALTAXAMT

    • getOrderDate

      public String getOrderDate()
      Gets the Order date

      Order date. Format: mmddyy mm - Month, dd - Day, yy - Year.

      Returns:
      String

      Maps to Payflow Parameter: ORDERDATE

    • setOrderDate

      public void setOrderDate(String orderDate)
      Sets the Order Date

      Order date. Format: mmddyy mm - Month, dd - Day, yy - Year.

      Parameters:
      orderDate - String

      Maps to Payflow Parameter: ORDERDATE

    • getOrderTime

      public String getOrderTime()
      Gets the Order Time
      Returns:
      String

      Maps to Payflow Parameter: ORDERTIME

    • setOrderTime

      public void setOrderTime(String orderTime)
      Sets the Order Time
      Parameters:
      orderTime - String

      Maps to Payflow Parameter: ORDERTIME

    • getPoNum

      public String getPoNum()
      Gets the PoNum.

      Purchase Order Number / Merchant related data.

      Returns:
      String

      Maps to Payflow Parameter: PONUM

    • setPoNum

      public void setPoNum(String poNum)
      Sets the PoNum.

      Purchase Order Number / Merchant related data.

      Parameters:
      poNum - String

      Maps to Payflow Parameter: PONUM

    • getTransactionId

      public String getTransactionId()
      Gets the TransactionId.

      Transaction ID / Merchant related data.

      Returns:
      String

      Maps to Payflow Parameter: TRANSACTIONID

    • setTransactionId

      public void setTransactionId(String transactionId)
      Sets the TransactionId.

      Transaction Id / Merchant related data.

      Parameters:
      transactionId - String

      Maps to Payflow Parameter: TRANSACTIONID

    • getEchoData

      public String getEchoData()
      Gets the EchoData.

      Used to echo data back in response.

      Returns:
      String

      Maps to Payflow Parameter: ECHODATA

    • setEchoData

      public void setEchoData(String echoData)
      Sets the EchoData.

      Echo Data is used to "echo" back data sent for processing in the response.

      For example, if you send "ECHODATA=ADDRESS" then the Billing Address fields will be returned in the response

      Parameters:
      echoData - String

      Maps to Payflow Parameter: ECHODATA

    • getOrderId

      public String getOrderId()
      Gets the OrderID

      Used for Order ID

      Returns:
      orderID String

      Maps to Payflow Parameter: ORDERID

    • setOrderId

      public void setOrderId(String orderId)
      Sets the OrderID.

      Order ID is used to prevent duplicate "orders" from being processed. This is NOT the same as Request ID; which is used at the transaction level. Order ID (ORDERID) is used to check for a duplicate order in the future. For example, if you pass ORDERID=10101 and in two weeks another order is processed with the same ORDERID, a duplicate condition will occur. The results you receive will be from the original order with DUPLICATE=2 to show that it was ORDERID that triggered the duplicate. The order id is stored for 3 years.

      Important Note: Order ID functionality to catch duplicate orders processed withing seconds of each other is limited. Order ID should be used in conjunction with Request ID to prevent duplicates due to processing / communication errors. DO NOT use ORDERID as your only means to check for duplicate transactions.

      Parameters:
      orderId - String

      Maps to Payflow Parameter: ORDERID

    • getRecurring

      public String getRecurring()
      Gets the Recurring status.

      Is a recurring transaction? Y or N.

      Returns:
      String

      Maps to Payflow Parameter: RECURRING

    • setRecurring

      public void setRecurring(String recurring)
      Sets the Recurring status.

      Is a recurring transaction? Y or N.

      Parameters:
      recurring - String

      Maps to Payflow Parameter: RECURRING

    • getShippingAmt

      public Currency getShippingAmt()
      Gets the Shipping Amt.

      Shipping Amount should always be a decimal. Exact amount to the cent (34.00, not 34). Do not include comma separators. Use 1199.95 instead of 1,199.95.

      Returns:
      Currency

      Maps to Payflow Parameter: SHIPPINGAMT

    • setShippingAmt

      public void setShippingAmt(Currency shippingAmt)
      Sets the Shipping Amt

      Shipping Amount should always be a decimal. Exact amount to the cent (34.00, not 34). Do not include comma separators. Use 1199.95 instead of 1,199.95.

      Parameters:
      shippingAmt - Currency

      Maps to Payflow Parameter: SHIPPINGAMT

    • getShipTo

      public ShipTo getShipTo()
      Returns:
      ShipTo

      Use this method to get the shipping addresses of the purchase order.

    • setShipTo

      public void setShipTo(ShipTo shipTo)
      Parameters:
      shipTo -

      Use this property to set the shipping addresses of the purchase order.

      ................. // inv is the Invoice object ................. // Set the Shipping Address details. ShipTo ship = New ShipTo(); ship.setShipToStreet ("685A E. Middlefield Rd."); ship.setShipToZip ("94043"); inv.setShipTo(ship); .................

    • getStartTime

      public String getStartTime()
      Gets the Start Time

      STARTTIME specifies the beginning of the time period during which the transaction specified by the CUSTREF occurred. If you set STARTTIME, and not ENDTIME, then ENDTIME is defaulted to 30 days after STARTTIME. If neither STARTTIME nor ENDTIME is specified, then the system searches the last 30 days. Format: yyyymmddhhmmss yyyy - Year, mm - Month dd - Day, hh - Hours, mm - Minutes ss - Seconds.

      Returns:
      startTime String

      Maps to Payflow Parameter: STARTTIME

    • setStartTime

      public void setStartTime(String startTime)
      Sets the Start Time.

      STARTTIME specifies the beginning of the time period during which the transaction specified by the CUSTREF occurred. If you set STARTTIME, and not ENDTIME, then ENDTIME is defaulted to 30 days after STARTTIME. If neither STARTTIME nor ENDTIME is specified, then the system searches the last 30 days. Format: yyyymmddhhmmss

      yyyy - Year, mm - Month dd - Day, hh - Hours, mm - Minutes ss - Seconds.

      Parameters:
      startTime - String

      Maps to Payflow Parameter: STARTTIME

    • getTaxAmt

      public Currency getTaxAmt()
      Gets the Tax Amt

      Tax Amount should always be a decimal. Exact amount to the cent (34.00, not 34). Do not include comma separators. Use 1199.95 instead of 1,199.95.

      Returns:
      taxAmt Currency

      Maps to Payflow Parameter: TAXAMT

    • setTaxAmt

      public void setTaxAmt(Currency taxAmt)
      Sets the Tax Amt

      Tax Amount should always be a decimal. Exact amount to the cent (34.00, not 34). Do not include comma separators. Use 1199.95 instead of 1,199.95.

      Parameters:
      taxAmt - Currency

      Maps to Payflow Parameter: TAXAMT

    • getTaxExempt

      public String getTaxExempt()
      Gets the TaxExempt

      Is the customer tax exempt? Y or N

      Returns:
      taxExempt String

      Maps to Payflow Parameter: TAXEXEMPT

    • setTaxExempt

      public void setTaxExempt(String taxExempt)
      Sets the TaxExempt

      Is the customer tax exempt? Y or N

      Parameters:
      taxExempt - String

      Maps to Payflow Parameter: TAXEXEMPT

    • getVatRegNum

      public String getVatRegNum()
      Gets the VAT registration number
      Returns:
      vatRegNum String

      Maps to Payflow Parameter: VATREGNUM

    • setVatRegNum

      public void setVatRegNum(String vatRegNum)
      Sets the VAT registration number
      Parameters:
      vatRegNum - String

      Maps to Payflow Parameter: VATREGNUM

    • getVatTaxAmt

      public Currency getVatTaxAmt()
      Gets the Vat Tax Amt

      VAT Tax Amount. Amount should always be a decimal. Exact amount to the cent (34.00, not 34). Do not include comma separators. Use 1199.95 instead of 1,199.95.

      Returns:
      vatTaxAmt Currency

      Maps to Payflow Parameter: VATTAXAMT

    • setVatTaxAmt

      public void setVatTaxAmt(Currency vatTaxAmt)
      Sets the Vat Tax Amt

      VAT Tax Amount. Amount should always be a decimal. Exact amount to the cent (34.00, not 34). Do not include comma separators. Use 1199.95 instead of 1,199.95.

      Parameters:
      vatTaxAmt - Currency

      Maps to Payflow Parameter: VATTAXAMT

    • getVatTaxPercent

      public String getVatTaxPercent()
      Gets the VAT Tax percentage.
      Returns:
      vatTaxPercent String

      Maps to Payflow Parameter: VATTAXPERCENT

    • setVatTaxPercent

      public void setVatTaxPercent(String vatTaxPercent)
      Sets the VAT Tax percentage.
      Parameters:
      vatTaxPercent - String

      Maps to Payflow Parameter: VATTAXPERCENT

    • getItemAmt

      public Currency getItemAmt()
      Gets the line item Amount.

      Amount should always be a decimal. Exact amount to the cent (34.00, not 34). Do not include comma separators. Use 1199.95 instead of 1,199.95.

      Returns:
      itemAmt String

      Maps to Payflow Parameter: ITEMAMT

    • setItemAmt

      public void setItemAmt(Currency itemAmt)
      Sets the line item Amount.

      Amount should always be a decimal. Exact amount to the cent (34.00, not 34). Do not include comma separators. Use 1199.95 instead of 1,199.95.

      Parameters:
      itemAmt - String

      Maps to Payflow Parameter: ITEMAMT

    • getOrderDesc

      public String getOrderDesc()
      Gets the order description for this Invoice
      Returns:
      orderDesc String

      Maps to Payflow Parameter: ORDERDESC

    • setOrderDesc

      public void setOrderDesc(String orderDesc)
      Sets the order description for this Invoice
      Parameters:
      orderDesc - String

      Maps to Payflow Parameter: ORDERDESC

    • setRecurringType

      public void setRecurringType(String recurringType)
      Sets the type of the Recurring transaction (UK). Type of transaction occurrence. The values are: F = First occurrence / S = Subsequent occurrence (default)
      Parameters:
      recurringType - String

      Maps to Payflow Parameter: RECURRINGTYPE

    • getRecurringType

      public String getRecurringType()
      Gets the type of the Recurring transaction (UK).
      Returns:
      recurringType String

      Maps to Payflow Parameter: RECURRINGTYPE

    • setCustIp

      public void setCustIp(String custIp)
      Sets the Customer's IP Address.
      Parameters:
      custIp - String

      Maps to Payflow Parameter: CUSTIP

    • getCustIp

      public String getCustIp()
      Gets the Customer's IP Address.
      Returns:
      custIp String

      Maps to Payflow Parameter: CUSTIP

    • setVatInvNum

      public void setVatInvNum(String vatInvNum)
      Sets the VAT Invoice Number.
      Parameters:
      vatInvNum - String

      Maps to Payflow Parameter: VATINVNUM

    • getVatInvNum

      public String getVatInvNum()
      Gets the VAT Invoice Number.
      Returns:
      vatInvNum String

      Maps to Payflow Parameter: VATINVNUM

    • setVatTaxRate

      public void setVatTaxRate(String vatTaxRate)
      Sets the VAT Tax Rate.
      Parameters:
      vatTaxRate - String

      Maps to Payflow Parameter: VATTAXRATE

    • getVatTaxRate

      public String getVatTaxRate()
      Gets the VAT Tax Rate.
      Returns:
      vatTaxRate String

      Maps to Payflow Parameter: VATTAXRATE

    • setReportGroup

      public void setReportGroup(String reportGroup)
      Sets the Report Group. Category that the transaction is in, for example: coffee mugs.
      Parameters:
      reportGroup - String

      Maps to Payflow Parameter: REPORTGROUP

    • getReportGroup

      public String getReportGroup()
      Gets the Report Group.
      Returns:
      reportGroup String

      Maps to Payflow Parameter: REPORTGROUP

    • setMiscData

      public void setMiscData(String miscData)
      Sets the Miscellaneous Data.
      Parameters:
      miscData - String

      Maps to Payflow Parameter: MISCDATA

    • getMiscData

      public String getMiscData()
      Gets the Miscellaneous Data.
      Returns:
      miscData String

      Maps to Payflow Parameter: MISCDATA

    • setScaExemption

      public void setScaExemption(String scaExemption)
      Sets the SCAExemption.
      Parameters:
      scaExemption - String

      Maps to Payflow Parameter: SCAEXEMPTION

    • getScaExemption

      public String getScaExemption()
      Gets the SCAExemption.
      Returns:
      scaExemption String

      Maps to Payflow Parameter: SCAEXEMPTION

    • setCitDate

      public void setCitDate(String citDate)
      Sets the CitDate.
      Parameters:
      citDate - String

      Maps to Payflow Parameter: CITDATE

    • getCitDate

      public String getCitDate()
      Gets the CitDate
      Returns:
      citDate String

      Maps to Payflow Parameter: CITDATE

    • setVMaid

      public void setVMaid(String vMaid)
      Sets the VMaid
      Parameters:
      vMaid - String

      Maps to Payflow Parameter: VMAID

    • getVMaid

      public String getVMaid()
      Gets the VMaid
      Returns:
      vMaid String

      Maps to Payflow Parameter: VMAID

    • setPar

      public void setPar(String par)
      Sets the PAR
      Parameters:
      par - String

      Maps to Payflow Parameter: PAR

    • getPar

      public String getPar()
      Gets the Par
      Returns:
      par String

      Maps to Payflow Parameter: PAR

    • getContext

      protected Context getContext()

    • setContext

      protected void setContext(Context context)

    • getRequestBuffer

      protected StringBuffer getRequestBuffer()
      Gets the Requestbuffer used for creating the actual request string.
      Returns:
      mRequestBuffer StringBuffer

    • setRequestBuffer

      protected void setRequestBuffer(StringBuffer value)
      sets the StringBuffer to hold the request string.
      Parameters:
      value - StringBuffer