Package com.stripe.model.treasury

Class CreditReversal

java.lang.Object
com.stripe.model.StripeObject
com.stripe.net.ApiResource
com.stripe.model.treasury.CreditReversal
All Implemented Interfaces:
HasId, StripeObjectInterface
public class CreditReversal extends ApiResource implements HasId

  • Constructor Details

    • CreditReversal

      public CreditReversal()

  • Method Details

    • getTransaction

      public String getTransaction()
      Get ID of expandable transaction object.

    • setTransaction

      public void setTransaction(String id)

    • getTransactionObject

      public Transaction getTransactionObject()
      Get expanded transaction.

    • setTransactionObject

      public void setTransactionObject(Transaction expandableObject)

    • list

      public static CreditReversalCollection list(Map<String,Object> params) throws StripeException
      Returns a list of CreditReversals.
      Throws:
      StripeException

    • list

      public static CreditReversalCollection list(Map<String,Object> params, RequestOptions options) throws StripeException
      Returns a list of CreditReversals.
      Throws:
      StripeException

    • list

      public static CreditReversalCollection list(CreditReversalListParams params) throws StripeException
      Returns a list of CreditReversals.
      Throws:
      StripeException

    • list

      public static CreditReversalCollection list(CreditReversalListParams params, RequestOptions options) throws StripeException
      Returns a list of CreditReversals.
      Throws:
      StripeException

    • retrieve

      public static CreditReversal retrieve(String creditReversal) throws StripeException
      Retrieves the details of an existing CreditReversal by passing the unique CreditReversal ID from either the CreditReversal creation request or CreditReversal list.
      Throws:
      StripeException

    • retrieve

      public static CreditReversal retrieve(String creditReversal, RequestOptions options) throws StripeException
      Retrieves the details of an existing CreditReversal by passing the unique CreditReversal ID from either the CreditReversal creation request or CreditReversal list.
      Throws:
      StripeException

    • retrieve

      public static CreditReversal retrieve(String creditReversal, Map<String,Object> params, RequestOptions options) throws StripeException
      Retrieves the details of an existing CreditReversal by passing the unique CreditReversal ID from either the CreditReversal creation request or CreditReversal list.
      Throws:
      StripeException

    • retrieve

      public static CreditReversal retrieve(String creditReversal, CreditReversalRetrieveParams params, RequestOptions options) throws StripeException
      Retrieves the details of an existing CreditReversal by passing the unique CreditReversal ID from either the CreditReversal creation request or CreditReversal list.
      Throws:
      StripeException

    • create

      public static CreditReversal create(Map<String,Object> params) throws StripeException
      Reverses a ReceivedCredit and creates a CreditReversal object.
      Throws:
      StripeException

    • create

      public static CreditReversal create(Map<String,Object> params, RequestOptions options) throws StripeException
      Reverses a ReceivedCredit and creates a CreditReversal object.
      Throws:
      StripeException

    • create

      public static CreditReversal create(CreditReversalCreateParams params) throws StripeException
      Reverses a ReceivedCredit and creates a CreditReversal object.
      Throws:
      StripeException

    • create

      public static CreditReversal create(CreditReversalCreateParams params, RequestOptions options) throws StripeException
      Reverses a ReceivedCredit and creates a CreditReversal object.
      Throws:
      StripeException

    • getAmount

      public Long getAmount()
      Amount (in cents) transferred.

    • getCurrency

      public String getCurrency()
      Three-letter ISO currency code, in lowercase. Must be a supported currency.

    • getFinancialAccount

      public String getFinancialAccount()
      The FinancialAccount to reverse funds from.

    • getHostedRegulatoryReceiptUrl

      public String getHostedRegulatoryReceiptUrl()
      A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.

    • getLivemode

      public Boolean getLivemode()
      Has the value true if the object exists in live mode or the value false if the object exists in test mode.

    • getMetadata

      public Map<String,String> getMetadata()
      Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

    • getNetwork

      public String getNetwork()
      The rails used to reverse the funds.

      One of ach, or stripe.

    • getObject

      public String getObject()
      String representing the object's type. Objects of the same type share the same value.

      Equal to treasury.credit_reversal.

    • getReceivedCredit

      public String getReceivedCredit()
      The ReceivedCredit being reversed.

    • getStatus

      public String getStatus()
      Status of the CreditReversal

      One of canceled, posted, or processing.

    • getStatusTransitions

      public CreditReversal.StatusTransitions getStatusTransitions()

    • setAmount

      public void setAmount(Long amount)
      Amount (in cents) transferred.

    • setCurrency

      public void setCurrency(String currency)
      Three-letter ISO currency code, in lowercase. Must be a supported currency.

    • setFinancialAccount

      public void setFinancialAccount(String financialAccount)
      The FinancialAccount to reverse funds from.

    • setHostedRegulatoryReceiptUrl

      public void setHostedRegulatoryReceiptUrl(String hostedRegulatoryReceiptUrl)
      A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.

    • setId

      public void setId(String id)
      Unique identifier for the object.

    • setLivemode

      public void setLivemode(Boolean livemode)
      Has the value true if the object exists in live mode or the value false if the object exists in test mode.

    • setMetadata

      public void setMetadata(Map<String,String> metadata)
      Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

    • setNetwork

      public void setNetwork(String network)
      The rails used to reverse the funds.

      One of ach, or stripe.

    • setObject

      public void setObject(String object)
      String representing the object's type. Objects of the same type share the same value.

      Equal to treasury.credit_reversal.

    • setReceivedCredit

      public void setReceivedCredit(String receivedCredit)
      The ReceivedCredit being reversed.

    • setStatus

      public void setStatus(String status)
      Status of the CreditReversal

      One of canceled, posted, or processing.

    • setStatusTransitions

      public void setStatusTransitions(CreditReversal.StatusTransitions statusTransitions)

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • getId

      public String getId()
      Unique identifier for the object.
      Specified by:
      getId in interface HasId