- Callback - Interface in com.stripe.stripeterminal.callable
-
The Callback
interface represents the simplest set of methods to run upon completion of
an operation. If the operation completes with error, the onFailure
method
will be called. If, instead, the operation completes with no error, the onSuccess
method will be called.
- cancel(callback) - Method in class com.stripe.stripeterminal.callable.Cancelable
-
Attempt to cancel the operation. If the operation cancels successfully, the callback will be
called with null
. If the cancellation fails for any reason, the callback will instead
be called with an Exception detailing the cause of failure.
- Cancelable - Class in com.stripe.stripeterminal.callable
-
A Cancelable
represents an ongoing operation run by the Terminal SDK. While the operation
runs, the Cancelable allows the user to check whether it has completed or cancel it if necessary.
- cancelPaymentIntent(intent, callback) - Method in class com.stripe.stripeterminal.Terminal
-
- CardDetails - Class in com.stripe.stripeterminal.model.external
-
The CardDetails
object contains details about a specific card presented to a reader
- CardPresentDetails - Class in com.stripe.stripeterminal.model.external
-
CardPresentDetails
contains payment method details for a payment method of type CARD_PRESENT
- Charge - Class in com.stripe.stripeterminal.model.external
-
- checkForUpdate(callback) - Method in class com.stripe.stripeterminal.Terminal
-
Checks for a reader update and prompts your app to begin installing the update.
- clearCachedCredentials() - Method in class com.stripe.stripeterminal.Terminal
-
Clears the current connection token, saved reader sessions, and any other cached credentials.
You can use this method to switch accounts in your app, e.g. to switch between live and test
Stripe API keys on your backend.
- collectPaymentMethod(intent, listener, callback) - Method in class com.stripe.stripeterminal.Terminal
-
- com.stripe.stripeterminal - package com.stripe.stripeterminal
-
- com.stripe.stripeterminal.api - package com.stripe.stripeterminal.api
-
- com.stripe.stripeterminal.callable - package com.stripe.stripeterminal.callable
-
- com.stripe.stripeterminal.log - package com.stripe.stripeterminal.log
-
- com.stripe.stripeterminal.model.external - package com.stripe.stripeterminal.model.external
-
- Companion - Static variable in class com.stripe.stripeterminal.api.ApiError
-
Deprecated.
- Companion - Static variable in class com.stripe.stripeterminal.model.external.ReadReusableCardParameters
-
- Companion - Static variable in class com.stripe.stripeterminal.Terminal
-
- Companion - Static variable in class com.stripe.stripeterminal.TerminalLifecycleObserver
-
- component1() - Method in class com.stripe.stripeterminal.model.external.CardDetails
-
Card brand.
- component1() - Method in class com.stripe.stripeterminal.model.external.CardPresentDetails
-
The brand of the payment method used
- component1() - Method in class com.stripe.stripeterminal.model.external.Charge
-
Unique identifier for the
- component1() - Method in class com.stripe.stripeterminal.model.external.DiscoveryConfiguration
-
The timeout for discovery,
- component1() - Method in class com.stripe.stripeterminal.model.external.PaymentIntent
-
Get the unique identifier for the
- component1() - Method in class com.stripe.stripeterminal.model.external.PaymentMethod
-
Unique identifier for the object.
- component1() - Method in class com.stripe.stripeterminal.model.external.ReceiptDetails
-
Identifier for this transaction
- component10() - Method in class com.stripe.stripeterminal.model.external.CardPresentDetails
-
How were card details read in this transaction.
- component10() - Method in class com.stripe.stripeterminal.model.external.Charge
-
Three-letter ISO currency code,
- component11() - Method in class com.stripe.stripeterminal.model.external.CardPresentDetails
-
Any information necessary for generating receipts
- component11() - Method in class com.stripe.stripeterminal.model.external.Charge
-
ID of the customer this
- component11() - Method in class com.stripe.stripeterminal.model.external.PaymentIntent
-
Get the client secret returned by this intent.
- component12() - Method in class com.stripe.stripeterminal.model.external.Charge
-
An arbitrary string attached to the
- component12() - Method in class com.stripe.stripeterminal.model.external.PaymentIntent
-
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.
- component13() - Method in class com.stripe.stripeterminal.model.external.Charge
-
Details about the dispute if the
- component13() - Method in class com.stripe.stripeterminal.model.external.PaymentIntent
-
Time at which the
- component14() - Method in class com.stripe.stripeterminal.model.external.Charge
-
Error code explaining reason for charge failure if available.
- component14() - Method in class com.stripe.stripeterminal.model.external.PaymentIntent
-
Three-letter ISO currency code,
- component15() - Method in class com.stripe.stripeterminal.model.external.Charge
-
Message to user further explaining reason for charge failure if available.
- component15() - Method in class com.stripe.stripeterminal.model.external.PaymentIntent
-
ID of the Customer this
- component16() - Method in class com.stripe.stripeterminal.model.external.Charge
-
ID of the invoice this charge is for if one exists.
- component16() - Method in class com.stripe.stripeterminal.model.external.PaymentIntent
-
An arbitrary string attached to the
- component17() - Method in class com.stripe.stripeterminal.model.external.Charge
-
Has the value
- component17() - Method in class com.stripe.stripeterminal.model.external.PaymentIntent
-
ID of the invoice that created this
- component18() - Method in class com.stripe.stripeterminal.model.external.Charge
-
Set of key-value pairs that you can attach to an object.
- component18() - Method in class com.stripe.stripeterminal.model.external.PaymentIntent
-
The payment error encountered in the previous
- component19() - Method in class com.stripe.stripeterminal.model.external.Charge
-
The account
- component19() - Method in class com.stripe.stripeterminal.model.external.PaymentIntent
-
Has the value
- component2() - Method in class com.stripe.stripeterminal.model.external.CardDetails
-
Two-letter ISO code representing the country of the card.
- component2() - Method in class com.stripe.stripeterminal.model.external.CardPresentDetails
-
The country of the payment method used
- component2() - Method in class com.stripe.stripeterminal.model.external.Charge
-
The amount of the charge
- component2() - Method in class com.stripe.stripeterminal.model.external.DiscoveryConfiguration
-
The reader
- component2() - Method in class com.stripe.stripeterminal.model.external.PaymentIntent
-
Get the amount of the
- component2() - Method in class com.stripe.stripeterminal.model.external.PaymentMethodDetails
-
A
- component2() - Method in class com.stripe.stripeterminal.model.external.ReceiptDetails
-
EMV tag 8A.
- component20() - Method in class com.stripe.stripeterminal.model.external.Charge
-
ID of the order this
- component20() - Method in class com.stripe.stripeterminal.model.external.PaymentIntent
-
Set of key-value pairs that you can attach to an object.
- component21() - Method in class com.stripe.stripeterminal.model.external.Charge
-
true
- component21() - Method in class com.stripe.stripeterminal.model.external.PaymentIntent
-
Return the account that the PaymentIntent is on behalf of
- component22() - Method in class com.stripe.stripeterminal.model.external.Charge
-
ID of the PaymentIntent associated with this
- component22() - Method in class com.stripe.stripeterminal.model.external.PaymentIntent
-
ID of the payment method used in this PaymentIntent.
- component23() - Method in class com.stripe.stripeterminal.model.external.Charge
-
ID of the
- component23() - Method in class com.stripe.stripeterminal.model.external.PaymentIntent
-
Email address that the receipt for the resulting payment will be sent to.
- component24() - Method in class com.stripe.stripeterminal.model.external.Charge
-
A
- component24() - Method in class com.stripe.stripeterminal.model.external.PaymentIntent
-
ID of the review associated with this
- component25() - Method in class com.stripe.stripeterminal.model.external.Charge
-
This is the email address that the receipt for this
- component25() - Method in class com.stripe.stripeterminal.model.external.PaymentIntent
-
Extra information about a
- component26() - Method in class com.stripe.stripeterminal.model.external.Charge
-
This is the transaction number that appears on email receipts sent for this
- component26() - Method in class com.stripe.stripeterminal.model.external.PaymentIntent
-
Status of this
- component27() - Method in class com.stripe.stripeterminal.model.external.Charge
-
This is the URL to view the receipt for this
- component27() - Method in class com.stripe.stripeterminal.model.external.PaymentIntent
-
Get the transfer group of this PaymentIntent
- component28() - Method in class com.stripe.stripeterminal.model.external.Charge
-
Whether the
- component29() - Method in class com.stripe.stripeterminal.model.external.Charge
-
ID of the review associated with this
- component3() - Method in class com.stripe.stripeterminal.model.external.CardDetails
-
The expiration month of the payment method
- component3() - Method in class com.stripe.stripeterminal.model.external.CardPresentDetails
-
The EMV auth data string of the payment method used
- component3() - Method in class com.stripe.stripeterminal.model.external.Charge
-
Amount in cents refunded
- component3() - Method in class com.stripe.stripeterminal.model.external.DiscoveryConfiguration
-
Whether the devices returned by discovery should be simulated
- component3() - Method in class com.stripe.stripeterminal.model.external.PaymentIntent
-
Amount that can be captured from this
- component3() - Method in class com.stripe.stripeterminal.model.external.PaymentMethod
-
A
- component3() - Method in class com.stripe.stripeterminal.model.external.ReceiptDetails
-
EMV tag 84.
- component30() - Method in class com.stripe.stripeterminal.model.external.Charge
-
Extra information about a
- component31() - Method in class com.stripe.stripeterminal.model.external.Charge
-
The status of the payment is either
- component32() - Method in class com.stripe.stripeterminal.model.external.Charge
-
ID of the transfer to the
- component33() - Method in class com.stripe.stripeterminal.model.external.Charge
-
A string that identifies this transaction as part of a group.
- component4() - Method in class com.stripe.stripeterminal.model.external.CardDetails
-
The expiration year of the payment method
- component4() - Method in class com.stripe.stripeterminal.model.external.CardPresentDetails
-
The expiration month of the payment method used
- component4() - Method in class com.stripe.stripeterminal.model.external.Charge
-
ID of the Connect application that created the
- component4() - Method in class com.stripe.stripeterminal.model.external.PaymentIntent
-
Amount that was collected by this PaymentIntent.
- component4() - Method in class com.stripe.stripeterminal.model.external.ReceiptDetails
-
Mnenomic of the Application Identifier.
- component5() - Method in class com.stripe.stripeterminal.model.external.CardDetails
-
Uniquely identifies this particular card number.
- component5() - Method in class com.stripe.stripeterminal.model.external.CardPresentDetails
-
The expiration year of the payment method used
- component5() - Method in class com.stripe.stripeterminal.model.external.Charge
-
The application fee
- component5() - Method in class com.stripe.stripeterminal.model.external.PaymentIntent
-
ID of the Connect application that created the PaymentIntent
- component5() - Method in class com.stripe.stripeterminal.model.external.PaymentMethod
-
The ID of the Customer to which this
- component5() - Method in class com.stripe.stripeterminal.model.external.ReceiptDetails
-
EMV tag 9F26,
- component6() - Method in class com.stripe.stripeterminal.model.external.CardDetails
-
Card funding type.
- component6() - Method in class com.stripe.stripeterminal.model.external.CardPresentDetails
-
The fingerprint of the payment method used
- component6() - Method in class com.stripe.stripeterminal.model.external.Charge
-
The amount of the application fee
- component6() - Method in class com.stripe.stripeterminal.model.external.PaymentIntent
-
The amount of the application fee for this PaymentIntent
- component6() - Method in class com.stripe.stripeterminal.model.external.PaymentMethod
-
Has the value
- component6() - Method in class com.stripe.stripeterminal.model.external.ReceiptDetails
-
How the cardholder verified ownership of the card
- component7() - Method in class com.stripe.stripeterminal.model.external.CardDetails
-
The last four digits of the card number
- component7() - Method in class com.stripe.stripeterminal.model.external.CardPresentDetails
-
Card funding type.
- component7() - Method in class com.stripe.stripeterminal.model.external.Charge
-
ID of the balance transaction that describes the impact of this
- component7() - Method in class com.stripe.stripeterminal.model.external.PaymentIntent
-
Populated when
- component7() - Method in class com.stripe.stripeterminal.model.external.PaymentMethod
-
Return any metadata that was attached to this PaymentMethod upon creation
- component7() - Method in class com.stripe.stripeterminal.model.external.ReceiptDetails
-
The outcome of a series of EMV functions performed by the card reader.
- component8() - Method in class com.stripe.stripeterminal.model.external.CardPresentDetails
-
The ID of a generated card that can be used for recurring charges
- component8() - Method in class com.stripe.stripeterminal.model.external.Charge
-
If the
- component8() - Method in class com.stripe.stripeterminal.model.external.PaymentIntent
-
Reason for cancellation of this
- component8() - Method in class com.stripe.stripeterminal.model.external.ReceiptDetails
-
An indication of various EMV functions performed during the transaction.
- component9() - Method in class com.stripe.stripeterminal.model.external.CardPresentDetails
-
The last four digits of the card used
- component9() - Method in class com.stripe.stripeterminal.model.external.Charge
-
Time at which the
- component9() - Method in class com.stripe.stripeterminal.model.external.PaymentIntent
-
One of automatic
(default) or manual
. When the capture method is automatic, Stripe
automatically captures funds when the customer authorizes the payment.
- ConnectionStatus - Enum in com.stripe.stripeterminal.model.external
-
The ConnectionStatus
represents the current state of the reader-terminal connection.
- ConnectionTokenCallback - Interface in com.stripe.stripeterminal.callable
-
- ConnectionTokenException - Exception in com.stripe.stripeterminal.model.external
-
The
ConnectionTokenException
is an exception type that should be thrown by the
interface ConnectionTokenProvider
when there's an unresolvable error that prevents us from
fetching a connection token
- ConnectionTokenException(message, cause) - Constructor for exception com.stripe.stripeterminal.model.external.ConnectionTokenException
-
The
ConnectionTokenException
is an exception type that should be thrown by the
interface ConnectionTokenProvider
when there's an unresolvable error that prevents us from
fetching a connection token
- ConnectionTokenException(message) - Constructor for exception com.stripe.stripeterminal.model.external.ConnectionTokenException
-
The
ConnectionTokenException
is an exception type that should be thrown by the
interface ConnectionTokenProvider
when there's an unresolvable error that prevents us from
fetching a connection token
- ConnectionTokenProvider - Interface in com.stripe.stripeterminal.callable
-
Before integrating the SDK, you should create an endpoint on your backend
server that creates a new connection token via the Stripe Terminal API. The
connection token is used by the SDK to connect to a reader.
- connectReader(reader, connectionCallback) - Method in class com.stripe.stripeterminal.Terminal
-
Attempts to connect to the given reader.
- copy(error) - Method in class com.stripe.stripeterminal.api.ApiError
-
An ApiError
is an object representing a Stripe API error object.
- copy(brand, country, expMonth, expYear, fingerprint, funding, last4) - Method in class com.stripe.stripeterminal.model.external.CardDetails
-
The CardDetails
object contains details about a specific card presented to a reader
- copy(brand, country, emvAuthData, expMonth, expYear, fingerprint, funding, generatedCard, last4, readMethod, receiptDetails) - Method in class com.stripe.stripeterminal.model.external.CardPresentDetails
-
CardPresentDetails
contains payment method details for a payment method of type CARD_PRESENT
- copy(id, amount, amountRefunded, application, applicationFee, applicationFeeAmount, balanceTransaction, captured, created, currency, customer, description, dispute, failureCode, failureMessage, invoice, livemode, metadata, onBehalfOf, order, paid, paymentIntentId, paymentMethodId, paymentMethodDetails, receiptEmail, receiptNumber, receiptUrl, refunded, review, statementDescriptor, status, transfer, transferGroup) - Method in class com.stripe.stripeterminal.model.external.Charge
-
- copy(timeout, deviceType, isSimulated) - Method in class com.stripe.stripeterminal.model.external.DiscoveryConfiguration
-
The DiscoveryConfiguration
contains configuration information relevant to the reader
discovery process.
- copy(id, amount, amountCapturable, amountReceived, application, applicationFeeAmount, canceledAt, cancellationReason, captureMethod, charges, clientSecret, confirmationMethod, created, currency, customer, description, invoice, lastPaymentError, livemode, metadata, onBehalfOf, paymentMethodId, receiptEmail, review, statementDescriptor, status, transferGroup) - Method in class com.stripe.stripeterminal.model.external.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.
- copy(id, objectType, cardDetails, created, customer, livemode, metadata, type) - Method in class com.stripe.stripeterminal.model.external.PaymentMethod
-
PaymentMethod
objects represent your customer's payment instruments. They can be used
with
class PaymentIntent
s to collect payments, or saved to Customer objects to store instrument
details for future payments.
- copy(type, cardPresentDetails) - Method in class com.stripe.stripeterminal.model.external.PaymentMethodDetails
-
PaymentMethodDetails
contains details about the payment method used to complete a
class PaymentIntent
- copy(authorizationCode, authorizationResponseCode, dedicatedFileName, applicationPreferredName, applicationCryptogram, cvm, tvr, tsi) - Method in class com.stripe.stripeterminal.model.external.ReceiptDetails
-
All necessary information for generating receipts
- createPaymentIntent(params, callback) - Method in class com.stripe.stripeterminal.Terminal
-
- getAmount() - Method in class com.stripe.stripeterminal.model.external.Charge
-
The amount of the charge
- getAmount() - Method in class com.stripe.stripeterminal.model.external.PaymentIntent
-
Get the amount of the
- getAmount() - Method in class com.stripe.stripeterminal.model.external.PaymentIntentParameters
-
The amount of the payment, provided in the currency's smallest unit.
- getAmountCapturable() - Method in class com.stripe.stripeterminal.model.external.PaymentIntent
-
Amount that can be captured from this
- getAmountReceived() - Method in class com.stripe.stripeterminal.model.external.PaymentIntent
-
Amount that was collected by this PaymentIntent.
- getAmountRefunded() - Method in class com.stripe.stripeterminal.model.external.Charge
-
Amount in cents refunded
- getApiError() - Method in exception com.stripe.stripeterminal.model.external.TerminalException
-
If the exception is of type
- getApplication() - Method in class com.stripe.stripeterminal.model.external.Charge
-
ID of the Connect application that created the
- getApplication() - Method in class com.stripe.stripeterminal.model.external.PaymentIntent
-
ID of the Connect application that created the PaymentIntent
- getApplicationCryptogram() - Method in class com.stripe.stripeterminal.model.external.ReceiptDetails
-
EMV tag 9F26,
- getApplicationFee() - Method in class com.stripe.stripeterminal.model.external.Charge
-
The application fee
- getApplicationFeeAmount() - Method in class com.stripe.stripeterminal.model.external.Charge
-
The amount of the application fee
- getApplicationFeeAmount() - Method in class com.stripe.stripeterminal.model.external.PaymentIntent
-
The amount of the application fee for this PaymentIntent
- getApplicationFeeAmount() - Method in class com.stripe.stripeterminal.model.external.PaymentIntentParameters
-
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.
- getApplicationPreferredName() - Method in class com.stripe.stripeterminal.model.external.ReceiptDetails
-
Mnenomic of the Application Identifier.
- getAuthorizationCode() - Method in class com.stripe.stripeterminal.model.external.ReceiptDetails
-
Identifier for this transaction
- getAuthorizationResponseCode() - Method in class com.stripe.stripeterminal.model.external.ReceiptDetails
-
EMV tag 8A.
- getBalanceTransaction() - Method in class com.stripe.stripeterminal.model.external.Charge
-
ID of the balance transaction that describes the impact of this
- getBatteryLevel() - Method in class com.stripe.stripeterminal.model.external.Reader
-
Get the current battery level as a boxed float in the range
0,1. If the reader does
not have a battery, or the battery level is unknown, this will return null.
- getBrand() - Method in class com.stripe.stripeterminal.model.external.CardDetails
-
Card brand.
- getBrand() - Method in class com.stripe.stripeterminal.model.external.CardPresentDetails
-
The brand of the payment method used
- getCanceledAt() - Method in class com.stripe.stripeterminal.model.external.PaymentIntent
-
Populated when
- getCancellationReason() - Method in class com.stripe.stripeterminal.model.external.PaymentIntent
-
Reason for cancellation of this
- getCaptured() - Method in class com.stripe.stripeterminal.model.external.Charge
-
If the
- getCaptureMethod() - Method in class com.stripe.stripeterminal.model.external.PaymentIntent
-
One of automatic
(default) or manual
. When the capture method is automatic, Stripe
automatically captures funds when the customer authorizes the payment.
- getCardDetails() - Method in class com.stripe.stripeterminal.model.external.PaymentMethod
-
A
- getCardPresentDetails() - Method in class com.stripe.stripeterminal.model.external.PaymentMethodDetails
-
A
- getCharge() - Method in class com.stripe.stripeterminal.api.ApiError
-
For card errors, the ID of the failed charge
- getCharges() - Method in class com.stripe.stripeterminal.model.external.PaymentIntent
-
Return the
class Charge
objects associated with this PaymentIntent
- getClientSecret() - Method in class com.stripe.stripeterminal.model.external.PaymentIntent
-
Get the client secret returned by this intent.
- getCode() - Method in class com.stripe.stripeterminal.api.ApiError
-
The code specific to this error type
- getConfirmationMethod() - Method in class com.stripe.stripeterminal.model.external.PaymentIntent
-
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.
- getConnectedReader() - Method in class com.stripe.stripeterminal.Terminal
-
- getConnectionStatus() - Method in class com.stripe.stripeterminal.Terminal
-
- getCountry() - Method in class com.stripe.stripeterminal.model.external.CardDetails
-
Two-letter ISO code representing the country of the card.
- getCountry() - Method in class com.stripe.stripeterminal.model.external.CardPresentDetails
-
The country of the payment method used
- getCreated() - Method in class com.stripe.stripeterminal.model.external.Charge
-
Time at which the
- getCreated() - Method in class com.stripe.stripeterminal.model.external.PaymentIntent
-
Time at which the
- getCurrency() - Method in class com.stripe.stripeterminal.model.external.Charge
-
Three-letter ISO currency code,
- getCurrency() - Method in class com.stripe.stripeterminal.model.external.PaymentIntent
-
Three-letter ISO currency code,
- getCurrency() - Method in class com.stripe.stripeterminal.model.external.PaymentIntentParameters
-
Three-letter ISO currency code, in lowercase. Must be a supported currency.
- getCustomer() - Method in class com.stripe.stripeterminal.model.external.Charge
-
ID of the customer this
- getCustomer() - Method in class com.stripe.stripeterminal.model.external.PaymentIntent
-
ID of the Customer this
- getCustomer() - Method in class com.stripe.stripeterminal.model.external.PaymentIntentParameters
-
- getCustomer() - Method in class com.stripe.stripeterminal.model.external.PaymentMethod
-
The ID of the Customer to which this
- getCvm() - Method in class com.stripe.stripeterminal.model.external.ReceiptDetails
-
How the cardholder verified ownership of the card
- getDeclineCode() - Method in class com.stripe.stripeterminal.api.ApiError
-
If this error results from a declined card (type = CARD_ERROR
), this field will
provide more details
- getDedicatedFileName() - Method in class com.stripe.stripeterminal.model.external.ReceiptDetails
-
EMV tag 84.
- getDescription() - Method in class com.stripe.stripeterminal.model.external.Charge
-
An arbitrary string attached to the
- getDescription() - Method in class com.stripe.stripeterminal.model.external.PaymentIntent
-
An arbitrary string attached to the
- getDescription() - Method in class com.stripe.stripeterminal.model.external.PaymentIntentParameters
-
An arbitrary string attached to the object. If you send a receipt email for
this payment, the email will include the description.
- getDescription() - Method in enum com.stripe.stripeterminal.model.external.ReaderSoftwareUpdate.UpdateTimeEstimate
-
Returns a user-facing string describing the amount of time the update will take
- getDeviceType() - Method in class com.stripe.stripeterminal.model.external.DiscoveryConfiguration
-
The reader
- getDeviceType() - Method in class com.stripe.stripeterminal.model.external.Reader
-
Get the
- getDispute() - Method in class com.stripe.stripeterminal.model.external.Charge
-
Details about the dispute if the
- getDocUrl() - Method in class com.stripe.stripeterminal.api.ApiError
-
A URL to learn more about the error reported
- getEmvAuthData() - Method in class com.stripe.stripeterminal.model.external.CardPresentDetails
-
The EMV auth data string of the payment method used
- getErrorCode() - Method in exception com.stripe.stripeterminal.model.external.TerminalException
-
- getErrorMessage() - Method in exception com.stripe.stripeterminal.model.external.TerminalException
-
- getExpMonth() - Method in class com.stripe.stripeterminal.model.external.CardDetails
-
The expiration month of the payment method
- getExpMonth() - Method in class com.stripe.stripeterminal.model.external.CardPresentDetails
-
The expiration month of the payment method used
- getExpYear() - Method in class com.stripe.stripeterminal.model.external.CardDetails
-
The expiration year of the payment method
- getExpYear() - Method in class com.stripe.stripeterminal.model.external.CardPresentDetails
-
The expiration year of the payment method used
- getFailureCode() - Method in class com.stripe.stripeterminal.model.external.Charge
-
Error code explaining reason for charge failure if available.
- getFailureMessage() - Method in class com.stripe.stripeterminal.model.external.Charge
-
Message to user further explaining reason for charge failure if available.
- getFingerprint() - Method in class com.stripe.stripeterminal.model.external.CardDetails
-
Uniquely identifies this particular card number.
- getFingerprint() - Method in class com.stripe.stripeterminal.model.external.CardPresentDetails
-
The fingerprint of the payment method used
- getFunding() - Method in class com.stripe.stripeterminal.model.external.CardDetails
-
Card funding type.
- getFunding() - Method in class com.stripe.stripeterminal.model.external.CardPresentDetails
-
Card funding type.
- getGeneratedCard() - Method in class com.stripe.stripeterminal.model.external.CardPresentDetails
-
The ID of a generated card that can be used for recurring charges
- getId() - Method in class com.stripe.stripeterminal.model.external.Charge
-
Unique identifier for the
- getId() - Method in class com.stripe.stripeterminal.model.external.PaymentIntent
-
Get the unique identifier for the
- getId() - Method in class com.stripe.stripeterminal.model.external.PaymentMethod
-
Unique identifier for the object.
- getInstance() - Method in class com.stripe.stripeterminal.Terminal.Companion
-
Returns the current instance of the
class Terminal
object. This instance should have been
initialized already by calling
initTerminal
.
- getInstance() - Static method in class com.stripe.stripeterminal.Terminal
-
Returns the current instance of the
class Terminal
object. This instance should have been
initialized already by calling
initTerminal
.
- getInstance() - Method in class com.stripe.stripeterminal.TerminalLifecycleObserver.Companion
-
- getInstance() - Static method in class com.stripe.stripeterminal.TerminalLifecycleObserver
-
- getInvoice() - Method in class com.stripe.stripeterminal.model.external.Charge
-
ID of the invoice this charge is for if one exists.
- getInvoice() - Method in class com.stripe.stripeterminal.model.external.PaymentIntent
-
ID of the invoice that created this
- getLast4() - Method in class com.stripe.stripeterminal.model.external.CardDetails
-
The last four digits of the card number
- getLast4() - Method in class com.stripe.stripeterminal.model.external.CardPresentDetails
-
The last four digits of the card used
- getLastPaymentError() - Method in class com.stripe.stripeterminal.model.external.PaymentIntent
-
The payment error encountered in the previous
- getLivemode() - Method in class com.stripe.stripeterminal.model.external.Charge
-
Has the value
- getLivemode() - Method in class com.stripe.stripeterminal.model.external.PaymentIntent
-
Has the value
- getLivemode() - Method in class com.stripe.stripeterminal.model.external.PaymentMethod
-
Has the value
- getMessage() - Method in class com.stripe.stripeterminal.api.ApiError
-
A human-readable message providing more details about the error
- getMetadata() - Method in class com.stripe.stripeterminal.model.external.Charge
-
Set of key-value pairs that you can attach to an object.
- getMetadata() - Method in class com.stripe.stripeterminal.model.external.PaymentIntent
-
Set of key-value pairs that you can attach to an object.
- getMetadata() - Method in class com.stripe.stripeterminal.model.external.PaymentIntentParameters
-
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.
- getMetadata() - Method in class com.stripe.stripeterminal.model.external.PaymentMethod
-
Return any metadata that was attached to this PaymentMethod upon creation
- getNULL() - Method in class com.stripe.stripeterminal.model.external.ReadReusableCardParameters.Companion
-
- getNULL() - Static method in class com.stripe.stripeterminal.model.external.ReadReusableCardParameters
-
- getOnBehalfOf() - Method in class com.stripe.stripeterminal.model.external.Charge
-
The account
- getOnBehalfOf() - Method in class com.stripe.stripeterminal.model.external.PaymentIntent
-
Return the account that the PaymentIntent is on behalf of
- getOnBehalfOf() - Method in class com.stripe.stripeterminal.model.external.PaymentIntentParameters
-
The Stripe account ID for which these funds are intended.
- getOrder() - Method in class com.stripe.stripeterminal.model.external.Charge
-
ID of the order this
- getPaid() - Method in class com.stripe.stripeterminal.model.external.Charge
-
true
- getParam() - Method in class com.stripe.stripeterminal.api.ApiError
-
If the error is parameter-specific, this returns the parameter related to the error
- getPaymentIntent() - Method in exception com.stripe.stripeterminal.model.external.TerminalException
-
If the exception is of type PROCESS_PAYMENT_ERROR
, this will return one of
three things:
- getPaymentIntentId() - Method in class com.stripe.stripeterminal.model.external.Charge
-
ID of the PaymentIntent associated with this
- getPaymentMethodDetails() - Method in class com.stripe.stripeterminal.model.external.Charge
-
A
- getPaymentMethodId() - Method in class com.stripe.stripeterminal.model.external.Charge
-
ID of the
- getPaymentMethodId() - Method in class com.stripe.stripeterminal.model.external.PaymentIntent
-
ID of the payment method used in this PaymentIntent.
- getPaymentStatus() - Method in class com.stripe.stripeterminal.Terminal
-
- getReadMethod() - Method in class com.stripe.stripeterminal.model.external.CardPresentDetails
-
How were card details read in this transaction.
- getReceiptDetails() - Method in class com.stripe.stripeterminal.model.external.CardPresentDetails
-
Any information necessary for generating receipts
- getReceiptEmail() - Method in class com.stripe.stripeterminal.model.external.Charge
-
This is the email address that the receipt for this
- getReceiptEmail() - Method in class com.stripe.stripeterminal.model.external.PaymentIntent
-
Email address that the receipt for the resulting payment will be sent to.
- getReceiptEmail() - Method in class com.stripe.stripeterminal.model.external.PaymentIntentParameters
-
Email address that the receipt for the resulting payment will be sent to.
- getReceiptNumber() - Method in class com.stripe.stripeterminal.model.external.Charge
-
This is the transaction number that appears on email receipts sent for this
- getReceiptUrl() - Method in class com.stripe.stripeterminal.model.external.Charge
-
This is the URL to view the receipt for this
- getRefunded() - Method in class com.stripe.stripeterminal.model.external.Charge
-
Whether the
- getReview() - Method in class com.stripe.stripeterminal.model.external.Charge
-
ID of the review associated with this
- getReview() - Method in class com.stripe.stripeterminal.model.external.PaymentIntent
-
ID of the review associated with this
- getSerialNumber() - Method in class com.stripe.stripeterminal.model.external.Reader
-
Get the serial number of this reader
- getSoftwareVersion() - Method in class com.stripe.stripeterminal.model.external.Reader
-
Get the current software version on the reader, expressed as a string
- getStatementDescriptor() - Method in class com.stripe.stripeterminal.model.external.Charge
-
Extra information about a
- getStatementDescriptor() - Method in class com.stripe.stripeterminal.model.external.PaymentIntent
-
Extra information about a
- getStatementDescriptor() - Method in class com.stripe.stripeterminal.model.external.PaymentIntentParameters
-
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.
- getStatus() - Method in class com.stripe.stripeterminal.model.external.Charge
-
The status of the payment is either
- getStatus() - Method in class com.stripe.stripeterminal.model.external.PaymentIntent
-
Status of this
- getTimeEstimate() - Method in class com.stripe.stripeterminal.model.external.ReaderSoftwareUpdate
-
The estimated amount of time for an update.
- getTimeout() - Method in class com.stripe.stripeterminal.model.external.DiscoveryConfiguration
-
The timeout for discovery,
- getTransfer() - Method in class com.stripe.stripeterminal.model.external.Charge
-
ID of the transfer to the
- getTransferDataDestination() - Method in class com.stripe.stripeterminal.model.external.PaymentIntentParameters
-
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.
- getTransferGroup() - Method in class com.stripe.stripeterminal.model.external.Charge
-
A string that identifies this transaction as part of a group.
- getTransferGroup() - Method in class com.stripe.stripeterminal.model.external.PaymentIntent
-
Get the transfer group of this PaymentIntent
- getTransferGroup() - Method in class com.stripe.stripeterminal.model.external.PaymentIntentParameters
-
A string that identifies the resulting payment as part of a group.
- getTsi() - Method in class com.stripe.stripeterminal.model.external.ReceiptDetails
-
An indication of various EMV functions performed during the transaction.
- getTvr() - Method in class com.stripe.stripeterminal.model.external.ReceiptDetails
-
The outcome of a series of EMV functions performed by the card reader.
- getType() - Method in class com.stripe.stripeterminal.api.ApiError
-
The type of error returned
- getVersion() - Method in class com.stripe.stripeterminal.model.external.ReaderSoftwareUpdate
-
Return the version string for this update