Protocols

The following protocols are available globally.

AdministrationApiRepository
Can be used to perform Administration functions on the API
See more
Declaration
Swift

public protocol AdministrationApiRepository
CustomerPaymentAgreementsApiRepository
Undocumented
See more
Declaration
Swift

public protocol CustomerPaymentAgreementsApiRepository
CustomerPaymentRequestsRepository
Undocumented
See more
Declaration
Swift

public protocol CustomerPaymentRequestsRepository
CustomerPaymentSessionsRepository
Undocumented
See more
Declaration
Swift

public protocol CustomerPaymentSessionsRepository
CustomerPreferencesRepository
Undocumented
See more
Declaration
Swift

public protocol CustomerPreferencesRepository
CustomerTermsAndConditionsApiRepository
Undocumented
See more
Declaration
Swift

public protocol CustomerTermsAndConditionsApiRepository
CustomerTransactionsRepository
Undocumented
See more
Declaration
Swift

public protocol CustomerTransactionsRepository
DigitalPayRepository
Undocumented
See more
Declaration
Swift

public protocol DigitalPayRepository
OpenPayApiRepository
Undocumented
See more
Declaration
Swift

public protocol OpenPayApiRepository
PaymentAgreementApiRepository
Undocumented
See more
Declaration
Swift

public protocol PaymentAgreementApiRepository
PaymentApiRepository
Undocumented
See more
Declaration
Swift

public protocol PaymentApiRepository
MerchantPaymentAgreementsRepository
Undocumented
See more
Declaration
Swift

public protocol MerchantPaymentAgreementsRepository
MerchantPaymentSessionsRepository
Undocumented
See more
Declaration
Swift

public protocol MerchantPaymentSessionsRepository
MerchantPaymentsRepository
Undocumented
See more
Declaration
Swift

public protocol MerchantPaymentsRepository
MerchantPreferencesRepository
Undocumented
See more
Declaration
Swift

public protocol MerchantPreferencesRepository
MerchantTransactionsRepository
Undocumented
See more
Declaration
Swift

public protocol MerchantTransactionsRepository
PaymentInstrumentsRepository
Undocumented
See more
Declaration
Swift

public protocol PaymentInstrumentsRepository
QRCodeRepository
Undocumented
See more
Declaration
Swift

public protocol QRCodeRepository
SchemasRepository
Undocumented
See more
Declaration
Swift

public protocol SchemasRepository
AndroidPayApiRepository
Undocumented
See more
Declaration
Swift

public protocol AndroidPayApiRepository
ApplePayApiRepository
Undocumented
See more
Declaration
Swift

public protocol ApplePayApiRepository
CardsApiRepository
Undocumented
See more
Declaration
Swift

public protocol CardsApiRepository
GiftcardsApiRepository
Undocumented
See more
Declaration
Swift

public protocol GiftcardsApiRepository
GooglePayApiRepository
Undocumented
See more
Declaration
Swift

public protocol GooglePayApiRepository
InstrumentsApiRepository
Undocumented
See more
Declaration
Swift

public protocol InstrumentsApiRepository
MerchantsApiRepository
Undocumented
See more
Declaration
Swift

public protocol MerchantsApiRepository
PayPalApiRepository
Undocumented
See more
Declaration
Swift

public protocol PayPalApiRepository
TransactionsApiRepository
Undocumented
See more
Declaration
Swift

public protocol TransactionsApiRepository
WalletApiRepository
Undocumented
See more
Declaration
Swift

public protocol WalletApiRepository
ApiAuthenticator
Abstracts how the SDK authenticates with the API.

If an application has an existing authentication/authorisation workflow then an Adapter class can be used to integrate that workflow into the SDK to provide the necessary authentication
See more
Declaration
Swift

public protocol ApiAuthenticator
CredentialsStore
Abstracts how the SDK stores credentials obtained after authenticating with the API
See more
Declaration
Swift

public protocol CredentialsStore
HasAccessToken
Indicates that a model has an access token that can be used to prove that SDK is authenticated
See more
Declaration
Swift

public protocol HasAccessToken
Basket
Basket of items associated with a payment request.
See more
Declaration
Swift

public protocol Basket
BasketItem
An item in a Basket
See more
Declaration
Swift

