Package com.stripe.param.identity

Class VerificationSessionCreateParams.Builder

java.lang.Object

com.stripe.param.identity.VerificationSessionCreateParams.Builder

Enclosing class:

VerificationSessionCreateParams

public static class VerificationSessionCreateParams.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
VerificationSessionCreateParams.Builder	addAllExpand(List<String> elements)	Add all elements to `expand` list.
VerificationSessionCreateParams.Builder	addExpand(String element)	Add an element to `expand` list.
VerificationSessionCreateParams	build()	Finalize and obtain parameter instance from this builder.
VerificationSessionCreateParams.Builder	putAllExtraParam(Map<String,Object> map)	Add all map key/value pairs to `extraParams` map.
VerificationSessionCreateParams.Builder	putAllMetadata(Map<String,String> map)	Add all map key/value pairs to `metadata` map.
VerificationSessionCreateParams.Builder	putExtraParam(String key, Object value)	Add a key/value pair to `extraParams` map.
VerificationSessionCreateParams.Builder	putMetadata(String key, String value)	Add a key/value pair to `metadata` map.
VerificationSessionCreateParams.Builder	setClientReferenceId(String clientReferenceId)	A string to reference this user.
VerificationSessionCreateParams.Builder	setOptions(VerificationSessionCreateParams.Options options)	A set of options for the session’s verification checks.
VerificationSessionCreateParams.Builder	setProvidedDetails(VerificationSessionCreateParams.ProvidedDetails providedDetails)	Details provided about the user being verified.
VerificationSessionCreateParams.Builder	setRelatedCustomer(String relatedCustomer)	Token referencing a Customer resource.
VerificationSessionCreateParams.Builder	setReturnUrl(String returnUrl)	The URL that the user will be redirected to upon completing the verification flow.
VerificationSessionCreateParams.Builder	setType(VerificationSessionCreateParams.Type type)	The type of verification check to be performed.
VerificationSessionCreateParams.Builder	setVerificationFlow(String verificationFlow)	The ID of a Verification Flow from the Dashboard.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

build

public VerificationSessionCreateParams build()

Finalize and obtain parameter instance from this builder.

setClientReferenceId

public VerificationSessionCreateParams.Builder setClientReferenceId(String clientReferenceId)

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.

addExpand

public VerificationSessionCreateParams.Builder addExpand(String element)

Add an element to `expand` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See VerificationSessionCreateParams.expand for the field documentation.

addAllExpand

public VerificationSessionCreateParams.Builder addAllExpand(List<String> elements)

Add all elements to `expand` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See VerificationSessionCreateParams.expand for the field documentation.

putExtraParam

public VerificationSessionCreateParams.Builder putExtraParam(String key,
 Object value)

Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See VerificationSessionCreateParams.extraParams for the field documentation.

putAllExtraParam

public VerificationSessionCreateParams.Builder putAllExtraParam(Map<String,Object> map)

Add all map key/value pairs to `extraParams` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See VerificationSessionCreateParams.extraParams for the field documentation.

putMetadata

public VerificationSessionCreateParams.Builder putMetadata(String key,
 String value)

Add a key/value pair to `metadata` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See VerificationSessionCreateParams.metadata for the field documentation.

putAllMetadata

public VerificationSessionCreateParams.Builder putAllMetadata(Map<String,String> map)

Add all map key/value pairs to `metadata` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See VerificationSessionCreateParams.metadata for the field documentation.

setOptions

public VerificationSessionCreateParams.Builder setOptions(VerificationSessionCreateParams.Options options)

A set of options for the session’s verification checks.

setProvidedDetails

public VerificationSessionCreateParams.Builder setProvidedDetails(VerificationSessionCreateParams.ProvidedDetails providedDetails)

Details provided about the user being verified. These details may be shown to the user.

setRelatedCustomer

public VerificationSessionCreateParams.Builder setRelatedCustomer(String relatedCustomer)

Token referencing a Customer resource.

setReturnUrl

public VerificationSessionCreateParams.Builder setReturnUrl(String returnUrl)

The URL that the user will be redirected to upon completing the verification flow.

setType

public VerificationSessionCreateParams.Builder setType(VerificationSessionCreateParams.Type type)

The type of verification check to be performed. You must provide a type if not passing verification_flow.

setVerificationFlow

public VerificationSessionCreateParams.Builder setVerificationFlow(String verificationFlow)

The ID of a Verification Flow from the Dashboard. See https://docs.stripe.com/identity/verification-flows.