VisaProfile


@interface VisaProfile : VInitInfo

The VisaProfile class is the mechanism to customize the Visa Checkout SDK’s configuration. These settings allow various modifications to the way the SDK behaves and also the way it appears to your users.

  • Set false if Canadian debit cards are not accepted. Default is true.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) BOOL acceptCanadianDebitCards;

    Swift

    var acceptCanadianDebitCards: Bool { get set }
  • The countries you are able to accept billing information from.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic)
        NSArray *_Nullable acceptedBillingCountries;

    Swift

    var acceptedBillingCountries: [Any]? { get set }
  • The countries you are able to accept billing information from.

    Declaration

    Objective-C

    - (void)acceptedBillingCountries:(NSArray *_Nonnull)countries;

    Swift

    func acceptedBillingCountries(_ countries: [Any])
  • The VisaCardBrands that are accepted as valid payment types.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic) NSArray *_Nullable acceptedCardBrands;

    Swift

    var acceptedCardBrands: [Any]? { get set }
  • The VisaCardBrands that are accepted as valid payment types.

    Declaration

    Objective-C

    - (void)acceptedCardBrands:(NSArray<NSNumber *> *_Nonnull)brands;

    Swift

    func acceptedCardBrands(_ brands: [NSNumber])
  • The countries you are able to ship to.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic)
        NSArray *_Nullable acceptedShippingCountries;

    Swift

    var acceptedShippingCountries: [Any]? { get set }
  • The countries you are able to ship to.

    Declaration

    Objective-C

    - (void)acceptedShippingCountries:(NSArray<NSNumber *> *_Nonnull)countries;

    Swift

    func acceptedShippingCountries(_ countries: [NSNumber])
  • The API Key string given associated with your Visa Merchant account. This key will be dependent on which VisaEnvironment you are connecting to. For instance, you will have one API Key for the Sandbox VisaEnvironment and a different API Key for the Production VisaEnvironment.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic) NSString *_Nonnull apiKey;

    Swift

    var apiKey: String { get set }
  • Set the client id if needed

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic) NSString *_Nullable clientId;

    Swift

    var clientId: String? { get set }
  • Not required for merchants. For partners, it is the unique ID associated with a partner’s client, such as the ID of a merchant onboarded by the partner. Typically, the external client ID is assigned by a partner; however, Visa Checkout assigns a value if one is not specified.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic) NSString *_Nullable externalClientId;

    Swift

    var externalClientId: String? { get set }
  • The level of detail that is returned on the VisaCheckoutResult object after the user completes a Visa Checkout transaction.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) VisaDataLevel datalevel;

    Swift

    var datalevel: DataLevel { get set }
  • How Visa Checkout should refer to your company/app

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic) NSString *_Nullable displayName;

    Swift

    var displayName: String? { get set }
  • Complete URL to your website.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic) NSString *_Nullable websiteUrl;

    Swift

    var websiteUrl: String? { get set }
  • Your complete customer service or support URL.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic) NSString *_Nullable customerSupportUrl;

    Swift

    var customerSupportUrl: String? { get set }
  • Set this to true to enable tokenization.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) BOOL enableTokenization;

    Swift

    var enableTokenization: Bool { get set }
  • The server environment to use

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) VisaEnvironment environment;

    Swift

    var environment: Environment { get set }
  • Specify the encryption key to be used by Visa

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic) NSString *_Nullable encryptionKey;

    Swift

    var encryptionKey: String? { get set }
  • The profile name associated with your Visa Merchant account. Default is default.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic) NSString *_Nullable profileName;

    Swift

    var profileName: String? { get set }
  • The locale, which controls how text displays.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic) NSString *_Nullable locale;

    Swift

    var locale: String? { get set }
  • Country code of the country where the purchase should be shipped, such as US; useful for calculating shipping costs.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic) NSString *_Nullable countryCode;

    Swift

    var countryCode: String? { get set }
  • Welcome message for the new user.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic) NSString *_Nullable welcomeMessage;

    Swift

    var welcomeMessage: String? { get set }
  • Welcome message description.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic)
        NSString *_Nullable welcomeMessageDescription;

    Swift

    var welcomeMessageDescription: String? { get set }
  • Welcome message for a returning user.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic)
        NSString *_Nullable returningUserWelcomeMessage;

    Swift

    var returningUserWelcomeMessage: String? { get set }
  • Initializer with basic information required to configure the Visa Checkout SDK.

    Declaration

    Objective-C

    - (instancetype _Nonnull)initWithEnvironment:(VisaEnvironment)environment
                                          apiKey:(NSString *_Nonnull)apiKey
                                     profileName:(NSString *_Nullable)profileName;

    Swift

    init(environment: Environment, apiKey: String, profileName: String?)

    Parameters

    environment
    apiKey

    The apiKey.

    profileName
  • Apply child directed treatment for Google ad tracking if COPPA compliance is necessary. Default value is false.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic)
        BOOL applyChildDirectedTreatmentForGoogleAds;

    Swift

    var applyChildDirectedTreatmentForGoogleAds: Bool { get set }
  • If you provide this along with facebookAdvertisingID, we will send Visa Checkout screen visible events to your facebook event tracker on your behalf

    Declaration

    Objective-C

    @property (readwrite, copy, nonatomic) NSString *_Nullable facebookAppID;

    Swift

    var facebookAppID: String? { get set }
  • If you provide this along with facebookAppID, we will send Visa Checkout screen visible events to your facebook event tracker on your behalf. This should be the value of Apple’s Advertising Identifier (IDFA).

    Declaration

    Objective-C

    @property (readwrite, copy, nonatomic) NSString *_Nullable facebookAdvertisingID;

    Swift

    var facebookAdvertisingID: String? { get set }
  • Provide the file name of a custom PNG logo to be shown inside Visa Checkout. The file should be a resource accessible by your app bundle.

    Declaration

    Objective-C

    @property (readwrite, copy, nonatomic) NSString *_Nullable logo;

    Swift

    var logo: String? { get set }