Easy Pay library offers access to the Easy Pay API for seamless integration with iOS applications.

General Easy Pay Developer Documentation

• Xcode 15 or above
• compatible with iOS 13.0 or above

1. Prerequisties - obtain from Easy Pay HMAC secret and API key

2. Configure Easy Pay class for example in your Payment Module or in AppDelegate (didFinishLaunchingWithOptions)

EasyPay.shared.configureSecrets(apiKey: "YOURAPIKEY",
                                hmacSecret: "YOURHMACSECRET")

3. Please mind that during Easy Pay initilization the process of downloading certificate is starting. Proceeding with any call before downloading has finished will result in error (RsaCertificateError.failedToLoadCertificateData). You can check the status of downloading by accessing following enum:

EasyPay.shared.certificateStatus

1. Setup with Swift Package Manager

.package(url: "https://github.com/Easy-Pay-Solutions/Mobile-SDK-IOS.git", from: "0.1.0")

2. Setup with Cocoapods

pod 'EasyPay'

EasyPay.shared.configureSecrets(apiKey: String, hmacSecret: String)

EasyPay.shared.loadCertificate(_ completion: @escaping (Result<Data, Error>) -> Void)

Processes a credit card cardsale when the credit card details are entered manually. Details include the card number, expiration date, CVV, card holder name and address.

EasyPay.apiClient.chargeCreditCard(request: CardSaleManualRequest,
                                   completion: @escaping (Result<CreditCardSaleResponse, Error>) -> Void)

• ChargeCreditCard
  • TransactionRequest
    • creditCardInfo: CreditCardInfo
    • accountHolder: AccountHolder
    • endCustomer: EndCustomer?
    • amounts: Amounts
    • purchItems: PurchItems
    • merchantId: Int

• ChargeCreditCard
  • CardSaleManualResponseModel

A query that returns annual consent details. Depending upon the query sent, a single consent or muliple consents may be returned.

EasyPay.apiClient.listAnnualConsents(request: ConsentAnnualListingRequest,
                                     completion: @escaping (Result<ListingConsentAnnualResponse, Error>) -> Void)

• ListAnnualConsents
  • AnnualQueryHelper
    • merchantId: String
    • customerReferenceId: String?
    • endDate: Date?

• ListAnnualConsents
  • ConsentAnnualListingResponseModel

This method creates an annual consent by sending the credit card details, which include: card number, expiration date, CVV, and card holder contact data. It is not created by swiping the card through a reader device.

EasyPay.apiClient.createAnnualConsent(request: CreateConsentAnnualRequest,
                                      completion: @escaping (Result<CreateConsentAnnualResponse, Error>) -> Void)

• CreateAnnualConsent
  • CreateConsentAnnualManualRequestModel
    • creditCardInfo: CreditCardInfo
    • consentAnnualCreate: CreateConsentAnnual
    • accountHolder: AccountHolder
    • endCustomer: AnnualEndCustomer?

• CreateAnnualConsent
  • CreateConsentAnnualResponseModel

Cancels an annual consent. Credit card data is removed from the system after the cancellation is complete.

EasyPay.apiClient.cancelAnnualConsent(request: CancelConsentAnnualRequest,
                                      completion: @escaping (Result<CancelConsentAnnualResponse, Error>) -> Void)

• CancelAnnualConsent
  • CancelConsentAnnualManualRequestModel
    • consentId: Int

• CancelAnnualConsent
  • CancelConsentAnnualResponseModel

This method uses the credit card stored on file to process a payment for an existing consent.

EasyPay.apiClient.processPaymentAnnualConsent(request: ProcessPaymentAnnualRequest,
                                              completion: @escaping (Result<ProcessPaymentAnnualResponse, Error>) -> Void)

• ProcessPaymentAnnualConsent
  • ProcessPaymentAnnualRequestModel
    • consentId: Int
    • processAmount: String

• ProcessPaymentAnnualConsent
  • ProcessPaymentAnnualResponseModel

SDK contains component called SecureTextField prepared to ensure safe input of number of credit card details. It is a subclass of UITextField which enables freedom of styling as needed.

Setting up requires configuring certificate once it was downloaded to encrypt credit card data.

nameOfYourTextField.setupConfig(EasyPay.shared.config)

To receive encrypted card string required to send to the API you can use following method:

nameOfYourTextField.encryptCardData()

It is critical that the response is consumed in the intended order and format. Clients who deviate from this can experience unwanted behavior.

if response.data.errorMessage != "" && response.data.errorCode != 0 {
    //This indicates an error which was handled on the EasyPay servers, consume the ErrCode and the ErrMsg 
    return
} else if response.data.functionOk == true && response.data.txApproved == false {
    //This indicates a declined authorization, display the TXID, RspMsg (friendly decline message), also the decline Code (TxnCode)
} else {
   //Transaction has been approved, display the TXID,  and approval code (also in TXNCODE)  
}

For all other calls you will consume the response the same. If there is No TxApproved flag, then you can omit the last evaluation.

Semantic versioning follows a three-part version number: MAJOR.MINOR.PATCH.

Increment the:

• MAJOR version when you make incompatible API changes,
• MINOR version when you add functionality in a backwards-compatible manner, and
• PATCH version when you make backwards-compatible bug fixes.