ApiErrorType

@Serializable
enum ApiErrorType : Enum<ApiErrorType>

An enum detailing what type of error is being returned

For more information, see the official Stripe docs: Error types

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

Entries

Link copied to clipboard
@SerialName(value = "api_connection_error")
API_CONNECTION_ERROR

Failure to connect to Stripe's API.

Link copied to clipboard
@SerialName(value = "api_error")
API_ERROR

API errors cover any other type of problem (e.g., a temporary problem with Stripe's servers), and are extremely uncommon.

Link copied to clipboard
@SerialName(value = "authentication_error")
AUTHENTICATION_ERROR

Failure to properly authenticate yourself in the request.

Link copied to clipboard
@SerialName(value = "card_error")
CARD_ERROR

Card errors are the most common type of error you should expect to handle. They result when the user enters a card that can't be charged for some reason.

Link copied to clipboard
@SerialName(value = "idempotency_error")
IDEMPOTENCY_ERROR

Idempotency errors occur when an Idempotency-Key is re-used on a request that does not match the first request's API endpoint and parameters.

Link copied to clipboard
@SerialName(value = "invalid_request_error")
INVALID_REQUEST_ERROR

Invalid request errors arise when your request has invalid parameters.

Link copied to clipboard
@SerialName(value = "rate_limit_error")
RATE_LIMIT_ERROR

Too many requests hit the API too quickly.

Properties

Link copied to clipboard

Returns a representation of an immutable list of all enum entries, in the order they're declared.

Link copied to clipboard
Link copied to clipboard

Functions

Link copied to clipboard

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Link copied to clipboard

Returns an array containing the constants of this enum type, in the order they're declared.