Classes

The following classes are available globally.

  • Holds global configuration information.

    See more

    Declaration

    Swift

    @objcMembers
    public class Configuration : NSObject

Public Methods

  • Provides access to status information from the remote system.

    See more

    Declaration

    Swift

    @objcMembers
    public class StatusMonitor : NSObject
  • Holds data about a payment device.

    See more

    Declaration

    Swift

    @objcMembers
    public class PaymentDevice : NSObject, Codable
  • Manage payment device status responses.

    See more

    Declaration

    Swift

    @objcMembers
    public class DeviceStatusResponse : NSObject, Codable
  • Manage service status responses.

    See more

    Declaration

    Swift

    @objcMembers
    public class ServiceStatusResponse : NSObject, Codable
  • Manage status responses.

    See more

    Declaration

    Swift

    @objcMembers
    public class StatusMonitorResponseHandler : NSObject
  • Holds data required when cancelling a card payment.

    See more

    Declaration

    Swift

    @objcMembers
    public class CardPaymentCancel : NSObject
  • Contains the data for performing a Card sale.

    See more

    Declaration

    Swift

    @objcMembers
    public class CardSale : PaymentRequest, CardPaymentRequest
  • Contains the data for performing a Card refund.

    See more

    Declaration

    Swift

    @objcMembers
    public class CardRefund : CardSale, PaymentRequestRefundable
  • Contains the data for performing a Card Pre-Auth Sale.

    See more

    Declaration

    Swift

    @objcMembers
    public class CardPreAuthSale : CardSale
  • Contains the data for performing a Card Check without Payment.

    See more

    Declaration

    Swift

    @objcMembers
    public class CardCheck : PaymentRequest
  • Contains the data for performing a Card Check with Payment.

    See more

    Declaration

    Swift

    @objcMembers
    public class CardCheckPayment : CardCheck
  • Contains the data for performing a Card keyed sale recovery.

    See more

    Declaration

    Swift

    @objcMembers
    public class CardKeyedSaleRecovery : PaymentRequest
  • Contains the data for performing a Card keyed refund recovery.

    See more

    Declaration

    Swift

    @objcMembers
    public class CardKeyedRefundRecovery : PaymentRequest, PaymentRequestRefundable
  • Contains the data for settling a pre-auth.

    See more

    Declaration

    Swift

    @objcMembers
    public class CardSettlement : NSObject
  • Holds the data to be sent to abort an in-flight transaction.

    See more

    Declaration

    Swift

    @objcMembers
    public class PaymentAbort : NSObject, Codable
  • Defines the parameters required by all query result requests.

    Refer to its subclasses

    PaymentResultQuery, PaymentReceiptQuery

    See more

    Declaration

    Swift

    @objcMembers
    public class PaymentQuery : NSObject
  • Contains the data for getting the PaymentResult from a previous payment.

    See more

    Declaration

    Swift

    @objcMembers
    public class PaymentResultQuery : PaymentQuery
  • Contains the data to query the receipt of the last payment.

    See more

    Declaration

    Swift

    @objcMembers
    public class PaymentReceiptQuery : PaymentQuery
  • Defines the parameters required by all payment requests.

    Refer to its subclasses

    CardSale, CardRefund, CardPreAuthSale, CardCheck, CardCheckPayment, TokenisedCardSale, TokenisedCardRefund, CardKeyedSaleRecovery, CardKeyedRefundRecovery

    See more

    Declaration

    Swift

    @objcMembers
    public class PaymentRequest : NSObject
  • Contains the data for performing a tokenised Card sale.

    See more

    Declaration

    Swift

    @objcMembers
    public class TokenisedCardSale : PaymentRequest
  • Contains the data for performing a tokenised Card refund.

    See more

    Declaration

    Swift

    @objcMembers
    public class TokenisedCardRefund : TokenisedCardSale, PaymentRequestRefundable
  • Message with details of the action completed by the merchant.

    See more

    Declaration

    Swift

    @objcMembers
    public class PaymentAction : NSObject, Codable
  • Contains all the data to be sent when voice authorisation is required during a payment.

    See more

    Declaration

    Swift

    @objcMembers
    public class VoiceAuthorisationComplete : PaymentAction
  • Contains all the data to be sent when signature is required during a payment

    See more

    Declaration

    Swift

    @objcMembers
    public class SignatureVerificationComplete : PaymentAction
  • Contains all the data to be sent when AVS confirmation is required during a payment

    See more

    Declaration

    Swift

    @objcMembers
    public class AVSConfirmationComplete : PaymentAction
  • Contains all the data to be sent when Cashback amount is required during a payment

    See more

    Declaration

    Swift

    @objcMembers
    public class CashbackAmountComplete : PaymentAction
  • Holds payment actions required by remote host

    See more

    Declaration

    Swift

    @objcMembers
    public class PaymentActionRequired : NSObject, Codable
  • Base class for all types of actions required during a payment

    See more

    Declaration

    Swift

    @objcMembers
    public class PaymentActionRequiredData : NSObject, Codable
  • Contains the voice authorisation data that is required during a payment

    See more

    Declaration

    Swift

    @objcMembers
    public class VoiceAuthorisationRequired : PaymentActionRequiredData
  • Referral contact details to complete voice authorisation for this payment.

    See more

    Declaration

    Swift

    @objcMembers
    public class ReferralContact : NSObject, Codable
  • Contains the signature verification data that is required during a payment

    Declaration

    Swift

    @objcMembers
    public class SignatureVerificationRequired : PaymentActionRequiredData
  • Contains the AVS confirmation data that is required during a payment

    See more

    Declaration

    Swift

    @objcMembers
    public class AVSConfirmationRequired : PaymentActionRequiredData
  • Results of the payment’s AVS check to be approved by the merchant.

    See more

    Declaration

    Swift

    @objcMembers
    public class AVSResults : NSObject, Codable
  • Contains the Cashback data that is required during a payment when cashback is supported

    See more

    Declaration

    Swift

    @objcMembers
    public class CashbackAmountRequired : PaymentActionRequiredData
  • Holds data about how the payment was performed.

    See more

    Declaration

    Swift

    @objcMembers
    public class CardPaymentInstrument : ResponsePaymentInstrument
    extension CardPaymentInstrument: CustomReflectable
  • Holds data about the payment authorisation.

    See more

    Declaration

    Swift

    @objcMembers
    public class PaymentAuthorisation : NSObject, Codable
    extension PaymentAuthorisation: CustomReflectable
  • Used for debug purpose only.

    See more

    Declaration

    Swift

    @objcMembers
    public class CardPaymentDebug : NSObject, Codable
  • Holds data about the card that performed the payment.

    See more

    Declaration

    Swift

    @objcMembers
    public class PaymentCard : NSObject, Codable
    extension PaymentCard: CustomReflectable
  • Month and Year for a card date (Start or Expiration) MM/YY

    See more

    Declaration

    Swift

    @objcMembers
    public class CardDate : NSObject, Codable
    extension CardDate: CustomReflectable
  • A generic object to parse the response from the server.

    See more

    Declaration

    Swift

    @objcMembers
    public class ResponsePaymentInstrument : NSObject, Codable
  • The message to communicate the real-time status of an in-flight payment.

    See more

    Declaration

    Swift

    @objcMembers
    public class PaymentNotification : NSObject, Codable
  • The message to receive a payment receipt.

    See more

    Declaration

    Swift

    @objcMembers
    public class PaymentReceipt : NSObject, Codable
  • The message to communicate the result of a completed payment.

    See more

    Declaration

    Swift

    @objcMembers
    public class PaymentResult : NSObject, Codable
  • Holds payment result information return from the remote host.

    See more

    Declaration

    Swift

    @objcMembers
    public class Payment : NSObject, Codable
  • The paypoint the request has been performed on.

    See more

    Declaration

    Swift

    @objcMembers
    public class Paypoint : NSObject, Codable
  • Holds the information about values used on the transaction.

    See more

    Declaration

    Swift

    @objcMembers
    public class Transaction : NSObject, Codable
  • Holds data about any on-terminal currency conversion.

    See more

    Declaration

    Swift

    @objcMembers
    public class CurrencyConversion : NSObject, Codable
  • Holds data about the merchant.

    See more

    Declaration

    Swift

    @objcMembers
    public class Merchant : NSObject, Codable
  • Holds an identifier for the merchant.

    See more

    Declaration

    Swift

    @objcMembers
    public class MerchantIdentifier : NSObject, Codable
  • The merchant’s address.

    See more

    Declaration

    Swift

    @objcMembers
    public class Address : NSObject, Codable
  • Provides access for sending and receiving data from the remote system.

    See more

    Declaration

    Swift

    @objcMembers
    public class PaymentManager : NSObject
  • Manage payment responses.

    See more

    Declaration

    Swift

    @objcMembers
    public class PaymentResponseHandler : NSObject
  • Class which is received when an Unhandled error is encountered

    See more

    Declaration

    Swift

    @objcMembers
    public class UnhandledError : NSObject
  • Holds the data for a Points of Sale.

    See more

    Declaration

    Swift

    @objcMembers
    public class PointOfSale : NSObject, Codable
  • Holds the data needed for registering a Point Of Sale.

    See more

    Declaration

    Swift

    @objcMembers
    public class PosRegistration : NSObject
  • Holds the POS License Key for a successful registration.

    See more

    Declaration

    Swift

    @objcMembers
    public class PosRegistrationResponse : NSObject, Codable
    extension PosRegistrationResponse: CustomReflectable
  • Manage Point of Sale registration responses.

    See more

    Declaration

    Swift

    @objcMembers
    public class PosRegistrationResponseHandler : NSObject
  • Provides methods for performing registrations.

    See more

    Declaration

    Swift

    @objcMembers
    public class RegistrationManager : NSObject