Package com.stripe.model

Class EphemeralKey

java.lang.Object

com.stripe.model.StripeObject

com.stripe.net.ApiResource

com.stripe.model.EphemeralKey

All Implemented Interfaces:

HasId, StripeActiveObject, StripeObjectInterface

public class EphemeralKey
extends ApiResource
implements HasId

Ephemeral keys give the SDKs (like Stripe's mobile SDKs and Issuing Elements) temporary, scoped access to a specific resource, such as a Customer, Issuing Card, or Identity VerificationSession, without exposing your secret API key.

Related guides: Using Issuing Elements.

Nested Class Summary

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
EphemeralKey()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
static EphemeralKey	create(EphemeralKeyCreateParams params)	Creates a short-lived API key for a given resource.
static EphemeralKey	create(EphemeralKeyCreateParams params, RequestOptions options)	Creates a short-lived API key for a given resource.
static EphemeralKey	create(Map<String,Object> params)	Creates a short-lived API key for a given resource.
static EphemeralKey	create(Map<String,Object> params, RequestOptions options)	Creates a short-lived API key for a given resource.
EphemeralKey	delete()	Invalidates a short-lived API key for a given resource.
EphemeralKey	delete(RequestOptions options)	Invalidates a short-lived API key for a given resource.
EphemeralKey	delete(EphemeralKeyDeleteParams params)	Invalidates a short-lived API key for a given resource.
EphemeralKey	delete(EphemeralKeyDeleteParams params, RequestOptions options)	Invalidates a short-lived API key for a given resource.
EphemeralKey	delete(Map<String,Object> params)	Invalidates a short-lived API key for a given resource.
EphemeralKey	delete(Map<String,Object> params, RequestOptions options)	Invalidates a short-lived API key for a given resource.
boolean	equals(Object o)
Long	getCreated()	Time at which the object was created.
Long	getExpires()	Time at which the key will expire.
String	getId()	Unique identifier for the object.
Boolean	getLivemode()	If the object exists in live mode, the value is true.
String	getObject()	String representing the object's type.
String	getRawJson()
String	getSecret()	The key's secret.
int	hashCode()
void	setCreated(Long created)	Time at which the object was created.
void	setExpires(Long expires)	Time at which the key will expire.
void	setId(String id)	Unique identifier for the object.
void	setLivemode(Boolean livemode)	If the object exists in live mode, the value is true.
void	setObject(String object)	String representing the object's type.
void	setRawJson(String rawJson)
void	setSecret(String secret)	The key's secret.

Methods inherited from class com.stripe.net.ApiResource

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

Methods inherited from class com.stripe.model.StripeObject

deserializeStripeObject, 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

EphemeralKey

public EphemeralKey()

Method Details

create

public static EphemeralKey create(Map<String,Object> params)
                           throws StripeException

Creates a short-lived API key for a given resource.

Throws:

StripeException

create

public static EphemeralKey create(Map<String,Object> params,
 RequestOptions options)
                           throws StripeException

Creates a short-lived API key for a given resource.

Throws:

StripeException

create

public static EphemeralKey create(EphemeralKeyCreateParams params)
                           throws StripeException

Creates a short-lived API key for a given resource.

Throws:

StripeException

create

public static EphemeralKey create(EphemeralKeyCreateParams params,
 RequestOptions options)
                           throws StripeException

Creates a short-lived API key for a given resource.

Throws:

StripeException

delete

public EphemeralKey delete()
                    throws StripeException

Invalidates a short-lived API key for a given resource.

Throws:

StripeException

delete

public EphemeralKey delete(RequestOptions options)
                    throws StripeException

Invalidates a short-lived API key for a given resource.

Throws:

StripeException

delete

public EphemeralKey delete(Map<String,Object> params)
                    throws StripeException

Invalidates a short-lived API key for a given resource.

Throws:

StripeException

delete

public EphemeralKey delete(Map<String,Object> params,
 RequestOptions options)
                    throws StripeException

Invalidates a short-lived API key for a given resource.

Throws:

StripeException

delete

public EphemeralKey delete(EphemeralKeyDeleteParams params)
                    throws StripeException

Invalidates a short-lived API key for a given resource.

Throws:

StripeException

delete

public EphemeralKey delete(EphemeralKeyDeleteParams params,
 RequestOptions options)
                    throws StripeException

Invalidates a short-lived API key for a given resource.

Throws:

StripeException

getCreated

public Long getCreated()

Time at which the object was created. Measured in seconds since the Unix epoch.

getExpires

public Long getExpires()

Time at which the key will expire. Measured in seconds since the Unix epoch.

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.

getObject

public String getObject()

String representing the object's type. Objects of the same type share the same value.

Equal to ephemeral_key.

getSecret

public String getSecret()

The key's secret. You can use this value to make authorized requests to the Stripe API.

getRawJson

public String getRawJson()

setCreated

public void setCreated(Long created)

Time at which the object was created. Measured in seconds since the Unix epoch.

setExpires

public void setExpires(Long expires)

Time at which the key will expire. Measured in seconds since the Unix epoch.

setId

public void setId(String id)

Unique identifier for the object.

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.

setObject

public void setObject(String object)

String representing the object's type. Objects of the same type share the same value.

Equal to ephemeral_key.

setSecret

public void setSecret(String secret)

The key's secret. You can use this value to make authorized requests to the Stripe API.

setRawJson

public void setRawJson(String rawJson)

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