Payment Reference


                    
                    
                    SCPPaymentIntent

A PaymentIntent tracks the process of collecting a payment from your customer. We recommend that you create exactly one PaymentIntent for each order or customer session in your system. You can reference the PaymentIntent later to see the history of payment attempts for a particular session.

A PaymentIntent transitions through multiple statuses throughout its lifetime and ultimately creates at most one successful charge.

https://stripe.com/docs/api/payment_intents

Declaration

Objective-C


@interface SCPPaymentIntent : NSObject <NSCopying>

Swift

class PaymentIntent : NSObject, NSCopying


                    
                    
                    SCPPaymentIntentParameters

Parameters for creating an SCPPaymentIntent. Pass an object of this type into Terminal.shared.createPaymentIntent().

See

https://stripe.com/docs/api/payment_intents/create

Declaration

Objective-C


@interface SCPPaymentIntentParameters : NSObject

Swift

class PaymentIntentParameters : NSObject


                    
                    
                    SCPPaymentIntentParametersBuilder

Builder class for SCPPaymentIntentParameters.

Declaration

Objective-C


@interface SCPPaymentIntentParametersBuilder
    : SCPBuilder <SCPPaymentIntentParameters *>

Swift

class PaymentIntentParametersBuilder : SCPBuilder<PaymentIntentParameters>


                    
                    
                    SCPPaymentIntentStatus

The possible statuses for a PaymentIntent.

https://stripe.com/docs/api/payment_intents/object#payment_intent_object-status

Declaration

Objective-C

enum SCPPaymentIntentStatus : NSUInteger {}

Swift

enum PaymentIntentStatus : UInt, @unchecked Sendable


                    
                    
                    SCPPaymentStatus

The possible payment statuses for the SDK.

See

https://stripe.com/docs/terminal/payments

Declaration

Objective-C

enum SCPPaymentStatus : NSUInteger {}

Swift

enum PaymentStatus : UInt, @unchecked Sendable


                    
                    
                    SCPAmountDetails

Contains details about items included in the [PaymentIntent] amount

Declaration

Objective-C


@interface SCPAmountDetails : NSObject <NSCopying>

Swift

class AmountDetails : NSObject, NSCopying


                    
                    
                    SCPTip

Contains details about tips

For more information, see the official Stripe docs: Collect on-reader tips

Declaration

Objective-C


@interface SCPTip : NSObject <NSCopying>

Swift

class Tip : NSObject, NSCopying


                    
                    
                    SCPCardPresentParameters

Parameters that will be applied to the card present PaymentIntent.

See

https://stripe.com/docs/api/payment_intents/create#create_payment_intent-payment_method_options-card_present

Declaration

Objective-C


@interface SCPCardPresentParameters : NSObject <NSCopying>

Swift

class CardPresentParameters : NSObject, NSCopying


                    
                    
                    SCPCardPresentParametersBuilder

Builder class for SCPCardPresentParameters.

Declaration

Objective-C


@interface SCPCardPresentParametersBuilder
    : SCPBuilder <SCPCardPresentParameters *>

Swift

class CardPresentParametersBuilder : SCPBuilder<CardPresentParameters>


                    
                    
                    SCPCardPresentCaptureMethod

Capture Method values that can be used as card-present payment method options.

Declaration

Objective-C

enum SCPCardPresentCaptureMethod : NSUInteger {}

Swift

enum CardPresentCaptureMethod : UInt, @unchecked Sendable


                    
                    
                    SCPCardPresentRouting

Network routing priority on co-branded EMV cards supporting domestic debit and international card schemes.

Declaration

Objective-C

enum SCPCardPresentRouting : NSUInteger {}

Swift

enum CardPresentRouting : UInt, @unchecked Sendable


                    
                    
                    SCPCardPresentDetails

An object representing details from a transaction using a card_present payment method.

See

https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present

Declaration

Objective-C


@interface SCPCardPresentDetails : NSObject

Swift

class CardPresentDetails : NSObject


                    
                    
                    SCPCardPresentRequestPartialAuthorization

Parameters for requesting partial authorization support on a transaction

Declaration

Objective-C

enum SCPCardPresentRequestPartialAuthorization : NSUInteger {}

Swift

enum CardPresentRequestPartialAuthorization : UInt, @unchecked Sendable


                    
                    
                    SCPReceiptDetails

Receipt details associated with a card present transaction.

See

https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-receipt

