WPError.h

Go to the documentation of this file.

//
//  WPError.h
//  WePay
//
//  Created by Chaitanya Bagaria on 12/22/14.
//  Copyright (c) 2014 WePay. All rights reserved.
//

#import <Foundation/Foundation.h>
#pragma mark - WPError constants.

FOUNDATION_EXPORT NSString * const kWPErrorAPIDomain;

FOUNDATION_EXPORT NSString * const kWPErrorSDKDomain;

FOUNDATION_EXPORT NSString * const kWPErrorCategoryKey;

FOUNDATION_EXPORT NSString * const kWPErrorCategoryNone;

FOUNDATION_EXPORT NSString * const kWPErrorCategoryCardReader;

FOUNDATION_EXPORT NSString * const kWPErrorCategoryCardSDK;

#pragma mark - Error Codes.

typedef enum WPErrorCode {
    WPErrorUnknown              = -10000,
    
    // -10001 to -10014 are reserved for legacy error codes
    
    WPErrorNoDataReturned       = -10015,
    
    WPErrorCardReaderGeneralError   = -10016,
    
    WPErrorCardReaderInitialization = -10017,
    
    WPErrorCardReaderTimeout        = -10018,
    
    WPErrorCardReaderStatusError    = -10019,
    
    WPErrorInvalidSignatureImage    = -10020,

    WPErrorNameNotFound         = -10021,

    WPErrorInvalidCardData = -10022,

    WPErrorCardNotSupported = -10023,

    WPErrorEMVTransactionError = -10024,

    WPErrorInvalidApplicationId = -10025,

    WPErrorDeclinedByCard = -10026,

    WPErrorCardBlocked = -10027,

    WPErrorDeclinedByIssuer = -10028,

    WPErrorIssuerUnreachable = -10029,
    
    WPErrorInvalidAuthInfo = -10030,
    
    WPErrorAuthInfoNotProvided = -10031,
    
    WPErrorPaymentMethodCannotBeTokenized = -10032,

    WPErrorFailedToGetBatteryLevel = -10033,
    
    WPErrorCardReaderNotConnected = -10034,
    
    WPErrorCardReaderModelNotSupported = -10035,
    
    WPErrorInvalidTransactionAmount = -10036,
    
    WPErrorInvalidTransactionCurrencyCode = -10037,
    
    WPErrorInvalidTransactionAccountID = -10038,
    
    WPErrorInvalidCardReaderSelection = -10039,

    WPErrorCardReaderBatteryTooLow = -10040,

    WPErrorCardReaderUnableToConnect = -10041

} WPErrorCode;

#pragma mark - User facing messages.

#define WPUnexpectedErrorMessage NSLocalizedStringFromTable(@"There was an unexpected error.", @"WePay", @"There was an unexpected error.");

#define WPNoDataReturnedErrorMessage NSLocalizedStringFromTable(@"There was no data returned.", @"WePay",  @"There was no data returned.");

#define WPCardReaderGeneralErrorMessage NSLocalizedStringFromTable(@"Swipe failed due to: (a) uneven swipe speed, (b) fast swipe, (c) slow swipe, or (d) damaged card.", @"WePay",  @"Swipe failed due to: (a) uneven swipe speed, (b) fast swipe, (c) slow swipe, or (d) damaged card.");

#define WPCardReaderInitializationErrorMessage NSLocalizedStringFromTable(@"Failed to initialize card reader.", @"WePay",  @"Failed to initialize card reader.");

#define WPCardReaderTimeoutErrorMessage NSLocalizedStringFromTable(@"Card reader timed out.", @"WePay",  @"Card reader timed out.");

#define WPSignatureInvalidImageErrorMessage NSLocalizedStringFromTable(@"Inavlid signature image provided.", @"WePay",  @"Inavlid signature image provided.");

#define WPNameNotFoundErrorMessage NSLocalizedStringFromTable(@"Name not found.", @"WePay",  @"Name not found.");

#define WPInvalidCardDataErrorMessage NSLocalizedStringFromTable(@"Invalid card data.", @"WePay",  @"Invalid card data.");

#define WPCardNotSupportedErrorMessage NSLocalizedStringFromTable(@"This card is not supported.", @"WePay",  @"This card is not supported.");

#define WPInvalidApplicationIdErrorMessage NSLocalizedStringFromTable(@"Invalid application ID selected.", @"WePay",  @"Invalid application ID selected.");

#define WPDeclinedByCardErrorMessage NSLocalizedStringFromTable(@"The transaction was declined by the card.", @"WePay",  @"The transaction was declined by the card.");

#define WPCardBlockedErrorMessage NSLocalizedStringFromTable(@"This card has been blocked.", @"WePay",  @"This card has been blocked.");

#define WPDeclinedByIssuerErrorMessage NSLocalizedStringFromTable(@"The transaction was declined by the issuer bank.", @"WePay",  @"The transaction was declined by the issuer bank.");

#define WPIssuerUnreachableErrorMessage NSLocalizedStringFromTable(@"The issuing bank could not be reached.", @"WePay",  @"The issuing bank could not be reached.");

#define WPInvalidAuthInfoErrorMessage NSLocalizedStringFromTable(@"The provided auth info is invalid.", @"WePay",  @"The provided auth info is invalid.");

#define WPAuthInfoNotProvidedErrorMessage NSLocalizedStringFromTable(@"Auth info was not provided.", @"WePay",  @"Auth info was not provided.");

#define WPPaymentMethodCannotBeTokenizedErrorMessage NSLocalizedStringFromTable(@"This payment method cannot be tokenized.", @"WePay",  @"This payment method cannot be tokenized.");

#define WPFailedToGetBatteryLevelErrorMessage NSLocalizedStringFromTable(@"Battery level could not be determined.", @"WePay",  @"Battery level could not be determined.");

#define WPCardReaderNotConnectedErrorMessage NSLocalizedStringFromTable(@"Card reader is not connected.", @"WePay",  @"Card reader is not connected.");

#define WPCardReaderModelNotSupportedErrorMessage NSLocalizedStringFromTable(@"This card reader model is not supported.", @"WePay",  @"This card reader model is not supported.");

#define WPErrorInvalidTransactionAmountErrorMessage NSLocalizedStringFromTable(@"The provided transaction amount is invalid.", @"WePay", @"The provided transaction amount is invalid.");

#define WPErrorInvalidTransactionCurrencyCodeErrorMessage NSLocalizedStringFromTable(@"The provided currency code is invalid.", @"WePay",  @"The provided currency code is invalid.");

#define WPErrorInvalidTransactionAccountIDErrorMessage NSLocalizedStringFromTable(@"The provided account ID is invalid.", @"WePay",  @"The provided account ID is invalid.");

#define WPErrorInvalidCardReaderSelectionErrorMessage NSLocalizedStringFromTable(@"Card reader selection is invalid.", @"WePay",  @"Card reader selection is invalid.");

#define WPErrorCardReaderBatteryTooLowErrorMessage NSLocalizedStringFromTable(@"The card reader battery does not have enough charge. Please charge before using.", @"WePay",  @"The card reader battery does not have enough charge. Please charge before using.");

#define WPErrorCardReaderUnableToConnectErrorMessage NSLocalizedStringFromTable(@"Please make sure you’re using a supported card reader and that it is fully charged.", @"WePay",  @"Please make sure you’re using a supported card reader and that it is fully charged.");