public protocol BasketItem
ChallengeResponse
The response to a step up challenge
See more
Declaration
Swift

public protocol ChallengeResponse
ChargePaymentAgreementRequest
Data required to charge against a PaymentAgreement
See more
Declaration
Swift

public protocol ChargePaymentAgreementRequest
CommonPaymentAgreementRequest
Common properties of the PaymentAgreement request
See more
Declaration
Swift

public protocol CommonPaymentAgreementRequest
CreatePaymentAgreementRequest
Request containing the details of the PaymentAgreement to create
See more
Declaration
Swift

public protocol CreatePaymentAgreementRequest : CommonPaymentAgreementRequest
UpdatePaymentAgreementRequest
Request containing the details of the PaymentAgreement to update
See more
Declaration
Swift

public protocol UpdatePaymentAgreementRequest : CommonPaymentAgreementRequest
PaymentAgreementBillingAddress
The customer’s billing address
See more
Declaration
Swift

public protocol PaymentAgreementBillingAddress
CreatePaymentRequestResult
The result from creating a new Payment Request.
See more
Declaration
Swift

public protocol CreatePaymentRequestResult
CreatePaymentSessionRequest
Request containing the details of the PaymentSession
See more
Declaration
Swift

public protocol CreatePaymentSessionRequest
CreatePaymentSessionResult
The result of creating a PaymentSession
See more
Declaration
Swift

public protocol CreatePaymentSessionResult
CustomerPaymentRequest
Detailed information for a single Payment Request
See more
Declaration
Swift

public protocol CustomerPaymentRequest : Payment
CustomerTransactionSummaries
List of customer transactions
See more
Declaration
Swift

public protocol CustomerTransactionSummaries : CustomerTransactions
CustomerTransactionSummary
Summary information of a transaction performed by a customer
See more
Declaration
Swift

public protocol CustomerTransactionSummary : TransactionSummary
CustomerTransactionDetails
Detailed information for a single transaction
See more
Declaration
Swift

public protocol CustomerTransactionDetails : CustomerTransactionSummary
CustomerUpdatePaymentSessionRequest
Request to update the customer messages to the merchant in the PaymentSession
See more
Declaration
Swift

public protocol CustomerUpdatePaymentSessionRequest
DigitalPayAddress
A customer’s address
See more
Declaration
Swift

public protocol DigitalPayAddress
DigitalPayChargePaymentAgreementRequest
The JSON request structure of the Charge Payment Agreement endpoint.
See more
Declaration
Swift

public protocol DigitalPayChargePaymentAgreementRequest
DigitalPayCompletionRequest
The JSON request structure of the Completions endpoint.
See more
Declaration
Swift

public protocol DigitalPayCompletionRequest
DigitalPayCompletion
Undocumented
See more
Declaration
Swift

public protocol DigitalPayCompletion
DigitalPayCompletionResponse
The JSON response structure of the Completions endpoint.
See more
Declaration
Swift

public protocol DigitalPayCompletionResponse
DigitalPayTransactionCompletionResponse
Undocumented
See more
Declaration
Swift

public protocol DigitalPayTransactionCompletionResponse
DigitalPayCreatePaymentAgreementRequest
The JSON request structure of the Create Payment Agreement endpoint.
See more
Declaration
Swift

public protocol DigitalPayCreatePaymentAgreementRequest
DigitalPayRequestPaymentAgreement
Undocumented
See more
Declaration
Swift

public protocol DigitalPayRequestPaymentAgreement
DigitalPayFraudPayload
Fraud check response
See more
Declaration
Swift

public protocol DigitalPayFraudPayload
DigitalPayPaymentAgreementResponse
The JSON response structure of the Create and Update Payment Agreement endpoints.
See more
Declaration
Swift

public protocol DigitalPayPaymentAgreementResponse
DigitalPayResponsePaymentAgreement
Undocumented
See more
Declaration
Swift

public protocol DigitalPayResponsePaymentAgreement
DigitalPayPaymentRequest
The JSON request structure of the Payments endpoint
See more
Declaration
Swift

public protocol DigitalPayPaymentRequest
DigitalPayPayment
Undocumented
See more
Declaration
Swift

