PaymentIntentParameters

class 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
Link copied to clipboard
class Builder(allowedPaymentMethodTypes: List<PaymentMethodType>)
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
Link copied to clipboard
val allowedPaymentMethodTypes: List<PaymentMethodType>
amount
Link copied to clipboard
val amount: Long?
The amount of the payment, provided in the currency's smallest unit.
applicationFeeAmount
Link copied to clipboard
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.
captureMethod
Link copied to clipboard
val captureMethod: String?
currency
Link copied to clipboard
val currency: String?
Three-letter ISO currency code, in lowercase.
customer
Link copied to clipboard
val customer: String?
The ID of the Customer this PaymentIntent is for, if one exists.
description
Link copied to clipboard
val description: String?
An arbitrary string attached to the object.
metadata
Link copied to clipboard
val metadata: Map<String, String>?
Map of key-value pairs that you can attach to an object.
onBehalfOf
Link copied to clipboard
val onBehalfOf: String?
The Stripe account ID for which these funds are intended.
receiptEmail
Link copied to clipboard
val receiptEmail: String?
Email address that the receipt for the resulting payment will be sent to.
setupFutureUsage
Link copied to clipboard
val setupFutureUsage: String?
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
statementDescriptor
Link copied to clipboard
val statementDescriptor: String?
A string to be displayed on your customer's credit card statement.
transferDataDestination
Link copied to clipboard
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
Link copied to clipboard
val transferGroup: String?
A string that identifies the resulting payment as part of a group.