Package com.stripe.param.threedsecure

Class AuthenticationCreateParams.Builder

java.lang.Object

com.stripe.param.threedsecure.AuthenticationCreateParams.Builder

Enclosing class:

AuthenticationCreateParams

public static class AuthenticationCreateParams.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
AuthenticationCreateParams.Builder	addAllExpand(List<String> elements)	Add all elements to `expand` list.
AuthenticationCreateParams.Builder	addExpand(String element)	Add an element to `expand` list.
AuthenticationCreateParams	build()	Finalize and obtain parameter instance from this builder.
AuthenticationCreateParams.Builder	putAllExtraParam(Map<String,Object> map)	Add all map key/value pairs to `extraParams` map.
AuthenticationCreateParams.Builder	putAllMetadata(Map<String,String> map)	Add all map key/value pairs to `metadata` map.
AuthenticationCreateParams.Builder	putExtraParam(String key, Object value)	Add a key/value pair to `extraParams` map.
AuthenticationCreateParams.Builder	putMetadata(String key, String value)	Add a key/value pair to `metadata` map.
AuthenticationCreateParams.Builder	setAcquirerDetails(AuthenticationCreateParams.AcquirerDetails acquirerDetails)	Contains additional details about the acquirer for this 3DS Authentication.
AuthenticationCreateParams.Builder	setAmount(Long amount)	A non-negative integer representing the amount in the smallest currency unit.
AuthenticationCreateParams.Builder	setChannel(AuthenticationCreateParams.Channel channel)	Required. Contains additional details on the channel used for this 3DS Authentication.
AuthenticationCreateParams.Builder	setCurrency(String currency)	Three-letter ISO currency code, in lowercase.
AuthenticationCreateParams.Builder	setDirectoryServer(AuthenticationCreateParams.DirectoryServer directoryServer)	The 3DS directory server with which this 3DS Authentication was processed.
AuthenticationCreateParams.Builder	setFlowPreference(AuthenticationCreateParams.FlowPreference flowPreference)	Contains additional details on your flow preference for this 3DS Authentication.
AuthenticationCreateParams.Builder	setFutureUsage(AuthenticationCreateParams.FutureUsage futureUsage)	Contains information about future usage of this 3DS Authentication.
AuthenticationCreateParams.Builder	setMessageCategory(AuthenticationCreateParams.MessageCategory messageCategory)	Required. Indicates whether this 3DS Authentication is being performed for a payment or non-payment use case.
AuthenticationCreateParams.Builder	setMetadata(EmptyParam metadata)	Set of key-value pairs that you can attach to an object.
AuthenticationCreateParams.Builder	setMetadata(Map<String,String> metadata)	Set of key-value pairs that you can attach to an object.
AuthenticationCreateParams.Builder	setPaymentMethod(String paymentMethod)	ID of the payment method (a PaymentMethod object) to attach to this 3DS Authentication.
AuthenticationCreateParams.Builder	setPaymentMethodData(AuthenticationCreateParams.PaymentMethodData paymentMethodData)	Hash used to generate the PaymentMethod to be used for this Authentication.
AuthenticationCreateParams.Builder	setReason(AuthenticationCreateParams.Reason reason)	The reason for invoking standalone 3DS.
AuthenticationCreateParams.Builder	setShippingAddress(AuthenticationCreateParams.ShippingAddress shippingAddress)	The shipping address requested by the cardholder.
AuthenticationCreateParams.Builder	setSubmit(AuthenticationCreateParams.Submit submit)	Set to always to skip the fingerprinting step and submit this Authentication immediately or if_fingerprinting_not_supported to submit this Authentication only if fingerprinting is not available.

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 AuthenticationCreateParams build()

Finalize and obtain parameter instance from this builder.

setAcquirerDetails

public AuthenticationCreateParams.Builder setAcquirerDetails(AuthenticationCreateParams.AcquirerDetails acquirerDetails)