public protocol DigitalPayPayment
DigitalPayStoreData
Undocumented
See more
Declaration
Swift

public protocol DigitalPayStoreData
ExtendedMerchantData
Undocumented
See more
Declaration
Swift

public protocol ExtendedMerchantData
DigitalPayPaymentResponse
The JSON success response structure of the Payments endpoint.
See more
Declaration
Swift

public protocol DigitalPayPaymentResponse
DigitalPayFraudResponse
Undocumented
See more
Declaration
Swift

public protocol DigitalPayFraudResponse
DigitalPayPaymentInstrument
Undocumented
See more
Declaration
Swift

public protocol DigitalPayPaymentInstrument


                    
                    
                    DigitalPayCreditCard

Undocumented

Declaration

Swift

public protocol DigitalPayCreditCard : DigitalPayPaymentInstrument

DigitalPayHandlingInstructions
Undocumented
See more
Declaration
Swift

public protocol DigitalPayHandlingInstructions


                    
                    
                    DigitalPayGiftCard

Undocumented

Declaration

Swift

public protocol DigitalPayGiftCard : DigitalPayPaymentInstrument


                    
                    
                    DigitalPayPayPal

Undocumented

Declaration

Swift

public protocol DigitalPayPayPal : DigitalPayPaymentInstrument


                    
                    
                    DigitalPayGooglePay

Undocumented

Declaration

Swift

public protocol DigitalPayGooglePay : DigitalPayPaymentInstrument


                    
                    
                    DigitalPayApplePay

Undocumented

Declaration

Swift

public protocol DigitalPayApplePay : DigitalPayPaymentInstrument

DigitalPayRecieptData
Undocumented
See more
Declaration
Swift

public protocol DigitalPayRecieptData
DigitalPayExtendedTransactionData
Undocumented
See more
Declaration
Swift

public protocol DigitalPayExtendedTransactionData
DigitalPayRefundRequest
The JSON request structure of the Refunds endpoint.
See more
Declaration
Swift

public protocol DigitalPayRefundRequest
DigitalPayRefund
Undocumented
See more
Declaration
Swift

public protocol DigitalPayRefund
DigitalPayRefundResponse
The JSON success response structure of the Refunds endpoint.
See more
Declaration
Swift

public protocol DigitalPayRefundResponse
DigitalPayRefundTransactionResponse
Undocumented
See more
Declaration
Swift

public protocol DigitalPayRefundTransactionResponse
DigitalPayTransactionType
Undocumented
See more
Declaration
Swift

public protocol DigitalPayTransactionType
GooglePayTransactionDetail
Undocumented
See more
Declaration
Swift

public protocol GooglePayTransactionDetail
ApplePayTransactionDetail
Undocumented
See more
Declaration
Swift

public protocol ApplePayTransactionDetail
DigitalPayUpdatePaymentAgreementRequest
The JSON request structure of the Update Payment Agreement endpoint.
See more
Declaration
Swift

public protocol DigitalPayUpdatePaymentAgreementRequest
DigitalPayPaymentAgreementUpdate
Undocumented
See more
Declaration
Swift

public protocol DigitalPayPaymentAgreementUpdate
DigitalPayVoidRequest
The JSON request structure of the Voids endpoint.
See more
Declaration
Swift

public protocol DigitalPayVoidRequest
DigitalPayVoid
Undocumented
See more
Declaration
Swift

public protocol DigitalPayVoid
DigitalPayVoidResponse
The JSON success response structure of the Voids endpoint.
See more
Declaration
Swift

public protocol DigitalPayVoidResponse
DigitalPayVoidTransactionResponse
Undocumented
See more
Declaration
Swift

public protocol DigitalPayVoidTransactionResponse
OpenPayCompletionRequest
The JSON request structure of the OpenPay Completions endpoint.
See more
Declaration
Swift

public protocol OpenPayCompletionRequest
OpenPayCompletion
Undocumented
See more
Declaration
Swift

public protocol OpenPayCompletion
OpenPayCompletionResponse
The JSON response structure of the OpenPay Completions endpoint.
See more
Declaration
Swift

public protocol OpenPayCompletionResponse
OpenPayTransactionCompletionResponse
Undocumented
See more
Declaration
Swift

