terminal-external-models/com.stripe.stripeterminal.external.models/PaymentIntentParameters

PaymentIntentParameters

The PaymentIntentParameters class contains information that will be used for the creation of a new PaymentIntent. To create a PaymentIntentParameters instance, the PaymentIntentParameters.Builder class should be used.

Use of this SDK is subject to the Stripe Terminal Terms: https://stripe.com/terminal/legal

Types

Builder

class Builder

The PaymentIntentParameters.Builder class provides a convenient way to create a new PaymentIntentParameters instance without having to deal with parameters that aren't relevant to your integration.

Properties

allowedPaymentMethodTypes

@Transient

val allowedPaymentMethodTypes: List<PaymentMethodType>

amount

val amount: Long?

The amount of the payment, provided in the currency's smallest unit.

applicationFeeAmount

val applicationFeeAmount: Long?

The amount of the application fee (if any) that will be applied to the payment and transferred to the application owner’s Stripe account. To use an application fee, the request must be made on behalf of another account, using the stripeAccount property or an OAuth key.

captureMethod

val captureMethod: CaptureMethod

Controls when the funds will be captured from the customer’s account.

currency

val currency: String?

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

customer

val customer: String?

The ID of the Customer this PaymentIntent is for, if one exists.

description

val description: String?

An arbitrary string attached to the object. If you send a receipt email for this payment, the email will include the description.

metadata

@Transient

val metadata: Map<String, String>?

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

onBehalfOf

val onBehalfOf: String?

The Stripe account ID for which these funds are intended.

paymentMethodOptionsParameters

val paymentMethodOptionsParameters: PaymentMethodOptionsParameters?

Payment-method-specific configuration for this PaymentIntent.

receiptEmail

val receiptEmail: String?

Email address that the receipt for the resulting payment will be sent to.

setupFutureUsage

val setupFutureUsage: String?

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.

statementDescriptor

val statementDescriptor: String?

A string to be displayed on your customer's credit card statement. This may be up to 22 characters. The statement descriptor must contain at least one letter, may not include <>"' characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped. While most banks and card issuers display this information consistently, some may display it incorrectly or not at all.

statementDescriptorSuffix

val statementDescriptorSuffix: String?

A string to specify details about the transaction so your customer can understand it clearly on their statement. The suffix is concatenated with the statementDescriptor, the * symbol, and a space to form the complete statement descriptor that your customer sees. Maximum 22 characters for the final concatenated descriptor.

transferDataDestination

val transferDataDestination: String?

The account (if any) the payment will be attributed to for tax reporting, and where funds from the payment will be transferred to upon payment success.

transferGroup

val transferGroup: String?

A string that identifies the resulting payment as part of a group.