VOMerchant

@interface VOMerchant : NSObject <NSCoding>

VOMerchants represent a personalization type that is of monetary value (eg. Gift cards, Money Transfers).

  • The id of the VOMerchant. This will be unique for each VOMerchant.

    Declaration

    Objective-C

    @property (readonly, nonatomic) long long merchantId;

    Swift

    var merchantId: Int64 { get }

  • A unique URI for the VOMerchant. Usually provided by the VOMerchant. Nil if no uri is provided for the VOMerchant.

    Declaration

    Objective-C

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

    Swift

    var merchantUri: String? { get }

  • The name of the VOMerchant.

    Declaration

    Objective-C

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

    Swift

    var name: String { get }

  • A company photo url for the VOMerchant.

    Declaration

    Objective-C

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

    Swift

    var photoUrl: String? { get }

  • A preview photo url for the VOMerchant. Shown in the default VOGiftCardPickerViewController screen.

    Declaration

    Objective-C

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

    Swift

    var previewPhotoUrl: String? { get }

  • The background color shown behind the previewPhotoUrl in the default VOGiftCardPickerViewController screen.

    Declaration

    Objective-C

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

    Swift

    var backgroundColorHexString: String? { get }

  • Whether the VOMerchant allows being used online.

    Declaration

    Objective-C

    @property (readonly, assign, nonatomic) BOOL canBeUsedOnline;

    Swift

    var canBeUsedOnline: Bool { get }

  • Whether if the VOMerchant is a P2P cash transfer.

    Declaration

    Objective-C

    @property (readonly, assign, nonatomic) BOOL isP2PCashTransfer;

    Swift

    var isP2PCashTransfer: Bool { get }

  • If productSearchEnabled is on, users will be able to browse and recommend a product to the recipient alongside their Money Personalization.

    Declaration

    Objective-C

    @property (readonly, assign, nonatomic) BOOL productSearchEnabled;

    Swift

    var productSearchEnabled: Bool { get }

  • A list of VOPaymentMerchantInfo associated with the VOMerchant.

    Declaration

    Objective-C

    @property (readonly, nonatomic)
    NSArray<VOPaymentMerchantInfo *> *_Nonnull paymentMerchantInfos;

    Swift

    var paymentMerchantInfos: [VOPaymentMerchantInfo] { get }

  • The currently selected (default) VOPaymentMerchantInfo for the VOMerchant.

    Declaration

    Objective-C

    @property (readonly, nonatomic) VOPaymentMerchantInfo *_Nonnull sourceInfo;

    Swift

    var sourceInfo: VOPaymentMerchantInfo { get }

  • The website url for the VOMerchant.

    Declaration

    Objective-C

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

    Swift

    var websiteUrl: String? { get }

  • VOMerchants that are featured will appear in bigger cells at the top of the default VOGiftCardPickerViewController screen. featuredBackgroundImageUrl shows the image in the background of the featured cell.

    Declaration

    Objective-C

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

    Swift

    var featuredBackgroundImageUrl: String? { get }

  • VOMerchants that are featured will appear in bigger cells at the top of the default VOGiftCardPickerViewController screen. featuredButtonImageUrl shows as the button image of the featured cell.

    Declaration

    Objective-C

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

    Swift

    var featuredButtonImageUrl: String? { get }

  • VOMerchants that are featured will appear in bigger cells at the top of the default VOGiftCardPickerViewController screen. featuredHeading shows up as header text in the featured cell.

    Declaration

    Objective-C

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

    Swift

    var featuredHeading: String? { get }

  • VOMerchants that are featured will appear in bigger cells at the top of the default VOGiftCardPickerViewController screen. featuredSubheading shows up as subheader text in the featured cell.

    Declaration

    Objective-C

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

    Swift

    var featuredSubheading: String? { get }

  • VOMerchants that are featured will appear in bigger cells at the top of the default VOGiftCardPickerViewController screen. ‘action’ is used as the deeplink action for the VOMerchant. This will be generated by the server.

    Declaration

    Objective-C

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

    Swift

    var action: String? { get }

  • Static initializer for VOMerchant from a dictionary. Converts a dictionary to a VOMerchant.

    Declaration

    Objective-C

    + (nonnull VOMerchant *)merchantFromDictionary:
    (nonnull NSDictionary *)dictionary;

    Swift

    /*not inherited*/ init(from dictionary: [AnyHashable : Any])

    Parameters

    dictionary

    - the dictionary being converted to a VOMerchant.

    Return Value

    Instance of VOMerchant.

  • Default initializer for VOMerchant from a Dictionary. Converts a dictionary to a VOMerchant.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithDictionary:(nonnull NSDictionary *)dictionary;

    Swift

    init(dictionary: [AnyHashable : Any])

    Parameters

    dictionary

    - the dictionary being converted to a VOMerchant.

    Return Value

    Instance of VOMerchant.

  • Converts a VOMerchant to an NSDictionary that can be used for caching or sending to the server.

    Declaration

    Objective-C

    - (nonnull NSDictionary *)dictionaryRepresentation;

    Swift

    func dictionaryRepresentation() -> [AnyHashable : Any]

    Return Value

    dictionary - Dictionary form of a VOMerchant.