Package-level declarations

Types

Link copied to clipboard
fun interface AlipayAuthenticator

Interface for handling PaymentIntent authentication with the Alipay SDK

Link copied to clipboard
interface ApiResultCallback<in ResultType : StripeModel>

Generic interface for an API operation callback that either returns a result, ResultType, or an Exception

Link copied to clipboard
data class EphemeralKey : StripeModel

Represents an Ephemeral Key that can be used temporarily for API operations that typically require a secret key.

Link copied to clipboard
fun interface EphemeralKeyProvider

Represents an object that can call to a server and create EphemeralKeys.

Link copied to clipboard

Represents a listener for Ephemeral Key Update events.

Link copied to clipboard
class GooglePayConfig @JvmOverloads constructor(publishableKey: String, connectedAccountId: String? = null)

Configuration settings for Google Pay's TokenizationSpecification.

Link copied to clipboard
@Singleton
class GooglePayJsonFactory

A factory for generating Google Pay JSON request objects for Google Pay API version 2.0.

Link copied to clipboard

Methods for retrieval / update of a Stripe Issuing card

Link copied to clipboard

Configuration for authentication mechanisms via StripePaymentController

Link copied to clipboard
Link copied to clipboard

A model representing the result of a PaymentIntent confirmation via Stripe.confirmPayment or handling of next actions via Stripe.handleNextActionForPayment.

Link copied to clipboard

Public utility class for common Pay with Google-related tasks.

Link copied to clipboard

A model representing the result of a SetupIntent confirmation via Stripe.confirmSetupIntent or handling of next actions via Stripe.handleNextActionForSetupIntent.

Link copied to clipboard
class Stripe

Entry-point to the Stripe SDK.

Link copied to clipboard

Enums of beta headers allowed to be override when initializing Stripe.

Link copied to clipboard
abstract class StripeIntentResult<out T : StripeIntent> : StripeModel

A model representing the result of a StripeIntent confirmation or authentication attempt via Stripe.confirmPayment or Stripe.handleNextActionForPayment

Functions

Link copied to clipboard
suspend fun Stripe.confirmAlipayPayment(confirmPaymentIntentParams: ConfirmPaymentIntentParams, authenticator: AlipayAuthenticator, stripeAccountId: String? = this.stripeAccountId): PaymentIntentResult

Confirm and authenticate a PaymentIntent using the Alipay SDK

Link copied to clipboard
suspend fun Stripe.confirmPaymentIntent(confirmPaymentIntentParams: ConfirmPaymentIntentParams, idempotencyKey: String? = null): PaymentIntent

Suspend function to confirm a PaymentIntent object.

Link copied to clipboard
suspend fun Stripe.confirmSetupIntent(confirmSetupIntentParams: ConfirmSetupIntentParams, idempotencyKey: String? = null, expand: List<String> = emptyList()): SetupIntent

Suspend function to confirm a SetupIntent object.

Link copied to clipboard
suspend fun Stripe.confirmWeChatPayPayment(confirmPaymentIntentParams: ConfirmPaymentIntentParams, stripeAccountId: String? = this.stripeAccountId): WeChatPayNextAction

Suspend function to confirm a PaymentIntent for WeChat Pay. Extract params from WeChatPayNextAction to pass to WeChat Pay SDK.

Link copied to clipboard
suspend fun Stripe.createAccountToken(accountParams: AccountParams, idempotencyKey: String? = null, stripeAccountId: String? = this.stripeAccountId): Token

Create a Token from a coroutine.

Link copied to clipboard
suspend fun Stripe.createBankAccountToken(bankAccountTokenParams: BankAccountTokenParams, idempotencyKey: String? = null, stripeAccountId: String? = this.stripeAccountId): Token

Create a bank account token from a coroutine.

Link copied to clipboard
suspend fun Stripe.createCardToken(cardParams: CardParams, idempotencyKey: String? = null, stripeAccountId: String? = this.stripeAccountId): Token

Create a Card token from a coroutine.

Link copied to clipboard
suspend fun Stripe.createCvcUpdateToken(@Size(min = 3, max = 4) cvc: String, idempotencyKey: String? = null, stripeAccountId: String? = this.stripeAccountId): Token

Create a CVC update token from a coroutine.

