PaymentIntent

com.stripe.stripeterminal.model.external.PaymentIntent

```
public class PaymentIntent
```
The PaymentIntent represents your intent to collect payment from a customer, tracking the lifecycle of the payment process through each step. Each PaymentIntent typically correlates with a single “cart” or customer session in your application.
Use of this SDK is subject to the Stripe Terminal Terms: https://stripe.com/terminal/legal

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`component1()` Get the unique identifier for the
`java.lang.String`	`component11()` Get the client secret returned by this intent.
`java.lang.String`	`component12()` One of `automatic` (default) or `manual`. When the confirmation method is automatic, a `class PaymentIntent` can be confirmed using a publishable key. After `next_actions` are handled, no additional confirmation is required to complete the payment.
`long`	`component13()` Time at which the
`java.lang.String`	`component14()` Three-letter ISO currency code,
`java.lang.String`	`component15()` ID of the Customer this
`java.lang.String`	`component16()` An arbitrary string attached to the
`java.lang.String`	`component17()` ID of the invoice that created this
`ApiError`	`component18()` The payment error encountered in the previous
`boolean`	`component19()` Has the value
`int`	`component2()` Get the amount of the
`java.util.Map<java.lang.String,java.lang.String>`	`component20()` Set of key-value pairs that you can attach to an object.
`java.lang.String`	`component21()` Return the account that the PaymentIntent is on behalf of
`java.lang.String`	`component22()` ID of the payment method used in this PaymentIntent.
`java.lang.String`	`component23()` Email address that the receipt for the resulting payment will be sent to.
`java.lang.String`	`component24()` ID of the review associated with this
`java.lang.String`	`component25()` Extra information about a
`PaymentIntentStatus`	`component26()` Status of this
`java.lang.String`	`component27()` Get the transfer group of this PaymentIntent
`int`	`component3()` Amount that can be captured from this
`int`	`component4()` Amount that was collected by this PaymentIntent.
`java.lang.String`	`component5()` ID of the Connect application that created the PaymentIntent
`int`	`component6()` The amount of the application fee for this PaymentIntent
`long`	`component7()` Populated when
`java.lang.String`	`component8()` Reason for cancellation of this
`java.lang.String`	`component9()` One of `automatic` (default) or `manual`. When the capture method is automatic, Stripe automatically captures funds when the customer authorizes the payment.
`PaymentIntent`	copy(java.lang.String id, int amount, int amountCapturable, int amountReceived, java.lang.String application, int applicationFeeAmount, long canceledAt, java.lang.String cancellationReason, java.lang.String captureMethod, com.stripe.stripeterminal.model.external.ChargesList charges, java.lang.String clientSecret, java.lang.String confirmationMethod, long created, java.lang.String currency, java.lang.String customer, java.lang.String description, java.lang.String invoice, ApiError lastPaymentError, boolean livemode, java.util.Map<java.lang.String,java.lang.String> metadata, java.lang.String onBehalfOf, java.lang.String paymentMethodId, java.lang.String receiptEmail, java.lang.String review, java.lang.String statementDescriptor, PaymentIntentStatus status, java.lang.String transferGroup) The `PaymentIntent` represents your intent to collect payment from a customer, tracking the lifecycle of the payment process through each step. Each `PaymentIntent` typically correlates with a single “cart” or customer session in your application.
`boolean`	`equals(java.lang.Object p)`
`int`	`getAmount()` Get the amount of the
`int`	`getAmountCapturable()` Amount that can be captured from this
`int`	`getAmountReceived()` Amount that was collected by this PaymentIntent.
`java.lang.String`	`getApplication()` ID of the Connect application that created the PaymentIntent
`int`	`getApplicationFeeAmount()` The amount of the application fee for this PaymentIntent
`long`	`getCanceledAt()` Populated when
`java.lang.String`	`getCancellationReason()` Reason for cancellation of this
`java.lang.String`	`getCaptureMethod()` One of `automatic` (default) or `manual`. When the capture method is automatic, Stripe automatically captures funds when the customer authorizes the payment.
`java.util.List<com.stripe.stripeterminal.model.external.Charge>`	`getCharges()` Return the `class Charge` objects associated with this PaymentIntent
`java.lang.String`	`getClientSecret()` Get the client secret returned by this intent.
`java.lang.String`	`getConfirmationMethod()` One of `automatic` (default) or `manual`. When the confirmation method is automatic, a `class PaymentIntent` can be confirmed using a publishable key. After `next_actions` are handled, no additional confirmation is required to complete the payment.
`long`	`getCreated()` Time at which the
`java.lang.String`	`getCurrency()` Three-letter ISO currency code,
`java.lang.String`	`getCustomer()` ID of the Customer this
`java.lang.String`	`getDescription()` An arbitrary string attached to the
`java.lang.String`	`getId()` Get the unique identifier for the
`java.lang.String`	`getInvoice()` ID of the invoice that created this
`ApiError`	`getLastPaymentError()` The payment error encountered in the previous
`boolean`	`getLivemode()` Has the value
`java.util.Map<java.lang.String,java.lang.String>`	`getMetadata()` Set of key-value pairs that you can attach to an object.
`java.lang.String`	`getOnBehalfOf()` Return the account that the PaymentIntent is on behalf of
`java.lang.String`	`getPaymentMethodId()` ID of the payment method used in this PaymentIntent.
`java.lang.String`	`getReceiptEmail()` Email address that the receipt for the resulting payment will be sent to.
`java.lang.String`	`getReview()` ID of the review associated with this
`java.lang.String`	`getStatementDescriptor()` Extra information about a
`PaymentIntentStatus`	`getStatus()` Status of this
`java.lang.String`	`getTransferGroup()` Get the transfer group of this PaymentIntent
`int`	`hashCode()`
`void`	`setStatus(PaymentIntentStatus p)` Status of this
`java.lang.String`	`toString()`

