Package com.restfb.types

Class Payment.Action

java.lang.Object
com.restfb.types.AbstractFacebookType
com.restfb.types.Payment.Action
All Implemented Interfaces:
Serializable
Enclosing class:
Payment
public static class Payment.Action extends AbstractFacebookType
The list of different action types that have occurred in this payment.
See Also:
Serialized Form

  • Constructor Summary

    Constructors
    Constructor
    Description
    Action()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getAmount()
    The amount of money covered by this action.
    String
    getCurrency()
    The currency of the above amount in this action.
    String
    getStatus()
    The status for this particular action. status can be: initiated: An initiated payment designates the payment was only initiated but not yet fully completed.
    String
    getTaxAmount()
    The amount reduced from your payout for any taxes remitted by Facebook.
    Date
    getTimeCreated()
    When this action occurred.
    Date
    getTimeUpdated()
    When this action was last updated.
    String
    getType()
    The type of this particular action. type can be: charge: This designates the type of action that was taken on this payment was a charge.
    void
    setAmount​(String amount)
    The amount of money covered by this action.
    void
    setCurrency​(String currency)
    The currency of the above amount in this action.
    void
    setStatus​(String status)
    The status for this particular action. status can be: initiated: An initiated payment designates the payment was only initiated but not yet fully completed.
    void
    setTaxAmount​(String taxAmount)
    The amount reduced from your payout for any taxes remitted by Facebook.
    void
    setTimeCreated​(Date timeCreated)
    When this action occurred.
    void
    setTimeUpdated​(Date timeUpdated)
    When this action was last updated.
    void
    setType​(String type)
    The type of this particular action. type can be: charge: This designates the type of action that was taken on this payment was a charge.

    Methods inherited from class com.restfb.types.AbstractFacebookType

    equals, hashCode, toString

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

  • Method Details

    • getType

      public String getType()
      The type of this particular action. type can be:
      • charge: This designates the type of action that was taken on this payment was a charge. If the charge has a status of completed, then you should fulfill the order.
      • refund: The refund type designates the payment has been refunded and the item sold to the consumer should be retracted if possible as you will no longer be paid out for this transaction.
      • chargeback: A chargeback is initiated by a consumer with their bank disputing the payment in question. When a chargeback occurs, you should retract the in-game item from the costumer where possible as you will not be paid out for this order.
      • chargeback_reversal: A chargeback_reversal occurs when a chargeback is retroactively reversed. In this case, you should reinstate the consumer's in-game item if possible as you will now be paid out for this payment.
      • decline: A decline occurs when a funding source used to create a bundled transaction is declined at the moment of processing the payment. You should retract the in-game item from the consumer where possible as you will not be paid out for this order. More information on bundled transactions and declines can be found in Handling Disputes and Refunds.

    • setType

      public void setType​(String type)
      The type of this particular action. type can be:
      • charge: This designates the type of action that was taken on this payment was a charge. If the charge has a status of completed, then you should fulfill the order.
      • refund: The refund type designates the payment has been refunded and the item sold to the consumer should be retracted if possible as you will no longer be paid out for this transaction.
      • chargeback: A chargeback is initiated by a consumer with their bank disputing the payment in question. When a chargeback occurs, you should retract the in-game item from the costumer where possible as you will not be paid out for this order.
      • chargeback_reversal: A chargeback_reversal occurs when a chargeback is retroactively reversed. In this case, you should reinstate the consumer's in-game item if possible as you will now be paid out for this payment.
      • decline: A decline occurs when a funding source used to create a bundled transaction is declined at the moment of processing the payment. You should retract the in-game item from the consumer where possible as you will not be paid out for this order. More information on bundled transactions and declines can be found in Handling Disputes and Refunds.

    • getStatus

      public String getStatus()
      The status for this particular action. status can be:
      • initiated: An initiated payment designates the payment was only initiated but not yet fully completed. You should not fulfill an order of this type with the consumer and you should not receive a real time update for a payment with this status. You will however get a real time update when the corresponding transaction is completed. Developers may see initiated state for certain payment methods which requires long time to settle, for example, certain methods require the costumer to fill-in a form online, print out a receipt and go to the bank offline to pay.
      • completed: A completed status means the action was successfully completed. If the type was a charge you will want to fulfill the order to the consumer at this time. Similarly, if the action type was a refund you will want to retract the item from the consumer.
      • failed: This designates a failed action for the underlying type. This value can be present for both a charge action type as well as a refund action type.

    • setStatus

      public void setStatus​(String status)
      The status for this particular action. status can be:
      • initiated: An initiated payment designates the payment was only initiated but not yet fully completed. You should not fulfill an order of this type with the consumer and you should not receive a real time update for a payment with this status. You will however get a real time update when the corresponding transaction is completed. Developers may see initiated state for certain payment methods which requires long time to settle, for example, certain methods require the costumer to fill-in a form online, print out a receipt and go to the bank offline to pay.
      • completed: A completed status means the action was successfully completed. If the type was a charge you will want to fulfill the order to the consumer at this time. Similarly, if the action type was a refund you will want to retract the item from the consumer.
      • failed: This designates a failed action for the underlying type. This value can be present for both a charge action type as well as a refund action type.

    • getAmount

      public String getAmount()
      The amount of money covered by this action.

    • setAmount

      public void setAmount​(String amount)
      The amount of money covered by this action.

    • getCurrency

      public String getCurrency()
      The currency of the above amount in this action.

    • setCurrency

      public void setCurrency​(String currency)
      The currency of the above amount in this action.

    • getTimeCreated

      public Date getTimeCreated()
      When this action occurred.

    • setTimeCreated

      public void setTimeCreated​(Date timeCreated)
      When this action occurred.

    • getTimeUpdated

      public Date getTimeUpdated()
      When this action was last updated.

    • setTimeUpdated

      public void setTimeUpdated​(Date timeUpdated)
      When this action was last updated.

    • getTaxAmount

      public String getTaxAmount()
      The amount reduced from your payout for any taxes remitted by Facebook. If tax is equal to not_taxed or already_paid this field will be omitted.

    • setTaxAmount

      public void setTaxAmount​(String taxAmount)
      The amount reduced from your payout for any taxes remitted by Facebook. If tax is equal to not_taxed or already_paid this field will be omitted.