payments-core/com.stripe.android.networking/StripeApiRepository

StripeApiRepository

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

class StripeApiRepository : StripeRepository

An implementation of StripeRepository that makes network requests to the Stripe API.

Constructors

@Inject

constructor(appContext: Context, @Named(value = "publishableKey") publishableKeyProvider: () -> String, workContext: CoroutineContext, @Named(value = "productUsage") productUsageTokens: Set<String>, paymentAnalyticsRequestFactory: PaymentAnalyticsRequestFactory, analyticsRequestExecutor: AnalyticsRequestExecutor, logger: Logger)

Functions

addCustomerSource

open suspend override fun addCustomerSource(customerId: String, publishableKey: String, productUsageTokens: Set<String>, sourceId: String, sourceType: String, requestOptions: ApiRequest.Options): Result<Source>

Analytics event: PaymentAnalyticsEvent.CustomerAddSource

attachFinancialConnectionsSessionToPaymentIntent

open suspend override fun attachFinancialConnectionsSessionToPaymentIntent(clientSecret: String, paymentIntentId: String, financialConnectionsSessionId: String, requestOptions: ApiRequest.Options, expandFields: List<String>): Result<PaymentIntent>

Attaches the Link Account Session to the Payment Intent

attachFinancialConnectionsSessionToSetupIntent

open suspend override fun attachFinancialConnectionsSessionToSetupIntent(clientSecret: String, setupIntentId: String, financialConnectionsSessionId: String, requestOptions: ApiRequest.Options, expandFields: List<String>): Result<SetupIntent>

Attaches the Link Account Session to the Setup Intent

attachHCaptchaToRadarSession

open suspend override fun attachHCaptchaToRadarSession(radarSessionToken: String, hcaptchaToken: String, hcaptchaEKey: String?, requestOptions: ApiRequest.Options): Result<RadarSessionWithHCaptcha>

attachPaymentMethod

open suspend override fun attachPaymentMethod(customerId: String, productUsageTokens: Set<String>, paymentMethodId: String, requestOptions: ApiRequest.Options): Result<PaymentMethod>

Analytics event: PaymentAnalyticsEvent.CustomerAttachPaymentMethod

buildPaymentUserAgent

open override fun buildPaymentUserAgent(attribution: Set<String>): String

cancelPaymentIntentSource

open suspend override fun cancelPaymentIntentSource(paymentIntentId: String, sourceId: String, options: ApiRequest.Options): Result<PaymentIntent>

Analytics event: PaymentAnalyticsEvent.PaymentIntentCancelSource

cancelSetupIntentSource

open suspend override fun cancelSetupIntentSource(setupIntentId: String, sourceId: String, options: ApiRequest.Options): Result<SetupIntent>

Analytics event: PaymentAnalyticsEvent.SetupIntentCancelSource

complete3ds2Auth

open suspend override fun complete3ds2Auth(sourceId: String, requestOptions: ApiRequest.Options): Result<Stripe3ds2AuthResult>

confirmPaymentIntent

open suspend override fun confirmPaymentIntent(confirmPaymentIntentParams: ConfirmPaymentIntentParams, options: ApiRequest.Options, expandFields: List<String>): Result<PaymentIntent>

Confirm a PaymentIntent using the provided ConfirmPaymentIntentParams

confirmSetupIntent

open suspend override fun confirmSetupIntent(confirmSetupIntentParams: ConfirmSetupIntentParams, options: ApiRequest.Options, expandFields: List<String>): Result<SetupIntent>

Confirm a SetupIntent using the provided ConfirmSetupIntentParams

consumerSignUp

open suspend override fun consumerSignUp(email: String, phoneNumber: String, country: String, name: String?, locale: Locale?, authSessionCookie: String?, consentAction: ConsumerSignUpConsentAction, requestOptions: ApiRequest.Options): Result<ConsumerSession>

Creates a new Link account for the credentials provided.

createFile

open suspend override fun createFile(fileParams: StripeFileParams, requestOptions: ApiRequest.Options): Result<StripeFile>

Analytics event: PaymentAnalyticsEvent.FileCreate

createFinancialConnectionsSessionForDeferredPayments

