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
,StripeObjectInterface
A Mandate is a record of the permission a customer has given you to debit their payment method.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
static class
The user agent of the browser from which the Mandate was accepted by the customer.static class
static class
Nested classes/interfaces inherited from class com.stripe.net.ApiResource
ApiResource.RequestMethod
-
Field Summary
Fields inherited from class com.stripe.net.ApiResource
CHARSET, GSON
Fields inherited from class com.stripe.model.StripeObject
PRETTY_PRINT_GSON
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected boolean
boolean
getId()
Unique identifier for the object.Has the valuetrue
if the object exists in live mode or the valuefalse
if the object exists in test mode.String representing the object's type.Get ID of expandablepaymentMethod
object.Get expandedpaymentMethod
.The status of the mandate, which indicates whether it can be used to initiate a payment.getType()
The type of the mandate.int
hashCode()
static Mandate
Retrieves a Mandate object.static Mandate
retrieve
(String mandate, RequestOptions options) Retrieves a Mandate object.static Mandate
retrieve
(String mandate, MandateRetrieveParams params, RequestOptions options) Retrieves a Mandate object.static Mandate
Retrieves a Mandate object.void
setCustomerAcceptance
(Mandate.CustomerAcceptance customerAcceptance) void
Unique identifier for the object.void
setLivemode
(Boolean livemode) Has the valuetrue
if the object exists in live mode or the valuefalse
if the object exists in test mode.void
setMultiUse
(Mandate.MultiUse multiUse) void
String representing the object's type.void
void
setPaymentMethodDetails
(Mandate.PaymentMethodDetails paymentMethodDetails) void
setPaymentMethodObject
(PaymentMethod expandableObject) void
setSingleUse
(Mandate.SingleUse singleUse) void
The status of the mandate, which indicates whether it can be used to initiate a payment.void
The type of the mandate.Methods inherited from class com.stripe.net.ApiResource
checkNullTypedParams, classUrl, classUrl, fullUrl, instanceUrl, instanceUrl, request, request, requestCollection, requestCollection, requestSearchResult, requestSearchResult, requestStream, requestStream, setExpandableFieldId, setStripeResponseGetter, singleClassUrl, singleClassUrl, subresourceUrl, urlEncode, urlEncodeId
Methods inherited from class com.stripe.model.StripeObject
equals, getLastResponse, getRawJsonObject, setLastResponse, toJson, toString
-
Constructor Details
-
Mandate
public Mandate()
-
-
Method Details
-
getPaymentMethod
Get ID of expandablepaymentMethod
object. -
setPaymentMethod
-
getPaymentMethodObject
Get expandedpaymentMethod
. -
setPaymentMethodObject
-
retrieve
Retrieves a Mandate object.- Throws:
StripeException
-
retrieve
Retrieves a Mandate object.- Throws:
StripeException
-
retrieve
public static Mandate retrieve(String mandate, Map<String, Object> params, RequestOptions options) throws StripeExceptionRetrieves a Mandate object.- Throws:
StripeException
-
retrieve
public static Mandate retrieve(String mandate, MandateRetrieveParams params, RequestOptions options) throws StripeException Retrieves a Mandate object.- Throws:
StripeException
-
getCustomerAcceptance
-
getLivemode
Has the valuetrue
if the object exists in live mode or the valuefalse
if the object exists in test mode. -
getMultiUse
-
getObject
String representing the object's type. Objects of the same type share the same value.Equal to
mandate
. -
getPaymentMethodDetails
-
getSingleUse
-
getStatus
The status of the mandate, which indicates whether it can be used to initiate a payment.One of
active
,inactive
, orpending
. -
getType
The type of the mandate.One of
multi_use
, orsingle_use
. -
setCustomerAcceptance
-
setId
Unique identifier for the object. -
setLivemode
Has the valuetrue
if the object exists in live mode or the valuefalse
if the object exists in test mode. -
setMultiUse
-
setObject
String representing the object's type. Objects of the same type share the same value.Equal to
mandate
. -
setPaymentMethodDetails
-
setSingleUse
-
setStatus
The status of the mandate, which indicates whether it can be used to initiate a payment.One of
active
,inactive
, orpending
. -
setType
The type of the mandate.One of
multi_use
, orsingle_use
. -
equals
-
canEqual
-
hashCode
public int hashCode() -
getId
Unique identifier for the object.
-