STPBankAccount

@interface STPBankAccount
    : NSObject <STPAPIResponseDecodable, STPSourceProtocol>

Representation of a user’s bank account details that have been tokenized with the Stripe API.

  • Unavailable

    You cannot directly instantiate an STPBankAccount. You should only use one that has been returned from an STPAPIClient callback.

    You cannot directly instantiate an STPBankAccount. You should only use one that has been returned from an STPAPIClient callback.

    Declaration

    Objective-C

    - (nonnull instancetype)init;
  • The routing number for the bank account. This should be the ACH routing number, not the wire routing number.

    Declaration

    Objective-C

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

    Swift

    var routingNumber: String? { get }
  • Two-letter ISO code representing the country the bank account is located in.

    Declaration

    Objective-C

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

    Swift

    var country: String { get }
  • The default currency for the bank account.

    Declaration

    Objective-C

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

    Swift

    var currency: String { get }
  • The last 4 digits of the account number.

    Declaration

    Objective-C

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

    Swift

    var last4: String { get }
  • The name of the bank that owns the account.

    Declaration

    Objective-C

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

    Swift

    var bankName: String { get }
  • The name of the person or business that owns the bank account.

    Declaration

    Objective-C

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

    Swift

    var accountHolderName: String? { get }
  • The type of entity that holds the account.

    Declaration

    Objective-C

    @property (readonly, nonatomic) STPBankAccountHolderType accountHolderType;

    Swift

    var accountHolderType: STPBankAccountHolderType { get }
  • A proxy for the account number, this uniquely identifies the account and can be used to compare equality of different bank accounts.

    Declaration

    Objective-C

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

    Swift

    var fingerprint: String? { get }
  • A set of key/value pairs associated with the bank account object.

    Declaration

    Objective-C

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

    Swift

    var metadata: [String : String]? { get }
  • The validation status of the bank account. - see: STPBankAccountStatus

    Declaration

    Objective-C

    @property (readonly, nonatomic) STPBankAccountStatus status;

    Swift

    var status: STPBankAccountStatus { get }
  • Deprecated

    Use stripeID (defined in STPSourceProtocol)

    The Stripe ID for the bank account.

    Declaration

    Objective-C

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

    Swift

    var bankAccountId: String { get }