public protocol OpenPayTransactionCompletionResponse
OpenPayPaymentRequestTransactionType
Undocumented
See more
Declaration
Swift

public protocol OpenPayPaymentRequestTransactionType
OpenPayPaymentRequest
The JSON request structure of the Openpay Payments endpoint
See more
Declaration
Swift

public protocol OpenPayPaymentRequest
OpenPayStoreData
Undocumented
See more
Declaration
Swift

public protocol OpenPayStoreData
OpenPayPayments
Undocumented
See more
Declaration
Swift

public protocol OpenPayPayments
OpenPayPaymentTransactionResponse
The JSON success response structure of the Payments endpoint.
See more
Declaration
Swift

public protocol OpenPayPaymentTransactionResponse
OpenPayPaymentResponse
Undocumented
See more
Declaration
Swift

public protocol OpenPayPaymentResponse
OpenPayExtendedTransactionData
Undocumented
See more
Declaration
Swift

public protocol OpenPayExtendedTransactionData
OpenPayRefundRequest
The JSON request structure of the Openpay Refunds endpoint.
See more
Declaration
Swift

public protocol OpenPayRefundRequest
StoreData
Undocumented
See more
Declaration
Swift

public protocol StoreData
OpenPayRefund
Undocumented
See more
Declaration
Swift

public protocol OpenPayRefund
OpenPayRefundResponse
The JSON success response structure of the Openpay Refunds endpoint.
See more
Declaration
Swift

public protocol OpenPayRefundResponse
OpenPayRefundTransactionResponse
Undocumented
See more
Declaration
Swift

public protocol OpenPayRefundTransactionResponse
OpenPayVoidRequest
The JSON request structure of the Openpay Voids endpoint.
See more
Declaration
Swift

public protocol OpenPayVoidRequest
OpenPayVoidResponse
The JSON success response structure of the Openpay Voids endpoint.
See more
Declaration
Swift

public protocol OpenPayVoidResponse
OpenPayVoidTransactionResponse
Undocumented
See more
Declaration
Swift

public protocol OpenPayVoidTransactionResponse
DynamicPayload
A payload of key/value pairs that is can be validated by a schema.
See more
Declaration
Swift

public protocol DynamicPayload
HealthCheck
Result of checking the health of the API server
See more
Declaration
Swift

public protocol HealthCheck
MerchantPayload
Payload provided by the merchant to support other types of messaging.
See more
Declaration
Swift

public protocol MerchantPayload
MerchantPaymentSummaries
List of payments made involving a merchant.
See more
Declaration
Swift

public protocol MerchantPaymentSummaries : MerchantPayments
MerchantPaymentSummary
Summary information for a single Payment Request
See more
Declaration
Swift

public protocol MerchantPaymentSummary : Payment
MerchantPaymentDetails
Detailed information for a single Payment Request
See more
Declaration
Swift

public protocol MerchantPaymentDetails : MerchantPaymentSummary
MerchantSchemaSummaries
List of merchant schemas
See more
Declaration
Swift

public protocol MerchantSchemaSummaries : MerchantSchemas
MerchantSchemaSummary
Summary information about a MerchantSchema
See more
Declaration
Swift

public protocol MerchantSchemaSummary
MerchantSchema
Details about a particular schema
See more
Declaration
Swift

public protocol MerchantSchema
MerchantTransactionSummaries
List of merchant transactions.
See more
Declaration
Swift

public protocol MerchantTransactionSummaries : MerchantTransactions
MerchantTransactionSummary
Summary information of the resulting transaction
See more
Declaration
Swift

public protocol MerchantTransactionSummary : TransactionSummary
MerchantTransactionDetails
Detailed information for a single transaction
See more
Declaration
Swift

public protocol MerchantTransactionDetails : MerchantTransactionSummary
MerchantUpdatePaymentSessionRequest
Request to update a PaymentSession for a merchant.
See more
Declaration
Swift

public protocol MerchantUpdatePaymentSessionRequest
NewPaymentRequest
The details of the payment to be created.
See more
Declaration
Swift

public protocol NewPaymentRequest
NewPaymentRequestQRCode
Request to create a new QRCode for a Payment Request
See more
Declaration
Swift