Link copied to clipboard
suspend fun Stripe.createFile(fileParams: StripeFileParams, idempotencyKey: String? = null, stripeAccountId: String? = this.stripeAccountId): StripeFile

Create a StripeFile from a coroutine.

Link copied to clipboard
suspend fun Stripe.createPaymentMethod(paymentMethodCreateParams: PaymentMethodCreateParams, idempotencyKey: String? = null, stripeAccountId: String? = this.stripeAccountId): PaymentMethod

Create a PaymentMethod from a coroutine.

Link copied to clipboard
suspend fun Stripe.createPersonToken(params: PersonTokenParams, idempotencyKey: String? = null, stripeAccountId: String? = this.stripeAccountId): Token

Creates a single-use token that represents the details for a person. Use this when creating or updating persons associated with a Connect account. See the documentation to learn more.

Link copied to clipboard
suspend fun Stripe.createPiiToken(personalId: String, idempotencyKey: String? = null, stripeAccountId: String? = this.stripeAccountId): Token

Create a PII token from a coroutine.

Link copied to clipboard

Create a Radar Session.

Link copied to clipboard
suspend fun Stripe.createSource(sourceParams: SourceParams, idempotencyKey: String? = null, stripeAccountId: String? = this.stripeAccountId): Source

Create a Source from a coroutine.

Link copied to clipboard
suspend fun Stripe.getAuthenticateSourceResult(requestCode: Int, data: Intent): Source

Get the Source from Intent returned via Activity#onActivityResult(int, int, Intent)}} for Source authentication. (see Stripe.authenticateSource)

Link copied to clipboard
suspend fun Stripe.getPaymentIntentResult(requestCode: Int, data: Intent): PaymentIntentResult

Get the PaymentIntentResult from Intent returned via Activity#onActivityResult(int, int, Intent)}} for PaymentIntent automatic confirmation (see Stripe.confirmPayment) or manual confirmation (see Stripe.handleNextActionForPayment})

Link copied to clipboard
suspend fun Stripe.getSetupIntentResult(requestCode: Int, data: Intent): SetupIntentResult

Get the SetupIntentResult from Intent returned via Activity#onActivityResult(int, int, Intent)}} for SetupIntentResult confirmation. (see confirmSetupIntent)

Link copied to clipboard
suspend fun Stripe.retrievePaymentIntent(clientSecret: String, stripeAccountId: String? = this.stripeAccountId, expand: List<String> = emptyList()): PaymentIntent

Retrieve a PaymentIntent from a coroutine.

Link copied to clipboard

Retrieve a list of possible brands for the given card number. Returns an error if the cardNumber length is less than 6 characters.

Link copied to clipboard
suspend fun Stripe.retrieveSetupIntent(clientSecret: String, stripeAccountId: String? = this.stripeAccountId, expand: List<String> = emptyList()): SetupIntent

Retrieve a SetupIntent asynchronously.

Link copied to clipboard
suspend fun Stripe.retrieveSource(@Size(min = 1) sourceId: String, @Size(min = 1) clientSecret: String, stripeAccountId: String? = this.stripeAccountId): Source

Retrieve a Source from a coroutine.

Link copied to clipboard
suspend fun Stripe.updatePaymentMethod(paymentMethodId: String, paymentMethodUpdateParams: PaymentMethodUpdateParams, ephemeralKeySecret: String, idempotencyKey: String? = null, stripeAccountId: String? = this.stripeAccountId): PaymentMethod

Update a PaymentMethod from a coroutine.

Link copied to clipboard
suspend fun Stripe.verifyPaymentIntentWithMicrodeposits(clientSecret: String, descriptorCode: String): PaymentIntent
suspend fun Stripe.verifyPaymentIntentWithMicrodeposits(clientSecret: String, firstAmount: Int, secondAmount: Int): PaymentIntent

Suspend function to verify a customer's bank account with micro-deposits

Link copied to clipboard
suspend fun Stripe.verifySetupIntentWithMicrodeposits(clientSecret: String, descriptorCode: String): SetupIntent
suspend fun Stripe.verifySetupIntentWithMicrodeposits(clientSecret: String, firstAmount: Int, secondAmount: Int): SetupIntent

Suspend function to verify a customer's bank account with micro-deposits