- Method Detail
  - getCharges
```
@NotNull
public java.util.List<com.stripe.stripeterminal.model.external.Charge> getCharges()
```
    Return the class Charge objects associated with this PaymentIntent
    
    See Also:
    
    class Charge
  - getId
```
@NotNull
public java.lang.String getId()
```
    Get the unique identifier for the
    class PaymentIntent
    
    See Also:
    
    class PaymentIntent
  - getAmount
```
public int getAmount()
```
    Get the amount of the
    class PaymentIntent
    
    See Also:
    
    class PaymentIntent
  - getAmountCapturable
```
public int getAmountCapturable()
```
    Amount that can be captured from this
    class PaymentIntent
    
    See Also:
    
    class PaymentIntent
  - getAmountReceived
```
public int getAmountReceived()
```
    Amount that was collected by this PaymentIntent.
  - getApplication
```
@Nullable
public java.lang.String getApplication()
```
    ID of the Connect application that created the PaymentIntent
  - getApplicationFeeAmount
```
public int getApplicationFeeAmount()
```
    The amount of the application fee for this PaymentIntent
  - getCanceledAt
```
public long getCanceledAt()
```
    Populated when
    status is PaymentIntentStatus.CANCELED, this is the time at which theclass PaymentIntent was canceled. Measured in seconds since the Unix epoch.
    
    See Also:
    
    class PaymentIntent
  - getCancellationReason
```
@Nullable
public java.lang.String getCancellationReason()
```
    Reason for cancellation of this
    class PaymentIntent, either user-provided (duplicate,fraudulent, requested_by_customer, or abandoned) or generated by Stripe internally(failed_invoice, void_invoice, or automatic).
    
    See Also:
    
    class PaymentIntent
  - getCaptureMethod
