Class Payment

    • Constructor Detail

    • Method Detail

      • getActions

        public List<Payment.ActiongetActions()
        The list of different action types that have occurred in this payment.
        Returns:
        list of actions
      • getDisputes

        public List<Payment.DisputegetDisputes()
        Contains the information related to a dispute, including the user_comment and user_email which is provided by the consumer when the dispute is initiated. Additionally, contains the current status of the dispute, the time the dispute was created an an resolution reason, if available.
        Returns:
        list of disputes
      • getUser

        public User getUser()
        The consumer's first and last name along with their user id. May be omitted in some cases.
      • setUser

        public void setUser​(User user)
        The consumer's first and last name along with their user id. May be omitted in some cases.
      • getQuantity

        public Integer getQuantity()
        The quantity of the product contained in the order
      • setQuantity

        public void setQuantity​(Integer quantity)
        The quantity of the product contained in the order
      • getRequestId

        public String getRequestId()
        The unique, optional app-created identifier passed into the JS function (255 character maximum)
      • setRequestId

        public void setRequestId​(String requestId)
        The unique, optional app-created identifier passed into the JS function (255 character maximum)
      • getCountry

        public String getCountry()
        Buyer's ISO Country Code, for tax purposes.
      • setCountry

        public void setCountry​(String country)
        Buyer's ISO Country Code, for tax purposes.
      • getTax

        public String getTax()
        The tax parameter specifies if a payment is subject to VAT and, if so, how the tax was paid.

        This can take on the following values:

        • not_taxed: There's no VAT on this payment because it came from outside the European Union.
        • already_paid: The tax on this payment has already been paid by the user's mobile carrier or other upstream party
        • tax_remitted: Facebook paid the VAT on this payment on your behalf. The tax amount will be deducted from your payout.
      • setTax

        public void setTax​(String tax)
        The tax parameter specifies if a payment is subject to VAT and, if so, how the tax was paid.

        This can take on the following values:

        • not_taxed: There's no VAT on this payment because it came from outside the European Union.
        • already_paid: The tax on this payment has already been paid by the user's mobile carrier or other upstream party
        • tax_remitted: Facebook paid the VAT on this payment on your behalf. The tax amount will be deducted from your payout.
      • getTaxCountry

        public String getTaxCountry()
        The country determined by Facebook for tax calculation of this purchase, given as an ISO 3166-1 alpha-2 country code. Note: This field is for your information only, and it should not be used for any recalculation or reconciliation purposes. If tax is equal to not_taxed or already_paid this field will be omitted.
      • setTaxCountry

        public void setTaxCountry​(String taxCountry)
        The country determined by Facebook for tax calculation of this purchase, given as an ISO 3166-1 alpha-2 country code. Note: This field is for your information only, and it should not be used for any recalculation or reconciliation purposes. If tax is equal to not_taxed or already_paid this field will be omitted.
      • setCreatedTime

        public void setCreatedTime​(Date createdTime)
        The time the payment was originally created.
      • setPayoutForeignExchangeRate

        public void setPayoutForeignExchangeRate​(Double payoutForeignExchangeRate)
        Exchange rate used to calculate payout amount which is remitted in USD.
      • getTest

        public Boolean getTest()
        Optional parameter that shows up when a payment is made by a payment tester listed in the app's dashboard. This represents a transaction that has not been charged to the consumer's payment instrument
      • setTest

        public void setTest​(Boolean test)
        Optional parameter that shows up when a payment is made by a payment tester listed in the app's dashboard. This represents a transaction that has not been charged to the consumer's payment instrument