PaymentIntentCreateParams (stripe-java 15.0.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.OffSession`
`static class`	`PaymentIntentCreateParams.PaymentMethodOptions`
`static class`	`PaymentIntentCreateParams.SetupFutureUsage`
`static class`	`PaymentIntentCreateParams.Shipping` Type of installment plan, one of `fixed_count`.
`static class`	`PaymentIntentCreateParams.TransferData` Add all map key/value pairs to `extraParams` map.

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()` A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency).
`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()` One of `automatic` (default) or `manual`.
`java.lang.Boolean`	`getConfirm()` Set to `true` to attempt to [confirm](https://stripe.com/docs/api/payment_intents/confirm) this PaymentIntent immediately.
`PaymentIntentCreateParams.ConfirmationMethod`	`getConfirmationMethod()` One of `automatic` (default) or `manual`.
`java.lang.String`	`getCurrency()` Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), 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.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.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, BankAccount, or saved 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.
`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()
```
    A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (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](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). 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](https://stripe.com/docs/payments/payment-intents/use-cases#connected-accounts).
  - getCaptureMethod
```
public PaymentIntentCreateParams.CaptureMethod getCaptureMethod()
```
    One of `automatic` (default) or `manual`.
    When the capture method is `automatic`, Stripe automatically captures funds when the customer authorizes the payment.
    Change `capture_method` to manual if you wish to [separate authorization and capture](https://stripe.com/docs/payments/payment-intents/creating-payment-intents#separate-authorization-and-capture) for payment methods that support this.
  - getConfirm
```
public java.lang.Boolean getConfirm()
```
    Set to `true` to attempt to [confirm](https://stripe.com/docs/api/payment_intents/confirm) this PaymentIntent immediately. This parameter defaults to `false`. When creating and confirming a PaymentIntent at the same time, parameters available in the [confirm](https://stripe.com/docs/api/payment_intents/confirm) API may also be provided.
  - getConfirmationMethod
```
public PaymentIntentCreateParams.ConfirmationMethod getConfirmationMethod()
```
    One of `automatic` (default) or `manual`.
    When the confirmation method is `automatic`, a PaymentIntent can be confirmed using a publishable key. After `next_action`s are handled, no additional confirmation is required to complete the payment.
    When the confirmation method is `manual`, all payment attempts must be made using a secret key. The PaymentIntent returns to the `requires_confirmation` state after handling `next_action`s, and requires your server to initiate each payment attempt with an explicit confirmation.
    Learn more about the different [confirmation flows](https://stripe.com/docs/payments/payment-intents/use-cases#one-time-payments).
  - getCurrency
```
public java.lang.String getCurrency()
```
    Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
  - getCustomer
```
public java.lang.String getCustomer()
```
    ID of the Customer this PaymentIntent belongs to, if one exists.
    If present, payment methods used with this PaymentIntent can only be attached to this Customer, and payment methods attached to other Customers cannot be used with this PaymentIntent.
  - getDescription
```
public java.lang.String getDescription()
```
    An arbitrary string attached to the object. Often useful for displaying to users.
  - 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.
  - 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.
  - 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](https://stripe.com/docs/payments/cards/charging-saved-cards). This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm).
  - 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](https://stripe.com/docs/payments/payment-intents/use-cases#connected-accounts).
  - getPaymentMethod
```
public java.lang.String getPaymentMethod()
```
    ID of the payment method (a PaymentMethod, Card, BankAccount, or saved Source object) to attach to this PaymentIntent.
  - 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`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm).
  - 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. Defaults to `false`.
    If the payment method is already saved to a customer, this does nothing. If this type of payment method cannot be saved to a customer, the request will error.
  - getSetupFutureUsage
```
public PaymentIntentCreateParams.SetupFutureUsage getSetupFutureUsage()
```
    Indicates that you intend to make future payments with this PaymentIntent's payment method.
    If present, the payment method used with this PaymentIntent can be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer, even after the transaction completes.
    Use `on_session` if you intend to only reuse the payment method when your customer is present in your checkout flow. Use `off_session` if your customer may or may not be in your checkout flow. See [Saving card details after a payment](https://stripe.com/docs/payments/cards/saving-cards-after-payment) to learn more.
    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](https://stripe.com/docs/strong-customer-authentication), using `off_session` will ensure that they are authenticated while processing this PaymentIntent. You will then be able to collect [off-session payments](https://stripe.com/docs/payments/cards/charging-saved-cards#off-session-payments-with-saved-cards) 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 Source, Card, and BankAccount objects.
  - 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](https://stripe.com/docs/payments/payment-intents/use-cases#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](https://stripe.com/docs/payments/payment-intents/use-cases#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

getExpand

getExtraParams

getMetadata

getOffSession

getOnBehalfOf

getPaymentMethod

getPaymentMethodOptions

getPaymentMethodTypes

getReceiptEmail

getReturnUrl

getSavePaymentMethod

getSetupFutureUsage

getShipping

getSource

getStatementDescriptor

getStatementDescriptorSuffix

getTransferData

getTransferGroup

getUseStripeSdk