```
@Nullable
public java.lang.String getCaptureMethod()
```
    One of automatic (default) or manual. When the capture method is automatic, Stripe automatically captures funds when the customer authorizes the payment.
    Change this to manual if you wish to separate authorization and capture for payment methods that support this.
  - getClientSecret
```
@Nullable
public java.lang.String getClientSecret()
```
    Get the client secret returned by this intent.
  - getConfirmationMethod
```
@Nullable
public java.lang.String getConfirmationMethod()
```
    One of automatic (default) or manual. When the confirmation method is automatic, a class PaymentIntent can be confirmed using a publishable key. After next_actions 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 class PaymentIntent returns to the PaymentIntentStatus.REQUIRES_CONFIRMATION state after handling next_actions, and requires your server to initiate each payment attempt with an explicit confirmation.
    
    See Also:
    
    class PaymentIntent, class PaymentIntent
  - getCreated
```
public long getCreated()
```
    Time at which the
    class PaymentIntent was created. Measured in seconds since the Unix epoch.
    
    See Also:
    
    class PaymentIntent
  - getCurrency
```
@Nullable
public java.lang.String getCurrency()
```
    Three-letter ISO currency code,
    in lowercase. Must be a supported currency.
  - getCustomer
```
@Nullable
public java.lang.String getCustomer()
```
    ID of the Customer this
    class PaymentIntent belongs to, if one exists. If present, paymentmethods used with this class PaymentIntent can only be attached to this Customer, and paymentmethods attached to other Customers cannot be used with this class PaymentIntent.
    
    See Also:
    
    class PaymentIntent, class PaymentIntent, class PaymentIntent
  - getDescription
```
@Nullable
public java.lang.String getDescription()
```
    An arbitrary string attached to the
    class PaymentIntent. Often useful for displaying to users.
    
    See Also:
    
    class PaymentIntent
  - getInvoice
```
@Nullable
public java.lang.String getInvoice()
```
    ID of the invoice that created this
    class PaymentIntent, if it exists.
    
    See Also:
    
    class PaymentIntent
  - getLastPaymentError
```
@Nullable
public ApiError getLastPaymentError()
```
    The payment error encountered in the previous
    class PaymentIntent confirmation.
    
    See Also:
    
    class PaymentIntent
  - getLivemode
```
public boolean getLivemode()
```
    Has the value
    true if the object exists in live mode or the value false if the objectexists in test mode.
  - getMetadata
```
@Nullable
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 storingadditional information about the class PaymentIntent in a structured format.
    
    See Also:
    
    class PaymentIntent
  - getOnBehalfOf
```
@Nullable
public java.lang.String getOnBehalfOf()
```
    Return the account that the PaymentIntent is on behalf of
  - getPaymentMethodId
```
@Nullable
public java.lang.String getPaymentMethodId()
```
    ID of the payment method used in this PaymentIntent.
  - getReceiptEmail
```
@Nullable
public java.lang.String getReceiptEmail()
```
    Email address that the receipt for the resulting payment will be sent to.
  - getReview
```
@Nullable
public java.lang.String getReview()
```
    ID of the review associated with this
    class PaymentIntent, if any.
    
    See Also:
    
    class PaymentIntent
  - getStatementDescriptor
```
@Nullable
public java.lang.String getStatementDescriptor()
```
    Extra information about a
    class PaymentIntent. This will appear on your customer’s statement whenthis class PaymentIntent succeeds in creating a charge.
    
    See Also:
    
    class PaymentIntent, class PaymentIntent
  - getStatus
```
@Nullable
public PaymentIntentStatus getStatus()
```
    Status of this
    class PaymentIntent.
    
    See Also:
    
    class PaymentIntent
  - setStatus
```
public void setStatus(@Nullable
                      PaymentIntentStatus p)
