VOVoucherPayment

@interface VOVoucherPayment : NSObject

VOVoucherPayment contains all payment information including source, destination, and redemption information. Each VOUser requesting a VOVoucher will receive different VOVoucherPayment information depending on their association of the VOVoucher.

  • Whether the VOVoucherPayment has been processed successfully.

    Declaration

    Objective-C

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

    Swift

    var success: Bool { get }

  • Source of an error, if one occurred.

    Declaration

    Objective-C

    @property (readonly, assign, nonatomic) VOPaymentInfoErrorSource errorSource;

    Swift

    var errorSource: VOPaymentInfoErrorSource { get }

  • State of an error, if one occurred.

    Declaration

    Objective-C

    @property (readonly, assign, nonatomic) VOPaymentInfoErrorState errorState;

    Swift

    var errorState: VOPaymentInfoErrorState { get }

  • Status code of an error, if one occurred.

    Declaration

    Objective-C

    @property (readonly, assign, nonatomic) NSInteger paymentErrorDetailsCode;

    Swift

    var paymentErrorDetailsCode: Int { get }

  • Message details of an error, if one occurred.

    Declaration

    Objective-C

    @property (readonly, strong, nonatomic, nullable)
    NSString *paymentErrorDetailsMessage;

    Swift

    var paymentErrorDetailsMessage: String? { get }

  • State of the VOVoucherPayment.

    Declaration

    Objective-C

    @property (readonly, assign, nonatomic) VOPaymentInfoState paymentState;

    Swift

    var paymentState: VOPaymentInfoState { get }

  • The source information (ie. Creator information) of the VOVoucherPayment.

    Declaration

    Objective-C

    @property (readonly, strong, nonatomic, nullable) VOPaymentInfo *sourceInfo;

    Swift

    var sourceInfo: VOPaymentInfo? { get }

  • The destination information (ie. claimer information) of the VOVoucherPayment.

    Declaration

    Objective-C

    @property (readonly, strong, nonatomic, nullable) VOPaymentInfo *destInfo;

    Swift

    var destInfo: VOPaymentInfo? { get }

  • The redemption information of the VOVoucherPayment.

    Declaration

    Objective-C

    @property (readonly, strong, nonatomic, nullable) VOPaymentInfo *redeemInfo;

    Swift

    var redeemInfo: VOPaymentInfo? { get }

  • An array of options related to the source of the payment.

    Declaration

    Objective-C

    @property (readonly, strong, nonatomic, nullable) NSArray *paymentSourceOptions;

    Swift

    var paymentSourceOptions: [Any]? { get }

  • An array of options related to the destination of the payment.

    Declaration

    Objective-C

    @property (readonly, strong, nonatomic, nullable) NSArray *paymentDestOptions;

    Swift

    var paymentDestOptions: [Any]? { get }

  • If an error occurs, indicates that the user must complete something to fix the error.

    Declaration

    Objective-C

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

    Swift

    var requiresIntervention: Bool { get }

  • Default Initializer for VOVoucherPayment that parses a dictionary of the VOVoucherPayment.

    Declaration

    Objective-C

    + (nonnull VOVoucherPayment *)voucherPaymentFromDictionary:
    (nonnull NSDictionary *)dictionary;

    Swift

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

    Parameters

    dictionary

    - dictionary form of the VOVoucherPayment.

    Return Value

    Instance of VOVoucherPayment.

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