open suspend override fun createFinancialConnectionsSessionForDeferredPayments(params: CreateFinancialConnectionsSessionForDeferredPaymentParams, requestOptions: ApiRequest.Options): Result<FinancialConnectionsSession>

createPaymentDetails

open suspend override fun createPaymentDetails(consumerSessionClientSecret: String, paymentDetailsCreateParams: ConsumerPaymentDetailsCreateParams, requestOptions: ApiRequest.Options, active: Boolean): Result<ConsumerPaymentDetails>

createPaymentIntentFinancialConnectionsSession

open suspend override fun createPaymentIntentFinancialConnectionsSession(paymentIntentId: String, params: CreateFinancialConnectionsSessionParams, requestOptions: ApiRequest.Options): Result<FinancialConnectionsSession>

createPaymentMethod

open suspend override fun createPaymentMethod(paymentMethodCreateParams: PaymentMethodCreateParams, options: ApiRequest.Options): Result<PaymentMethod>

Analytics event: PaymentAnalyticsEvent.PaymentMethodCreate

createRadarSession

open suspend override fun createRadarSession(requestOptions: ApiRequest.Options): Result<RadarSessionWithHCaptcha>

Get the latest FraudDetectionData from FraudDetectionDataRepository and send in POST request to /v1/radar/session.

createSetupIntentFinancialConnectionsSession

open suspend override fun createSetupIntentFinancialConnectionsSession(setupIntentId: String, params: CreateFinancialConnectionsSessionParams, requestOptions: ApiRequest.Options): Result<FinancialConnectionsSession>

createSource

open suspend override fun createSource(sourceParams: SourceParams, options: ApiRequest.Options): Result<Source>

Create a Source using the input SourceParams.

createToken

open suspend override fun createToken(tokenParams: TokenParams, options: ApiRequest.Options): Result<Token>

Create a Token using the input token parameters.

deleteCustomerSource

open suspend override fun deleteCustomerSource(customerId: String, publishableKey: String, productUsageTokens: Set<String>, sourceId: String, requestOptions: ApiRequest.Options): Result<Source>

Analytics event: PaymentAnalyticsEvent.CustomerDeleteSource

detachPaymentMethod

open suspend override fun detachPaymentMethod(productUsageTokens: Set<String>, paymentMethodId: String, requestOptions: ApiRequest.Options): Result<PaymentMethod>

Analytics event: PaymentAnalyticsEvent.CustomerDetachPaymentMethod

getCardMetadata

open suspend override fun getCardMetadata(bin: Bin, options: ApiRequest.Options): Result<CardMetadata>

getFpxBankStatus

open suspend override fun getFpxBankStatus(options: ApiRequest.Options): Result<BankStatuses>

getPaymentMethods

open suspend override fun getPaymentMethods(listPaymentMethodsParams: ListPaymentMethodsParams, productUsageTokens: Set<String>, requestOptions: ApiRequest.Options): Result<List<PaymentMethod>>

Retrieve a Customer's PaymentMethods

logOut

open suspend override fun logOut(consumerSessionClientSecret: String, consumerAccountPublishableKey: String?, requestOptions: ApiRequest.Options): Result<ConsumerSession>

refreshPaymentIntent

open suspend override fun refreshPaymentIntent(clientSecret: String, options: ApiRequest.Options): Result<PaymentIntent>

Refresh a PaymentIntent using its client_secret

retrieveCardElementConfig

open suspend override fun retrieveCardElementConfig(requestOptions: ApiRequest.Options): Result<MobileCardElementConfig>

retrieveCardMetadata

open suspend override fun retrieveCardMetadata(cardNumber: String, requestOptions: ApiRequest.Options): Result<CardMetadata>

retrieveCustomer

open suspend override fun retrieveCustomer(customerId: String, productUsageTokens: Set<String>, requestOptions: ApiRequest.Options): Result<Customer>

Analytics event: PaymentAnalyticsEvent.CustomerRetrieve

retrieveElementsSession

open suspend override fun retrieveElementsSession(params: ElementsSessionParams, options: ApiRequest.Options): Result<ElementsSession>

retrieveIssuingCardPin