Declaration

Objective-C


@interface SCPReceiptDetails : NSObject <NSCopying>

Swift

class ReceiptDetails : NSObject, NSCopying


                    
                    
                    SCPConfirmPaymentIntentError

An error from -[SCPTerminal confirmPaymentIntent:completion:].

See

https://stripe.com/docs/terminal/payments#process

Declaration

Objective-C


@interface SCPConfirmPaymentIntentError : NSError

Swift

class ConfirmPaymentIntentError : NSError


                    
                    
                    SCPCardBrand

The various card brands for a card.

See

https://stripe.com/docs/api/cards/object#card_object-brand

Declaration

Objective-C

enum SCPCardBrand : NSInteger {}

Swift

enum CardBrand : Int, @unchecked Sendable


                    
                    
                    SCPCardFundingType

The various funding sources for a card.

See

https://stripe.com/docs/api/cards/object#card_object-funding

Declaration

Objective-C

enum SCPCardFundingType : NSInteger {}

Swift

enum CardFundingType : Int, @unchecked Sendable


                    
                    
                    SCPCharge

An object representing a Stripe charge.

See

https://stripe.com/docs/api#charges

Declaration

Objective-C


@interface SCPCharge : NSObject

Swift

class Charge : NSObject


                    
                    
                    SCPChargeStatus

The possible statuses for a charge

Declaration

Objective-C

enum SCPChargeStatus : NSUInteger {}

Swift

enum ChargeStatus : UInt, @unchecked Sendable


                    
                    
                    SCPPaymentMethodDetails

Details about a PaymentMethod at a specific time. ex: at time of transaction for a Charge.

See

https://stripe.com/docs/api/charges/object#charge_object-payment_method_details

Unlike an SCPPaymentMethod, the details object does not have a stripeId, and only exists as a sub-object of another Stripe object.

Declaration

Objective-C


@interface SCPPaymentMethodDetails : NSObject

Swift

class PaymentMethodDetails : NSObject


                    
                    
                    SCPCardDetails

Contains details about a user’s credit card.

See

https://stripe.com/docs/api/payment_methods/object#payment_method_object-card

Declaration

Objective-C


@interface SCPCardDetails : NSObject

Swift

class CardDetails : NSObject


                    
                    
                    SCPPaymentMethod

PaymentMethod objects represent your customer’s payment instruments. They can be used with PaymentIntents to collect payments, or saved to Customer objects to store instrument details for future payments.

See

https://stripe.com/docs/api/payment_methods

See

https://stripe.com/docs/payments/payment-methods/saving#attach-method

Declaration

Objective-C


@interface SCPPaymentMethod : NSObject

Swift

class PaymentMethod : NSObject


                    
                    
                    SCPPaymentMethodType

The type of the PaymentMethod.

See

https://stripe.com/docs/api/payment_methods/object#payment_method_object-type

Declaration

Objective-C

enum SCPPaymentMethodType : NSUInteger {}

Swift

enum PaymentMethodType : UInt, @unchecked Sendable


                    
                    
                    SCPPaymentMethodOptionsParameters

The PaymentMethodOptionsParameters contains options for PaymentMethod creation.

Declaration

Objective-C


@interface SCPPaymentMethodOptionsParameters : NSObject <NSCopying>

Swift

class PaymentMethodOptionsParameters : NSObject, NSCopying


                    
                    
                    SCPPaymentMethodOptionsParametersBuilder

Builder class for SCPPaymentMethodOptionsParameters.

Declaration

Objective-C


@interface SCPPaymentMethodOptionsParametersBuilder
    : SCPBuilder <SCPPaymentMethodOptionsParameters *>

Swift

class PaymentMethodOptionsParametersBuilder : SCPBuilder<PaymentMethodOptionsParameters>


                    
                    
                    SCPCollectPaymentIntentConfiguration

The CollectPaymentIntentConfiguration contains configuration information relevant to collecting a payment method.

Declaration

Objective-C


@interface SCPCollectPaymentIntentConfiguration : NSObject <NSCopying>

Swift

class CollectPaymentIntentConfiguration : NSObject, NSCopying


                    
                    
                    SCPCollectPaymentIntentConfigurationBuilder

The CollectPaymentIntentConfigurationBuilder is used to create a CollectPaymentIntentConfiguration object.

Declaration

Objective-C