public protocol NewPaymentRequestQRCode
Payment
Properties common to all Payments and Payment Requests
See more
Declaration
Swift

public protocol Payment
PaymentAgreement
Properties of a Payment Agreement
See more
Declaration
Swift

public protocol PaymentAgreement
PaymentAgreementStepUp
Undocumented
See more
Declaration
Swift

public protocol PaymentAgreementStepUp
PaymentAgreements
List of payments agreements.
See more
Declaration
Swift

public protocol PaymentAgreements
PaymentInstrumentAddition
Initiate the addition of a new payment instrument for this customer.

This API returns a URL to be used to access the DigiPay IFrame based interface to request the customer to enter a payment instrument details.
See more
Declaration
Swift

public protocol PaymentInstrumentAddition
PaymentInstrumentAdditionResult
The result of trying to initiate the addition of a new PaymentInstrument
See more
Declaration
Swift

public protocol PaymentInstrumentAdditionResult
WalletContents
All the possible PaymentInstruments that a customer might have in a wallet.
See more
Declaration
Swift

public protocol WalletContents : PaymentInstruments
PaymentInstruments
List of grouped payment instruments.
See more
Declaration
Swift

public protocol PaymentInstruments
PaymentInstrument
Common properties to all PaymentInstruments
See more
Declaration
Swift

public protocol PaymentInstrument


                    
                    
                    CardPaymentInstrument

Undocumented

Declaration

Swift

public protocol CardPaymentInstrument : PaymentInstrument


                    
                    
                    CreditCard

An added credit card

Declaration

Swift

public protocol CreditCard : CardPaymentInstrument


                    
                    
                    GiftCard

An added gift card.

Declaration

Swift

public protocol GiftCard : CardPaymentInstrument

CreditCardStepUp
Details of what step up is required to use a CreditCard
See more
Declaration
Swift

public protocol CreditCardStepUp
GiftCardStepUp
Details of what step up is required to use a GiftCard
See more
Declaration
Swift

public protocol GiftCardStepUp
SecondaryPaymentInstrument
Used to identify other PaymentInstruments to be used as part of a payment.
See more
Declaration
Swift

public protocol SecondaryPaymentInstrument


                    
                    
                    IndividualPaymentInstrument

Undocumented

Declaration

Swift

public protocol IndividualPaymentInstrument : PaymentInstrument

IndividualPaymentInstrumentDetail
Undocumented
See more
Declaration
Swift

public protocol IndividualPaymentInstrumentDetail
PaymentSession
A session between a customer and a merchant
See more
Declaration
Swift

public protocol PaymentSession
PosPayload
Payload describing the specific POS system.
See more
Declaration
Swift

public protocol PosPayload
CustomerPreferences
Available preference settings for a customer
See more
Declaration
Swift

public protocol CustomerPreferences
PaymentPreferences
Payment preferences for a customer
See more
Declaration
Swift

public protocol PaymentPreferences
SecondaryInstrumentPreferences
Undocumented
See more
Declaration
Swift

public protocol SecondaryInstrumentPreferences
QRCode
Detail of a QR code
See more
Declaration
Swift

public protocol QRCode
TermsAndConditionsAcceptances
List of terms and conditions acceptances
See more
Declaration
Swift

public protocol TermsAndConditionsAcceptances
TermsAndConditionsAcceptance
The Terms and Conditions the customer has accepted.
See more
Declaration
Swift

public protocol TermsAndConditionsAcceptance
AcceptTermsAndConditionsRequest
Undocumented
See more
Declaration
Swift

public protocol AcceptTermsAndConditionsRequest
TokenizePaypalResponse
The JSON response structure of the Tokenize PayPalApi endpoint.
See more
Declaration
Swift

public protocol TokenizePaypalResponse
PaypalDetails
Undocumented
See more
Declaration
Swift

public protocol PaypalDetails
TransactionRefundDetails
Request payload containing the refund reason and instructions
See more
Declaration
Swift

public protocol TransactionRefundDetails
TransactionSummary
Summary information of a transaction
See more
Declaration
Swift

public protocol TransactionSummary : Payment
TransactionSummaryUsedPaymentInstrument
An instrument used for a transaction
See more
Declaration
Swift