```
    Status of this
    class PaymentIntent.
    
    Parameters:
    
    p - Status of this class PaymentIntent.
    
    See Also:
    
    class PaymentIntent
  - getTransferGroup
```
@Nullable
public java.lang.String getTransferGroup()
```
    Get the transfer group of this PaymentIntent
  - component1
```
@NotNull
public java.lang.String component1()
```
    Get the unique identifier for the
    class PaymentIntent
    
    See Also:
    
    class PaymentIntent
  - component2
```
public int component2()
```
    Get the amount of the
    class PaymentIntent
    
    See Also:
    
    class PaymentIntent
  - component3
```
public int component3()
```
    Amount that can be captured from this
    class PaymentIntent
    
    See Also:
    
    class PaymentIntent
  - component4
```
public int component4()
```
    Amount that was collected by this PaymentIntent.
  - component5
```
@Nullable
public java.lang.String component5()
```
    ID of the Connect application that created the PaymentIntent
  - component6
```
public int component6()
```
    The amount of the application fee for this PaymentIntent
  - component7
```
public long component7()
```
    Populated when
    status is PaymentIntentStatus.CANCELED, this is the time at which theclass PaymentIntent was canceled. Measured in seconds since the Unix epoch.
    
    See Also:
    
    class PaymentIntent
  - component8
```
@Nullable
public java.lang.String component8()
```
    Reason for cancellation of this
    class PaymentIntent, either user-provided (duplicate,fraudulent, requested_by_customer, or abandoned) or generated by Stripe internally(failed_invoice, void_invoice, or automatic).
    
    See Also:
    
    class PaymentIntent
  - component9
```
@Nullable
public java.lang.String component9()
```
    One of automatic (default) or manual. When the capture method is automatic, Stripe automatically captures funds when the customer authorizes the payment.
    Change this to manual if you wish to separate authorization and capture for payment methods that support this.
  - component11
```
@Nullable
public java.lang.String component11()
```
    Get the client secret returned by this intent.
  - component12
```
@Nullable
public java.lang.String component12()
```
    One of automatic (default) or manual. When the confirmation method is automatic, a class PaymentIntent can be confirmed using a publishable key. After next_actions 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 class PaymentIntent returns to the PaymentIntentStatus.REQUIRES_CONFIRMATION state after handling next_actions, and requires your server to initiate each payment attempt with an explicit confirmation.
    
    See Also:
    
    class PaymentIntent, class PaymentIntent
  - component13
```
public long component13()
```
    Time at which the
    class PaymentIntent was created. Measured in seconds since the Unix epoch.
    
    See Also:
    
    class PaymentIntent
  - component14
```
@Nullable
public java.lang.String component14()
```
    Three-letter ISO currency code,
    in lowercase. Must be a supported currency.
  - component15
```
@Nullable
public java.lang.String component15()
```
    ID of the Customer this
    class PaymentIntent belongs to, if one exists. If present, paymentmethods used with this class PaymentIntent can only be attached to this Customer, and paymentmethods attached to other Customers cannot be used with this class PaymentIntent.
    
    See Also:
    
    class PaymentIntent, class PaymentIntent, class PaymentIntent
  - component16
```
@Nullable
public java.lang.String component16()
```
    An arbitrary string attached to the
    class PaymentIntent. Often useful for displaying to users.
    
    See Also:
    
    class PaymentIntent
  - component17
```
@Nullable
public java.lang.String component17()
```
    ID of the invoice that created this
    class PaymentIntent, if it exists.
    
    See Also:
    
    class PaymentIntent
  - component18
```
@Nullable
public ApiError component18()
```
    The payment error encountered in the previous
    class PaymentIntent confirmation.
    
    See Also:
    
    class PaymentIntent
  - component19
```
public boolean component19()
```
    Has the value
    true if the object exists in live mode or the value false if the objectexists in test mode.
  - component20
```
@Nullable
public java.util.Map<java.lang.String,java.lang.String> component20()
```
    Set of key-value pairs that you can attach to an object.
    This can be useful for storingadditional information about the class PaymentIntent in a structured format.
    
    See Also:
    
    class PaymentIntent
  - component21
```
@Nullable
public java.lang.String component21()
```
    Return the account that the PaymentIntent is on behalf of
  - component22
```
@Nullable
public java.lang.String component22()
```
    ID of the payment method used in this PaymentIntent.
  - component23
```
@Nullable
public java.lang.String component23()
```
    Email address that the receipt for the resulting payment will be sent to.
  - component24
```
@Nullable
public java.lang.String component24()
```
    ID of the review associated with this
    class PaymentIntent, if any.
    
    See Also:
    
    class PaymentIntent
  - component25
```
@Nullable
public java.lang.String component25()
```
    Extra information about a
    class PaymentIntent. This will appear on your customer’s statement whenthis class PaymentIntent succeeds in creating a charge.
    
    See Also:
    
    class PaymentIntent, class PaymentIntent
  - component26
```
@Nullable
public PaymentIntentStatus component26()
```
    Status of this
    class PaymentIntent.
    
    See Also:
    
    class PaymentIntent
  - component27
```
@Nullable
public java.lang.String component27()
```
    Get the transfer group of this PaymentIntent
  - copy
```
@NotNull
public PaymentIntent copy(@NotNull
                                   java.lang.String id,
                                   int amount,
                                   int amountCapturable,
                                   int amountReceived,
                                   @Nullable
                                   java.lang.String application,
                                   int applicationFeeAmount,
                                   long canceledAt,
                                   @Nullable
                                   java.lang.String cancellationReason,
                                   @Nullable
                                   java.lang.String captureMethod,
                                   @Nullable
                                   com.stripe.stripeterminal.model.external.ChargesList charges,
                                   @Nullable
                                   java.lang.String clientSecret,
                                   @Nullable
                                   java.lang.String confirmationMethod,
                                   long created,
                                   @Nullable
                                   java.lang.String currency,
                                   @Nullable
                                   java.lang.String customer,
                                   @Nullable
                                   java.lang.String description,
                                   @Nullable
                                   java.lang.String invoice,
                                   @Nullable
                                   ApiError lastPaymentError,
                                   boolean livemode,
                                   @Nullable
                                   java.util.Map<java.lang.String,java.lang.String> metadata,
                                   @Nullable
                                   java.lang.String onBehalfOf,
                                   @Nullable
                                   java.lang.String paymentMethodId,
                                   @Nullable
                                   java.lang.String receiptEmail,
                                   @Nullable
                                   java.lang.String review,
                                   @Nullable
                                   java.lang.String statementDescriptor,
                                   @Nullable
                                   PaymentIntentStatus status,
                                   @Nullable
                                   java.lang.String transferGroup)
```
    The PaymentIntent represents your intent to collect payment from a customer, tracking the lifecycle of the payment process through each step. Each PaymentIntent typically correlates with a single “cart” or customer session in your application.
    Use of this SDK is subject to the Stripe Terminal Terms: https://stripe.com/terminal/legal
  - toString
```
@NotNull
public java.lang.String toString()
```
  - hashCode
```
public int hashCode()
```
  - equals
```
public boolean equals(@Nullable
                      java.lang.Object p)
```

Class PaymentIntent

Method Summary

Method Detail

getCharges

getId

getAmount

getAmountCapturable

getAmountReceived

getApplication

getApplicationFeeAmount

getCanceledAt

getCancellationReason

getCaptureMethod

getClientSecret

getConfirmationMethod

getCreated

getCurrency

getCustomer

getDescription

getInvoice

getLastPaymentError

getLivemode

getMetadata

getOnBehalfOf

getPaymentMethodId

getReceiptEmail

getReview

getStatementDescriptor

getStatus

setStatus

getTransferGroup

component1

component2

component3

component4

component5

component6

component7

component8

component9

component11

component12

component13

component14

component15

component16

component17

component18

component19

component20

component21

component22

component23

component24

component25

component26

component27

copy

toString

hashCode

equals