Package com.restfb.types
Class Payment
java.lang.Object
com.restfb.types.AbstractFacebookType
com.restfb.types.FacebookType
com.restfb.types.Payment
- All Implemented Interfaces:
HasCreatedTime
,Serializable
Represents the Payment Graph API type.
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
The list of different action types that have occurred in this payment.static class
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.static class
The items associated with the payment.Nested classes/interfaces inherited from class com.restfb.types.FacebookType
FacebookType.Metadata
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionboolean
addAction
(Payment.Action action) boolean
addDispute
(Payment.Dispute dispute) boolean
addItem
(Payment.Item item) The list of different action types that have occurred in this payment.The app associated with this paymentBuyer's ISO Country Code, for tax purposes.The time the payment was originally created.Contains the information related to a dispute, including theuser_comment
anduser_email
which is provided by the consumer when the dispute is initiated.getItems()
The items associated with the payment.Exchange rate used to calculate payout amount which is remitted in USD.The quantity of the product contained in the orderThe unique, optional app-created identifier passed into the JS function (255 character maximum)getTax()
The tax parameter specifies if a payment is subject to VAT and, if so, how the tax was paid.The country determined by Facebook for tax calculation of this purchase, given as an ISO 3166-1 alpha-2 country code.getTest()
Optional parameter that shows up when a payment is made by a payment tester listed in the app's dashboard.getUser()
The consumer's first and last name along with their user id.boolean
removeAction
(Payment.Action action) boolean
removeDispute
(Payment.Dispute dispute) boolean
removeItem
(Payment.Item item) void
setApplication
(Application application) The app associated with this paymentvoid
setCountry
(String country) Buyer's ISO Country Code, for tax purposes.void
setCreatedTime
(Date createdTime) The time the payment was originally created.void
setPayoutForeignExchangeRate
(Double payoutForeignExchangeRate) Exchange rate used to calculate payout amount which is remitted in USD.void
setQuantity
(Integer quantity) The quantity of the product contained in the ordervoid
setRequestId
(String requestId) The unique, optional app-created identifier passed into the JS function (255 character maximum)void
The tax parameter specifies if a payment is subject to VAT and, if so, how the tax was paid.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.void
Optional parameter that shows up when a payment is made by a payment tester listed in the app's dashboard.void
The consumer's first and last name along with their user id.Methods inherited from class com.restfb.types.FacebookType
getId, getMetadata, getType, setId, setMetadata, setType
Methods inherited from class com.restfb.types.AbstractFacebookType
equals, hashCode, toString
-
Constructor Details
-
Payment
public Payment()
-
-
Method Details
-
getItems
The items associated with the payment.- Returns:
- list of items
-
addItem
-
removeItem
-
getActions
The list of different action types that have occurred in this payment.- Returns:
- list of actions
-
addAction
-
removeAction
-
getDisputes
Contains the information related to a dispute, including theuser_comment
anduser_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
-
addDispute
-
removeDispute
-
getUser
The consumer's first and last name along with their user id. May be omitted in some cases. -
setUser
The consumer's first and last name along with their user id. May be omitted in some cases. -
getQuantity
The quantity of the product contained in the order -
setQuantity
The quantity of the product contained in the order -
getRequestId
The unique, optional app-created identifier passed into the JS function (255 character maximum) -
setRequestId
The unique, optional app-created identifier passed into the JS function (255 character maximum) -
getApplication
The app associated with this payment -
setApplication
The app associated with this payment -
getCountry
Buyer's ISO Country Code, for tax purposes. -
setCountry
Buyer's ISO Country Code, for tax purposes. -
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 partytax_remitted
: Facebook paid the VAT on this payment on your behalf. The tax amount will be deducted from your payout.
-
setTax
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 partytax_remitted
: Facebook paid the VAT on this payment on your behalf. The tax amount will be deducted from your payout.
-
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
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. -
getCreatedTime
The time the payment was originally created.- Specified by:
getCreatedTime
in interfaceHasCreatedTime
-
setCreatedTime
The time the payment was originally created. -
getPayoutForeignExchangeRate
Exchange rate used to calculate payout amount which is remitted in USD. -
setPayoutForeignExchangeRate
Exchange rate used to calculate payout amount which is remitted in USD. -
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
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
-