public protocol TransactionSummaryUsedPaymentInstrument
UsedPaymentInstrumentTransaction
A subtransaction associated with a payment instrument
See more
Declaration
Swift

public protocol UsedPaymentInstrumentTransaction
GiftcardsBalanceRequest
The JSON request structure of the GiftcardsApi Balance endpoint.
See more
Declaration
Swift

public protocol GiftcardsBalanceRequest
GiftCardBalenceGiftCard
Undocumented
See more
Declaration
Swift

public protocol GiftCardBalenceGiftCard
GiftCardInstrument
Undocumented
See more
Declaration
Swift

public protocol GiftCardInstrument
GiftcardsBalanceResponse
The JSON response structure of the GiftcardsApi Balance endpoint.
See more
Declaration
Swift

public protocol GiftcardsBalanceResponse
GiftCardBalance
Undocumented
See more
Declaration
Swift

public protocol GiftCardBalance
ImportPaymentInstrumentsRequest
The JSON request structure of the Import Payment InstrumentsApi endpoint.
See more
Declaration
Swift

public protocol ImportPaymentInstrumentsRequest
PayPalDetail
Undocumented
See more
Declaration
Swift

public protocol PayPalDetail
PaymentInstrumentRequestCreditCard
Undocumented
See more
Declaration
Swift

public protocol PaymentInstrumentRequestCreditCard
ImportPaymentInstrumentsResponse
The JSON response structure of the Import Payment InstrumentsApi endpoint.
See more
Declaration
Swift

public protocol ImportPaymentInstrumentsResponse
PayPal
Undocumented
See more
Declaration
Swift

public protocol PayPal
ErrorMessage
Undocumented
See more
Declaration
Swift

public protocol ErrorMessage
CreditCardResult
Undocumented
See more
Declaration
Swift

public protocol CreditCardResult
InitiateCardCaptureRequest
The JSON request structure of the Initiate Card Capture endpoint.
See more
Declaration
Swift

public protocol InitiateCardCaptureRequest
InitiateCardCaptureResponse
The JSON response structure of the Initiate Card Capture endpoint.
See more
Declaration
Swift

public protocol InitiateCardCaptureResponse
ListPaymentInstrumentsRequest
The JSON request structure of the List Payment InstrumentsApi endpoint.
See more
Declaration
Swift

public protocol ListPaymentInstrumentsRequest
ListPaymentInstrumentsResponse
The JSON response structure of the List Payment InstrumentsApi endpoint.
See more
Declaration
Swift

public protocol ListPaymentInstrumentsResponse
CreditCardDetails
Undocumented
See more
Declaration
Swift

public protocol CreditCardDetails
GiftCardDetails
Undocumented
See more
Declaration
Swift

public protocol GiftCardDetails
PayPalDetails
Undocumented
See more
Declaration
Swift

public protocol PayPalDetails
PaymentAgreementDetails
Undocumented
See more
Declaration
Swift

public protocol PaymentAgreementDetails
GooglePayDetails
Undocumented
See more
Declaration
Swift

public protocol GooglePayDetails
ApplePayDetails
Undocumented
See more
Declaration
Swift

public protocol ApplePayDetails
StepUp
Undocumented
See more
Declaration
Swift

public protocol StepUp
AllowedPaymentMethodsGiftCard
Undocumented
See more
Declaration
Swift

public protocol AllowedPaymentMethodsGiftCard
AllowedPaymentMethodsCreditCard
Undocumented
See more
Declaration
Swift

public protocol AllowedPaymentMethodsCreditCard
AllowedPaymentMethodsPaypal
Undocumented
See more
Declaration
Swift

public protocol AllowedPaymentMethodsPaypal
AllowedPaymentMethodsGooglePay
Undocumented
See more
Declaration
Swift

public protocol AllowedPaymentMethodsGooglePay
AllowedPaymentMethodsApplePay
Undocumented
See more
Declaration
Swift

public protocol AllowedPaymentMethodsApplePay
Card
Undocumented
See more
Declaration
Swift

public protocol Card
MerchantProfileResponse
The JSON response structure of the Merchant Profile endpoint.
See more
Declaration
Swift

public protocol MerchantProfileResponse
AllowedPaymentMethods
Undocumented
See more
Declaration
Swift

