Package com.stripe.model.delegatedcheckout

Class RequestedSession

java.lang.Object

com.stripe.model.StripeObject

com.stripe.net.ApiResource

com.stripe.model.delegatedcheckout.RequestedSession

All Implemented Interfaces:

HasId, MetadataStore<RequestedSession>, StripeActiveObject, StripeObjectInterface

public class RequestedSession
extends ApiResource
implements HasId, MetadataStore<RequestedSession>

A requested session is a session that has been requested by a customer.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RequestedSession.FulfillmentDetails	For more details about FulfillmentDetails, please refer to the API Reference.
static class	RequestedSession.LineItemDetail	For more details about LineItemDetail, please refer to the API Reference.
static class	RequestedSession.OrderDetails	For more details about OrderDetails, please refer to the API Reference.
static class	RequestedSession.PaymentMethodPreview	For more details about PaymentMethodPreview, please refer to the API Reference.
static class	RequestedSession.SellerDetails	For more details about SellerDetails, please refer to the API Reference.
static class	RequestedSession.TotalDetails	For more details about TotalDetails, 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
RequestedSession()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
RequestedSession	confirm()	Confirms a requested session.
RequestedSession	confirm(RequestOptions options)	Confirms a requested session.
RequestedSession	confirm(RequestedSessionConfirmParams params)	Confirms a requested session.
RequestedSession	confirm(RequestedSessionConfirmParams params, RequestOptions options)	Confirms a requested session.
RequestedSession	confirm(Map<String,Object> params)	Confirms a requested session.
RequestedSession	confirm(Map<String,Object> params, RequestOptions options)	Confirms a requested session.
static RequestedSession	create(RequestedSessionCreateParams params)	Creates a requested session.
static RequestedSession	create(RequestedSessionCreateParams params, RequestOptions options)	Creates a requested session.
static RequestedSession	create(Map<String,Object> params)	Creates a requested session.
static RequestedSession	create(Map<String,Object> params, RequestOptions options)	Creates a requested session.
boolean	equals(Object o)
RequestedSession	expire()	Expires a requested session.
RequestedSession	expire(RequestOptions options)	Expires a requested session.
RequestedSession	expire(RequestedSessionExpireParams params)	Expires a requested session.
RequestedSession	expire(RequestedSessionExpireParams params, RequestOptions options)	Expires a requested session.
RequestedSession	expire(Map<String,Object> params)	Expires a requested session.
RequestedSession	expire(Map<String,Object> params, RequestOptions options)	Expires a requested session.
Long	getAmountSubtotal()	The subtotal amount of the requested session.
Long	getAmountTotal()	The total amount of the requested session.
Long	getCreatedAt()	Time at which the object was created.
String	getCurrency()	Three-letter ISO currency code, in lowercase.
String	getCustomer()	The customer for this requested session.
Long	getExpiresAt()	Time at which the requested session expires.
RequestedSession.FulfillmentDetails	getFulfillmentDetails()	The details of the fulfillment.
String	getId()	Unique identifier for the object.
List<RequestedSession.LineItemDetail>	getLineItemDetails()	The line items to be purchased.
Boolean	getLivemode()	Has the value true if the object exists in live mode or the value false if the object exists in test mode.
Map<String,String>	getMetadata()	Set of key-value pairs that you can attach to an object.
String	getObject()	String representing the object's type.
RequestedSession.OrderDetails	getOrderDetails()	The details of the order.
String	getPaymentMethod()	The payment method used for the requested session.
RequestedSession.PaymentMethodPreview	getPaymentMethodPreview()	The preview of the payment method to be created when the requested session is confirmed.
RequestedSession.SellerDetails	getSellerDetails()
String	getSetupFutureUsage()	Whether or not the payment method should be saved for future use.
Map<String,String>	getSharedMetadata()	The metadata shared with the seller.
String	getSharedPaymentIssuedToken()	The SPT used for payment.
String	getStatus()	The status of the requested session.
RequestedSession.TotalDetails	getTotalDetails()
Long	getUpdatedAt()	Time at which the object was last updated.
int	hashCode()
static RequestedSession	retrieve(String requestedSession)	Retrieves a requested session.
static RequestedSession	retrieve(String requestedSession, RequestOptions options)	Retrieves a requested session.
static RequestedSession	retrieve(String requestedSession, RequestedSessionRetrieveParams params, RequestOptions options)	Retrieves a requested session.
static RequestedSession	retrieve(String requestedSession, Map<String,Object> params, RequestOptions options)	Retrieves a requested session.
void	setAmountSubtotal(Long amountSubtotal)	The subtotal amount of the requested session.
void	setAmountTotal(Long amountTotal)	The total amount of the requested session.
void	setCreatedAt(Long createdAt)	Time at which the object was created.
void	setCurrency(String currency)	Three-letter ISO currency code, in lowercase.
void	setCustomer(String customer)	The customer for this requested session.
void	setExpiresAt(Long expiresAt)	Time at which the requested session expires.
void	setFulfillmentDetails(RequestedSession.FulfillmentDetails fulfillmentDetails)	The details of the fulfillment.
void	setId(String id)	Unique identifier for the object.
void	setLineItemDetails(List<RequestedSession.LineItemDetail> lineItemDetails)	The line items to be purchased.
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	setMetadata(Map<String,String> metadata)	Set of key-value pairs that you can attach to an object.
void	setObject(String object)	String representing the object's type.
void	setOrderDetails(RequestedSession.OrderDetails orderDetails)	The details of the order.
void	setPaymentMethod(String paymentMethod)	The payment method used for the requested session.
void	setPaymentMethodPreview(RequestedSession.PaymentMethodPreview paymentMethodPreview)	The preview of the payment method to be created when the requested session is confirmed.
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	setSellerDetails(RequestedSession.SellerDetails sellerDetails)
void	setSetupFutureUsage(String setupFutureUsage)	Whether or not the payment method should be saved for future use.
void	setSharedMetadata(Map<String,String> sharedMetadata)	The metadata shared with the seller.
void	setSharedPaymentIssuedToken(String sharedPaymentIssuedToken)	The SPT used for payment.
void	setStatus(String status)	The status of the requested session.
void	setTotalDetails(RequestedSession.TotalDetails totalDetails)
void	setUpdatedAt(Long updatedAt)	Time at which the object was last updated.
RequestedSession	update(RequestedSessionUpdateParams params)	Updates a requested session.
RequestedSession	update(RequestedSessionUpdateParams params, RequestOptions options)	Updates a requested session.
RequestedSession	update(Map<String,Object> params)	Updates a requested session.
RequestedSession	update(Map<String,Object> params, RequestOptions options)	Updates a requested session.

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