@interface SCPCollectPaymentIntentConfigurationBuilder
    : SCPBuilder <SCPCollectPaymentIntentConfiguration *>

Swift

class CollectPaymentIntentConfigurationBuilder : SCPBuilder<CollectPaymentIntentConfiguration>


                    
                    
                    SCPConfirmPaymentIntentConfiguration

The ConfirmPaymentIntentConfiguration contains configuration information relevant to confirming a payment intent.

Declaration

Objective-C


@interface SCPConfirmPaymentIntentConfiguration : NSObject <NSCopying>

Swift

class ConfirmPaymentIntentConfiguration : NSObject, NSCopying


                    
                    
                    SCPConfirmPaymentIntentConfigurationBuilder

The ConfirmPaymentIntentConfigurationBuilder is used to create a ConfirmPaymentIntentConfiguration object.

Declaration

Objective-C


@interface SCPConfirmPaymentIntentConfigurationBuilder
    : SCPBuilder <SCPConfirmPaymentIntentConfiguration *>

Swift

class ConfirmPaymentIntentConfigurationBuilder : SCPBuilder<ConfirmPaymentIntentConfiguration>


                    
                    
                    SCPSurchargeConfiguration

The SurchargeConfiguration contains configuration information relevant to surcharge collection during payment confirmation.

Declaration

Objective-C


@interface SCPSurchargeConfiguration : NSObject <NSCopying>

Swift

class SurchargeConfiguration : NSObject, NSCopying


                    
                    
                    SCPSurchargeConfigurationBuilder

The SurchargeConfigurationBuilder is used to create a SurchargeConfiguration object.

Declaration

Objective-C


@interface SCPSurchargeConfigurationBuilder
    : SCPBuilder <SCPSurchargeConfiguration *>

Swift

class SurchargeConfigurationBuilder : SCPBuilder<SurchargeConfiguration>


                    
                    
                    SCPSurchargeConsent

The SurchargeConsent contains configuration information for surcharge consent collection.

Declaration

Objective-C


@interface SCPSurchargeConsent : NSObject <NSCopying>

Swift

class SurchargeConsent : NSObject, NSCopying


                    
                    
                    SCPSurchargeConsentBuilder

The SurchargeConsentBuilder is used to create a SurchargeConsent object.

Declaration

Objective-C


@interface SCPSurchargeConsentBuilder : SCPBuilder <SCPSurchargeConsent *>

Swift

class SurchargeConsentBuilder : SCPBuilder<SurchargeConsent>


                    
                    
                    SCPSurchargeConsentCollection

Enum representing surcharge consent collection states.

Declaration

Objective-C

enum SCPSurchargeConsentCollection : NSUInteger {}

Swift

enum SurchargeConsentCollection : UInt, @unchecked Sendable


                    
                    
                    SCPCollectSetupIntentConfiguration

The CollectSetupIntentConfiguration contains configuration information relevant to collecting a payment method for an SCPSetupIntent.

Declaration

Objective-C


@interface SCPCollectSetupIntentConfiguration : NSObject <NSCopying>

Swift

class CollectSetupIntentConfiguration : NSObject, NSCopying


                    
                    
                    SCPCollectSetupIntentConfigurationBuilder

The CollectSetupIntentConfigurationBuilder is used to create a CollectSetupIntentConfiguration object.

Declaration

Objective-C


@interface SCPCollectSetupIntentConfigurationBuilder
    : SCPBuilder <SCPCollectSetupIntentConfiguration *>

Swift

class CollectSetupIntentConfigurationBuilder : SCPBuilder<CollectSetupIntentConfiguration>


                    
                    
                    SCPCollectRefundConfiguration

The CollectRefundConfiguration contains configuration information relevant to refunding a payment.

Declaration

Objective-C


@interface SCPCollectRefundConfiguration : NSObject <NSCopying>

Swift

class CollectRefundConfiguration : NSObject, NSCopying


                    
                    
                    SCPCollectRefundConfigurationBuilder

The CollectRefundConfigurationBuilder is used to create a CollectRefundConfiguration object.

Declaration

Objective-C


@interface SCPCollectRefundConfigurationBuilder
    : SCPBuilder <SCPCollectRefundConfiguration *>

Swift

class CollectRefundConfigurationBuilder : SCPBuilder<CollectRefundConfiguration>


                    
                    
                    SCPCustomerCancellation

Controls whether customer-initiated cancellation is enabled during payment collection.