public protocol AllowedPaymentMethods
TokenizeAndroidPayRequest
The JSON request structure of the Tokenize Android Pay endpoint.
See more
Declaration
Swift

public protocol TokenizeAndroidPayRequest
TokenizeAndroidPayResponse
The JSON response structure of the Tokenize Android Pay endpoint.
See more
Declaration
Swift

public protocol TokenizeAndroidPayResponse
TokenizeApplePayRequest
The JSON request structure of the Tokenize Apple Pay endpoint.
See more
Declaration
Swift

public protocol TokenizeApplePayRequest
TokenizeApplePayResponse
The JSON response structure of the Tokenize Android Pay endpoint.
See more
Declaration
Swift

public protocol TokenizeApplePayResponse
TokenizeGiftcardRequest
The JSON request structure of the Tokenize Giftcard endpoint.
See more
Declaration
Swift

public protocol TokenizeGiftcardRequest
TokenizeGiftcardResponse
The JSON response structure of the Tokenize Giftcard endpoint.
See more
Declaration
Swift

public protocol TokenizeGiftcardResponse
TokenizedGiftCard
Undocumented
See more
Declaration
Swift

public protocol TokenizedGiftCard
TokenizeGooglePayRequest
The JSON request structure of the Tokenize Google Pay endpoint.
See more
Declaration
Swift

public protocol TokenizeGooglePayRequest
TokenizeGooglePayResponse
The JSON response structure of the Tokenize Google Pay endpoint.
See more
Declaration
Swift

public protocol TokenizeGooglePayResponse
TokenizePaypalRequest
The JSON request structure of the Tokenize PayPalApi endpoint.
See more
Declaration
Swift

public protocol TokenizePaypalRequest
TransactionHistoryRequest
The JSON request structure of the Transaction History endpoint.
See more
Declaration
Swift

public protocol TransactionHistoryRequest
TransactionHistoryResponse
The JSON response structure of the Transaction History endpoint.
See more
Declaration
Swift

public protocol TransactionHistoryResponse
Transaction
Undocumented
See more
Declaration
Swift

public protocol Transaction
VerifyPaymentInstrumentsRequest
The JSON request structure of the Verify Payment InstrumentsApi endpoint.
See more
Declaration
Swift

public protocol VerifyPaymentInstrumentsRequest
FraudPayload
Undocumented
See more
Declaration
Swift

public protocol FraudPayload
VerifyPaymentInstrumentsRequestInstrument
Undocumented
See more
Declaration
Swift

public protocol VerifyPaymentInstrumentsRequestInstrument
VerifyPaymentInstrumentsSuccessResponse
The JSON success response structure of the Verify Payment InstrumentsApi endpoint.
See more
Declaration
Swift

public protocol VerifyPaymentInstrumentsSuccessResponse
FraudResponse
Undocumented
See more
Declaration
Swift

public protocol FraudResponse
VerifyResponse
Undocumented
See more
Declaration
Swift

public protocol VerifyResponse
WalletDeleteRequest
The JSON request structure of the Delete Wallet endpoint.
See more
Declaration
Swift

public protocol WalletDeleteRequest
WalletDeleteResponse
The JSON response structure of the Delete Wallet endpoint.
Declaration
Swift

public protocol WalletDeleteResponse
RequestHeaderFactory
Abstracts how HTTP headers are added to a Dictionary.
See more
Declaration
Swift

public protocol RequestHeaderFactory
RequestHeadersFactory
Creates a Dictionary of headers to be added to HTTP requests
See more
Declaration
Swift

public protocol RequestHeadersFactory
VillageCustomerApiRepository
Defines the API operations that the SDK can use to call the Customer Village API

The SDK is technology agnostic with applications being able to choose an implementation that meets the needs and preexisting technology choices of the application.

Implementations of the protocol may provide additional constraints on the user.
See more
Declaration
Swift

public protocol VillageCustomerApiRepository
VillageMerchantApiRepository
Defines the API operations that the SDK can use to call the Merchant Village API

The SDK is technology agnostic with applications being able to choose an implementation that meets the needs and preexisting technology choices of the application.

Implementations of the protocol may provide additional constraints on the user.
See more
Declaration
Swift

public protocol VillageMerchantApiRepository