RequestedSession

public RequestedSession()

Method Details

confirm

public RequestedSession confirm()
                         throws StripeException

Confirms a requested session.

Throws:

StripeException

confirm

public RequestedSession confirm(RequestOptions options)
                         throws StripeException

Confirms a requested session.

Throws:

StripeException

confirm

public RequestedSession confirm(Map<String,Object> params)
                         throws StripeException

Confirms a requested session.

Throws:

StripeException

confirm

public RequestedSession confirm(Map<String,Object> params,
 RequestOptions options)
                         throws StripeException

Confirms a requested session.

Throws:

StripeException

confirm

public RequestedSession confirm(RequestedSessionConfirmParams params)
                         throws StripeException

Confirms a requested session.

Throws:

StripeException

confirm

public RequestedSession confirm(RequestedSessionConfirmParams params,
 RequestOptions options)
                         throws StripeException

Confirms a requested session.

Throws:

StripeException

create

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

Creates a requested session.

Throws:

StripeException

create

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

Creates a requested session.

Throws:

StripeException

create

public static RequestedSession create(RequestedSessionCreateParams params)
                               throws StripeException

Creates a requested session.

Throws:

StripeException

create

public static RequestedSession create(RequestedSessionCreateParams params,
 RequestOptions options)
                               throws StripeException

Creates a requested session.

Throws:

StripeException

expire

public RequestedSession expire()
                        throws StripeException

Expires a requested session.

Throws:

StripeException

expire

public RequestedSession expire(RequestOptions options)
                        throws StripeException

Expires a requested session.

Throws:

StripeException

expire

public RequestedSession expire(Map<String,Object> params)
                        throws StripeException

Expires a requested session.

Throws:

StripeException

expire

public RequestedSession expire(Map<String,Object> params,
 RequestOptions options)
                        throws StripeException

Expires a requested session.

Throws:

StripeException

expire

public RequestedSession expire(RequestedSessionExpireParams params)
                        throws StripeException

Expires a requested session.

Throws:

StripeException

expire

public RequestedSession expire(RequestedSessionExpireParams params,
 RequestOptions options)
                        throws StripeException

Expires a requested session.

Throws:

StripeException

retrieve

public static RequestedSession retrieve(String requestedSession)
                                 throws StripeException

Retrieves a requested session.

Throws:

StripeException

retrieve

public static RequestedSession retrieve(String requestedSession,
 RequestOptions options)
                                 throws StripeException

Retrieves a requested session.

Throws:

StripeException

retrieve

public static RequestedSession retrieve(String requestedSession,
 Map<String,Object> params,
 RequestOptions options)
                                 throws StripeException

Retrieves a requested session.

Throws:

StripeException

retrieve

public static RequestedSession retrieve(String requestedSession,
 RequestedSessionRetrieveParams params,
 RequestOptions options)
                                 throws StripeException

Retrieves a requested session.

Throws:

StripeException

update

public RequestedSession update(Map<String,Object> params)
                        throws StripeException

Updates a requested session.

