com.stripe.stripeterminal.model.external

Class PaymentIntentParameters

com.stripe.stripeterminal.model.external.PaymentIntentParameters

public class PaymentIntentParameters

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

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

See Also:

class PaymentIntent, class PaymentIntentParameters.Builder

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
java.lang.Integer	getAmount() The amount of the payment, provided in the currency's smallest unit.
java.lang.Integer	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. To use an application fee, the request must be made on behalf of another account, using the stripeAccount property or an OAuth key.
java.lang.String	getCurrency() Three-letter ISO currency code, in lowercase. Must be a supported currency.
java.lang.String	getCustomer() The ID of the Customer this class PaymentIntent is for, if one exists.
java.lang.String	getDescription() An arbitrary string attached to the object. If you send a receipt email for this payment, the email will include the description.
java.util.Map<java.lang.String,java.lang.String>	getMetadata() 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.
java.lang.String	getOnBehalfOf() The Stripe account ID for which these funds are intended.
java.lang.String	getReceiptEmail() Email address that the receipt for the resulting payment will be sent to.
java.lang.String	getStatementDescriptor() 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.
java.lang.String	getTransferDataDestination() 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.
java.lang.String	getTransferGroup() A string that identifies the resulting payment as part of a group.

Method Detail

getAmount

@Nullable
public java.lang.Integer getAmount()

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

Zero Decimal

See Also:

Zero Decimal

getApplicationFeeAmount

@Nullable
public java.lang.Integer 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. To use an application fee, the request must be made on behalf of another account, using the stripeAccount property or an OAuth key.

The amount must be provided as an int in the currency's smallest unit.

Collecting Fees

See Also:

Collecting Fees

getCurrency

@Nullable
public java.lang.String getCurrency()

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

Currencies

See Also:

Currencies

getCustomer

@Nullable
public java.lang.String getCustomer()

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

See Also:

class PaymentIntent

getDescription

@Nullable
public java.lang.String getDescription()

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

getOnBehalfOf

@Nullable
public java.lang.String getOnBehalfOf()

The Stripe account ID for which these funds are intended.

When transferDataDestination is specified, onBehalfOf must also be specified and must match the destination of the transfer.

On Behalf Of

See Also:

On Behalf Of

getReceiptEmail

@Nullable
public java.lang.String getReceiptEmail()

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

Receipts

See Also:

Receipts

getStatementDescriptor

@Nullable
public java.lang.String getStatementDescriptor()

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.

getTransferDataDestination

@Nullable
public java.lang.String getTransferDataDestination()

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.

At capture time, use transfer_dataamount to specify the amount that will be transferred automatically when a charge succeeds.

See Also:

amount

getTransferGroup

@Nullable
public java.lang.String getTransferGroup()

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

Grouping Transactions

See Also:

Grouping Transactions

getMetadata

@Nullable
public java.util.Map<java.lang.String,java.lang.String> getMetadata()

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.