STPPaymentIntentLastPaymentError

Objective-C

@interface STPPaymentIntentLastPaymentError : NSObject <STPAPIResponseDecodable>

Swift

class STPPaymentIntentLastPaymentError : NSObject, STPAPIResponseDecodable

The payment error encountered in the previous PaymentIntent confirmation.

See

https://stripe.com/docs/api/payment_intents/object#payment_intent_object-last_payment_error
Show on GitHub

  • For some errors that could be handled programmatically, a short string indicating the error code reported.

    See

    https://stripe.com/docs/error-codes

    Declaration

    Objective-C

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

    Swift

    var code: String? { get }
    Show on GitHub

  • For card (STPPaymentIntentLastPaymentErrorTypeCard) errors resulting from a card issuer decline, a short string indicating the card issuer’s reason for the decline if they provide one.

    See

    https://stripe.com/docs/declines#issuer-declines

    Declaration

    Objective-C

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

    Swift

    var declineCode: String? { get }
    Show on GitHub

  • A URL to more information about the error code reported.

    See

    https://stripe.com/docs/error-codes

    Declaration

    Objective-C

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

    Swift

    var docURL: String { get }
    Show on GitHub

  • A human-readable message providing more details about the error. For card (STPPaymentIntentLastPaymentErrorTypeCard) errors, these messages can be shown to your users.

    Declaration

    Objective-C

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

    Swift

    var message: String { get }
    Show on GitHub

  • If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.

    Declaration

    Objective-C

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

    Swift

    var param: String? { get }
    Show on GitHub

  • The PaymentMethod object for errors returned on a request involving a PaymentMethod.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) STPPaymentMethod *paymentMethod;

    Swift

    var paymentMethod: STPPaymentMethod? { get }
    Show on GitHub

  • The type of error.

    Declaration

    Objective-C

    @property (nonatomic, readonly) STPPaymentIntentLastPaymentErrorType type;

    Swift

    var type: STPPaymentIntentLastPaymentErrorType { get }
    Show on GitHub