Package com.stripe.model

Class SetupAttempt

java.lang.Object
com.stripe.model.StripeObject
com.stripe.net.ApiResource
com.stripe.model.SetupAttempt
All Implemented Interfaces:
HasId, StripeActiveObject, StripeObjectInterface
public class SetupAttempt extends ApiResource implements HasId
A SetupAttempt describes one attempted confirmation of a SetupIntent, whether that confirmation is successful or unsuccessful. You can use SetupAttempts to inspect details of a specific attempt at setting up a payment method using a SetupIntent.

  • Constructor Details

    • SetupAttempt

      public SetupAttempt()

  • Method Details

    • getApplication

      public String getApplication()
      Get ID of expandable application object.

    • setApplication

      public void setApplication(String id)

    • getApplicationObject

      public Application getApplicationObject()
      Get expanded application.

    • setApplicationObject

      public void setApplicationObject(Application expandableObject)

    • getCustomer

      public String getCustomer()
      Get ID of expandable customer object.

    • setCustomer

      public void setCustomer(String id)

    • getCustomerObject

      public Customer getCustomerObject()
      Get expanded customer.

    • setCustomerObject

      public void setCustomerObject(Customer expandableObject)

    • getOnBehalfOf

      public String getOnBehalfOf()
      Get ID of expandable onBehalfOf object.

    • setOnBehalfOf

      public void setOnBehalfOf(String id)

    • getOnBehalfOfObject

      public Account getOnBehalfOfObject()
      Get expanded onBehalfOf.

    • setOnBehalfOfObject

      public void setOnBehalfOfObject(Account expandableObject)

    • getPaymentMethod

      public String getPaymentMethod()
      Get ID of expandable paymentMethod object.

    • setPaymentMethod

      public void setPaymentMethod(String id)

    • getPaymentMethodObject

      public PaymentMethod getPaymentMethodObject()
      Get expanded paymentMethod.

    • setPaymentMethodObject

      public void setPaymentMethodObject(PaymentMethod expandableObject)

    • getSetupIntent

      public String getSetupIntent()
      Get ID of expandable setupIntent object.

    • setSetupIntent

      public void setSetupIntent(String id)

    • getSetupIntentObject

      public SetupIntent getSetupIntentObject()
      Get expanded setupIntent.

    • setSetupIntentObject

      public void setSetupIntentObject(SetupIntent expandableObject)

    • list

      public static SetupAttemptCollection list(Map<String,Object> params) throws StripeException
      Returns a list of SetupAttempts that associate with a provided SetupIntent.
      Throws:
      StripeException

    • list

      public static SetupAttemptCollection list(Map<String,Object> params, RequestOptions options) throws StripeException
      Returns a list of SetupAttempts that associate with a provided SetupIntent.
      Throws:
      StripeException

    • list

      public static SetupAttemptCollection list(SetupAttemptListParams params) throws StripeException
      Returns a list of SetupAttempts that associate with a provided SetupIntent.
      Throws:
      StripeException

    • list

      public static SetupAttemptCollection list(SetupAttemptListParams params, RequestOptions options) throws StripeException
      Returns a list of SetupAttempts that associate with a provided SetupIntent.
      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.

    • getAttachToSelf

      public Boolean getAttachToSelf()
      If present, the SetupIntent's payment method will be attached to the in-context Stripe Account.

      It can only be used for this Stripe Account’s own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer.

    • getCreated

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

    • getCustomerAccount

      public String getCustomerAccount()
      The value of customer_account on the SetupIntent at the time of this confirmation.

    • getFlowDirections

      public List<String> getFlowDirections()
      Indicates the directions of money movement for which this payment method is intended to be used.

      Include inbound if you intend to use the payment method as the origin to pull funds from. Include outbound if you intend to use the payment method as the destination to send funds to. You can include both if you intend to use the payment method for both purposes.

    • 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.

    • getObject

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

      Equal to setup_attempt.

    • getPaymentMethodDetails

      public SetupAttempt.PaymentMethodDetails getPaymentMethodDetails()

    • getSetupError

      public StripeError getSetupError()
      The error encountered during this attempt to confirm the SetupIntent, if any.

    • getStatus

      public String getStatus()
      Status of this SetupAttempt, one of requires_confirmation, requires_action, processing, succeeded, failed, or abandoned.

    • getUsage

      public String getUsage()
      The value of usage on the SetupIntent at the time of this confirmation, one of off_session or on_session.

    • setAttachToSelf

      public void setAttachToSelf(Boolean attachToSelf)
      If present, the SetupIntent's payment method will be attached to the in-context Stripe Account.

      It can only be used for this Stripe Account’s own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer.

    • setCreated

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

    • setCustomerAccount

      public void setCustomerAccount(String customerAccount)
      The value of customer_account on the SetupIntent at the time of this confirmation.

    • setFlowDirections

      public void setFlowDirections(List<String> flowDirections)
      Indicates the directions of money movement for which this payment method is intended to be used.

      Include inbound if you intend to use the payment method as the origin to pull funds from. Include outbound if you intend to use the payment method as the destination to send funds to. You can include both if you intend to use the payment method for both purposes.

    • 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.

    • setObject

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

      Equal to setup_attempt.

    • setPaymentMethodDetails

      public void setPaymentMethodDetails(SetupAttempt.PaymentMethodDetails paymentMethodDetails)

    • setSetupError

      public void setSetupError(StripeError setupError)
      The error encountered during this attempt to confirm the SetupIntent, if any.

    • setStatus

      public void setStatus(String status)
      Status of this SetupAttempt, one of requires_confirmation, requires_action, processing, succeeded, failed, or abandoned.

    • setUsage

      public void setUsage(String usage)
      The value of usage on the SetupIntent at the time of this confirmation, one of off_session or on_session.

    • 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