open suspend override fun retrieveIssuingCardPin(cardId: String, verificationId: String, userOneTimeCode: String, requestOptions: ApiRequest.Options): Result<String>

Analytics event: PaymentAnalyticsEvent.IssuingRetrievePin

retrieveObject

open suspend override fun retrieveObject(url: String, requestOptions: ApiRequest.Options): Result<StripeResponse<String>>

retrievePaymentIntent

open suspend override fun retrievePaymentIntent(clientSecret: String, options: ApiRequest.Options, expandFields: List<String>): Result<PaymentIntent>

Retrieve a PaymentIntent using its client_secret

retrievePaymentMethodMessage

open suspend override fun retrievePaymentMethodMessage(paymentMethods: List<String>, amount: Int, currency: String, country: String, locale: String, logoColor: String, requestOptions: ApiRequest.Options): Result<PaymentMethodMessage>

retrieveSetupIntent

open suspend override fun retrieveSetupIntent(clientSecret: String, options: ApiRequest.Options, expandFields: List<String>): Result<SetupIntent>

Retrieve a SetupIntent using its client_secret

retrieveSource

open suspend override fun retrieveSource(sourceId: String, clientSecret: String, options: ApiRequest.Options): Result<Source>

Retrieve an existing Source object from the server.

retrieveStripeIntent

open suspend override fun retrieveStripeIntent(clientSecret: String, options: ApiRequest.Options, expandFields: List<String>): Result<StripeIntent>

setCustomerShippingInfo

open suspend override fun setCustomerShippingInfo(customerId: String, publishableKey: String, productUsageTokens: Set<String>, shippingInformation: ShippingInformation, requestOptions: ApiRequest.Options): Result<Customer>

Analytics event: PaymentAnalyticsEvent.CustomerSetShippingInfo

setDefaultCustomerSource

open suspend override fun setDefaultCustomerSource(customerId: String, publishableKey: String, productUsageTokens: Set<String>, sourceId: String, sourceType: String, requestOptions: ApiRequest.Options): Result<Customer>

Analytics event: PaymentAnalyticsEvent.CustomerSetDefaultSource

sharePaymentDetails

open suspend override fun sharePaymentDetails(consumerSessionClientSecret: String, id: String, requestOptions: ApiRequest.Options): Result<String>

start3ds2Auth

@VisibleForTesting

open suspend override fun start3ds2Auth(authParams: Stripe3ds2AuthParams, requestOptions: ApiRequest.Options): Result<Stripe3ds2AuthResult>

Analytics event: PaymentAnalyticsEvent.Auth3ds2Start

updateIssuingCardPin

open suspend override fun updateIssuingCardPin(cardId: String, newPin: String, verificationId: String, userOneTimeCode: String, requestOptions: ApiRequest.Options): Throwable?

Analytics event: PaymentAnalyticsEvent.IssuingUpdatePin

updatePaymentMethod

open suspend override fun updatePaymentMethod(paymentMethodId: String, paymentMethodUpdateParams: PaymentMethodUpdateParams, options: ApiRequest.Options): Result<PaymentMethod>

verifyPaymentIntentWithMicrodeposits

open suspend override fun verifyPaymentIntentWithMicrodeposits(clientSecret: String, descriptorCode: String, requestOptions: ApiRequest.Options): Result<PaymentIntent>

Verifies the PaymentIntent with microdeposits descriptor code

open suspend override fun verifyPaymentIntentWithMicrodeposits(clientSecret: String, firstAmount: Int, secondAmount: Int, requestOptions: ApiRequest.Options): Result<PaymentIntent>

Verifies the PaymentIntent with microdeposits amounts

verifySetupIntentWithMicrodeposits

open suspend override fun verifySetupIntentWithMicrodeposits(clientSecret: String, descriptorCode: String, requestOptions: ApiRequest.Options): Result<SetupIntent>

Verifies the SetupIntent with microdeposits descriptor code

open suspend override fun verifySetupIntentWithMicrodeposits(clientSecret: String, firstAmount: Int, secondAmount: Int, requestOptions: ApiRequest.Options): Result<SetupIntent>

Verifies the SetupIntent with microdeposits amounts