Android based internet readers support enabling and disabling customer cancellation.
WisePad 3 and Tap to Pay will always show customer cancellation and it cannot be disabled.
Stripe M2 and Chipper 2X do not support customer cancellation.

Declaration

Objective-C

enum SCPCustomerCancellation : NSUInteger {}

Swift

enum CustomerCancellation : UInt, @unchecked Sendable


                    
                    
                    SCPCaptureMethod

@abstract Controls when the funds will be captured from the customer’s account.

See

https://stripe.com/docs/terminal/payments/collect-payment?terminal-sdk-platform=ios#capture-payment

Declaration

Objective-C

enum SCPCaptureMethod : NSUInteger {}

Swift

enum CaptureMethod : UInt, @unchecked Sendable


                    
                    
                    SCPCreateConfiguration

The CreateConfiguration contains configuration relevant to creating a payment intent.

Declaration

Objective-C


@interface SCPCreateConfiguration : NSObject

Swift

class CreateConfiguration : NSObject


                    
                    
                    SCPCreateConfigurationBuilder

Builder class for SCPCreateConfiguration.

Declaration

Objective-C


@interface SCPCreateConfigurationBuilder : SCPBuilder <SCPCreateConfiguration *>

Swift

class CreateConfigurationBuilder : SCPBuilder<CreateConfiguration>


                    
                    
                    SCPOfflineBehavior

The available operating modes that define how payment intents respond to changes in network connectivity.

Declaration

Objective-C

enum SCPOfflineBehavior : NSInteger {}

Swift

enum OfflineBehavior : Int, @unchecked Sendable


                    
                    
                    SCPOfflineCardPresentDetails

Contains details about the payment method used to process a PaymentIntent offline.

Declaration

Objective-C


@interface SCPOfflineCardPresentDetails : NSObject <NSCopying>

Swift

class OfflineCardPresentDetails : NSObject, NSCopying


                    
                    
                    SCPOfflineDetails

The payment details available via intent.offlineDetails when a payment is created or confirmed while offline.

When an intent is created offline, the intent.stripeId will be nil. To keep track of offline payments, we recommend using the intent.metadata with your own identifiers.

Declaration

Objective-C


@interface SCPOfflineDetails : NSObject <NSCopying>

Swift

class OfflineDetails : NSObject, NSCopying


                    
                    
                    SCPOfflineStatusDetails

Contains status and statistics relevant to operating offline.

Declaration

Objective-C


@interface SCPOfflineStatusDetails : NSObject

Swift

class OfflineStatusDetails : NSObject


                    
                    
                    SCPSurcharge

Contains details about the availability and maximum amount for surcharging on this PaymentIntent.

Declaration

Objective-C


@interface SCPSurcharge : NSObject <NSCopying>

Swift

class Surcharge : NSObject, NSCopying


                    
                    
                    SCPTippingConfiguration

The TippingConfiguration contains configuration information relevant to collecting tips.

Declaration

Objective-C


@interface SCPTippingConfiguration : NSObject <NSCopying>

Swift

class TippingConfiguration : NSObject, NSCopying


                    
                    
                    SCPTippingConfigurationBuilder

A builder class for SCPTippingConfiguration.

Declaration

Objective-C


@interface SCPTippingConfigurationBuilder
    : SCPBuilder <SCPTippingConfiguration *>

Swift

class TippingConfigurationBuilder : SCPBuilder<TippingConfiguration>


                    
                    
                    SCPNetworks

Contains information about card networks that can be used to process the payment.

See

https://stripe.com/docs/api/payment_methods/object#payment_method_object-card-networks-available

Declaration

Objective-C

@interface SCPNetworks : NSObject

Swift

class SCPNetworks : NSObject


                    
                    
                    SCPIncrementalAuthorizationStatus

Represents the ability for a PaymentIntent to be incrementally authorized.

See

https://stripe.com/docs/terminal/features/incremental-authorizations

Declaration

Objective-C

enum SCPIncrementalAuthorizationStatus : NSUInteger {}

Swift

enum IncrementalAuthorizationStatus : UInt, @unchecked Sendable


                    
                    
                    SCPMotoConfiguration

The MotoConfiguration allows configuring Mail Order/Telephone Order transactions.

Pass a non-nil value for this configuration to enable MO/TO.

Declaration

Objective-C


@interface SCPMotoConfiguration : NSObject <NSCopying>

Swift

