Package com.stripe.param.identity

Class VerificationSessionListParams

java.lang.Object

com.stripe.net.ApiRequestParams

com.stripe.param.identity.VerificationSessionListParams

public class VerificationSessionListParams
extends ApiRequestParams

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VerificationSessionListParams.Builder
static class	VerificationSessionListParams.Created
static enum	VerificationSessionListParams.Status	Maximum value to filter by (inclusive).

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

ApiRequestParams.EnumParam

Field Summary

Fields inherited from class com.stripe.net.ApiRequestParams

EXTRA_PARAMS_KEY

Method Summary

Modifier and Type	Method	Description
static VerificationSessionListParams.Builder	builder()
String	getClientReferenceId()	A string to reference this user.
Object	getCreated()	Only return VerificationSessions that were created during the given date interval.
String	getEndingBefore()	A cursor for use in pagination.
List<String>	getExpand()	Specifies which fields in the response should be expanded.
Map<String,Object>	getExtraParams()	Map of extra parameters for custom features not available in this client library.
Long	getLimit()	A limit on the number of objects to be returned.
String	getRelatedCustomer()
String	getStartingAfter()	A cursor for use in pagination.
VerificationSessionListParams.Status	getStatus()	Only return VerificationSessions with this status.

Methods inherited from class com.stripe.net.ApiRequestParams

paramsToMap, toMap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

builder

public static VerificationSessionListParams.Builder builder()

getClientReferenceId

public String getClientReferenceId()

A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.

getCreated

public Object getCreated()

Only return VerificationSessions that were created during the given date interval.

getEndingBefore

public String getEndingBefore()

A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.

getExpand

public List<String> getExpand()

Specifies which fields in the response should be expanded.

getExtraParams

public Map<String,Object> getExtraParams()

Map of extra parameters for custom features not available in this client library. The content in this map is not serialized under this field's @SerializedName value. Instead, each key/value pair is serialized as if the key is a root-level field (serialized) name in this param object. Effectively, this map is flattened to its parent instance.

getLimit

public Long getLimit()

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

getRelatedCustomer

public String getRelatedCustomer()

getStartingAfter

public String getStartingAfter()

A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

getStatus

public VerificationSessionListParams.Status getStatus()

Only return VerificationSessions with this status. Learn more about the lifecycle of sessions.