PaymentIntentCreateParams (stripe-java 18.10.0 API)

java.lang.Object
- com.stripe.net.ApiRequestParams
- - com.stripe.param.PaymentIntentCreateParams

public class PaymentIntentCreateParams
extends ApiRequestParams

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`PaymentIntentCreateParams.Builder`
`static class`	`PaymentIntentCreateParams.CaptureMethod` Add all map key/value pairs to `extraParams` map.
`static class`	`PaymentIntentCreateParams.ConfirmationMethod`
`static class`	`PaymentIntentCreateParams.MandateData`
`static class`	`PaymentIntentCreateParams.OffSession`
`static class`	`PaymentIntentCreateParams.PaymentMethodOptions` The user agent of the browser from which the Mandate was accepted by the customer.
`static class`	`PaymentIntentCreateParams.SetupFutureUsage`
`static class`	`PaymentIntentCreateParams.Shipping` Type of installment plan, one of `fixed_count`.
`static class`	`PaymentIntentCreateParams.TransferData` State, county, province, or region.

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

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static PaymentIntentCreateParams.Builder`	`builder()`
`java.lang.Long`	`getAmount()` Amount intended to be collected by this PaymentIntent.
`java.lang.Long`	`getApplicationFeeAmount()` The amount of the application fee (if any) that will be applied to the payment and transferred to the application owner's Stripe account.
`PaymentIntentCreateParams.CaptureMethod`	`getCaptureMethod()` Controls when the funds will be captured from the customer's account.
`java.lang.Boolean`	`getConfirm()` Set to `true` to attempt to confirm this PaymentIntent immediately.
`PaymentIntentCreateParams.ConfirmationMethod`	`getConfirmationMethod()`
`java.lang.String`	`getCurrency()` Three-letter ISO currency code, in lowercase.
`java.lang.String`	`getCustomer()` ID of the Customer this PaymentIntent belongs to, if one exists.
`java.lang.String`	`getDescription()` An arbitrary string attached to the object.
`java.lang.Boolean`	`getErrorOnRequiresAction()` Set to `true` to fail the payment attempt if the PaymentIntent transitions into `requires_action`.
`java.util.List<java.lang.String>`	`getExpand()` Specifies which fields in the response should be expanded.
`java.util.Map<java.lang.String,java.lang.Object>`	`getExtraParams()` Map of extra parameters for custom features not available in this client library.
`java.lang.String`	`getMandate()` ID of the mandate to be used for this payment.
`PaymentIntentCreateParams.MandateData`	`getMandateData()` This hash contains details about the Mandate to create.
`java.util.Map<java.lang.String,java.lang.String>`	`getMetadata()` Set of key-value pairs that you can attach to an object.
`java.lang.Object`	`getOffSession()` Set to `true` to indicate that the customer is not in your checkout flow during this payment attempt, and therefore is unable to authenticate.
`java.lang.String`	`getOnBehalfOf()` The Stripe account ID for which these funds are intended.
`java.lang.String`	`getPaymentMethod()` ID of the payment method (a PaymentMethod, Card, or compatible Source object) to attach to this PaymentIntent.
`PaymentIntentCreateParams.PaymentMethodOptions`	`getPaymentMethodOptions()` Payment-method-specific configuration for this PaymentIntent.
`java.util.List<java.lang.String>`	`getPaymentMethodTypes()` The list of payment method types (e.g.
`java.lang.String`	`getReceiptEmail()` Email address that the receipt for the resulting payment will be sent to.
`java.lang.String`	`getReturnUrl()` The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site.
`java.lang.Boolean`	`getSavePaymentMethod()` If the PaymentIntent has a `payment_method` and a `customer` or if you're attaching a payment method to the PaymentIntent in this request, you can pass `save_payment_method=true` to save the payment method to the customer immediately.
`PaymentIntentCreateParams.SetupFutureUsage`	`getSetupFutureUsage()` Indicates that you intend to make future payments with this PaymentIntent's payment method.
`PaymentIntentCreateParams.Shipping`	`getShipping()` Shipping information for this PaymentIntent.
`java.lang.String`	`getSource()` This is a legacy field that will be removed in the future.
`java.lang.String`	`getStatementDescriptor()` For non-card charges, you can use this value as the complete description that appears on your customers’ statements.
`java.lang.String`	`getStatementDescriptorSuffix()` Provides information about a card payment that customers see on their statements.
`PaymentIntentCreateParams.TransferData`	`getTransferData()` The parameters used to automatically create a Transfer when the payment succeeds.
`java.lang.String`	`getTransferGroup()` A string that identifies the resulting payment as part of a group.
`java.lang.Boolean`	`getUseStripeSdk()` Set to `true` only when using manual confirmation and the iOS or Android SDKs to handle additional authentication steps.

Methods inherited from class com.stripe.net.ApiRequestParams
toMap

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - builder
```
public static PaymentIntentCreateParams.Builder builder()
```
  - getAmount
```
public java.lang.Long getAmount()
```
    Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or equivalent in charge currency. The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).
  - getApplicationFeeAmount
```
public java.lang.Long getApplicationFeeAmount()
```
    The amount of the application fee (if any) that will be applied to the payment and transferred to the application owner's Stripe account. For more information, see the PaymentIntents use case for connected accounts.
  - getCaptureMethod
```
public PaymentIntentCreateParams.CaptureMethod getCaptureMethod()
```
    Controls when the funds will be captured from the customer's account.
  - getConfirm
```
public java.lang.Boolean getConfirm()
```
    Set to true to attempt to confirm this PaymentIntent immediately. This parameter defaults to false. When creating and confirming a PaymentIntent at the same time, parameters available in the confirm API may also be provided.
  - getConfirmationMethod
```
public PaymentIntentCreateParams.ConfirmationMethod getConfirmationMethod()
```
  - getCurrency
```
public java.lang.String getCurrency()
```
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
  - getCustomer
```
public java.lang.String getCustomer()
```
    ID of the Customer this PaymentIntent belongs to, if one exists.
    Payment methods attached to other Customers cannot be used with this PaymentIntent.
    If present in combination with setup_future_usage, this PaymentIntent's payment method will be attached to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete.
  - getDescription
```
public java.lang.String getDescription()
```
    An arbitrary string attached to the object. Often useful for displaying to users.
  - getErrorOnRequiresAction
```
public java.lang.Boolean getErrorOnRequiresAction()
```
    Set to true to fail the payment attempt if the PaymentIntent transitions into requires_action. This parameter is intended for simpler integrations that do not handle customer actions, like saving cards without authentication. This parameter can only be used with confirm=true.
  - getExpand
```
public java.util.List<java.lang.String> getExpand()
```
    Specifies which fields in the response should be expanded.
  - getExtraParams
```
public java.util.Map<java.lang.String,java.lang.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.
  - getMandate
