STPConnectAccountParams
@interface STPConnectAccountParams : NSObject <STPFormEncodable>
Parameters for creating a Connect Account token.
-
Optional boolean indicating that the Terms Of Service were shown to the user & the user accepted them.
Declaration
Objective-C
@property (readonly, nonatomic, nullable) NSNumber *tosShownAndAccepted;
Swift
var tosShownAndAccepted: NSNumber? { get }
-
The business type.
Declaration
Objective-C
@property (readonly, nonatomic) STPConnectAccountBusinessType businessType;
Swift
var businessType: STPConnectAccountBusinessType { get }
-
Information about the individual represented by the account.
Declaration
Objective-C
@property (readonly, nonatomic, nullable) STPConnectAccountIndividualParams *individual;
Swift
var individual: STPConnectAccountIndividualParams? { get }
-
Information about the company or business.
Declaration
Objective-C
@property (readonly, nonatomic, nullable) STPConnectAccountCompanyParams *company;
Swift
var company: STPConnectAccountCompanyParams? { get }
-
Unavailable
Cannot be directly instantiated
STPConnectAccountParams
cannot be directly instantiated.Declaration
Objective-C
- (nonnull instancetype)init;
-
Initialize
STPConnectAccountParams
with tosShownAndAccepted = YESThis method cannot be called with
wasAccepted == NO
, guarded by aNSParameterAssert()
.Use this init method if you want to set the
tosShownAndAccepted
parameter. If you don’t, use theinitWithIndividual:
version instead.Declaration
Objective-C
- (nonnull instancetype) initWithTosShownAndAccepted:(BOOL)wasAccepted individual:(nonnull STPConnectAccountIndividualParams *) individual;
Swift
init(tosShownAndAccepted wasAccepted: Bool, individual: STPConnectAccountIndividualParams)
Parameters
wasAccepted
Must be YES, but only if the user was shown & accepted the ToS
individual
Information about the person represented by the account. See
STPConnectAccountIndividualParams
. -
Initialize
STPConnectAccountParams
with tosShownAndAccepted = YESThis method cannot be called with
wasAccepted == NO
, guarded by aNSParameterAssert()
.Use this init method if you want to set the
tosShownAndAccepted
parameter. If you don’t, use theinitWithCompany:
version instead.Declaration
Objective-C
- (nonnull instancetype) initWithTosShownAndAccepted:(BOOL)wasAccepted company: (nonnull STPConnectAccountCompanyParams *)company;
Swift
init(tosShownAndAccepted wasAccepted: Bool, company: STPConnectAccountCompanyParams)
Parameters
wasAccepted
Must be YES, but only if the user was shown & accepted the ToS
company
Information about the company or business. See
STPConnectAccountCompanyParams
. -
Initialize
STPConnectAccountParams
with the providedindividual
dictionary.This init method cannot change the
tosShownAndAccepted
parameter. UseinitWithTosShownAndAccepted:individual:
instead if you need to do that.Declaration
Objective-C
- (nonnull instancetype)initWithIndividual: (nonnull STPConnectAccountIndividualParams *)individual;
Swift
init(individual: STPConnectAccountIndividualParams)
Parameters
individual
Information about the person represented by the account
-
Initialize
STPConnectAccountParams
with the providedcompany
dictionary.This init method cannot change the
tosShownAndAccepted
parameter. UseinitWithTosShownAndAccepted:company:
instead if you need to do that.Declaration
Objective-C
- (nonnull instancetype)initWithCompany: (nonnull STPConnectAccountCompanyParams *)company;
Swift
init(company: STPConnectAccountCompanyParams)
Parameters
company
Information about the company or business