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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Mandate.CustomerAcceptance	For more details about CustomerAcceptance, please refer to the API Reference.
static class	Mandate.MultiUse	For more details about MultiUse, please refer to the API Reference.
static class	Mandate.PaymentMethodDetails	For more details about PaymentMethodDetails, please refer to the API Reference.
static class	Mandate.SingleUse	For more details about SingleUse, please refer to the API Reference.

Nested classes/interfaces inherited from class com.stripe.net.ApiResource

ApiResource.RequestMethod

Field Summary

Fields inherited from class com.stripe.net.ApiResource

CHARSET, GSON, INTERNAL_GSON

Fields inherited from class com.stripe.model.StripeObject

PRETTY_PRINT_GSON

Constructor Summary

Constructors

Constructor	Description
Mandate()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
Mandate.CustomerAcceptance	getCustomerAcceptance()
String	getId()	Unique identifier for the object.
Boolean	getLivemode()	Has the value true if the object exists in live mode or the value false if the object exists in test mode.
Mandate.MultiUse	getMultiUse()
String	getObject()	String representing the object's type.
String	getOnBehalfOf()	The account (if any) that the mandate is intended for.
String	getPaymentMethod()	Get ID of expandable paymentMethod object.
Mandate.PaymentMethodDetails	getPaymentMethodDetails()
PaymentMethod	getPaymentMethodObject()	Get expanded paymentMethod.
Mandate.SingleUse	getSingleUse()
String	getStatus()	The mandate status indicates whether or not you can use it to initiate a payment.
String	getType()	The type of the mandate.
int	hashCode()
static MandateCollection	list(MandateListParams params)	Retrieves a list of Mandates for a given PaymentMethod.
static MandateCollection	list(MandateListParams params, RequestOptions options)	Retrieves a list of Mandates for a given PaymentMethod.
static MandateCollection	list(Map<String,Object> params)	Retrieves a list of Mandates for a given PaymentMethod.
static MandateCollection	list(Map<String,Object> params, RequestOptions options)	Retrieves a list of Mandates for a given PaymentMethod.
static Mandate	retrieve(String 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	retrieve(String mandate, Map<String,Object> params, RequestOptions options)	Retrieves a Mandate object.
void	setCustomerAcceptance(Mandate.CustomerAcceptance customerAcceptance)
void	setId(String id)	Unique identifier for the object.
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.
void	setMultiUse(Mandate.MultiUse multiUse)
void	setObject(String object)	String representing the object's type.
void	setOnBehalfOf(String onBehalfOf)	The account (if any) that the mandate is intended for.
void	setPaymentMethod(String id)
void	setPaymentMethodDetails(Mandate.PaymentMethodDetails paymentMethodDetails)
void	setPaymentMethodObject(PaymentMethod expandableObject)
void	setResponseGetter(StripeResponseGetter responseGetter)	Method is used by the containing object or StripeResponseGetter implementations to set the StripeResponseGetter instance used to make further requests.
void	setSingleUse(Mandate.SingleUse singleUse)
void	setStatus(String status)	The mandate status indicates whether or not you can use it to initiate a payment.
void	setType(String type)	The type of the mandate.

Methods inherited from class com.stripe.net.ApiResource

checkNullTypedParams, getGlobalResponseGetter, getResponseGetter, setExpandableFieldId, setGlobalResponseGetter, urlEncode, urlEncodeId

Methods inherited from class com.stripe.model.StripeObject

deserializeStripeObject, deserializeStripeObject, deserializeStripeObject, deserializeStripeObject, equals, getLastResponse, getRawJsonObject, setLastResponse, toJson, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.stripe.model.StripeActiveObject

trySetResponseGetter

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)

list

public static MandateCollection list(Map<String,Object> params)
                              throws StripeException

Retrieves a list of Mandates for a given PaymentMethod.

Throws:

StripeException

list

public static MandateCollection list(Map<String,Object> params,
 RequestOptions options)
                              throws StripeException

Retrieves a list of Mandates for a given PaymentMethod.

Throws:

StripeException

list

public static MandateCollection list(MandateListParams params)
                              throws StripeException

Retrieves a list of Mandates for a given PaymentMethod.

Throws:

StripeException

list

public static MandateCollection list(MandateListParams params,
 RequestOptions options)
                              throws StripeException

Retrieves a list of Mandates for a given PaymentMethod.

Throws:

StripeException

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