Package com.stripe.param.threedsecure

Class AuthenticationCreateParams

java.lang.Object
com.stripe.net.ApiRequestParams
com.stripe.param.threedsecure.AuthenticationCreateParams
public class AuthenticationCreateParams extends ApiRequestParams

  • Method Details

    • builder

      public static AuthenticationCreateParams.Builder builder()

    • getAcquirerDetails

      public AuthenticationCreateParams.AcquirerDetails getAcquirerDetails()
      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.

    • getAmount

      public Long getAmount()
      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

    • getChannel

      public AuthenticationCreateParams.Channel getChannel()
      Required. Contains additional details on the channel used for this 3DS Authentication.

    • getCurrency

      public String getCurrency()
      Three-letter ISO currency code, in lowercase. Must be a supported currency.

    • getDirectoryServer

      public AuthenticationCreateParams.DirectoryServer getDirectoryServer()
      The 3DS directory server with which this 3DS Authentication was processed.

    • 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.

    • getFlowPreference

      public AuthenticationCreateParams.FlowPreference getFlowPreference()
      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.

    • getFutureUsage

      public AuthenticationCreateParams.FutureUsage getFutureUsage()
      Contains information about future usage of this 3DS Authentication.

    • getMessageCategory

      public AuthenticationCreateParams.MessageCategory getMessageCategory()
      Required. Indicates whether this 3DS Authentication is being performed for a payment or non-payment use case.

    • getMetadata

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

    • getPaymentMethod

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

    • getPaymentMethodData

      public AuthenticationCreateParams.PaymentMethodData getPaymentMethodData()
      Hash used to generate the PaymentMethod to be used for this Authentication. This is mutually exclusive with the payment_method parameter.

    • getReason

      public AuthenticationCreateParams.Reason getReason()
      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.

    • getShippingAddress

      public AuthenticationCreateParams.ShippingAddress getShippingAddress()
      The shipping address requested by the cardholder. You should try to include as complete address information as possible.

    • getSubmit

      public AuthenticationCreateParams.Submit getSubmit()
      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.

    • 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