Specified by:

update in interface MetadataStore<RequestedSession>

Throws:

StripeException

update

public RequestedSession update(Map<String,Object> params,
 RequestOptions options)
                        throws StripeException

Updates a requested session.

Specified by:

update in interface MetadataStore<RequestedSession>

Throws:

StripeException

update

public RequestedSession update(RequestedSessionUpdateParams params)
                        throws StripeException

Updates a requested session.

Throws:

StripeException

update

public RequestedSession update(RequestedSessionUpdateParams params,
 RequestOptions options)
                        throws StripeException

Updates a requested session.

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.

getAmountSubtotal

public Long getAmountSubtotal()

The subtotal amount of the requested session.

getAmountTotal

public Long getAmountTotal()

The total amount of the requested session.

getCreatedAt

public Long getCreatedAt()

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

getCurrency

public String getCurrency()

Three-letter ISO currency code, in lowercase. Must be a supported currency.

getCustomer

public String getCustomer()

The customer for this requested session.

getExpiresAt

public Long getExpiresAt()

Time at which the requested session expires. Measured in seconds since the Unix epoch.

getFulfillmentDetails

public RequestedSession.FulfillmentDetails getFulfillmentDetails()

The details of the fulfillment.

getLineItemDetails

public List<RequestedSession.LineItemDetail> getLineItemDetails()

The line items to be purchased.

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 delegated_checkout.requested_session.

getOrderDetails

public RequestedSession.OrderDetails getOrderDetails()

The details of the order.

getPaymentMethod

public String getPaymentMethod()

The payment method used for the requested session.

getPaymentMethodPreview

public RequestedSession.PaymentMethodPreview getPaymentMethodPreview()

The preview of the payment method to be created when the requested session is confirmed.

getSellerDetails

public RequestedSession.SellerDetails getSellerDetails()

getSetupFutureUsage

public String getSetupFutureUsage()

Whether or not the payment method should be saved for future use.

Equal to on_session.

getSharedMetadata

public Map<String,String> getSharedMetadata()

The metadata shared with the seller.

getSharedPaymentIssuedToken

public String getSharedPaymentIssuedToken()

The SPT used for payment.

getStatus

public String getStatus()

The status of the requested session.

One of completed, expired, or open.

getTotalDetails

public RequestedSession.TotalDetails getTotalDetails()

getUpdatedAt

public Long getUpdatedAt()

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

setAmountSubtotal

public void setAmountSubtotal(Long amountSubtotal)

The subtotal amount of the requested session.

setAmountTotal

public void setAmountTotal(Long amountTotal)

The total amount of the requested session.

setCreatedAt

public void setCreatedAt(Long createdAt)

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

setCurrency

public void setCurrency(String currency)

Three-letter ISO currency code, in lowercase. Must be a supported currency.

setCustomer

public void setCustomer(String customer)

The customer for this requested session.

setExpiresAt

public void setExpiresAt(Long expiresAt)

Time at which the requested session expires. Measured in seconds since the Unix epoch.

setFulfillmentDetails

public void setFulfillmentDetails(RequestedSession.FulfillmentDetails fulfillmentDetails)

The details of the fulfillment.

setId

public void setId(String id)

Unique identifier for the object.

setLineItemDetails

public void setLineItemDetails(List<RequestedSession.LineItemDetail> lineItemDetails)

The line items to be purchased.

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.

setMetadata

public void setMetadata(Map<String,String> metadata)

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

setObject

public void setObject(String object)

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

Equal to delegated_checkout.requested_session.

setOrderDetails

public void setOrderDetails(RequestedSession.OrderDetails orderDetails)

The details of the order.

setPaymentMethod

public void setPaymentMethod(String paymentMethod)

The payment method used for the requested session.

setPaymentMethodPreview

public void setPaymentMethodPreview(RequestedSession.PaymentMethodPreview paymentMethodPreview)

The preview of the payment method to be created when the requested session is confirmed.

setSellerDetails

public void setSellerDetails(RequestedSession.SellerDetails sellerDetails)

setSetupFutureUsage

public void setSetupFutureUsage(String setupFutureUsage)

Whether or not the payment method should be saved for future use.

Equal to on_session.

setSharedMetadata

public void setSharedMetadata(Map<String,String> sharedMetadata)

The metadata shared with the seller.

setSharedPaymentIssuedToken

public void setSharedPaymentIssuedToken(String sharedPaymentIssuedToken)

The SPT used for payment.

setStatus

public void setStatus(String status)

The status of the requested session.

One of completed, expired, or open.

setTotalDetails

public void setTotalDetails(RequestedSession.TotalDetails totalDetails)

setUpdatedAt

public void setUpdatedAt(Long updatedAt)

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

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

getMetadata

public Map<String,String> getMetadata()

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

Specified by:

getMetadata in interface MetadataStore<RequestedSession>