Package com.stripe.model.treasury

Class ReceivedDebit

java.lang.Object
com.stripe.model.StripeObject
com.stripe.net.ApiResource
com.stripe.model.treasury.ReceivedDebit
All Implemented Interfaces:
HasId, StripeActiveObject, StripeObjectInterface
public class ReceivedDebit extends ApiResource implements HasId
Legacy ReceivedDebits are part of the v1 version of Treasury for platforms and do not support many of the features introduced in Treasury for platforms v2. Use Received Debits instead of building a new v1 integration.

ReceivedDebits represent funds pulled from a FinancialAccount. These are not initiated from the FinancialAccount.

  • Constructor Details

    • ReceivedDebit

      public ReceivedDebit()

  • 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 ReceivedDebitCollection list(Map<String,Object> params) throws StripeException
      Returns a list of ReceivedDebits.
      Throws:
      StripeException

    • list

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

    • list

      public static ReceivedDebitCollection list(ReceivedDebitListParams params) throws StripeException
      Returns a list of ReceivedDebits.
      Throws:
      StripeException

    • list

      public static ReceivedDebitCollection list(ReceivedDebitListParams params, RequestOptions options) throws StripeException
      Returns a list of ReceivedDebits.
      Throws:
      StripeException

    • retrieve

      public static ReceivedDebit retrieve(String id) throws StripeException
      Retrieves the details of an existing ReceivedDebit by passing the unique ReceivedDebit ID from the ReceivedDebit list.
      Throws:
      StripeException

    • retrieve

      public static ReceivedDebit retrieve(String id, RequestOptions options) throws StripeException
      Retrieves the details of an existing ReceivedDebit by passing the unique ReceivedDebit ID from the ReceivedDebit list.
      Throws:
      StripeException

    • retrieve

      public static ReceivedDebit retrieve(String id, Map<String,Object> params, RequestOptions options) throws StripeException
      Retrieves the details of an existing ReceivedDebit by passing the unique ReceivedDebit ID from the ReceivedDebit list.
      Throws:
      StripeException

    • retrieve

      public static ReceivedDebit retrieve(String id, ReceivedDebitRetrieveParams params, RequestOptions options) throws StripeException
      Retrieves the details of an existing ReceivedDebit by passing the unique ReceivedDebit ID from the ReceivedDebit list.
      Throws:
      StripeException

    • setResponseGetter

      public void setResponseGetter(StripeResponseGetter responseGetter)
      Description copied from interface: StripeActiveObject
      Method is used by the containing object or StripeResponseGetter implementations to set the StripeResponseGetter instance used to make further requests.
      Specified by:
      setResponseGetter in interface StripeActiveObject
      Overrides:
      setResponseGetter in class ApiResource
      Parameters:
      responseGetter - the StripeResponseGetter instance to use for making further requests.

    • getAmount

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

    • getCreated

      public Long getCreated()
      Time at which the object was created. Measured in seconds since the Unix epoch.

    • getCurrency

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

    • getDescription

      public String getDescription()
      An arbitrary string attached to the object. Often useful for displaying to users.

    • getFailureCode

      public String getFailureCode()
      Reason for the failure. A ReceivedDebit might fail because the FinancialAccount doesn't have sufficient funds, is closed, or is frozen.

      One of account_closed, account_frozen, insufficient_funds, international_transaction, or other.

    • getFinancialAccount

      public String getFinancialAccount()
      The FinancialAccount that funds were pulled 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.

    • getInitiatingPaymentMethodDetails

      public ReceivedDebit.InitiatingPaymentMethodDetails getInitiatingPaymentMethodDetails()

    • getLinkedFlows

      public ReceivedDebit.LinkedFlows getLinkedFlows()

    • getLivemode

      public Boolean getLivemode()
      If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

    • getNetwork

      public String getNetwork()
      The network used for the ReceivedDebit.

      One of ach, card, or stripe.

    • getObject

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

      Equal to treasury.received_debit.

    • getReversalDetails

      public ReceivedDebit.ReversalDetails getReversalDetails()
      Details describing when a ReceivedDebit might be reversed.

    • getStatus

      public String getStatus()
      Status of the ReceivedDebit. ReceivedDebits are created with a status of either succeeded (approved) or failed (declined). The failure reason can be found under the failure_code.

      One of failed, or succeeded.

    • setAmount

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

    • setCreated

      public void setCreated(Long created)
      Time at which the object was created. Measured in seconds since the Unix epoch.

    • setCurrency

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

    • setDescription

      public void setDescription(String description)
      An arbitrary string attached to the object. Often useful for displaying to users.

    • setFailureCode

      public void setFailureCode(String failureCode)
      Reason for the failure. A ReceivedDebit might fail because the FinancialAccount doesn't have sufficient funds, is closed, or is frozen.

      One of account_closed, account_frozen, insufficient_funds, international_transaction, or other.

    • setFinancialAccount

      public void setFinancialAccount(String financialAccount)
      The FinancialAccount that funds were pulled 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.

    • setInitiatingPaymentMethodDetails

      public void setInitiatingPaymentMethodDetails(ReceivedDebit.InitiatingPaymentMethodDetails initiatingPaymentMethodDetails)

    • setLinkedFlows

      public void setLinkedFlows(ReceivedDebit.LinkedFlows linkedFlows)

    • setLivemode

      public void setLivemode(Boolean livemode)
      If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

    • setNetwork

      public void setNetwork(String network)
      The network used for the ReceivedDebit.

      One of ach, card, 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.received_debit.

    • setReversalDetails

      public void setReversalDetails(ReceivedDebit.ReversalDetails reversalDetails)
      Details describing when a ReceivedDebit might be reversed.

    • setStatus

      public void setStatus(String status)
      Status of the ReceivedDebit. ReceivedDebits are created with a status of either succeeded (approved) or failed (declined). The failure reason can be found under the failure_code.

      One of failed, or succeeded.

    • 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