Contains additional details about the acquirer for this 3DS Authentication.

Refer to the Pass acquirer details and directory server section of the standalone 3DS guide for more information.

setAmount

public AuthenticationCreateParams.Builder setAmount(Long amount)

A non-negative integer representing the amount in the smallest currency unit. You can't include this parameter if message_category is non_payment_authentication

setChannel

public AuthenticationCreateParams.Builder setChannel(AuthenticationCreateParams.Channel channel)

Required. Contains additional details on the channel used for this 3DS Authentication.

setCurrency

public AuthenticationCreateParams.Builder setCurrency(String currency)

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

setDirectoryServer

public AuthenticationCreateParams.Builder setDirectoryServer(AuthenticationCreateParams.DirectoryServer directoryServer)

The 3DS directory server with which this 3DS Authentication was processed.

addExpand

public AuthenticationCreateParams.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 AuthenticationCreateParams.expand for the field documentation.

addAllExpand

public AuthenticationCreateParams.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 AuthenticationCreateParams.expand for the field documentation.

putExtraParam

public AuthenticationCreateParams.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 AuthenticationCreateParams.extraParams for the field documentation.

putAllExtraParam

public AuthenticationCreateParams.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 AuthenticationCreateParams.extraParams for the field documentation.

setFlowPreference

public AuthenticationCreateParams.Builder setFlowPreference(AuthenticationCreateParams.FlowPreference flowPreference)

Contains additional details on your flow preference for this 3DS Authentication.

Refer to the Specify a flow preference section of the standalone 3DS guide for more information.

setFutureUsage

public AuthenticationCreateParams.Builder setFutureUsage(AuthenticationCreateParams.FutureUsage futureUsage)

Contains information about future usage of this 3DS Authentication.

setMessageCategory

public AuthenticationCreateParams.Builder setMessageCategory(AuthenticationCreateParams.MessageCategory messageCategory)

Required. Indicates whether this 3DS Authentication is being performed for a payment or non-payment use case.

putMetadata

public AuthenticationCreateParams.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 AuthenticationCreateParams.metadata for the field documentation.

putAllMetadata

public AuthenticationCreateParams.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 AuthenticationCreateParams.metadata for the field documentation.

setMetadata

public AuthenticationCreateParams.Builder setMetadata(EmptyParam 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

setMetadata

public AuthenticationCreateParams.Builder 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

setPaymentMethod

public AuthenticationCreateParams.Builder setPaymentMethod(String paymentMethod)

ID of the payment method (a PaymentMethod object) to attach to this 3DS Authentication.

setPaymentMethodData

public AuthenticationCreateParams.Builder setPaymentMethodData(AuthenticationCreateParams.PaymentMethodData paymentMethodData)

Hash used to generate the PaymentMethod to be used for this Authentication. This is mutually exclusive with the payment_method parameter.

setReason

public AuthenticationCreateParams.Builder setReason(AuthenticationCreateParams.Reason reason)

The reason for invoking standalone 3DS. This is tailored specifically for cases when you want Stripe to help determine the standalone 3DS flow to fit your use case instead of needing to select a specific 3DS flow.

This parameter is exclusive with flow_preference. You can either use reason for controlling 3DS according to your business requirements, or use flow_preference for having fine-grained control over your 3DS flow preference.

setShippingAddress

public AuthenticationCreateParams.Builder setShippingAddress(AuthenticationCreateParams.ShippingAddress shippingAddress)

The shipping address requested by the cardholder. You should try to include as complete address information as possible.

setSubmit

public AuthenticationCreateParams.Builder setSubmit(AuthenticationCreateParams.Submit submit)

Set to always to skip the fingerprinting step and submit this Authentication immediately or if_fingerprinting_not_supported to submit this Authentication only if fingerprinting is not available. This parameter defaults to never.

Refer to the Submit at creation section of the standalone 3DS guide for more information.