Merchant

@interface Merchant : NSObject <NSCoding>

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

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

    Declaration

    Objective-C

    @property (readonly, nonatomic) long long merchantId;

    Swift

    var merchantId: Int64 { get }

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

    Declaration

    Objective-C

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

    Swift

    var merchantUri: String? { get }

  • The name of the Merchant.

    Declaration

    Objective-C

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

    Swift

    var name: String { get }

  • A company photo url for the Merchant.

    Declaration

    Objective-C

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

    Swift

    var photoUrl: String? { get }

  • A preview photo url for the Merchant. Shown in the default GiftCardPickerViewController 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 GiftCardPickerViewController screen.

    Declaration

    Objective-C

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

    Swift

    var backgroundColorHexString: String? { get }

  • Whether the Merchant allows being used online.

    Declaration

    Objective-C

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

    Swift

    var canBeUsedOnline: Bool { get }

  • Whether if the Merchant 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 PaymentMerchantInfo associated with the Merchant.

    Declaration

    Objective-C

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

    Swift

    var paymentMerchantInfos: [PaymentMerchantInfo] { get }

  • The currently selected (default) PaymentMerchantInfo for the Merchant.

    Declaration

    Objective-C

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

    Swift

    var sourceInfo: PaymentMerchantInfo { get }

  • The website url for the Merchant.

    Declaration

    Objective-C

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

    Swift

    var websiteUrl: String? { get }

  • Merchants that are featured will appear in bigger cells at the top of the default GiftCardPickerViewController 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 }

  • Merchants that are featured will appear in bigger cells at the top of the default GiftCardPickerViewController 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 }

  • Merchants that are featured will appear in bigger cells at the top of the default GiftCardPickerViewController 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 }

  • Merchants that are featured will appear in bigger cells at the top of the default GiftCardPickerViewController 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 }

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

    Declaration

    Objective-C

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

    Swift

    var action: String? { get }

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

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    dictionary

    - the dictionary being converted to a Merchant.

    Return Value

    Instance of Merchant.

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

    Declaration

    Objective-C

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

    Swift

    init(dictionary: [AnyHashable : Any])

    Parameters

    dictionary

    - the dictionary being converted to a Merchant.

    Return Value

    Instance of Merchant.

  • Converts a Merchant 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 Merchant.