SCPPaymentIntentParameters

Objective-C


@interface SCPPaymentIntentParameters : NSObject

Swift

class PaymentIntentParameters : NSObject

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

See

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

  • The amount of the payment, provided in the currency’s smallest unit.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSUInteger amount;

    Swift

    var amount: UInt { get }

  • Three-letter ISO currency code, in lowercase. Must be a supported currency.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSString *_Nonnull currency;

    Swift

    var currency: String { get }

  • The list of payment method types that this PaymentIntent is allowed to use. The default is value for this is [“card_present”].

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSArray<NSString *> *_Nonnull paymentMethodTypes;

    Swift

    var paymentMethodTypes: [String] { get }

  • The capture method that this PaymentIntent should use. Defaults to SCPCaptureMethodManual.

    Declaration

    Objective-C

    @property (nonatomic, readonly) SCPCaptureMethod captureMethod;

    Swift

    var captureMethod: CaptureMethod { get }

  • Set 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.

    See

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

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSDictionary<NSString *, NSString *> *metadata;

    Swift

    var metadata: [String : String]? { get }

  • An arbitrary string attached to the object. If you send a receipt email for this payment, the email will include the description.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSString *stripeDescription;

    Swift

    var stripeDescription: String? { get }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSString *statementDescriptor;

    Swift

    var statementDescriptor: String? { get }

  • A string to specify details about the transaction so your customer can understand it clearly on their statement. The suffix is concatenated with the statementDescriptor, the * symbol, and a space to form the complete statement descriptor that your customer sees. Maximum 22 characters for the final concatenated descriptor.

    See

    https://stripe.com/docs/account/statement-descriptors

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSString *statementDescriptorSuffix;

    Swift

    var statementDescriptorSuffix: String? { get }

  • Email address that the receipt for the resulting payment will be sent to.

    See

    https://stripe.com/docs/terminal/checkout/receipts

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSString *receiptEmail;

    Swift

    var receiptEmail: String? { get }

  • The ID of the Customer this PaymentIntent is for, if one exists.

    See

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

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSString *customer;

    Swift

    var customer: String? { get }

  • 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.

    The amount is a boxed UInt in the currency’s smallest unit.

    See

    https://stripe.com/docs/connect/direct-charges#collecting-fees

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSNumber *applicationFeeAmount;

    Swift

    var applicationFeeAmount: NSNumber? { get }

  • A string that identifies the resulting payment as part of a group.

    See

    https://stripe.com/docs/connect/charges-transfers#grouping-transactions

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSString *transferGroup;

    Swift

    var transferGroup: String? { get }

  • 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.

    At capture time, use transfer_data[amount] to specify the amount that will be transferred automatically when a charge succeeds.

    When transferDataDestination is specified, onBehalfOf must also be specified and must match the destination of the transfer.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSString *transferDataDestination;

    Swift

    var transferDataDestination: String? { get }

  • The Stripe account ID for which these funds are intended.

    When transferDataDestination is specified, onBehalfOf must also be specified and must match the destination of the transfer.

    See

    https://stripe.com/docs/connect/charges-transfers#on-behalf-of

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSString *onBehalfOf;

    Swift

    var onBehalfOf: String? { get }

  • Indicates that you intend to make future payments with this PaymentIntent’s payment method.

    Providing this parameter will attach the payment method to the PaymentIntent’s Customer, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be attached to a Customer after the transaction completes.

    Possible values: “on_session”: Use “on_session” if you intend to only reuse the payment method when your customer is present in your checkout flow. “off_session”: Use “off_session” if your customer may or may not be present in your checkout flow.

    See

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

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSString *setupFutureUsage;

    Swift

    var setupFutureUsage: String? { get }

  • Specific options used during the creation of the PaymentMethod.

    Declaration

    Objective-C

    @property (nonatomic, readonly) SCPPaymentMethodOptionsParameters *_Nonnull paymentMethodOptionsParameters;

    Swift

    var paymentMethodOptionsParameters: PaymentMethodOptionsParameters { get }

  • Unavailable

    Use SCPPaymentIntentParametersBuilder

    Declaration

    Objective-C

    - (nonnull instancetype)init;

  • Unavailable

    Use SCPPaymentIntentParametersBuilder

    Declaration

    Objective-C

    + (nonnull instancetype)new;

  • Deprecated

    Did you mean to use stripeDescription?

    Use stripeDescription for the string attached to the object.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) DEPRECATED_MSG_ATTRIBUTE("Did you mean to use stripeDescription?") NSString *description;

    Swift

    var description: String { get }