class MotoConfiguration : NSObject, NSCopying


                    
                    
                    SCPMotoConfigurationBuilder

A builder class for SCPMotoConfiguration.

Declaration

Objective-C


@interface SCPMotoConfigurationBuilder : SCPBuilder <SCPMotoConfiguration *>

Swift

class MotoConfigurationBuilder : SCPBuilder<MotoConfiguration>


                    
                    
                    SCPReadMethod

How card details were read in this transaction.

Declaration

Objective-C

enum SCPReadMethod : NSUInteger {}

Swift

enum ReadMethod : UInt, @unchecked Sendable


                    
                    
                    SCPWallet

If this payment is part of a card wallet, this contains the details of the card wallet.

Declaration

Objective-C

@interface SCPWallet : NSObject

Swift

class SCPWallet : NSObject


                    
                    
                    SCPWechatPayDetails

Contains details about a user’s wechat_payment

See

https://stripe.com/docs/api/payment_methods/object#payment_method_object-wechat_pay

Declaration

Objective-C


@interface SCPWechatPayDetails : NSObject

Swift

class WechatPayDetails : NSObject


                    
                    
                    SCPAllowRedisplay

A field used to indicate whether a payment method can be shown again to its customer in a checkout flow. Consent must be obtained to set this field.

Declaration

Objective-C

enum SCPAllowRedisplay : NSUInteger {}

Swift

enum AllowRedisplay : UInt, @unchecked Sendable


                    
                    
                    SCPAffirmDetails

Contains details about a user’s affirm payment

See

https://stripe.com/docs/api/payment_methods/object#payment_method_object-affirm

Declaration

Objective-C


@interface SCPAffirmDetails : NSObject

Swift

class AffirmDetails : NSObject


                    
                    
                    SCPPaynowDetails

Contains details about a user’s paynow payment

See

https://stripe.com/docs/api/payment_methods/object#payment_method_object-paynow

Declaration

Objective-C


@interface SCPPaynowDetails : NSObject

Swift

class PaynowDetails : NSObject


                    
                    
                    SCPPaypayDetails

Contains details about a user’s PayPay payment

See

https://stripe.com/docs/api/payment_methods/object#payment_method_object-paypay

Declaration

Objective-C


@interface SCPPaypayDetails : NSObject

Swift

class PaypayDetails : NSObject


                    
                    
                    SCPDynamicCurrencyConversion

An object representing the dynamic currency conversion details for a transaction.

See

https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-dynamic_currency_conversion

Declaration

Objective-C


@interface SCPDynamicCurrencyConversion : NSObject <NSCopying>

Swift

class DynamicCurrencyConversion : NSObject, NSCopying


                    
                    
                    SCPNextAction

Represents the next action that should be taken for a PaymentIntent.

See

https://stripe.com/docs/api/payment_intents/object#payment_intent_object-next_action

Declaration

Objective-C


@interface SCPNextAction : NSObject <NSCopying>

Swift

class NextAction : NSObject, NSCopying


                    
                    
                    SCPWechatPayDisplayQrCode

Contains instructions for displaying a QR code for WeChat Pay payments.

Declaration

Objective-C


@interface SCPWechatPayDisplayQrCode : NSObject <NSCopying>

Swift

class WechatPayDisplayQrCode : NSObject, NSCopying


                    
                    
                    SCPRedirectToUrl

Contains instructions for redirecting the customer to another URL.

Declaration

Objective-C


@interface SCPRedirectToUrl : NSObject <NSCopying>

Swift

class RedirectToUrl : NSObject, NSCopying


                    
                    
                    SCPUseStripeSdk

Contains information for Stripe SDK authentication flows.

Declaration

Objective-C


@interface SCPUseStripeSdk : NSObject <NSCopying>

Swift

class UseStripeSdk : NSObject, NSCopying


                    
                    
                    SCPGeneratedFrom

Contains details of the original PaymentMethod that created this CardDetails object.

See

https://stripe.com/docs/api/payment_methods/object#payment_method_object-card-generated_from

Declaration

Objective-C


@interface SCPGeneratedFrom : NSObject <NSCopying>

Swift

class GeneratedFrom : NSObject, NSCopying


                    
                    
                    SCPApiError

An API error returned by Stripe when a request fails.

See

https://stripe.com/docs/api/errors

Declaration

Objective-C


@interface SCPApiError : NSObject <NSCopying>

Swift

class ApiError : NSObject, NSCopying