```
public java.lang.String getMandate()
```
    ID of the mandate to be used for this payment. This parameter can only be used with confirm=true.
  - getMandateData
```
public PaymentIntentCreateParams.MandateData getMandateData()
```
    This hash contains details about the Mandate to create. This parameter can only be used with confirm=true.
  - getMetadata
```
public java.util.Map<java.lang.String,java.lang.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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
  - getOffSession
```
public java.lang.Object getOffSession()
```
    Set to true to indicate that the customer is not in your checkout flow during this payment attempt, and therefore is unable to authenticate. This parameter is intended for scenarios where you collect card details and charge them later. This parameter can only be used with confirm=true.
  - getOnBehalfOf
```
public java.lang.String getOnBehalfOf()
```
    The Stripe account ID for which these funds are intended. For details, see the PaymentIntents use case for connected accounts.
  - getPaymentMethod
```
public java.lang.String getPaymentMethod()
```
    ID of the payment method (a PaymentMethod, Card, or compatible Source object) to attach to this PaymentIntent.
    If neither the payment_method parameter nor the source parameter are provided with confirm=true, source will be automatically populated with customer.default_source to improve the migration experience for users of the Charges API. We recommend that you explicitly provide the payment_method going forward.
  - getPaymentMethodOptions
```
public PaymentIntentCreateParams.PaymentMethodOptions getPaymentMethodOptions()
```
    Payment-method-specific configuration for this PaymentIntent.
  - getPaymentMethodTypes
```
public java.util.List<java.lang.String> getPaymentMethodTypes()
```
    The list of payment method types (e.g. card) that this PaymentIntent is allowed to use. If this is not provided, defaults to ["card"].
  - getReceiptEmail
```
public java.lang.String getReceiptEmail()
```
    Email address that the receipt for the resulting payment will be sent to.
  - getReturnUrl
```
public java.lang.String getReturnUrl()
```
    The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter can only be used with confirm=true.
  - getSavePaymentMethod
```
public java.lang.Boolean getSavePaymentMethod()
```
    If the PaymentIntent has a payment_method and a customer or if you're attaching a payment method to the PaymentIntent in this request, you can pass save_payment_method=true to save the payment method to the customer immediately.
    If the payment method is already saved to a customer, this parameter does nothing. If this type of payment method cannot be saved to a customer, the request will error.
    Saving a payment method using this parameter is not recommended because it will save the payment method even if it cannot be charged (e.g. the user made a typo). To ensure that only payment methods which are likely to be chargeable are saved to a customer, use the (setup_future_usage)[#payment_intents/object#payment_intent_object-setup_future_usage] property, which saves the payment method after the PaymentIntent has been confirmed and all required actions by the customer are complete.
  - getSetupFutureUsage
```
public PaymentIntentCreateParams.SetupFutureUsage getSetupFutureUsage()
```
    Indicates that you intend to make future payments with this PaymentIntent's payment method.
    Providing this parameter will attach the payment method to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be attached to a Customer after the transaction completes.
    For more, learn to save card details during payment.
    Stripe uses setup_future_usage to dynamically optimize your payment flow and comply with regional legislation and network rules. For example, if your customer is impacted by SCA, using off_session will ensure that they are authenticated while processing this PaymentIntent. You will then be able to collect off-session payments for this customer.
  - getShipping
```
public PaymentIntentCreateParams.Shipping getShipping()
```
    Shipping information for this PaymentIntent.
  - getSource
```
public java.lang.String getSource()
```
    This is a legacy field that will be removed in the future. It is the ID of the Source object to attach to this PaymentIntent. Please use the payment_method field instead, which also supports Cards and compatible Source objects.If neither the payment_method parameter nor the source parameter are provided with confirm=true, this field will be automatically populated with customer.default_source to improve the migration experience for users of the Charges API. We recommend that you explicitly provide the source or payment_method parameter going forward.
  - getStatementDescriptor
```
public java.lang.String getStatementDescriptor()
```
    For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters.
  - getStatementDescriptorSuffix
```
public java.lang.String getStatementDescriptorSuffix()
```
    Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor.
  - getTransferData
```
public PaymentIntentCreateParams.TransferData getTransferData()
```
    The parameters used to automatically create a Transfer when the payment succeeds. For more information, see the PaymentIntents use case for connected accounts.
  - getTransferGroup
```
public java.lang.String getTransferGroup()
```
    A string that identifies the resulting payment as part of a group. See the PaymentIntents use case for connected accounts for details.
  - getUseStripeSdk
```
public java.lang.Boolean getUseStripeSdk()
```
    Set to true only when using manual confirmation and the iOS or Android SDKs to handle additional authentication steps.

Class PaymentIntentCreateParams

Nested Class Summary

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

Field Summary

Fields inherited from class com.stripe.net.ApiRequestParams

Method Summary

Methods inherited from class com.stripe.net.ApiRequestParams

Methods inherited from class java.lang.Object

Method Detail

builder

getAmount

getApplicationFeeAmount

getCaptureMethod

getConfirm

getConfirmationMethod

getCurrency

getCustomer

getDescription

getErrorOnRequiresAction

getExpand

getExtraParams

getMandate

getMandateData

getMetadata

getOffSession

getOnBehalfOf

getPaymentMethod

getPaymentMethodOptions

getPaymentMethodTypes

getReceiptEmail

getReturnUrl

getSavePaymentMethod

getSetupFutureUsage

getShipping

getSource

getStatementDescriptor

getStatementDescriptorSuffix

getTransferData

getTransferGroup

getUseStripeSdk