Package com.stripe.model

Class Mandate

java.lang.Object
com.stripe.model.StripeObject
com.stripe.net.ApiResource
com.stripe.model.Mandate
All Implemented Interfaces:
HasId, StripeActiveObject, StripeObjectInterface
public class Mandate extends ApiResource implements HasId
A Mandate is a record of the permission that your customer gives you to debit their payment method.

  • Constructor Details

    • Mandate

      public Mandate()

  • Method Details

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

    • retrieve

      public static Mandate retrieve(String mandate) throws StripeException
      Retrieves a Mandate object.
      Throws:
      StripeException

    • retrieve

      public static Mandate retrieve(String mandate, RequestOptions options) throws StripeException
      Retrieves a Mandate object.
      Throws:
      StripeException

    • retrieve

      public static Mandate retrieve(String mandate, Map<String,Object> params, RequestOptions options) throws StripeException
      Retrieves a Mandate object.
      Throws:
      StripeException

    • retrieve

      public static Mandate retrieve(String mandate, MandateRetrieveParams params, RequestOptions options) throws StripeException
      Retrieves a Mandate object.
      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.

    • getCustomerAcceptance

      public Mandate.CustomerAcceptance getCustomerAcceptance()

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

    • getMultiUse

      public Mandate.MultiUse getMultiUse()

    • getObject

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

      Equal to mandate.

    • getOnBehalfOf

      public String getOnBehalfOf()
      The account (if any) that the mandate is intended for.

    • getPaymentMethodDetails

      public Mandate.PaymentMethodDetails getPaymentMethodDetails()

    • getSingleUse

      public Mandate.SingleUse getSingleUse()

    • getStatus

      public String getStatus()
      The mandate status indicates whether or not you can use it to initiate a payment.

      One of active, inactive, or pending.

    • getType

      public String getType()
      The type of the mandate.

      One of multi_use, or single_use.

    • setCustomerAcceptance

      public void setCustomerAcceptance(Mandate.CustomerAcceptance customerAcceptance)

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

    • setMultiUse

      public void setMultiUse(Mandate.MultiUse multiUse)

    • setObject

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

      Equal to mandate.

    • setOnBehalfOf

      public void setOnBehalfOf(String onBehalfOf)
      The account (if any) that the mandate is intended for.

    • setPaymentMethodDetails

      public void setPaymentMethodDetails(Mandate.PaymentMethodDetails paymentMethodDetails)

    • setSingleUse

      public void setSingleUse(Mandate.SingleUse singleUse)

    • setStatus

      public void setStatus(String status)
      The mandate status indicates whether or not you can use it to initiate a payment.

      One of active, inactive, or pending.

    • setType

      public void setType(String type)
      The type of the mandate.

      One of multi_use, or single_use.

    • 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