Skip navigation links
A C D E G H I J L M O P Q R S T U V 

A

abortPayment(abort) - Method in class com.worldpay.payment.PaymentHandler
Abort an in-flight payment.
abortPayment(abort, p) - Method in class com.worldpay.payment.PaymentStream
Abort an in-flight payment.
ActionType - Enum in com.worldpay.websocket.api.payment.action
The action taken by the POS to proceed with the payment.
ActionTypeSerializer - Class in com.worldpay.websocket.api.payment.action
Handles the serialization and deserialization of ReceiptType to/from JSON.
Address - Class in com.worldpay.websocket.api.payment.merchant
The merchant’s address.
Address(line1, line2, line3, city, state, postalCode, countryCode) - Constructor for class com.worldpay.websocket.api.payment.merchant.Address
The merchant’s address.
Address() - Constructor for class com.worldpay.websocket.api.payment.merchant.Address
The merchant’s address.
AlipayBarcodePaymentCancel - Class in com.worldpay.payment.model
Holds data required when cancelling an alipay barcode payment.
AlipayBarcodePaymentCancel(merchantTransactionReference, gatewayTransactionReference, barcode, sendAttempt, quantity, paypointId) - Constructor for class com.worldpay.payment.model.AlipayBarcodePaymentCancel
Holds data required when cancelling an alipay barcode payment.
AlipayBarcodePaymentCancel(merchantTransactionReference, gatewayTransactionReference, barcode, sendAttempt, quantity) - Constructor for class com.worldpay.payment.model.AlipayBarcodePaymentCancel
Holds data required when cancelling an alipay barcode payment.
AlipayBarcodePaymentCancel(merchantTransactionReference, gatewayTransactionReference, barcode, sendAttempt) - Constructor for class com.worldpay.payment.model.AlipayBarcodePaymentCancel
Holds data required when cancelling an alipay barcode payment.
AlipayBarcodePaymentCancel(merchantTransactionReference, gatewayTransactionReference, barcode) - Constructor for class com.worldpay.payment.model.AlipayBarcodePaymentCancel
Holds data required when cancelling an alipay barcode payment.
AlipayPaymentInstrument - Class in com.worldpay.websocket.api.payment.instrument
Holds data about how the payment was performed.
AlipayPaymentInstrument(barcode, authorisation) - Constructor for class com.worldpay.websocket.api.payment.instrument.AlipayPaymentInstrument
Holds data about how the payment was performed.
AppDetails - Class in com.worldpay
Holds details of the current application
AppDetails(appName, appVersion) - Constructor for class com.worldpay.AppDetails
Holds details of the current application
AvsConfirmationComplete - Class in com.worldpay.payment.model
Contains all the data to be sent when AVS confirmation is required during a payment
AvsConfirmationComplete(merchantTransactionReference, isAvsConfirmed) - Constructor for class com.worldpay.payment.model.AvsConfirmationComplete
Contains all the data to be sent when AVS confirmation is required during a payment
AVSConfirmationRequired - Class in com.worldpay.websocket.api.payment.action
Contains the AVS confirmation data that is required during a payment
AVSConfirmationRequired(action, avsResults) - Constructor for class com.worldpay.websocket.api.payment.action.AVSConfirmationRequired
Contains the AVS confirmation data that is required during a payment
AvsMatchResult - Enum in com.worldpay.websocket.api.payment.action
Represents different possible types of checks to be authorised by the merchant.
AvsMatchResultSerializer - Class in com.worldpay.websocket.api.payment.action
Handles the serialization and deserialization of AvsMatchResult to/from JSON.
AVSResults - Class in com.worldpay.websocket.api.payment.action
Results of the payment's AVS check to be authorised by the merchant.
AVSResults(isCvvMatch, isAddressLineMatch, isPostalCodeMatch) - Constructor for class com.worldpay.websocket.api.payment.action.AVSResults
Results of the payment's AVS check to be authorised by the merchant.

C

cancelPayment(request, callback, p) - Method in class com.worldpay.payment.PaymentManager
Cancels a previous payment.
cancelPayment(coroutineContext, request, handler) - Static method in class com.worldpay.payment.PaymentManagerCompat
Cancels a previous payment by creating a new connection to the remote system using a callback for Java implementation.
Card - Class in com.worldpay.payment.model
Details to validate against a previous card-based pre-auth
Card(type, cardNumber, cardExpiryDate) - Constructor for class com.worldpay.payment.model.Card
Details to validate against a previous card-based pre-auth
CardCheck - Class in com.worldpay.payment.model
Contains the data for performing a Card Check without payment.
CardCheck(type, value, merchantTransactionReference, paypointId, isHandledOnline) - Constructor for class com.worldpay.payment.model.CardCheck
Contains the data for performing a Card Check without payment.
CardCheck(type, value, merchantTransactionReference, paypointId) - Constructor for class com.worldpay.payment.model.CardCheck
Contains the data for performing a Card Check without payment.
CardCheck(type, value, merchantTransactionReference) - Constructor for class com.worldpay.payment.model.CardCheck
Contains the data for performing a Card Check without payment.
CardCheckPayment - Class in com.worldpay.payment.model
Contains the data for performing a Card Check with Payment.
CardCheckPayment(type, value, merchantTransactionReference, paypointId, isHandledOnline) - Constructor for class com.worldpay.payment.model.CardCheckPayment
Contains the data for performing a Card Check with Payment.
CardCheckPayment(type, value, merchantTransactionReference, paypointId) - Constructor for class com.worldpay.payment.model.CardCheckPayment
Contains the data for performing a Card Check with Payment.
CardCheckPayment(type, value, merchantTransactionReference) - Constructor for class com.worldpay.payment.model.CardCheckPayment
Contains the data for performing a Card Check with Payment.
CardCheckRequest - Interface in com.worldpay.payment.model
Defines the parameters required by all card check requests.
CardCheckRequest() - Constructor for interface com.worldpay.payment.model.CardCheckRequest
 
CardDate - Class in com.worldpay.websocket.api.payment.card
Month and Year for a card date (Start or Expiration) MM/YY.
CardDate(month, year) - Constructor for class com.worldpay.websocket.api.payment.card.CardDate
Month and Year for a card date (Start or Expiration) MM/YY.
CardInteraction - Enum in com.worldpay.payment.model
Type of card usage (present, keyed or not present).
CardKeyedRefundRecovery - Class in com.worldpay.payment.model
Contains the data for performing a Card keyed refund recovery.
CardKeyedRefundRecovery(value, merchantTransactionReference, originalMerchantCode, originalTransactionReference, originalGatewayTransactionReference, paypointId) - Constructor for class com.worldpay.payment.model.CardKeyedRefundRecovery
Contains the data for performing a Card keyed refund recovery.
CardKeyedRefundRecovery(value, merchantTransactionReference, originalMerchantCode, originalTransactionReference, originalGatewayTransactionReference) - Constructor for class com.worldpay.payment.model.CardKeyedRefundRecovery
Contains the data for performing a Card keyed refund recovery.
CardKeyedSaleRecovery - Class in com.worldpay.payment.model
Contains the data for performing a Card keyed sale recovery.
CardKeyedSaleRecovery(value, merchantTransactionReference, authorisationCode, paypointId) - Constructor for class com.worldpay.payment.model.CardKeyedSaleRecovery
Contains the data for performing a Card keyed sale recovery.
CardKeyedSaleRecovery(value, merchantTransactionReference, authorisationCode) - Constructor for class com.worldpay.payment.model.CardKeyedSaleRecovery
Contains the data for performing a Card keyed sale recovery.
CardKeyedSaleRecovery(value, merchantTransactionReference) - Constructor for class com.worldpay.payment.model.CardKeyedSaleRecovery
Contains the data for performing a Card keyed sale recovery.
CardPaymentCancel - Class in com.worldpay.payment.model
Holds data required when cancelling a card payment.
CardPaymentCancel(merchantTransactionReference, gatewayTransactionReference, cardNumber, cardExpiryDate, paypointId) - Constructor for class com.worldpay.payment.model.CardPaymentCancel
Holds data required when cancelling a card payment.
CardPaymentCancel(merchantTransactionReference, gatewayTransactionReference, cardNumber, cardExpiryDate) - Constructor for class com.worldpay.payment.model.CardPaymentCancel
Holds data required when cancelling a card payment.
CardPaymentDebug - Class in com.worldpay.websocket.api.payment.card
Used for debug purpose only.
CardPaymentDebug(transactionStatusInfo, transactionVerificationResults) - Constructor for class com.worldpay.websocket.api.payment.card.CardPaymentDebug
Used for debug purpose only.
CardPaymentDebug() - Constructor for class com.worldpay.websocket.api.payment.card.CardPaymentDebug
Used for debug purpose only.
CardPaymentInstrument - Class in com.worldpay.websocket.api.payment.instrument
Holds data about how the payment was performed.
CardPaymentInstrument(type, posEntryMode, cardVerificationMethod, isHandledOnline, card, authorisation, debug) - Constructor for class com.worldpay.websocket.api.payment.instrument.CardPaymentInstrument
Holds data about how the payment was performed.
CardPaymentRequest - Interface in com.worldpay.payment.model
Defines the parameters required for card-based payment requests.
CardPaymentRequest() - Constructor for interface com.worldpay.payment.model.CardPaymentRequest
 
CardPreAuthSale - Class in com.worldpay.payment.model
Contains data for performing a Card Pre-Auth Sale.
CardPreAuthSale(type, value, merchantTransactionReference, paypointId) - Constructor for class com.worldpay.payment.model.CardPreAuthSale
Contains data for performing a Card Pre-Auth Sale.
CardPreAuthSale(type, value, merchantTransactionReference) - Constructor for class com.worldpay.payment.model.CardPreAuthSale
Contains data for performing a Card Pre-Auth Sale.
CardRefund - Class in com.worldpay.payment.model
Contains the data for performing a Card refund.
CardRefund(type, value, merchantTransactionReference, originalMerchantCode, originalTransactionReference, originalGatewayTransactionReference, paypointId) - Constructor for class com.worldpay.payment.model.CardRefund
Contains the data for performing a Card refund.
CardRefund(type, value, merchantTransactionReference, originalMerchantCode, originalTransactionReference, originalGatewayTransactionReference) - Constructor for class com.worldpay.payment.model.CardRefund
Contains the data for performing a Card refund.
CardRefundRequest - Interface in com.worldpay.payment.model
Defines the parameters required to proceed with a payment request, after a Card Check with Payment
CardRefundRequest() - Constructor for interface com.worldpay.payment.model.CardRefundRequest
 
CardSale - Class in com.worldpay.payment.model
Contains the data for performing a Card sale.
CardSale(type, value, merchantTransactionReference, paypointId) - Constructor for class com.worldpay.payment.model.CardSale
Contains the data for performing a Card sale.
CardSale(type, value, merchantTransactionReference) - Constructor for class com.worldpay.payment.model.CardSale
Contains the data for performing a Card sale.
CardSettlement - Class in com.worldpay.payment.model
Contains the data for settling a pre-auth.
CardSettlement(merchantTransactionReference, gatewayTransactionReference, cardNumber, cardExpiryDate, value, paypointId) - Constructor for class com.worldpay.payment.model.CardSettlement
Contains the data for settling a pre-auth.
CardSettlement(merchantTransactionReference, gatewayTransactionReference, cardNumber, cardExpiryDate, value) - Constructor for class com.worldpay.payment.model.CardSettlement
Contains the data for settling a pre-auth.
CashbackAmountComplete - Class in com.worldpay.payment.model
Contains all the data to be sent when Cashback amount is required during a payment
CashbackAmountComplete(merchantTransactionReference, cashbackAmount) - Constructor for class com.worldpay.payment.model.CashbackAmountComplete
Contains all the data to be sent when Cashback amount is required during a payment
CashbackAmountRequired - Class in com.worldpay.websocket.api.payment.action
Contains the Cashback data that is required during a payment when cashback is supported
CashbackAmountRequired(action, maximumCashbackAmount) - Constructor for class com.worldpay.websocket.api.payment.action.CashbackAmountRequired
Contains the Cashback data that is required during a payment when cashback is supported
CashPaymentInstrument - Class in com.worldpay.websocket.api.payment.instrument
Holds data about how the payment was performed.
CashPaymentInstrument(cashTenderAmount) - Constructor for class com.worldpay.websocket.api.payment.instrument.CashPaymentInstrument
Holds data about how the payment was performed.
CashPaymentInstrument() - Constructor for class com.worldpay.websocket.api.payment.instrument.CashPaymentInstrument
Holds data about how the payment was performed.
close(failure, p) - Method in class com.worldpay.payment.PaymentStream
Attempts to normally close down this payment stream.
close(thrown) - Method in class com.worldpay.websocket.SingleStream
Attempts to normally close down this payment stream.
com.worldpay - package com.worldpay
 
com.worldpay.crossplatform - package com.worldpay.crossplatform
 
com.worldpay.error - package com.worldpay.error
 
com.worldpay.monitor - package com.worldpay.monitor
 
com.worldpay.monitor.model - package com.worldpay.monitor.model
 
com.worldpay.payment - package com.worldpay.payment
 
com.worldpay.payment.model - package com.worldpay.payment.model
 
com.worldpay.registration - package com.worldpay.registration
 
com.worldpay.registration.model - package com.worldpay.registration.model
 
com.worldpay.websocket - package com.worldpay.websocket
 
com.worldpay.websocket.api.payment - package com.worldpay.websocket.api.payment
 
com.worldpay.websocket.api.payment.action - package com.worldpay.websocket.api.payment.action
 
com.worldpay.websocket.api.payment.authorisation - package com.worldpay.websocket.api.payment.authorisation
 
com.worldpay.websocket.api.payment.card - package com.worldpay.websocket.api.payment.card
 
com.worldpay.websocket.api.payment.instruction - package com.worldpay.websocket.api.payment.instruction
 
com.worldpay.websocket.api.payment.instrument - package com.worldpay.websocket.api.payment.instrument
 
com.worldpay.websocket.api.payment.merchant - package com.worldpay.websocket.api.payment.merchant
 
com.worldpay.websocket.api.payment.query - package com.worldpay.websocket.api.payment.query
 
com.worldpay.websocket.api.payment.terminal - package com.worldpay.websocket.api.payment.terminal
 
com.worldpay.websocket.api.payment.transaction - package com.worldpay.websocket.api.payment.transaction
 
com.worldpay.websocket.api.registration - package com.worldpay.websocket.api.registration
 
component1() - Method in class com.worldpay.AppDetails
The name of the current application
component1() - Method in exception com.worldpay.error.InternalServerError
 
component1() - Method in class com.worldpay.monitor.model.PaymentDevice
The serial number of the payment device.
component1() - Method in class com.worldpay.monitor.model.PaymentDeviceStatus
the current
component1() - Method in class com.worldpay.monitor.model.PaymentServiceStatus
The current status of the payment service.
component1() - Method in class com.worldpay.payment.model.AlipayBarcodePaymentCancel
The transaction reference defined by the merchant to uniquely identify the payment.
component1() - Method in class com.worldpay.payment.model.AvsConfirmationComplete
The transaction Reference defined by the merchant to uniquely identify the payment.
component1() - Method in class com.worldpay.payment.model.Card
The manner in which the payment is to be made
component1() - Method in class com.worldpay.payment.model.CardCheck
The manner in which the payment is to be made
component1() - Method in class com.worldpay.payment.model.CardCheckPayment
The manner in which the payment is to be made
component1() - Method in class com.worldpay.payment.model.CardKeyedRefundRecovery
The value of the payment in minor units.
component1() - Method in class com.worldpay.payment.model.CardKeyedSaleRecovery
The value of the payment in minor units.
component1() - Method in class com.worldpay.payment.model.CardPaymentCancel
The transaction reference defined by the merchant to uniquely identify the payment.
component1() - Method in class com.worldpay.payment.model.CardPreAuthSale
The manner in which the payment is to be made
component1() - Method in class com.worldpay.payment.model.CardRefund
The manner in which the payment is to be made
component1() - Method in class com.worldpay.payment.model.CardSale
The manner in which the payment is to be made
component1() - Method in class com.worldpay.payment.model.CardSettlement
The transaction reference defined by the merchant to uniquely identify the payment.
component1() - Method in class com.worldpay.payment.model.CashbackAmountComplete
The transaction reference defined by the merchant to uniquely identify the payment.
component1() - Method in class com.worldpay.payment.model.PaymentAbort
The transaction reference defined by the merchant to uniquely identify the payment.
component1() - Method in class com.worldpay.payment.model.SignatureVerificationComplete
The transaction Reference defined by the merchant to uniquely identify the payment.
component1() - Method in class com.worldpay.payment.model.TokenisedCardRefund
The card token to be used for the payment.
component1() - Method in class com.worldpay.payment.model.TokenisedCardSale
The card token to be used for the payment.
component1() - Method in class com.worldpay.payment.model.VoiceAuthorisationComplete
The transaction Reference defined by the merchant to uniquely identify the payment.
component1() - Method in class com.worldpay.registration.model.PointOfSale
A unique identifier for the Point of Sale.
component1() - Method in class com.worldpay.registration.model.PosRegistration
contains the data to register a new Point of Sale.
component1() - Method in class com.worldpay.websocket.api.payment.action.AVSConfirmationRequired
 
component1() - Method in class com.worldpay.websocket.api.payment.action.AVSResults
 
component1() - Method in class com.worldpay.websocket.api.payment.action.CashbackAmountRequired
 
component1() - Method in class com.worldpay.websocket.api.payment.action.SignatureVerificationRequired
 
component1() - Method in class com.worldpay.websocket.api.payment.action.VoiceAuthorisationRequired
 
component1() - Method in class com.worldpay.websocket.api.payment.authorisation.PaymentAuthorisation
 
component1() - Method in class com.worldpay.websocket.api.payment.authorisation.ReferralContact
 
component1() - Method in class com.worldpay.websocket.api.payment.card.CardDate
 
component1() - Method in class com.worldpay.websocket.api.payment.card.CardPaymentDebug
 
component1() - Method in class com.worldpay.websocket.api.payment.card.PaymentCard
 
component1() - Method in class com.worldpay.websocket.api.payment.instruction.InstructionAmount
 
component1() - Method in class com.worldpay.websocket.api.payment.instruction.PaymentInstruction
 
component1() - Method in class com.worldpay.websocket.api.payment.instrument.AlipayPaymentInstrument
The barcode value generated by the customer
component1() - Method in class com.worldpay.websocket.api.payment.instrument.CardPaymentInstrument
The type of payment instrument.
component1() - Method in class com.worldpay.websocket.api.payment.instrument.CashPaymentInstrument
The tendered amount for the cash payment requested in minor currency units.
component1() - Method in class com.worldpay.websocket.api.payment.instrument.PaymentInstrument
 
component1() - Method in class com.worldpay.websocket.api.payment.merchant.Address
 
component1() - Method in class com.worldpay.websocket.api.payment.merchant.Merchant
The payment gateway
component1() - Method in class com.worldpay.websocket.api.payment.merchant.MerchantIdentifier
the merchants unique ID.
component1() - Method in class com.worldpay.websocket.api.payment.Payment
 
component1() - Method in class com.worldpay.websocket.api.payment.PaymentActionRequired
 
component1() - Method in class com.worldpay.websocket.api.payment.PaymentNotification
 
component1() - Method in class com.worldpay.websocket.api.payment.PaymentReceipt
The type of receipt
component1() - Method in class com.worldpay.websocket.api.payment.PaymentResult
 
component1() - Method in class com.worldpay.websocket.api.payment.query.PaymentReceiptQuery
The transaction reference defined by the merchant to uniquely identify the payment.
component1() - Method in class com.worldpay.websocket.api.payment.query.PaymentResultQuery
The transaction reference defined by the merchant to uniquely identify the payment.
component1() - Method in class com.worldpay.websocket.api.payment.terminal.Paypoint
 
component1() - Method in class com.worldpay.websocket.api.payment.transaction.CurrencyConversion
 
component1() - Method in class com.worldpay.websocket.api.payment.transaction.Transaction
 
component1() - Method in class com.worldpay.websocket.api.registration.PosRegistrationResponse
a unique key assigned to the POS to allow it to perform authenticated operations.
component10() - Method in class com.worldpay.websocket.api.payment.card.PaymentCard
 
component10() - Method in class com.worldpay.websocket.api.payment.Payment
 
component11() - Method in class com.worldpay.websocket.api.payment.card.PaymentCard
 
component11() - Method in class com.worldpay.websocket.api.payment.Payment
 
component12() - Method in class com.worldpay.websocket.api.payment.Payment
 
component13() - Method in class com.worldpay.websocket.api.payment.Payment
 
component14() - Method in class com.worldpay.websocket.api.payment.Payment
 
component15() - Method in class com.worldpay.websocket.api.payment.Payment
 
component2() - Method in class com.worldpay.AppDetails
The version of the current application
component2() - Method in class com.worldpay.monitor.model.PaymentDeviceStatus
The paypoint that the payment device is connected to.
component2() - Method in class com.worldpay.payment.model.AlipayBarcodePaymentCancel
The Payment Gateway Transaction Reference
component2() - Method in class com.worldpay.payment.model.AvsConfirmationComplete
true whether AVS results are confirmed
component2() - Method in class com.worldpay.payment.model.Card
The masked card number of the card used in the original payment to check against.
component2() - Method in class com.worldpay.payment.model.CardCheck
The value of the payment in minor units.
component2() - Method in class com.worldpay.payment.model.CardCheckPayment
The value of the payment in minor units.
component2() - Method in class com.worldpay.payment.model.CardKeyedRefundRecovery
The transaction reference defined by the merchant to uniquely identify the payment.
component2() - Method in class com.worldpay.payment.model.CardKeyedSaleRecovery
The transaction reference defined by the merchant to uniquely identify the payment.
component2() - Method in class com.worldpay.payment.model.CardPaymentCancel
The Payment Gateway Transaction Reference
component2() - Method in class com.worldpay.payment.model.CardPreAuthSale
The value of the payment in minor units.
component2() - Method in class com.worldpay.payment.model.CardRefund
The value of the payment in minor units.
component2() - Method in class com.worldpay.payment.model.CardSale
The value of the payment in minor units.
component2() - Method in class com.worldpay.payment.model.CardSettlement
The Payment Gateway Transaction Reference
component2() - Method in class com.worldpay.payment.model.CashbackAmountComplete
the amount of cash back to be included in the payment,
component2() - Method in class com.worldpay.payment.model.SignatureVerificationComplete
true whether the signature was verified.
component2() - Method in class com.worldpay.payment.model.TokenisedCardRefund
The value of the payment in minor units.
component2() - Method in class com.worldpay.payment.model.TokenisedCardSale
The value of the payment in minor units.
component2() - Method in class com.worldpay.payment.model.VoiceAuthorisationComplete
generated by the issuer for an authorised payment.
component2() - Method in class com.worldpay.registration.model.PointOfSale
A reference provided by the merchant for the Point of Sale.
component2() - Method in class com.worldpay.registration.model.PosRegistration
identifier for the paypoint on which the action should or has been performed on.
component2() - Method in class com.worldpay.websocket.api.payment.action.AVSConfirmationRequired
 
component2() - Method in class com.worldpay.websocket.api.payment.action.AVSResults
 
component2() - Method in class com.worldpay.websocket.api.payment.action.CashbackAmountRequired
 
component2() - Method in class com.worldpay.websocket.api.payment.action.VoiceAuthorisationRequired
 
component2() - Method in class com.worldpay.websocket.api.payment.authorisation.PaymentAuthorisation
 
component2() - Method in class com.worldpay.websocket.api.payment.authorisation.ReferralContact
 
component2() - Method in class com.worldpay.websocket.api.payment.card.CardDate
 
component2() - Method in class com.worldpay.websocket.api.payment.card.CardPaymentDebug
 
component2() - Method in class com.worldpay.websocket.api.payment.card.PaymentCard
 
component2() - Method in class com.worldpay.websocket.api.payment.instruction.PaymentInstruction
 
component2() - Method in class com.worldpay.websocket.api.payment.instrument.AlipayPaymentInstrument
Data for the authorisation of the payment.
component2() - Method in class com.worldpay.websocket.api.payment.instrument.CardPaymentInstrument
The 2-digit code representing the PAN Entry Mode of the POS Entry Mode.
component2() - Method in class com.worldpay.websocket.api.payment.instrument.PaymentInstrument
 
component2() - Method in class com.worldpay.websocket.api.payment.merchant.Address
 
component2() - Method in class com.worldpay.websocket.api.payment.merchant.Merchant
the merchant
component2() - Method in class com.worldpay.websocket.api.payment.Payment
 
component2() - Method in class com.worldpay.websocket.api.payment.PaymentActionRequired
 
component2() - Method in class com.worldpay.websocket.api.payment.PaymentNotification
 
component2() - Method in class com.worldpay.websocket.api.payment.PaymentReceipt
The content of the receipt.
component2() - Method in class com.worldpay.websocket.api.payment.query.PaymentReceiptQuery
the ReceiptType of the receipt to return.
component2() - Method in class com.worldpay.websocket.api.payment.query.PaymentResultQuery
Identifier for the paypoint on which the action should or has been performed on.
component2() - Method in class com.worldpay.websocket.api.payment.terminal.Paypoint
 
component2() - Method in class com.worldpay.websocket.api.payment.transaction.CurrencyConversion
 
component2() - Method in class com.worldpay.websocket.api.payment.transaction.Transaction
 
component3() - Method in class com.worldpay.monitor.model.PaymentDeviceStatus
The connected payment device.
component3() - Method in class com.worldpay.payment.model.AlipayBarcodePaymentCancel
The barcode value generated by the customer
component3() - Method in class com.worldpay.payment.model.Card
The expiry date of the card used in the original payment to check against.
component3() - Method in class com.worldpay.payment.model.CardCheck
The transaction reference defined by the merchant to uniquely identify the payment.
component3() - Method in class com.worldpay.payment.model.CardCheckPayment
The transaction reference defined by the merchant to uniquely identify the payment.
component3() - Method in class com.worldpay.payment.model.CardKeyedRefundRecovery
provide the merchant code used in the original sale being refunded.
component3() - Method in class com.worldpay.payment.model.CardKeyedSaleRecovery
The authorisation code for the payment obtained through a prior voice authorisation.
component3() - Method in class com.worldpay.payment.model.CardPaymentCancel
The masked card number of the card used in the original payment to check against.
component3() - Method in class com.worldpay.payment.model.CardPreAuthSale
The transaction reference defined by the merchant to uniquely identify the payment.
component3() - Method in class com.worldpay.payment.model.CardRefund
The transaction reference defined by the merchant to uniquely identify the payment.
component3() - Method in class com.worldpay.payment.model.CardSale
The transaction reference defined by the merchant to uniquely identify the payment.
component3() - Method in class com.worldpay.payment.model.CardSettlement
The masked card number of the card used in the original payment to check against.
component3() - Method in class com.worldpay.payment.model.TokenisedCardRefund
The transaction reference defined by the merchant to uniquely identify the payment.
component3() - Method in class com.worldpay.payment.model.TokenisedCardSale
The transaction reference defined by the merchant to uniquely identify the payment.
component3() - Method in class com.worldpay.registration.model.PointOfSale
A unique code to allow a Point of Sale to be activated.
component3() - Method in class com.worldpay.websocket.api.payment.action.AVSResults
 
component3() - Method in class com.worldpay.websocket.api.payment.action.VoiceAuthorisationRequired
 
component3() - Method in class com.worldpay.websocket.api.payment.card.PaymentCard
 
component3() - Method in class com.worldpay.websocket.api.payment.instruction.PaymentInstruction
 
component3() - Method in class com.worldpay.websocket.api.payment.instrument.CardPaymentInstrument
The numeric code representing the verification method of the card.
component3() - Method in class com.worldpay.websocket.api.payment.instrument.PaymentInstrument
 
component3() - Method in class com.worldpay.websocket.api.payment.merchant.Address
 
component3() - Method in class com.worldpay.websocket.api.payment.merchant.Merchant
The merchant
component3() - Method in class com.worldpay.websocket.api.payment.Payment
 
component3() - Method in class com.worldpay.websocket.api.payment.PaymentReceipt
The transaction reference defined by the merchant to uniquely identify the payment.
component3() - Method in class com.worldpay.websocket.api.payment.query.PaymentReceiptQuery
Identifier for the paypoint on which the action should or has been performed on.
component3() - Method in class com.worldpay.websocket.api.payment.transaction.CurrencyConversion
 
component3() - Method in class com.worldpay.websocket.api.payment.transaction.Transaction
 
component4() - Method in class com.worldpay.payment.model.AlipayBarcodePaymentCancel
An incrementing count of the number of attempts to send this barcode for this payment.
component4() - Method in class com.worldpay.payment.model.CardCheck
Identifier for the paypoint on which the action should or has been performed on.
component4() - Method in class com.worldpay.payment.model.CardCheckPayment
Identifier for the paypoint on which the action should or has been performed on.
component4() - Method in class com.worldpay.payment.model.CardKeyedRefundRecovery
provide the transaction reference from the original sale being refunded.
component4() - Method in class com.worldpay.payment.model.CardKeyedSaleRecovery
Identifier for the paypoint on which the action should or has been performed on.
component4() - Method in class com.worldpay.payment.model.CardPaymentCancel
The expiry date
component4() - Method in class com.worldpay.payment.model.CardPreAuthSale
Identifier for the paypoint on which the action should or has been performed on.
component4() - Method in class com.worldpay.payment.model.CardRefund
provide the merchant code used in the original sale being refunded.
component4() - Method in class com.worldpay.payment.model.CardSale
Identifier for the paypoint on which the action should or has been performed on.
component4() - Method in class com.worldpay.payment.model.CardSettlement
The expiry date of the card used in the original payment to check against
component4() - Method in class com.worldpay.payment.model.TokenisedCardRefund
provide the merchant code used in the original sale being refunded.
component4() - Method in class com.worldpay.payment.model.TokenisedCardSale
Identifier for the paypoint on which the action should or has been performed on.
component4() - Method in class com.worldpay.websocket.api.payment.card.PaymentCard
 
component4() - Method in class com.worldpay.websocket.api.payment.instruction.PaymentInstruction
 
component4() - Method in class com.worldpay.websocket.api.payment.instrument.CardPaymentInstrument
Indicates whether the payment request was handled online or not.
component4() - Method in class com.worldpay.websocket.api.payment.instrument.PaymentInstrument
 
component4() - Method in class com.worldpay.websocket.api.payment.merchant.Address
 
component4() - Method in class com.worldpay.websocket.api.payment.Payment
 
component4() - Method in class com.worldpay.websocket.api.payment.transaction.Transaction
 
component5() - Method in class com.worldpay.payment.model.AlipayBarcodePaymentCancel
Quantity of the commodity in the payment.
component5() - Method in class com.worldpay.payment.model.CardCheck
Indicates whether the payment should be performed online or not.
component5() - Method in class com.worldpay.payment.model.CardCheckPayment
Indicates whether the payment should be performed online or not.
component5() - Method in class com.worldpay.payment.model.CardKeyedRefundRecovery
For refunding card sales,
component5() - Method in class com.worldpay.payment.model.CardPaymentCancel
Identifier for the paypoint on which the action should or has been performed on.
component5() - Method in class com.worldpay.payment.model.CardRefund
provide the transaction reference from the original sale being refunded.
component5() - Method in class com.worldpay.payment.model.CardSettlement
Mandatory value of the payment in minor units.
component5() - Method in class com.worldpay.payment.model.TokenisedCardRefund
provide the transaction reference from the original sale being refunded.
component5() - Method in class com.worldpay.websocket.api.payment.card.PaymentCard
 
component5() - Method in class com.worldpay.websocket.api.payment.instruction.PaymentInstruction
 
component5() - Method in class com.worldpay.websocket.api.payment.instrument.CardPaymentInstrument
Data for the card used in the payment.
component5() - Method in class com.worldpay.websocket.api.payment.instrument.PaymentInstrument
 
component5() - Method in class com.worldpay.websocket.api.payment.merchant.Address
 
component5() - Method in class com.worldpay.websocket.api.payment.Payment
 
component5() - Method in class com.worldpay.websocket.api.payment.transaction.Transaction
 
component6() - Method in class com.worldpay.payment.model.AlipayBarcodePaymentCancel
Identifier for the paypoint on which the action should or has been performed on.
component6() - Method in class com.worldpay.payment.model.CardKeyedRefundRecovery
Identifier for the paypoint on which the action should or has been performed on.
component6() - Method in class com.worldpay.payment.model.CardRefund
For refunding card sales,
component6() - Method in class com.worldpay.payment.model.CardSettlement
Identifier for the paypoint on which the action should or has been performed on.
component6() - Method in class com.worldpay.payment.model.TokenisedCardRefund
For refunding card sales,
component6() - Method in class com.worldpay.websocket.api.payment.card.PaymentCard
 
component6() - Method in class com.worldpay.websocket.api.payment.instrument.CardPaymentInstrument
Data for the authorisation of the payment.
component6() - Method in class com.worldpay.websocket.api.payment.merchant.Address
 
component6() - Method in class com.worldpay.websocket.api.payment.Payment
 
component6() - Method in class com.worldpay.websocket.api.payment.transaction.Transaction
 
component7() - Method in class com.worldpay.payment.model.CardRefund
Identifier for the paypoint on which the action should or has been performed on.
component7() - Method in class com.worldpay.payment.model.TokenisedCardRefund
Identifier for the paypoint on which the action should or has been performed on.
component7() - Method in class com.worldpay.websocket.api.payment.card.PaymentCard
 
component7() - Method in class com.worldpay.websocket.api.payment.instrument.CardPaymentInstrument
Debug information.
component7() - Method in class com.worldpay.websocket.api.payment.merchant.Address
 
component7() - Method in class com.worldpay.websocket.api.payment.Payment
 
component8() - Method in class com.worldpay.websocket.api.payment.card.PaymentCard
 
component8() - Method in class com.worldpay.websocket.api.payment.Payment
 
component9() - Method in class com.worldpay.websocket.api.payment.card.PaymentCard
 
component9() - Method in class com.worldpay.websocket.api.payment.Payment
 
Configuration - Class in com.worldpay
Holds global configuration information
configure(serverUrl, timeout, posLicenseKey, paypointId, logger, appDetails) - Static method in class com.worldpay.Configuration
Sets up the configuration for the SDK.
configure(serverUrl, timeout, posLicenseKey, paypointId, logger) - Static method in class com.worldpay.Configuration
Sets up the configuration for the SDK.
configure(serverUrl, timeout, posLicenseKey, paypointId) - Static method in class com.worldpay.Configuration
Sets up the configuration for the SDK.
configure(serverUrl, timeout, posLicenseKey) - Static method in class com.worldpay.Configuration
Sets up the configuration for the SDK.
configure(serverUrl, timeout) - Static method in class com.worldpay.Configuration
Sets up the configuration for the SDK.
ConnectionClosedError - Exception in com.worldpay.payment
 
ConnectionClosedError() - Constructor for exception com.worldpay.payment.ConnectionClosedError
 
copy(appName, appVersion) - Method in class com.worldpay.AppDetails
Holds details of the current application
copy(message) - Method in exception com.worldpay.error.InternalServerError
Internal placeholder for a server error message.
copy(serialNumber) - Method in class com.worldpay.monitor.model.PaymentDevice
Holds data about a payment device.
copy(status, paypoint, paymentDevice) - Method in class com.worldpay.monitor.model.PaymentDeviceStatus
Holds status information about a payment device.
copy(status) - Method in class com.worldpay.monitor.model.PaymentServiceStatus
The message to receive the status of the payment service.
copy(merchantTransactionReference, gatewayTransactionReference, barcode, sendAttempt, quantity, paypointId) - Method in class com.worldpay.payment.model.AlipayBarcodePaymentCancel
Holds data required when cancelling an alipay barcode payment.
copy(merchantTransactionReference, isAvsConfirmed) - Method in class com.worldpay.payment.model.AvsConfirmationComplete
Contains all the data to be sent when AVS confirmation is required during a payment
copy(type, cardNumber, cardExpiryDate) - Method in class com.worldpay.payment.model.Card
Details to validate against a previous card-based pre-auth
copy(type, value, merchantTransactionReference, paypointId, isHandledOnline) - Method in class com.worldpay.payment.model.CardCheck
Contains the data for performing a Card Check without payment.
copy(type, value, merchantTransactionReference, paypointId, isHandledOnline) - Method in class com.worldpay.payment.model.CardCheckPayment
Contains the data for performing a Card Check with Payment.
copy(value, merchantTransactionReference, originalMerchantCode, originalTransactionReference, originalGatewayTransactionReference, paypointId) - Method in class com.worldpay.payment.model.CardKeyedRefundRecovery
Contains the data for performing a Card keyed refund recovery.
copy(value, merchantTransactionReference, authorisationCode, paypointId) - Method in class com.worldpay.payment.model.CardKeyedSaleRecovery
Contains the data for performing a Card keyed sale recovery.
copy(merchantTransactionReference, gatewayTransactionReference, cardNumber, cardExpiryDate, paypointId) - Method in class com.worldpay.payment.model.CardPaymentCancel
Holds data required when cancelling a card payment.
copy(type, value, merchantTransactionReference, paypointId) - Method in class com.worldpay.payment.model.CardPreAuthSale
Contains data for performing a Card Pre-Auth Sale.
copy(type, value, merchantTransactionReference, originalMerchantCode, originalTransactionReference, originalGatewayTransactionReference, paypointId) - Method in class com.worldpay.payment.model.CardRefund
Contains the data for performing a Card refund.
copy(type, value, merchantTransactionReference, paypointId) - Method in class com.worldpay.payment.model.CardSale
Contains the data for performing a Card sale.
copy(merchantTransactionReference, gatewayTransactionReference, cardNumber, cardExpiryDate, value, paypointId) - Method in class com.worldpay.payment.model.CardSettlement
Contains the data for settling a pre-auth.
copy(merchantTransactionReference, cashbackAmount) - Method in class com.worldpay.payment.model.CashbackAmountComplete
Contains all the data to be sent when Cashback amount is required during a payment
copy(merchantTransactionReference) - Method in class com.worldpay.payment.model.PaymentAbort
Holds the data to be sent to abort an in-flight transaction.
copy(merchantTransactionReference, isSignatureVerified) - Method in class com.worldpay.payment.model.SignatureVerificationComplete
Contains all the data to be sent when signature is required during a payment
copy(tokenId, value, merchantTransactionReference, originalMerchantCode, originalTransactionReference, originalGatewayTransactionReference, paypointId) - Method in class com.worldpay.payment.model.TokenisedCardRefund
Contains the data for performing a tokenised Card refund.
copy(tokenId, value, merchantTransactionReference, paypointId) - Method in class com.worldpay.payment.model.TokenisedCardSale
Contains the data for performing a tokenised Card sale.
copy(merchantTransactionReference, authorisationCode) - Method in class com.worldpay.payment.model.VoiceAuthorisationComplete
Contains all the data to be sent when voice authorisation is required during a payment
copy(id, reference, activationCode) - Method in class com.worldpay.registration.model.PointOfSale
Holds the data for a Points of Sale.
copy(pointOfSale, paypointId) - Method in class com.worldpay.registration.model.PosRegistration
Holds the data needed for registering a Point Of Sale.
copy(action, avsResults) - Method in class com.worldpay.websocket.api.payment.action.AVSConfirmationRequired
Contains the AVS confirmation data that is required during a payment
copy(isCvvMatch, isAddressLineMatch, isPostalCodeMatch) - Method in class com.worldpay.websocket.api.payment.action.AVSResults
Results of the payment's AVS check to be authorised by the merchant.
copy(action, maximumCashbackAmount) - Method in class com.worldpay.websocket.api.payment.action.CashbackAmountRequired
Contains the Cashback data that is required during a payment when cashback is supported
copy(action) - Method in class com.worldpay.websocket.api.payment.action.SignatureVerificationRequired
Contains the signature verification data that is required during a payment
copy(action, merchant, referralContacts) - Method in class com.worldpay.websocket.api.payment.action.VoiceAuthorisationRequired
Contains the voice authorisation data that is required during a payment
copy(authorisationCode, cvvResponseData) - Method in class com.worldpay.websocket.api.payment.authorisation.PaymentAuthorisation
Holds data about the payment authorisation.
copy(method, value) - Method in class com.worldpay.websocket.api.payment.authorisation.ReferralContact
Referral contact details to complete voice authorisation for this payment.
copy(month, year) - Method in class com.worldpay.websocket.api.payment.card.CardDate
Month and Year for a card date (Start or Expiration) MM/YY.
copy(transactionStatusInfo, transactionVerificationResults) - Method in class com.worldpay.websocket.api.payment.card.CardPaymentDebug
Used for debug purpose only.
copy(tokenId, cardNumber, track2Data, expiryDate, type, issuerCode, countryCode, panSequenceNumber, applicationLabel, applicationIdentifier, applicationEffectiveDate) - Method in class com.worldpay.websocket.api.payment.card.PaymentCard
Holds data about the card that performed the payment.
copy(amount) - Method in class com.worldpay.websocket.api.payment.instruction.InstructionAmount
Represents data about the value of the transaction
copy(value, paymentInstrument, originalMerchantCode, originalTransactionReference, originalGatewayTransactionReference) - Method in class com.worldpay.websocket.api.payment.instruction.PaymentInstruction
Holds payment status information returned from the remote host.
copy(barcode, authorisation) - Method in class com.worldpay.websocket.api.payment.instrument.AlipayPaymentInstrument
Holds data about how the payment was performed.
copy(type, posEntryMode, cardVerificationMethod, isHandledOnline, card, authorisation, debug) - Method in class com.worldpay.websocket.api.payment.instrument.CardPaymentInstrument
Holds data about how the payment was performed.
copy(cashTenderAmount) - Method in class com.worldpay.websocket.api.payment.instrument.CashPaymentInstrument
Holds data about how the payment was performed.
copy(type, isHandledOnline, cashTenderAmount, tokenId, authorisationCode) - Method in class com.worldpay.websocket.api.payment.instrument.PaymentInstrument
Represents data about the hardware to perform the payment.
copy(line1, line2, line3, city, state, postalCode, countryCode) - Method in class com.worldpay.websocket.api.payment.merchant.Address
The merchant’s address.
copy(merchantId, name, address) - Method in class com.worldpay.websocket.api.payment.merchant.Merchant
Holds data about the merchant.
copy(merchantId) - Method in class com.worldpay.websocket.api.payment.merchant.MerchantIdentifier
Holds an identifier for the merchant.
copy(paymentType, transactionDateTime, result, paypoint, merchantTransactionReference, value, paymentInstrument, merchant, gatewayTransactionReference, eftSequenceNumber, retrievalReferenceNumber, receiptNumber, receiptRetentionReminder, receiptCustomerDeclaration, taxFreeVoucher) - Method in class com.worldpay.websocket.api.payment.Payment
Holds payment result information return from the remote host
copy(merchantTransactionReference, data) - Method in class com.worldpay.websocket.api.payment.PaymentActionRequired
Holds payment actions required by remote host
copy(merchantTransactionReference, notificationText) - Method in class com.worldpay.websocket.api.payment.PaymentNotification
The message to communicate the real-time status of an in-flight payment.
copy(type, content, merchantTransactionReference) - Method in class com.worldpay.websocket.api.payment.PaymentReceipt
The message to receive a payment receipt.
copy(payments) - Method in class com.worldpay.websocket.api.payment.PaymentResult
The message to communicate the result of a completed payment.
copy(merchantTransactionReference, type, paypointId) - Method in class com.worldpay.websocket.api.payment.query.PaymentReceiptQuery
Contains the data to query the receipt of the last payment.
copy(merchantTransactionReference, paypointId) - Method in class com.worldpay.websocket.api.payment.query.PaymentResultQuery
Contains the data for getting the PaymentResult from a previous payment.
copy(paypointId, terminalId) - Method in class com.worldpay.websocket.api.payment.terminal.Paypoint
The paypoint the request has been performed on.
copy(convertedCurrencyCode, convertedAmount, conversionRate) - Method in class com.worldpay.websocket.api.payment.transaction.CurrencyConversion
Holds data about any on-terminal currency conversion.
copy(amount, currencyCode, cashbackAmount, gratuityAmount, donationAmount, dcc) - Method in class com.worldpay.websocket.api.payment.transaction.Transaction
Holds the information about values used on the transaction.
copy(pointOfSaleLicenseKey) - Method in class com.worldpay.websocket.api.registration.PosRegistrationResponse
Holds the POS License Key for a successful registration.
CurrencyConversion - Class in com.worldpay.websocket.api.payment.transaction
Holds data about any on-terminal currency conversion.
CurrencyConversion(convertedCurrencyCode, convertedAmount, conversionRate) - Constructor for class com.worldpay.websocket.api.payment.transaction.CurrencyConversion
Holds data about any on-terminal currency conversion.

D

deserialize(decoder) - Method in class com.worldpay.monitor.model.ServiceStatusSerializer
 
deserialize(decoder) - Method in class com.worldpay.websocket.api.payment.action.ActionTypeSerializer
 
deserialize(decoder) - Method in class com.worldpay.websocket.api.payment.action.AvsMatchResultSerializer
 
deserialize(decoder) - Method in class com.worldpay.websocket.api.payment.action.PaymentActionDataSerializer
 
deserialize(decoder) - Method in class com.worldpay.websocket.api.payment.instrument.PaymentResultInstrumentSerializer
 
deserialize(decoder) - Method in class com.worldpay.websocket.api.payment.PaymentOutcomeSerializer
 
deserialize(decoder) - Method in class com.worldpay.websocket.api.payment.ReceiptTypeSerializer
 
deserialize(decoder) - Method in class com.worldpay.websocket.api.payment.TransactionTypeSerializer
 
DeviceStatus - Enum in com.worldpay.monitor.model
Defines the possible values for the status of a device.
DeviceStatusCallback - Class in com.worldpay.monitor
Abstract class for receiving class PaymentDeviceStatus events.
DeviceStatusCallback() - Constructor for class com.worldpay.monitor.DeviceStatusCallback
Abstract class for receiving class PaymentDeviceStatus events.
DeviceStatusStream - Class in com.worldpay.monitor
Class containing communication streams for device status events.
DeviceStatusStream(coroutineContext, thrown) - Constructor for class com.worldpay.monitor.DeviceStatusStream
Class containing communication streams for device status events.

E

EnumKt - Class in com.worldpay
 
EnumKt() - Constructor for class com.worldpay.EnumKt
 
equals(p) - Method in class com.worldpay.AppDetails
Holds details of the current application
equals(p) - Method in exception com.worldpay.error.InternalServerError
Internal placeholder for a server error message.
equals(p) - Method in class com.worldpay.monitor.model.PaymentDevice
Holds data about a payment device.
equals(p) - Method in class com.worldpay.monitor.model.PaymentDeviceStatus
Holds status information about a payment device.
equals(p) - Method in class com.worldpay.monitor.model.PaymentServiceStatus
The message to receive the status of the payment service.
equals(p) - Method in class com.worldpay.payment.model.AlipayBarcodePaymentCancel
Holds data required when cancelling an alipay barcode payment.
equals(p) - Method in class com.worldpay.payment.model.AvsConfirmationComplete
Contains all the data to be sent when AVS confirmation is required during a payment
equals(p) - Method in class com.worldpay.payment.model.Card
Details to validate against a previous card-based pre-auth
equals(p) - Method in class com.worldpay.payment.model.CardCheck
Contains the data for performing a Card Check without payment.
equals(p) - Method in class com.worldpay.payment.model.CardCheckPayment
Contains the data for performing a Card Check with Payment.
equals(p) - Method in class com.worldpay.payment.model.CardKeyedRefundRecovery
Contains the data for performing a Card keyed refund recovery.
equals(p) - Method in class com.worldpay.payment.model.CardKeyedSaleRecovery
Contains the data for performing a Card keyed sale recovery.
equals(p) - Method in class com.worldpay.payment.model.CardPaymentCancel
Holds data required when cancelling a card payment.
equals(p) - Method in class com.worldpay.payment.model.CardPreAuthSale
Contains data for performing a Card Pre-Auth Sale.
equals(p) - Method in class com.worldpay.payment.model.CardRefund
Contains the data for performing a Card refund.
equals(p) - Method in class com.worldpay.payment.model.CardSale
Contains the data for performing a Card sale.
equals(p) - Method in class com.worldpay.payment.model.CardSettlement
Contains the data for settling a pre-auth.
equals(p) - Method in class com.worldpay.payment.model.CashbackAmountComplete
Contains all the data to be sent when Cashback amount is required during a payment
equals(p) - Method in class com.worldpay.payment.model.PaymentAbort
Holds the data to be sent to abort an in-flight transaction.
equals(p) - Method in class com.worldpay.payment.model.SignatureVerificationComplete
Contains all the data to be sent when signature is required during a payment
equals(p) - Method in class com.worldpay.payment.model.TokenisedCardRefund
Contains the data for performing a tokenised Card refund.
equals(p) - Method in class com.worldpay.payment.model.TokenisedCardSale
Contains the data for performing a tokenised Card sale.
equals(p) - Method in class com.worldpay.payment.model.VoiceAuthorisationComplete
Contains all the data to be sent when voice authorisation is required during a payment
equals(p) - Method in class com.worldpay.registration.model.PointOfSale
Holds the data for a Points of Sale.
equals(p) - Method in class com.worldpay.registration.model.PosRegistration
Holds the data needed for registering a Point Of Sale.
equals(p) - Method in class com.worldpay.websocket.api.payment.action.AVSConfirmationRequired
Contains the AVS confirmation data that is required during a payment
equals(p) - Method in class com.worldpay.websocket.api.payment.action.AVSResults
Results of the payment's AVS check to be authorised by the merchant.
equals(p) - Method in class com.worldpay.websocket.api.payment.action.CashbackAmountRequired
Contains the Cashback data that is required during a payment when cashback is supported
equals(p) - Method in class com.worldpay.websocket.api.payment.action.SignatureVerificationRequired
Contains the signature verification data that is required during a payment
equals(other) - Method in class com.worldpay.websocket.api.payment.action.VoiceAuthorisationRequired
 
equals(p) - Method in class com.worldpay.websocket.api.payment.authorisation.PaymentAuthorisation
Holds data about the payment authorisation.
equals(p) - Method in class com.worldpay.websocket.api.payment.authorisation.ReferralContact
Referral contact details to complete voice authorisation for this payment.
equals(p) - Method in class com.worldpay.websocket.api.payment.card.CardDate
Month and Year for a card date (Start or Expiration) MM/YY.
equals(p) - Method in class com.worldpay.websocket.api.payment.card.CardPaymentDebug
Used for debug purpose only.
equals(p) - Method in class com.worldpay.websocket.api.payment.card.PaymentCard
Holds data about the card that performed the payment.
equals(p) - Method in class com.worldpay.websocket.api.payment.instruction.InstructionAmount
Represents data about the value of the transaction
equals(p) - Method in class com.worldpay.websocket.api.payment.instruction.PaymentInstruction
Holds payment status information returned from the remote host.
equals(p) - Method in class com.worldpay.websocket.api.payment.instrument.AlipayPaymentInstrument
Holds data about how the payment was performed.
equals(p) - Method in class com.worldpay.websocket.api.payment.instrument.CardPaymentInstrument
Holds data about how the payment was performed.
equals(p) - Method in class com.worldpay.websocket.api.payment.instrument.CashPaymentInstrument
Holds data about how the payment was performed.
equals(p) - Method in class com.worldpay.websocket.api.payment.instrument.PaymentInstrument
Represents data about the hardware to perform the payment.
equals(p) - Method in class com.worldpay.websocket.api.payment.merchant.Address
The merchant’s address.
equals(p) - Method in class com.worldpay.websocket.api.payment.merchant.Merchant
Holds data about the merchant.
equals(p) - Method in class com.worldpay.websocket.api.payment.merchant.MerchantIdentifier
Holds an identifier for the merchant.
equals(p) - Method in class com.worldpay.websocket.api.payment.Payment
Holds payment result information return from the remote host
equals(p) - Method in class com.worldpay.websocket.api.payment.PaymentActionRequired
Holds payment actions required by remote host
equals(other) - Method in class com.worldpay.websocket.api.payment.PaymentComplete
 
equals(p) - Method in class com.worldpay.websocket.api.payment.PaymentNotification
The message to communicate the real-time status of an in-flight payment.
equals(p) - Method in class com.worldpay.websocket.api.payment.PaymentReceipt
The message to receive a payment receipt.
equals(p) - Method in class com.worldpay.websocket.api.payment.PaymentResult
The message to communicate the result of a completed payment.
equals(p) - Method in class com.worldpay.websocket.api.payment.query.PaymentReceiptQuery
Contains the data to query the receipt of the last payment.
equals(p) - Method in class com.worldpay.websocket.api.payment.query.PaymentResultQuery
Contains the data for getting the PaymentResult from a previous payment.
equals(p) - Method in class com.worldpay.websocket.api.payment.terminal.Paypoint
The paypoint the request has been performed on.
equals(p) - Method in class com.worldpay.websocket.api.payment.transaction.CurrencyConversion
Holds data about any on-terminal currency conversion.
equals(p) - Method in class com.worldpay.websocket.api.payment.transaction.Transaction
Holds the information about values used on the transaction.
equals(p) - Method in class com.worldpay.websocket.api.registration.PosRegistrationResponse
Holds the POS License Key for a successful registration.
ErrorType - Enum in com.worldpay.error
an enum to show the type of error thrown

G

getAction() - Method in class com.worldpay.payment.model.AvsConfirmationComplete
 
getAction() - Method in class com.worldpay.payment.model.CashbackAmountComplete
 
getAction() - Method in class com.worldpay.payment.model.PaymentActionComplete
 
getAction() - Method in class com.worldpay.payment.model.SignatureVerificationComplete
 
getAction() - Method in class com.worldpay.payment.model.VoiceAuthorisationComplete
 
getAction() - Method in class com.worldpay.websocket.api.payment.action.AVSConfirmationRequired
 
getAction() - Method in class com.worldpay.websocket.api.payment.action.CashbackAmountRequired
 
getAction() - Method in class com.worldpay.websocket.api.payment.action.PaymentActionRequiredData
 
getAction() - Method in class com.worldpay.websocket.api.payment.action.SignatureVerificationRequired
 
getAction() - Method in class com.worldpay.websocket.api.payment.action.VoiceAuthorisationRequired
 
getActivationCode() - Method in class com.worldpay.registration.model.PointOfSale
A unique code to allow a Point of Sale to be activated.
getAddress() - Method in class com.worldpay.websocket.api.payment.merchant.Merchant
The merchant
getAmount() - Method in class com.worldpay.websocket.api.payment.instruction.InstructionAmount
 
getAmount() - Method in class com.worldpay.websocket.api.payment.transaction.Transaction
 
getApplicationEffectiveDate() - Method in class com.worldpay.websocket.api.payment.card.PaymentCard
 
getApplicationIdentifier() - Method in class com.worldpay.websocket.api.payment.card.PaymentCard
 
getApplicationLabel() - Method in class com.worldpay.websocket.api.payment.card.PaymentCard
 
getAppName() - Method in class com.worldpay.AppDetails
The name of the current application
getAppVersion() - Method in class com.worldpay.AppDetails
The version of the current application
getAuthorisation() - Method in class com.worldpay.websocket.api.payment.instrument.AlipayPaymentInstrument
Data for the authorisation of the payment.
getAuthorisation() - Method in class com.worldpay.websocket.api.payment.instrument.CardPaymentInstrument
Data for the authorisation of the payment.
getAuthorisationCode() - Method in class com.worldpay.payment.model.CardKeyedSaleRecovery
The authorisation code for the payment obtained through a prior voice authorisation.
getAuthorisationCode() - Method in class com.worldpay.payment.model.VoiceAuthorisationComplete
generated by the issuer for an authorised payment.
getAuthorisationCode() - Method in class com.worldpay.websocket.api.payment.authorisation.PaymentAuthorisation
 
getAuthorisationCode() - Method in class com.worldpay.websocket.api.payment.instrument.PaymentInstrument
 
getAvsResults() - Method in class com.worldpay.websocket.api.payment.action.AVSConfirmationRequired
 
getBarcode() - Method in class com.worldpay.payment.model.AlipayBarcodePaymentCancel
The barcode value generated by the customer
getBarcode() - Method in class com.worldpay.websocket.api.payment.instrument.AlipayPaymentInstrument
The barcode value generated by the customer
getCard() - Method in class com.worldpay.websocket.api.payment.instrument.CardPaymentInstrument
Data for the card used in the payment.
getCardExpiryDate() - Method in class com.worldpay.payment.model.Card
The expiry date of the card used in the original payment to check against.
getCardExpiryDate() - Method in class com.worldpay.payment.model.CardPaymentCancel
The expiry date
getCardExpiryDate() - Method in class com.worldpay.payment.model.CardSettlement
The expiry date of the card used in the original payment to check against
getCardNumber() - Method in class com.worldpay.payment.model.Card
The masked card number of the card used in the original payment to check against.
getCardNumber() - Method in class com.worldpay.payment.model.CardPaymentCancel
The masked card number of the card used in the original payment to check against.
getCardNumber() - Method in class com.worldpay.payment.model.CardSettlement
The masked card number of the card used in the original payment to check against.
getCardNumber() - Method in class com.worldpay.websocket.api.payment.card.PaymentCard
 
getCardVerificationMethod() - Method in class com.worldpay.websocket.api.payment.instrument.CardPaymentInstrument
The numeric code representing the verification method of the card.
getCashbackAmount() - Method in class com.worldpay.payment.model.CashbackAmountComplete
the amount of cash back to be included in the payment,
getCashbackAmount() - Method in class com.worldpay.websocket.api.payment.transaction.Transaction
 
getCashTenderAmount() - Method in class com.worldpay.websocket.api.payment.instrument.CashPaymentInstrument
The tendered amount for the cash payment requested in minor currency units.
getCashTenderAmount() - Method in class com.worldpay.websocket.api.payment.instrument.PaymentInstrument
 
getCity() - Method in class com.worldpay.websocket.api.payment.merchant.Address
 
getContent() - Method in class com.worldpay.websocket.api.payment.PaymentReceipt
The content of the receipt.
getConversionRate() - Method in class com.worldpay.websocket.api.payment.transaction.CurrencyConversion
 
getConvertedAmount() - Method in class com.worldpay.websocket.api.payment.transaction.CurrencyConversion
 
getConvertedCurrencyCode() - Method in class com.worldpay.websocket.api.payment.transaction.CurrencyConversion
 
getCoroutineContext() - Method in class com.worldpay.websocket.SingleStream
the context that will be used for any coroutine calls within the receiver.
getCountryCode() - Method in class com.worldpay.websocket.api.payment.card.PaymentCard
 
getCountryCode() - Method in class com.worldpay.websocket.api.payment.merchant.Address
 
getCurrencyCode() - Method in class com.worldpay.websocket.api.payment.transaction.Transaction
 
getCvvResponseData() - Method in class com.worldpay.websocket.api.payment.authorisation.PaymentAuthorisation
 
getData() - Method in class com.worldpay.websocket.api.payment.PaymentActionRequired
 
getDcc() - Method in class com.worldpay.websocket.api.payment.transaction.Transaction
 
getDebug() - Method in class com.worldpay.websocket.api.payment.instrument.CardPaymentInstrument
Debug information.
getDefaultLogger() - Method in class com.worldpay.crossplatform.LoggerFactory
Provides access to a platform-specific Logger, in this case LogcatLogger
getDescriptor() - Method in class com.worldpay.monitor.model.ServiceStatusSerializer
 
getDescriptor() - Method in class com.worldpay.websocket.api.payment.action.ActionTypeSerializer
 
getDescriptor() - Method in class com.worldpay.websocket.api.payment.action.AvsMatchResultSerializer
 
getDescriptor() - Method in class com.worldpay.websocket.api.payment.action.PaymentActionDataSerializer
 
getDescriptor() - Method in class com.worldpay.websocket.api.payment.instrument.PaymentResultInstrumentSerializer
 
getDescriptor() - Method in class com.worldpay.websocket.api.payment.PaymentOutcomeSerializer
 
getDescriptor() - Method in class com.worldpay.websocket.api.payment.ReceiptTypeSerializer
 
getDescriptor() - Method in class com.worldpay.websocket.api.payment.TransactionTypeSerializer
 
getDeviceStatus(paypointId, callback, p) - Method in class com.worldpay.monitor.StatusMonitor
Gets the current device status for the supplied paypoint ID
getDeviceStatus(coroutineContext, paypointId, callback) - Static method in class com.worldpay.monitor.StatusMonitorCompat
Gets the current device status for the supplied paypoint ID
getDeviceStatus(coroutineContext, callback) - Static method in class com.worldpay.monitor.StatusMonitorCompat
Gets the current device status for the supplied paypoint ID
getDonationAmount() - Method in class com.worldpay.websocket.api.payment.transaction.Transaction
 
getEftSequenceNumber() - Method in class com.worldpay.websocket.api.payment.Payment
 
getError() - Method in class com.worldpay.payment.PaymentStream
Will complete with the exception UnhandledError with the reason for the error or exception ServerError if the server reports an Error.
getError() - Method in class com.worldpay.websocket.SingleStream
may complete with an exception UnhandledError if there is a problem.
getErrorCode() - Method in exception com.worldpay.error.ServerError
the error code thrown.
getErrorType() - Method in exception com.worldpay.error.UnhandledError
the error type thrown.
getEvents() - Method in class com.worldpay.payment.PaymentStream
Received from the remote system.
getEvents() - Method in class com.worldpay.websocket.SingleStream
will emit received class PaymentServiceStatus
getExpiryDate() - Method in class com.worldpay.websocket.api.payment.card.PaymentCard
 
getGatewayTransactionReference() - Method in class com.worldpay.payment.model.AlipayBarcodePaymentCancel
The Payment Gateway Transaction Reference
getGatewayTransactionReference() - Method in class com.worldpay.payment.model.CardPaymentCancel
The Payment Gateway Transaction Reference
getGatewayTransactionReference() - Method in class com.worldpay.payment.model.CardSettlement
The Payment Gateway Transaction Reference
getGatewayTransactionReference() - Method in class com.worldpay.payment.model.PaymentCancel
The gateway transaction reference of a previous transaction
getGatewayTransactionReference() - Method in class com.worldpay.websocket.api.payment.Payment
 
getGratuityAmount() - Method in class com.worldpay.websocket.api.payment.transaction.Transaction
 
getId() - Method in class com.worldpay.registration.model.PointOfSale
A unique identifier for the Point of Sale.
getIssuerCode() - Method in class com.worldpay.websocket.api.payment.card.PaymentCard
 
getLine1() - Method in class com.worldpay.websocket.api.payment.merchant.Address
 
getLine2() - Method in class com.worldpay.websocket.api.payment.merchant.Address
 
getLine3() - Method in class com.worldpay.websocket.api.payment.merchant.Address
 
getMaximumCashbackAmount() - Method in class com.worldpay.websocket.api.payment.action.CashbackAmountRequired
 
getMerchant() - Method in class com.worldpay.websocket.api.payment.action.VoiceAuthorisationRequired
 
getMerchant() - Method in class com.worldpay.websocket.api.payment.Payment
 
getMerchantId() - Method in class com.worldpay.websocket.api.payment.merchant.Merchant
The payment gateway
getMerchantId() - Method in class com.worldpay.websocket.api.payment.merchant.MerchantIdentifier
the merchants unique ID.
getMerchantTransactionReference() - Method in class com.worldpay.payment.model.AlipayBarcodePaymentCancel
The transaction reference defined by the merchant to uniquely identify the payment.
getMerchantTransactionReference() - Method in class com.worldpay.payment.model.AvsConfirmationComplete
The transaction Reference defined by the merchant to uniquely identify the payment.
getMerchantTransactionReference() - Method in class com.worldpay.payment.model.CardCheck
The transaction reference defined by the merchant to uniquely identify the payment.
getMerchantTransactionReference() - Method in class com.worldpay.payment.model.CardCheckPayment
The transaction reference defined by the merchant to uniquely identify the payment.
getMerchantTransactionReference() - Method in class com.worldpay.payment.model.CardKeyedRefundRecovery
The transaction reference defined by the merchant to uniquely identify the payment.
getMerchantTransactionReference() - Method in class com.worldpay.payment.model.CardKeyedSaleRecovery
The transaction reference defined by the merchant to uniquely identify the payment.
getMerchantTransactionReference() - Method in class com.worldpay.payment.model.CardPaymentCancel
The transaction reference defined by the merchant to uniquely identify the payment.
getMerchantTransactionReference() - Method in class com.worldpay.payment.model.CardPreAuthSale
The transaction reference defined by the merchant to uniquely identify the payment.
getMerchantTransactionReference() - Method in class com.worldpay.payment.model.CardRefund
The transaction reference defined by the merchant to uniquely identify the payment.
getMerchantTransactionReference() - Method in class com.worldpay.payment.model.CardSale
The transaction reference defined by the merchant to uniquely identify the payment.
getMerchantTransactionReference() - Method in class com.worldpay.payment.model.CardSettlement
The transaction reference defined by the merchant to uniquely identify the payment.
getMerchantTransactionReference() - Method in class com.worldpay.payment.model.CashbackAmountComplete
The transaction reference defined by the merchant to uniquely identify the payment.
getMerchantTransactionReference() - Method in class com.worldpay.payment.model.PaymentAbort
The transaction reference defined by the merchant to uniquely identify the payment.
getMerchantTransactionReference() - Method in class com.worldpay.payment.model.PaymentActionComplete
 
getMerchantTransactionReference() - Method in class com.worldpay.payment.model.PaymentCancel
The transaction reference defined by the merchant to uniquely identify the payment.
getMerchantTransactionReference() - Method in interface com.worldpay.payment.model.PaymentRequest
The transaction reference defined by the merchant to uniquely identify the payment.
getMerchantTransactionReference() - Method in class com.worldpay.payment.model.SignatureVerificationComplete
The transaction Reference defined by the merchant to uniquely identify the payment.
getMerchantTransactionReference() - Method in class com.worldpay.payment.model.TokenisedCardRefund
The transaction reference defined by the merchant to uniquely identify the payment.
getMerchantTransactionReference() - Method in class com.worldpay.payment.model.TokenisedCardSale
The transaction reference defined by the merchant to uniquely identify the payment.
getMerchantTransactionReference() - Method in class com.worldpay.payment.model.VoiceAuthorisationComplete
The transaction Reference defined by the merchant to uniquely identify the payment.
getMerchantTransactionReference() - Method in class com.worldpay.websocket.api.payment.Payment
 
getMerchantTransactionReference() - Method in class com.worldpay.websocket.api.payment.PaymentActionRequired
 
getMerchantTransactionReference() - Method in class com.worldpay.websocket.api.payment.PaymentNotification
 
getMerchantTransactionReference() - Method in class com.worldpay.websocket.api.payment.PaymentReceipt
The transaction reference defined by the merchant to uniquely identify the payment.
getMerchantTransactionReference() - Method in class com.worldpay.websocket.api.payment.query.PaymentQuery
The transaction reference defined by the merchant to uniquely identify the payment.
getMerchantTransactionReference() - Method in class com.worldpay.websocket.api.payment.query.PaymentReceiptQuery
The transaction reference defined by the merchant to uniquely identify the payment.
getMerchantTransactionReference() - Method in class com.worldpay.websocket.api.payment.query.PaymentResultQuery
The transaction reference defined by the merchant to uniquely identify the payment.
getMessage() - Method in exception com.worldpay.error.InternalServerError
 
getMessage() - Method in exception com.worldpay.error.ServerError
 
getMethod() - Method in class com.worldpay.websocket.api.payment.authorisation.ReferralContact
 
getMonth() - Method in class com.worldpay.websocket.api.payment.card.CardDate
 
getName() - Method in class com.worldpay.websocket.api.payment.merchant.Merchant
the merchant
getNotificationText() - Method in class com.worldpay.websocket.api.payment.PaymentNotification
 
getOriginalGatewayTransactionReference() - Method in class com.worldpay.payment.model.CardKeyedRefundRecovery
For refunding card sales,
getOriginalGatewayTransactionReference() - Method in class com.worldpay.payment.model.CardRefund
For refunding card sales,
getOriginalGatewayTransactionReference() - Method in interface com.worldpay.payment.model.CardRefundRequest
 
getOriginalGatewayTransactionReference() - Method in class com.worldpay.payment.model.TokenisedCardRefund
For refunding card sales,
getOriginalGatewayTransactionReference() - Method in class com.worldpay.websocket.api.payment.instruction.PaymentInstruction
 
getOriginalMerchantCode() - Method in class com.worldpay.payment.model.CardKeyedRefundRecovery
provide the merchant code used in the original sale being refunded.
getOriginalMerchantCode() - Method in class com.worldpay.payment.model.CardRefund
provide the merchant code used in the original sale being refunded.
getOriginalMerchantCode() - Method in interface com.worldpay.payment.model.CardRefundRequest
 
getOriginalMerchantCode() - Method in class com.worldpay.payment.model.TokenisedCardRefund
provide the merchant code used in the original sale being refunded.
getOriginalMerchantCode() - Method in class com.worldpay.websocket.api.payment.instruction.PaymentInstruction
 
getOriginalTransactionReference() - Method in class com.worldpay.payment.model.CardKeyedRefundRecovery
provide the transaction reference from the original sale being refunded.
getOriginalTransactionReference() - Method in class com.worldpay.payment.model.CardRefund
provide the transaction reference from the original sale being refunded.
getOriginalTransactionReference() - Method in interface com.worldpay.payment.model.CardRefundRequest
 
getOriginalTransactionReference() - Method in class com.worldpay.payment.model.TokenisedCardRefund
provide the transaction reference from the original sale being refunded.
getOriginalTransactionReference() - Method in class com.worldpay.websocket.api.payment.instruction.PaymentInstruction
 
getPanSequenceNumber() - Method in class com.worldpay.websocket.api.payment.card.PaymentCard
 
getPaymentDevice() - Method in class com.worldpay.monitor.model.PaymentDeviceStatus
The connected payment device.
getPaymentInstrument() - Method in class com.worldpay.websocket.api.payment.instruction.PaymentInstruction
 
getPaymentInstrument() - Method in class com.worldpay.websocket.api.payment.Payment
 
getPayments() - Method in class com.worldpay.websocket.api.payment.PaymentResult
 
getPaymentType() - Method in class com.worldpay.websocket.api.payment.Payment
 
getPaypoint() - Method in class com.worldpay.monitor.model.PaymentDeviceStatus
The paypoint that the payment device is connected to.
getPaypoint() - Method in class com.worldpay.websocket.api.payment.Payment
 
getPaypointId() - Method in class com.worldpay.payment.model.AlipayBarcodePaymentCancel
Identifier for the paypoint on which the action should or has been performed on.
getPaypointId() - Method in class com.worldpay.payment.model.CardCheck
Identifier for the paypoint on which the action should or has been performed on.
getPaypointId() - Method in class com.worldpay.payment.model.CardCheckPayment
Identifier for the paypoint on which the action should or has been performed on.
getPaypointId() - Method in class com.worldpay.payment.model.CardKeyedRefundRecovery
Identifier for the paypoint on which the action should or has been performed on.
getPaypointId() - Method in class com.worldpay.payment.model.CardKeyedSaleRecovery
Identifier for the paypoint on which the action should or has been performed on.
getPaypointId() - Method in class com.worldpay.payment.model.CardPaymentCancel
Identifier for the paypoint on which the action should or has been performed on.
getPaypointId() - Method in class com.worldpay.payment.model.CardPreAuthSale
Identifier for the paypoint on which the action should or has been performed on.
getPaypointId() - Method in class com.worldpay.payment.model.CardRefund
Identifier for the paypoint on which the action should or has been performed on.
getPaypointId() - Method in class com.worldpay.payment.model.CardSale
Identifier for the paypoint on which the action should or has been performed on.
getPaypointId() - Method in class com.worldpay.payment.model.CardSettlement
Identifier for the paypoint on which the action should or has been performed on.
getPaypointId() - Method in class com.worldpay.payment.model.PaymentCancel
Identifier for the paypoint on which the action should or has been performed on.
getPaypointId() - Method in interface com.worldpay.payment.model.PaymentRequest
Identifier for the paypoint on which the action should or has been performed on.
getPaypointId() - Method in class com.worldpay.payment.model.TokenisedCardRefund
Identifier for the paypoint on which the action should or has been performed on.
getPaypointId() - Method in class com.worldpay.payment.model.TokenisedCardSale
Identifier for the paypoint on which the action should or has been performed on.
getPaypointId() - Method in class com.worldpay.registration.model.PosRegistration
identifier for the paypoint on which the action should or has been performed on.
getPaypointId() - Method in class com.worldpay.websocket.api.payment.query.PaymentQuery
Identifier for the paypoint on which the action should or has been performed on.
getPaypointId() - Method in class com.worldpay.websocket.api.payment.query.PaymentReceiptQuery
Identifier for the paypoint on which the action should or has been performed on.
getPaypointId() - Method in class com.worldpay.websocket.api.payment.query.PaymentResultQuery
Identifier for the paypoint on which the action should or has been performed on.
getPaypointId() - Method in class com.worldpay.websocket.api.payment.terminal.Paypoint
 
getPointOfSale() - Method in class com.worldpay.registration.model.PosRegistration
contains the data to register a new Point of Sale.
getPointOfSaleLicenseKey() - Method in class com.worldpay.websocket.api.registration.PosRegistrationResponse
a unique key assigned to the POS to allow it to perform authenticated operations.
getPosEntryMode() - Method in class com.worldpay.websocket.api.payment.instrument.CardPaymentInstrument
The 2-digit code representing the PAN Entry Mode of the POS Entry Mode.
getPostalCode() - Method in class com.worldpay.websocket.api.payment.merchant.Address
 
getQuantity() - Method in class com.worldpay.payment.model.AlipayBarcodePaymentCancel
Quantity of the commodity in the payment.
getReceiptCustomerDeclaration() - Method in class com.worldpay.websocket.api.payment.Payment
 
getReceiptNumber() - Method in class com.worldpay.websocket.api.payment.Payment
 
getReceiptRetentionReminder() - Method in class com.worldpay.websocket.api.payment.Payment
 
getReference() - Method in class com.worldpay.registration.model.PointOfSale
A reference provided by the merchant for the Point of Sale.
getReferralContacts() - Method in class com.worldpay.websocket.api.payment.action.VoiceAuthorisationRequired
 
getResult() - Method in class com.worldpay.websocket.api.payment.Payment
 
getRetrievalReferenceNumber() - Method in class com.worldpay.websocket.api.payment.Payment
 
getSendAttempt() - Method in class com.worldpay.payment.model.AlipayBarcodePaymentCancel
An incrementing count of the number of attempts to send this barcode for this payment.
getSerialNumber() - Method in class com.worldpay.monitor.model.PaymentDevice
The serial number of the payment device.
getServiceStatus(paypointId, callback, p) - Method in class com.worldpay.monitor.StatusMonitor
Gets the Service status for the supplied paypoint ID
getServiceStatus(coroutineContext, paypointId, callback) - Static method in class com.worldpay.monitor.StatusMonitorCompat
Gets the current Service status.
getServiceStatus(coroutineContext, callback) - Static method in class com.worldpay.monitor.StatusMonitorCompat
Gets the current Service status.
getState() - Method in class com.worldpay.websocket.api.payment.merchant.Address
 
getStatus() - Method in class com.worldpay.monitor.model.PaymentDeviceStatus
the current
getStatus() - Method in class com.worldpay.monitor.model.PaymentServiceStatus
The current status of the payment service.
getTaxFreeVoucher() - Method in class com.worldpay.websocket.api.payment.Payment
 
getTerminalId() - Method in class com.worldpay.websocket.api.payment.terminal.Paypoint
 
getTokenId() - Method in interface com.worldpay.payment.model.TokenisedCardPaymentRequest
The card token to be used for the payment.
getTokenId() - Method in class com.worldpay.payment.model.TokenisedCardRefund
The card token to be used for the payment.
getTokenId() - Method in class com.worldpay.payment.model.TokenisedCardSale
The card token to be used for the payment.
getTokenId() - Method in class com.worldpay.websocket.api.payment.card.PaymentCard
 
getTokenId() - Method in class com.worldpay.websocket.api.payment.instrument.PaymentInstrument
 
getTrack2Data() - Method in class com.worldpay.websocket.api.payment.card.PaymentCard
 
getTransactionDateTime() - Method in class com.worldpay.websocket.api.payment.Payment
 
getTransactionStatusInfo() - Method in class com.worldpay.websocket.api.payment.card.CardPaymentDebug
 
getTransactionVerificationResults() - Method in class com.worldpay.websocket.api.payment.card.CardPaymentDebug
 
getType() - Method in class com.worldpay.payment.model.Card
The manner in which the payment is to be made
getType() - Method in class com.worldpay.payment.model.CardCheck
The manner in which the payment is to be made
getType() - Method in class com.worldpay.payment.model.CardCheckPayment
The manner in which the payment is to be made
getType() - Method in class com.worldpay.payment.model.CardKeyedRefundRecovery
The manner in which the payment is to be made (present, keyed or not present).
getType() - Method in class com.worldpay.payment.model.CardKeyedSaleRecovery
The manner in which the payment is to be made (present, keyed or not present).
getType() - Method in interface com.worldpay.payment.model.CardPaymentRequest
The manner in which the payment is to be made (present, keyed or not present).
getType() - Method in class com.worldpay.payment.model.CardPreAuthSale
The manner in which the payment is to be made
getType() - Method in class com.worldpay.payment.model.CardRefund
The manner in which the payment is to be made
getType() - Method in class com.worldpay.payment.model.CardSale
The manner in which the payment is to be made
getType() - Method in class com.worldpay.websocket.api.payment.card.PaymentCard
 
getType() - Method in class com.worldpay.websocket.api.payment.instrument.AlipayPaymentInstrument
 
getType() - Method in class com.worldpay.websocket.api.payment.instrument.CardPaymentInstrument
The type of payment instrument.
getType() - Method in class com.worldpay.websocket.api.payment.instrument.CashPaymentInstrument
 
getType() - Method in class com.worldpay.websocket.api.payment.instrument.PaymentInstrument
 
getType() - Method in class com.worldpay.websocket.api.payment.instrument.PaymentResultInstrument
 
getType() - Method in class com.worldpay.websocket.api.payment.PaymentReceipt
The type of receipt
getType() - Method in class com.worldpay.websocket.api.payment.query.PaymentReceiptQuery
the ReceiptType of the receipt to return.
getType$module() - Method in class com.worldpay.payment.model.AlipayBarcodePaymentCancel
 
getType$module() - Method in class com.worldpay.payment.model.CardPaymentCancel
 
getValue() - Method in class com.worldpay.payment.model.CardCheck
The value of the payment in minor units.
getValue() - Method in class com.worldpay.payment.model.CardCheckPayment
The value of the payment in minor units.
getValue() - Method in class com.worldpay.payment.model.CardKeyedRefundRecovery
The value of the payment in minor units.
getValue() - Method in class com.worldpay.payment.model.CardKeyedSaleRecovery
The value of the payment in minor units.
getValue() - Method in class com.worldpay.payment.model.CardPreAuthSale
The value of the payment in minor units.
getValue() - Method in class com.worldpay.payment.model.CardRefund
The value of the payment in minor units.
getValue() - Method in class com.worldpay.payment.model.CardSale
The value of the payment in minor units.
getValue() - Method in class com.worldpay.payment.model.CardSettlement
Mandatory value of the payment in minor units.
getValue() - Method in interface com.worldpay.payment.model.PaymentRequest
The value of the payment in minor units.
getValue() - Method in class com.worldpay.payment.model.TokenisedCardRefund
The value of the payment in minor units.
getValue() - Method in class com.worldpay.payment.model.TokenisedCardSale
The value of the payment in minor units.
getValue() - Method in class com.worldpay.websocket.api.payment.authorisation.ReferralContact
 
getValue() - Method in class com.worldpay.websocket.api.payment.instruction.PaymentInstruction
 
getValue() - Method in class com.worldpay.websocket.api.payment.Payment
 
getYear() - Method in class com.worldpay.websocket.api.payment.card.CardDate
 

H

hashCode() - Method in class com.worldpay.AppDetails
Holds details of the current application
hashCode() - Method in exception com.worldpay.error.InternalServerError
Internal placeholder for a server error message.
hashCode() - Method in class com.worldpay.monitor.model.PaymentDevice
Holds data about a payment device.
hashCode() - Method in class com.worldpay.monitor.model.PaymentDeviceStatus
Holds status information about a payment device.
hashCode() - Method in class com.worldpay.monitor.model.PaymentServiceStatus
The message to receive the status of the payment service.
hashCode() - Method in class com.worldpay.payment.model.AlipayBarcodePaymentCancel
Holds data required when cancelling an alipay barcode payment.
hashCode() - Method in class com.worldpay.payment.model.AvsConfirmationComplete
Contains all the data to be sent when AVS confirmation is required during a payment
hashCode() - Method in class com.worldpay.payment.model.Card
Details to validate against a previous card-based pre-auth
hashCode() - Method in class com.worldpay.payment.model.CardCheck
Contains the data for performing a Card Check without payment.
hashCode() - Method in class com.worldpay.payment.model.CardCheckPayment
Contains the data for performing a Card Check with Payment.
hashCode() - Method in class com.worldpay.payment.model.CardKeyedRefundRecovery
Contains the data for performing a Card keyed refund recovery.
hashCode() - Method in class com.worldpay.payment.model.CardKeyedSaleRecovery
Contains the data for performing a Card keyed sale recovery.
hashCode() - Method in class com.worldpay.payment.model.CardPaymentCancel
Holds data required when cancelling a card payment.
hashCode() - Method in class com.worldpay.payment.model.CardPreAuthSale
Contains data for performing a Card Pre-Auth Sale.
hashCode() - Method in class com.worldpay.payment.model.CardRefund
Contains the data for performing a Card refund.
hashCode() - Method in class com.worldpay.payment.model.CardSale
Contains the data for performing a Card sale.
hashCode() - Method in class com.worldpay.payment.model.CardSettlement
Contains the data for settling a pre-auth.
hashCode() - Method in class com.worldpay.payment.model.CashbackAmountComplete
Contains all the data to be sent when Cashback amount is required during a payment
hashCode() - Method in class com.worldpay.payment.model.PaymentAbort
Holds the data to be sent to abort an in-flight transaction.
hashCode() - Method in class com.worldpay.payment.model.SignatureVerificationComplete
Contains all the data to be sent when signature is required during a payment
hashCode() - Method in class com.worldpay.payment.model.TokenisedCardRefund
Contains the data for performing a tokenised Card refund.
hashCode() - Method in class com.worldpay.payment.model.TokenisedCardSale
Contains the data for performing a tokenised Card sale.
hashCode() - Method in class com.worldpay.payment.model.VoiceAuthorisationComplete
Contains all the data to be sent when voice authorisation is required during a payment
hashCode() - Method in class com.worldpay.registration.model.PointOfSale
Holds the data for a Points of Sale.
hashCode() - Method in class com.worldpay.registration.model.PosRegistration
Holds the data needed for registering a Point Of Sale.
hashCode() - Method in class com.worldpay.websocket.api.payment.action.AVSConfirmationRequired
Contains the AVS confirmation data that is required during a payment
hashCode() - Method in class com.worldpay.websocket.api.payment.action.AVSResults
Results of the payment's AVS check to be authorised by the merchant.
hashCode() - Method in class com.worldpay.websocket.api.payment.action.CashbackAmountRequired
Contains the Cashback data that is required during a payment when cashback is supported
hashCode() - Method in class com.worldpay.websocket.api.payment.action.SignatureVerificationRequired
Contains the signature verification data that is required during a payment
hashCode() - Method in class com.worldpay.websocket.api.payment.action.VoiceAuthorisationRequired
 
hashCode() - Method in class com.worldpay.websocket.api.payment.authorisation.PaymentAuthorisation
Holds data about the payment authorisation.
hashCode() - Method in class com.worldpay.websocket.api.payment.authorisation.ReferralContact
Referral contact details to complete voice authorisation for this payment.
hashCode() - Method in class com.worldpay.websocket.api.payment.card.CardDate
Month and Year for a card date (Start or Expiration) MM/YY.
hashCode() - Method in class com.worldpay.websocket.api.payment.card.CardPaymentDebug
Used for debug purpose only.
hashCode() - Method in class com.worldpay.websocket.api.payment.card.PaymentCard
Holds data about the card that performed the payment.
hashCode() - Method in class com.worldpay.websocket.api.payment.instruction.InstructionAmount
Represents data about the value of the transaction
hashCode() - Method in class com.worldpay.websocket.api.payment.instruction.PaymentInstruction
Holds payment status information returned from the remote host.
hashCode() - Method in class com.worldpay.websocket.api.payment.instrument.AlipayPaymentInstrument
Holds data about how the payment was performed.
hashCode() - Method in class com.worldpay.websocket.api.payment.instrument.CardPaymentInstrument
Holds data about how the payment was performed.
hashCode() - Method in class com.worldpay.websocket.api.payment.instrument.CashPaymentInstrument
Holds data about how the payment was performed.
hashCode() - Method in class com.worldpay.websocket.api.payment.instrument.PaymentInstrument
Represents data about the hardware to perform the payment.
hashCode() - Method in class com.worldpay.websocket.api.payment.merchant.Address
The merchant’s address.
hashCode() - Method in class com.worldpay.websocket.api.payment.merchant.Merchant
Holds data about the merchant.
hashCode() - Method in class com.worldpay.websocket.api.payment.merchant.MerchantIdentifier
Holds an identifier for the merchant.
hashCode() - Method in class com.worldpay.websocket.api.payment.Payment
Holds payment result information return from the remote host
hashCode() - Method in class com.worldpay.websocket.api.payment.PaymentActionRequired
Holds payment actions required by remote host
hashCode() - Method in class com.worldpay.websocket.api.payment.PaymentComplete
 
hashCode() - Method in class com.worldpay.websocket.api.payment.PaymentNotification
The message to communicate the real-time status of an in-flight payment.
hashCode() - Method in class com.worldpay.websocket.api.payment.PaymentReceipt
The message to receive a payment receipt.
hashCode() - Method in class com.worldpay.websocket.api.payment.PaymentResult
The message to communicate the result of a completed payment.
hashCode() - Method in class com.worldpay.websocket.api.payment.query.PaymentReceiptQuery
Contains the data to query the receipt of the last payment.
hashCode() - Method in class com.worldpay.websocket.api.payment.query.PaymentResultQuery
Contains the data for getting the PaymentResult from a previous payment.
hashCode() - Method in class com.worldpay.websocket.api.payment.terminal.Paypoint
The paypoint the request has been performed on.
hashCode() - Method in class com.worldpay.websocket.api.payment.transaction.CurrencyConversion
Holds data about any on-terminal currency conversion.
hashCode() - Method in class com.worldpay.websocket.api.payment.transaction.Transaction
Holds the information about values used on the transaction.
hashCode() - Method in class com.worldpay.websocket.api.registration.PosRegistrationResponse
Holds the POS License Key for a successful registration.

I

INSTANCE - Static variable in class com.worldpay.Configuration
Holds global configuration information
INSTANCE - Static variable in class com.worldpay.crossplatform.LoggerFactory
Provides access to a platform-specific Logger
INSTANCE - Static variable in class com.worldpay.monitor.model.ServiceStatusSerializer
Serializes and deserializes a enum ServiceStatus to/from a string
INSTANCE - Static variable in class com.worldpay.monitor.StatusMonitor
Provides access to status information from the remote system.
INSTANCE - Static variable in class com.worldpay.monitor.StatusMonitorCompat
Provides access to status information from the remote system.
INSTANCE - Static variable in class com.worldpay.payment.PaymentManager
Provides access for sending and receiving data from the remote system.
INSTANCE - Static variable in class com.worldpay.payment.PaymentManagerCompat
Provides Java-style wrapper methods for PaymentManager
INSTANCE - Static variable in class com.worldpay.registration.RegistrationManager
Provides methods for performing registrations
INSTANCE - Static variable in class com.worldpay.registration.RegistrationManagerCompat
Provides Java-style wrapper methods for class RegistrationManager
INSTANCE - Static variable in class com.worldpay.websocket.api.payment.action.ActionTypeSerializer
Handles the serialization and deserialization of ReceiptType to/from JSON.
INSTANCE - Static variable in class com.worldpay.websocket.api.payment.action.AvsMatchResultSerializer
Handles the serialization and deserialization of AvsMatchResult to/from JSON.
INSTANCE - Static variable in class com.worldpay.websocket.api.payment.action.PaymentActionDataSerializer
Handles the serialization and deserialization of PaymentActionData subclass from JSON.
INSTANCE - Static variable in class com.worldpay.websocket.api.payment.instrument.PaymentResultInstrumentSerializer
Handles the serialization and deserialization of PaymentResultInstrument subclass from JSON.
INSTANCE - Static variable in class com.worldpay.websocket.api.payment.PaymentOutcomeSerializer
Handles the serialization and deserialization of the TransactionOutcomeSerializer to/from JSON.
INSTANCE - Static variable in class com.worldpay.websocket.api.payment.ReceiptTypeSerializer
Handles the serialization and deserialization of ReceiptType to/from JSON.
INSTANCE - Static variable in class com.worldpay.websocket.api.payment.TransactionTypeSerializer
Handles the serialization and deserialization of the TransactionType to/from JSON.
InstructionAmount - Class in com.worldpay.websocket.api.payment.instruction
Represents data about the value of the transaction
InstructionAmount(amount) - Constructor for class com.worldpay.websocket.api.payment.instruction.InstructionAmount
Represents data about the value of the transaction
InternalServerError - Exception in com.worldpay.error
Internal placeholder for a server error message.
InternalServerError(message) - Constructor for exception com.worldpay.error.InternalServerError
Internal placeholder for a server error message.
InvalidValueException - Exception in com.worldpay.payment
Class which is received when an invalid value has been set
InvalidValueException() - Constructor for exception com.worldpay.payment.InvalidValueException
Class which is received when an invalid value has been set
isAddressLineMatch() - Method in class com.worldpay.websocket.api.payment.action.AVSResults
 
isAvsConfirmed() - Method in class com.worldpay.payment.model.AvsConfirmationComplete
true whether AVS results are confirmed
isCvvMatch() - Method in class com.worldpay.websocket.api.payment.action.AVSResults
 
isHandledOnline() - Method in class com.worldpay.payment.model.CardCheck
Indicates whether the payment should be performed online or not.
isHandledOnline() - Method in class com.worldpay.payment.model.CardCheckPayment
Indicates whether the payment should be performed online or not.
isHandledOnline() - Method in interface com.worldpay.payment.model.CardCheckRequest
Indicates whether the payment should be performed online or not. Defaults to true if omitted on a payment where it is applicable. Currently, an online/offline choice is only applicable to the check-card and check-card-payment payment types, online/offline processing is determined automatically for all other payments regardless of this indicator.
isHandledOnline() - Method in class com.worldpay.websocket.api.payment.instrument.CardPaymentInstrument
Indicates whether the payment request was handled online or not.
isHandledOnline() - Method in class com.worldpay.websocket.api.payment.instrument.PaymentInstrument
 
isPostalCodeMatch() - Method in class com.worldpay.websocket.api.payment.action.AVSResults
 
isSignatureVerified() - Method in class com.worldpay.payment.model.SignatureVerificationComplete
true whether the signature was verified.

J

JsonKt - Class in com.worldpay
 
JsonKt() - Constructor for class com.worldpay.JsonKt
 

L

LoggerFactory - Class in com.worldpay.crossplatform
Provides access to a platform-specific Logger

M

Merchant - Class in com.worldpay.websocket.api.payment.merchant
Holds data about the merchant.
Merchant(merchantId, name, address) - Constructor for class com.worldpay.websocket.api.payment.merchant.Merchant
Holds data about the merchant.
MerchantIdentifier - Class in com.worldpay.websocket.api.payment.merchant
Holds an identifier for the merchant.
MerchantIdentifier(merchantId) - Constructor for class com.worldpay.websocket.api.payment.merchant.MerchantIdentifier
Holds an identifier for the merchant.
MissingPaypointException - Exception in com.worldpay
Raised when there is no Configuration default of paypoint ID and none specified in the request.
MissingPaypointException() - Constructor for exception com.worldpay.MissingPaypointException
Raised when there is no Configuration default of paypoint ID and none specified in the request.

O

onError(error) - Method in class com.worldpay.monitor.DeviceStatusCallback
the function called when we receive an unhandled error when getting the status.
onError(error) - Method in class com.worldpay.monitor.ServiceStatusCallback
Function called when we receive an unhandled error while getting the status.
onError(error) - Method in class com.worldpay.registration.PosRegistrationCallback
the function called when we receive an unhandled error when performing registration.
onErrorReceived(error) - Method in class com.worldpay.payment.PaymentHandler
the function called when we receive an unhandled error during payment
onErrorReceived(error) - Method in class com.worldpay.payment.SettleHandler
the function called when we receive an unhandled error during payment
onEvent(paymentEvent) - Method in class com.worldpay.payment.PaymentHandler
the function called when we receive a payment event to be implemented
onRegistrationComplete(response) - Method in class com.worldpay.registration.PosRegistrationCallback
Called when a class PosRegistrationResponse is received.
onResult(paymentResult) - Method in class com.worldpay.payment.SettleHandler
the function called when we receive a payment result to be implemented
onStatusReceived(paymentDeviceStatus) - Method in class com.worldpay.monitor.DeviceStatusCallback
Called when a class PaymentDeviceStatus is received.
onStatusReceived(paymentServiceStatus) - Method in class com.worldpay.monitor.ServiceStatusCallback
Called when a class PaymentServiceStatus is received.

P

Payment - Class in com.worldpay.websocket.api.payment
Holds payment result information return from the remote host
Payment(paymentType, transactionDateTime, result, paypoint, merchantTransactionReference, value, paymentInstrument, merchant, gatewayTransactionReference, eftSequenceNumber, retrievalReferenceNumber, receiptNumber, receiptRetentionReminder, receiptCustomerDeclaration, taxFreeVoucher) - Constructor for class com.worldpay.websocket.api.payment.Payment
Holds payment result information return from the remote host
PaymentAbort - Class in com.worldpay.payment.model
Holds the data to be sent to abort an in-flight transaction.
PaymentAbort(merchantTransactionReference) - Constructor for class com.worldpay.payment.model.PaymentAbort
Holds the data to be sent to abort an in-flight transaction.
PaymentActionComplete - Class in com.worldpay.payment.model
Base class for types of action data that can be sent during a payment
PaymentActionDataSerializer - Class in com.worldpay.websocket.api.payment.action
Handles the serialization and deserialization of PaymentActionData subclass from JSON.
PaymentActionRequired - Class in com.worldpay.websocket.api.payment
Holds payment actions required by remote host
PaymentActionRequired(merchantTransactionReference, data) - Constructor for class com.worldpay.websocket.api.payment.PaymentActionRequired
Holds payment actions required by remote host
PaymentActionRequiredData - Class in com.worldpay.websocket.api.payment.action
Base class for all types of actions required during a payment
PaymentAuthorisation - Class in com.worldpay.websocket.api.payment.authorisation
Holds data about the payment authorisation.
PaymentAuthorisation(authorisationCode, cvvResponseData) - Constructor for class com.worldpay.websocket.api.payment.authorisation.PaymentAuthorisation
Holds data about the payment authorisation.
PaymentAuthorisation() - Constructor for class com.worldpay.websocket.api.payment.authorisation.PaymentAuthorisation
Holds data about the payment authorisation.
PaymentCancel - Class in com.worldpay.payment.model
Base class for common data required when cancelling a payment.
PaymentCard - Class in com.worldpay.websocket.api.payment.card
Holds data about the card that performed the payment.
PaymentCard(tokenId, cardNumber, track2Data, expiryDate, type, issuerCode, countryCode, panSequenceNumber, applicationLabel, applicationIdentifier, applicationEffectiveDate) - Constructor for class com.worldpay.websocket.api.payment.card.PaymentCard
Holds data about the card that performed the payment.
PaymentCard() - Constructor for class com.worldpay.websocket.api.payment.card.PaymentCard
Holds data about the card that performed the payment.
PaymentCardType - Enum in com.worldpay.websocket.api.payment.card
Defines the possible types of card used in a payment
PaymentComplete - Class in com.worldpay.websocket.api.payment
This communicates that the payment process is complete
PaymentComplete() - Constructor for class com.worldpay.websocket.api.payment.PaymentComplete
This communicates that the payment process is complete
PaymentDevice - Class in com.worldpay.monitor.model
Holds data about a payment device.
PaymentDevice(serialNumber) - Constructor for class com.worldpay.monitor.model.PaymentDevice
Holds data about a payment device.
PaymentDeviceStatus - Class in com.worldpay.monitor.model
Holds status information about a payment device.
PaymentDeviceStatus(status, paypoint, paymentDevice) - Constructor for class com.worldpay.monitor.model.PaymentDeviceStatus
Holds status information about a payment device.
PaymentEvent - Class in com.worldpay.websocket.api.payment
Base class for types of events that can be emitted during a payment
PaymentEventStream - Class in com.worldpay.payment
Class containing communication streams for payment query events.
PaymentEventStream(coroutineContext, thrown) - Constructor for class com.worldpay.payment.PaymentEventStream
Class containing communication streams for payment query events.
PaymentHandler - Class in com.worldpay.payment
Interface for receiving payment events via a handler
PaymentHandler() - Constructor for class com.worldpay.payment.PaymentHandler
Interface for receiving payment events via a handler
PaymentInstruction - Class in com.worldpay.websocket.api.payment.instruction
Holds payment status information returned from the remote host.
PaymentInstruction(value, paymentInstrument, originalMerchantCode, originalTransactionReference, originalGatewayTransactionReference) - Constructor for class com.worldpay.websocket.api.payment.instruction.PaymentInstruction
Holds payment status information returned from the remote host.
PaymentInstrument - Class in com.worldpay.websocket.api.payment.instrument
Represents data about the hardware to perform the payment.
PaymentInstrument(type, isHandledOnline, cashTenderAmount, tokenId, authorisationCode) - Constructor for class com.worldpay.websocket.api.payment.instrument.PaymentInstrument
Represents data about the hardware to perform the payment.
PaymentInstrumentType - Enum in com.worldpay.websocket.api.payment.instrument
The method by which the payment was made.
PaymentManager - Class in com.worldpay.payment
Provides access for sending and receiving data from the remote system.
PaymentManagerCompat - Class in com.worldpay.payment
Provides Java-style wrapper methods for PaymentManager
PaymentNotification - Class in com.worldpay.websocket.api.payment
The message to communicate the real-time status of an in-flight payment.
PaymentNotification(merchantTransactionReference, notificationText) - Constructor for class com.worldpay.websocket.api.payment.PaymentNotification
The message to communicate the real-time status of an in-flight payment.
PaymentOutcome - Enum in com.worldpay.websocket.api.payment
Defines the possible outcomes for a payment
PaymentOutcomeSerializer - Class in com.worldpay.websocket.api.payment
Handles the serialization and deserialization of the TransactionOutcomeSerializer to/from JSON.
PaymentQuery - Class in com.worldpay.websocket.api.payment.query
Defines the parameters required by all query result requests.
PaymentReceipt - Class in com.worldpay.websocket.api.payment
The message to receive a payment receipt.
PaymentReceipt(type, content, merchantTransactionReference) - Constructor for class com.worldpay.websocket.api.payment.PaymentReceipt
The message to receive a payment receipt.
PaymentReceiptQuery - Class in com.worldpay.websocket.api.payment.query
Contains the data to query the receipt of the last payment.
PaymentReceiptQuery(merchantTransactionReference, type, paypointId) - Constructor for class com.worldpay.websocket.api.payment.query.PaymentReceiptQuery
Contains the data to query the receipt of the last payment.
PaymentRequest - Interface in com.worldpay.payment.model
Defines the parameters required by all payment requests.
PaymentRequest() - Constructor for interface com.worldpay.payment.model.PaymentRequest
 
PaymentResult - Class in com.worldpay.websocket.api.payment
The message to communicate the result of a completed payment.
PaymentResult(payments) - Constructor for class com.worldpay.websocket.api.payment.PaymentResult
The message to communicate the result of a completed payment.
PaymentResultCode - Enum in com.worldpay.websocket.api.payment
The code representing the result of payment request.
PaymentResultInstrument - Class in com.worldpay.websocket.api.payment.instrument
Holds data about how the payment was performed.
PaymentResultInstrumentSerializer - Class in com.worldpay.websocket.api.payment.instrument
Handles the serialization and deserialization of PaymentResultInstrument subclass from JSON.
PaymentResultQuery - Class in com.worldpay.websocket.api.payment.query
Contains the data for getting the PaymentResult from a previous payment.
PaymentResultQuery(merchantTransactionReference, paypointId) - Constructor for class com.worldpay.websocket.api.payment.query.PaymentResultQuery
Contains the data for getting the PaymentResult from a previous payment.
PaymentServiceStatus - Class in com.worldpay.monitor.model
The message to receive the status of the payment service.
PaymentServiceStatus(status) - Constructor for class com.worldpay.monitor.model.PaymentServiceStatus
The message to receive the status of the payment service.
PaymentStream - Class in com.worldpay.payment
Abstract class containing communication streams for transaction events
PaymentStream(outgoing, incoming) - Constructor for class com.worldpay.payment.PaymentStream
Abstract class containing communication streams for transaction events
PaymentType - Enum in com.worldpay.websocket.api.payment
The type of payment.
Paypoint - Class in com.worldpay.websocket.api.payment.terminal
The paypoint the request has been performed on.
Paypoint(paypointId, terminalId) - Constructor for class com.worldpay.websocket.api.payment.terminal.Paypoint
The paypoint the request has been performed on.
Paypoint() - Constructor for class com.worldpay.websocket.api.payment.terminal.Paypoint
The paypoint the request has been performed on.
PointOfSale - Class in com.worldpay.registration.model
Holds the data for a Points of Sale.
PointOfSale(id, reference, activationCode) - Constructor for class com.worldpay.registration.model.PointOfSale
Holds the data for a Points of Sale.
PosRegistration - Class in com.worldpay.registration.model
Holds the data needed for registering a Point Of Sale.
PosRegistration(pointOfSale, paypointId) - Constructor for class com.worldpay.registration.model.PosRegistration
Holds the data needed for registering a Point Of Sale.
PosRegistrationCallback - Class in com.worldpay.registration
Abstract class for receiving class PosRegistrationResponse events.
PosRegistrationCallback() - Constructor for class com.worldpay.registration.PosRegistrationCallback
Abstract class for receiving class PosRegistrationResponse events.
PosRegistrationResponse - Class in com.worldpay.websocket.api.registration
Holds the POS License Key for a successful registration.
PosRegistrationResponse(pointOfSaleLicenseKey) - Constructor for class com.worldpay.websocket.api.registration.PosRegistrationResponse
Holds the POS License Key for a successful registration.
PosRegistrationStream - Class in com.worldpay.registration
Class containing communication streams for pos registrations.
PosRegistrationStream(coroutineContext, error) - Constructor for class com.worldpay.registration.PosRegistrationStream
Class containing communication streams for pos registrations.
proceedWithPayment(payment) - Method in class com.worldpay.payment.PaymentHandler
Proceed with the payment of a previous CardCheckPayment request.
proceedWithPayment(payment, p) - Method in class com.worldpay.payment.PaymentStream
Proceed with the payment of a previous CardCheckPayment request.

Q

queryPayment(request, callback, p) - Method in class com.worldpay.payment.PaymentManager
Starts a new query result request by creating a new connection to the remote system.
queryPayment(coroutineContext, request, handler) - Static method in class com.worldpay.payment.PaymentManagerCompat
Starts a new query result request by creating a new connection to the remote system using a callback for Java implementation.

R

ReceiptType - Enum in com.worldpay.websocket.api.payment
The type of receipt.
ReceiptTypeSerializer - Class in com.worldpay.websocket.api.payment
Handles the serialization and deserialization of ReceiptType to/from JSON.
ReferralContact - Class in com.worldpay.websocket.api.payment.authorisation
Referral contact details to complete voice authorisation for this payment.
ReferralContact(method, value) - Constructor for class com.worldpay.websocket.api.payment.authorisation.ReferralContact
Referral contact details to complete voice authorisation for this payment.
registerPointOfSale(request, callback, p) - Method in class com.worldpay.registration.RegistrationManager
Registers a Point Of Sale with the remote host.
registerPointOfSale(coroutineContext, request, handler) - Static method in class com.worldpay.registration.RegistrationManagerCompat
Registers a Point of Sale by creating a new connection to the remote system using a callback for Java implementation.
RegistrationManager - Class in com.worldpay.registration
Provides methods for performing registrations
RegistrationManagerCompat - Class in com.worldpay.registration
Provides Java-style wrapper methods for class RegistrationManager

S

sendActionConfirmation(action) - Method in class com.worldpay.payment.PaymentHandler
Delivers the provided response to the remote host.
sendActionConfirmation(action, p) - Method in class com.worldpay.payment.PaymentStream
A queue for sending information back to the remote system in response to events.
serialize(encoder, value) - Method in class com.worldpay.monitor.model.ServiceStatusSerializer
 
serialize(encoder, obj) - Method in class com.worldpay.websocket.api.payment.action.ActionTypeSerializer
 
serialize(encoder, obj) - Method in class com.worldpay.websocket.api.payment.action.AvsMatchResultSerializer
 
serialize(encoder, obj) - Method in class com.worldpay.websocket.api.payment.PaymentOutcomeSerializer
 
serialize(encoder, obj) - Method in class com.worldpay.websocket.api.payment.ReceiptTypeSerializer
 
serialize(encoder, obj) - Method in class com.worldpay.websocket.api.payment.TransactionTypeSerializer
 
ServerError - Exception in com.worldpay.error
Class which is received when the server reports an error along with error code extends UnhandledError
ServerError(errorCode, message) - Constructor for exception com.worldpay.error.ServerError
Class which is received when the server reports an error along with error code extends UnhandledError
ServiceStatus - Enum in com.worldpay.monitor.model
Defines the possible values for the Service status.
ServiceStatusCallback - Class in com.worldpay.monitor
Abstract class for receiving class PaymentServiceStatus events.
ServiceStatusCallback() - Constructor for class com.worldpay.monitor.ServiceStatusCallback
Abstract class for receiving class PaymentServiceStatus events.
ServiceStatusSerializer - Class in com.worldpay.monitor.model
Serializes and deserializes a enum ServiceStatus to/from a string
ServiceStatusStream - Class in com.worldpay.monitor
Class containing communication streams for service status events.
ServiceStatusStream(coroutineContext, thrown) - Constructor for class com.worldpay.monitor.ServiceStatusStream
Class containing communication streams for service status events.
setPosLicenseKey(posLicenseKey) - Method in class com.worldpay.Configuration
sets a new license key for authenticating the POS application
SettleHandler - Class in com.worldpay.payment
Interface for receiving settle events via a handler
SettleHandler() - Constructor for class com.worldpay.payment.SettleHandler
Interface for receiving settle events via a handler
settlePayment(request, callback, p) - Method in class com.worldpay.payment.PaymentManager
Settles a previous authorisation by creating a new connection to the remote system.
settlePayment(coroutineContext, request, handler) - Static method in class com.worldpay.payment.PaymentManagerCompat
settles a previous authorisation by creating a new connection to the remote system using a callback for Java implementation.
SignatureVerificationComplete - Class in com.worldpay.payment.model
Contains all the data to be sent when signature is required during a payment
SignatureVerificationComplete(merchantTransactionReference, isSignatureVerified) - Constructor for class com.worldpay.payment.model.SignatureVerificationComplete
Contains all the data to be sent when signature is required during a payment
SignatureVerificationRequired - Class in com.worldpay.websocket.api.payment.action
Contains the signature verification data that is required during a payment
SignatureVerificationRequired(action) - Constructor for class com.worldpay.websocket.api.payment.action.SignatureVerificationRequired
Contains the signature verification data that is required during a payment
SignatureVerificationRequired() - Constructor for class com.worldpay.websocket.api.payment.action.SignatureVerificationRequired
Contains the signature verification data that is required during a payment
SingleStream<T> - Class in com.worldpay.websocket
Abstract class containing communication streams for client status events.
SingleStream(coroutineContext, thrown) - Constructor for class com.worldpay.websocket.SingleStream
Abstract class containing communication streams for client status events.
startPayment(request, callback, p) - Method in class com.worldpay.payment.PaymentManager
Starts a new transaction by creating a new connection to the remote system.
startPayment(coroutineContext, request, handler) - Static method in class com.worldpay.payment.PaymentManagerCompat
Starts a new transaction by creating a new connection to the remote system using a callback for Java implementation.
StatusMonitor - Class in com.worldpay.monitor
Provides access to status information from the remote system.
StatusMonitorCompat - Class in com.worldpay.monitor
Provides access to status information from the remote system.

T

TokenisedCardPaymentRequest - Interface in com.worldpay.payment.model
Defines the parameters required for tokenised card payment requests.
TokenisedCardPaymentRequest() - Constructor for interface com.worldpay.payment.model.TokenisedCardPaymentRequest
 
TokenisedCardRefund - Class in com.worldpay.payment.model
Contains the data for performing a tokenised Card refund.
TokenisedCardRefund(tokenId, value, merchantTransactionReference, originalMerchantCode, originalTransactionReference, originalGatewayTransactionReference, paypointId) - Constructor for class com.worldpay.payment.model.TokenisedCardRefund
Contains the data for performing a tokenised Card refund.
TokenisedCardRefund(tokenId, value, merchantTransactionReference, originalMerchantCode, originalTransactionReference, originalGatewayTransactionReference) - Constructor for class com.worldpay.payment.model.TokenisedCardRefund
Contains the data for performing a tokenised Card refund.
TokenisedCardSale - Class in com.worldpay.payment.model
Contains the data for performing a tokenised Card sale.
TokenisedCardSale(tokenId, value, merchantTransactionReference, paypointId) - Constructor for class com.worldpay.payment.model.TokenisedCardSale
Contains the data for performing a tokenised Card sale.
TokenisedCardSale(tokenId, value, merchantTransactionReference) - Constructor for class com.worldpay.payment.model.TokenisedCardSale
Contains the data for performing a tokenised Card sale.
toString() - Method in class com.worldpay.AppDetails
 
toString() - Method in exception com.worldpay.error.InternalServerError
Internal placeholder for a server error message.
toString() - Method in class com.worldpay.monitor.model.PaymentDevice
Holds data about a payment device.
toString() - Method in class com.worldpay.monitor.model.PaymentDeviceStatus
Holds status information about a payment device.
toString() - Method in class com.worldpay.monitor.model.PaymentServiceStatus
The message to receive the status of the payment service.
toString() - Method in class com.worldpay.payment.model.AlipayBarcodePaymentCancel
Holds data required when cancelling an alipay barcode payment.
toString() - Method in class com.worldpay.payment.model.AvsConfirmationComplete
Contains all the data to be sent when AVS confirmation is required during a payment
toString() - Method in class com.worldpay.payment.model.Card
 
toString() - Method in class com.worldpay.payment.model.CardCheck
Contains the data for performing a Card Check without payment.
toString() - Method in class com.worldpay.payment.model.CardCheckPayment
Contains the data for performing a Card Check with Payment.
toString() - Method in class com.worldpay.payment.model.CardKeyedRefundRecovery
Contains the data for performing a Card keyed refund recovery.
toString() - Method in class com.worldpay.payment.model.CardKeyedSaleRecovery
 
toString() - Method in class com.worldpay.payment.model.CardPaymentCancel
 
toString() - Method in class com.worldpay.payment.model.CardPreAuthSale
Contains data for performing a Card Pre-Auth Sale.
toString() - Method in class com.worldpay.payment.model.CardRefund
Contains the data for performing a Card refund.
toString() - Method in class com.worldpay.payment.model.CardSale
Contains the data for performing a Card sale.
toString() - Method in class com.worldpay.payment.model.CardSettlement
 
toString() - Method in class com.worldpay.payment.model.CashbackAmountComplete
Contains all the data to be sent when Cashback amount is required during a payment
toString() - Method in class com.worldpay.payment.model.PaymentAbort
Holds the data to be sent to abort an in-flight transaction.
toString() - Method in class com.worldpay.payment.model.SignatureVerificationComplete
Contains all the data to be sent when signature is required during a payment
toString() - Method in class com.worldpay.payment.model.TokenisedCardRefund
Contains the data for performing a tokenised Card refund.
toString() - Method in class com.worldpay.payment.model.TokenisedCardSale
Contains the data for performing a tokenised Card sale.
toString() - Method in class com.worldpay.payment.model.VoiceAuthorisationComplete
 
toString() - Method in class com.worldpay.registration.model.PointOfSale
Holds the data for a Points of Sale.
toString() - Method in class com.worldpay.registration.model.PosRegistration
Holds the data needed for registering a Point Of Sale.
toString() - Method in class com.worldpay.websocket.api.payment.action.AVSConfirmationRequired
Contains the AVS confirmation data that is required during a payment
toString() - Method in class com.worldpay.websocket.api.payment.action.AVSResults
Results of the payment's AVS check to be authorised by the merchant.
toString() - Method in class com.worldpay.websocket.api.payment.action.CashbackAmountRequired
Contains the Cashback data that is required during a payment when cashback is supported
toString() - Method in class com.worldpay.websocket.api.payment.action.SignatureVerificationRequired
Contains the signature verification data that is required during a payment
toString() - Method in class com.worldpay.websocket.api.payment.action.VoiceAuthorisationRequired
Contains the voice authorisation data that is required during a payment
toString() - Method in class com.worldpay.websocket.api.payment.authorisation.PaymentAuthorisation
 
toString() - Method in class com.worldpay.websocket.api.payment.authorisation.ReferralContact
Referral contact details to complete voice authorisation for this payment.
toString() - Method in class com.worldpay.websocket.api.payment.card.CardDate
 
toString() - Method in class com.worldpay.websocket.api.payment.card.CardPaymentDebug
Used for debug purpose only.
toString() - Method in class com.worldpay.websocket.api.payment.card.PaymentCard
 
toString() - Method in class com.worldpay.websocket.api.payment.instruction.InstructionAmount
Represents data about the value of the transaction
toString() - Method in class com.worldpay.websocket.api.payment.instruction.PaymentInstruction
Holds payment status information returned from the remote host.
toString() - Method in class com.worldpay.websocket.api.payment.instrument.AlipayPaymentInstrument
Holds data about how the payment was performed.
toString() - Method in class com.worldpay.websocket.api.payment.instrument.CardPaymentInstrument
Holds data about how the payment was performed.
toString() - Method in class com.worldpay.websocket.api.payment.instrument.CashPaymentInstrument
Holds data about how the payment was performed.
toString() - Method in class com.worldpay.websocket.api.payment.instrument.PaymentInstrument
 
toString() - Method in class com.worldpay.websocket.api.payment.merchant.Address
The merchant’s address.
toString() - Method in class com.worldpay.websocket.api.payment.merchant.Merchant
Holds data about the merchant.
toString() - Method in class com.worldpay.websocket.api.payment.merchant.MerchantIdentifier
Holds an identifier for the merchant.
toString() - Method in class com.worldpay.websocket.api.payment.Payment
Holds payment result information return from the remote host
toString() - Method in class com.worldpay.websocket.api.payment.PaymentActionRequired
Holds payment actions required by remote host
toString() - Method in class com.worldpay.websocket.api.payment.PaymentNotification
The message to communicate the real-time status of an in-flight payment.
toString() - Method in class com.worldpay.websocket.api.payment.PaymentReceipt
The message to receive a payment receipt.
toString() - Method in class com.worldpay.websocket.api.payment.PaymentResult
The message to communicate the result of a completed payment.
toString() - Method in class com.worldpay.websocket.api.payment.query.PaymentReceiptQuery
Contains the data to query the receipt of the last payment.
toString() - Method in class com.worldpay.websocket.api.payment.query.PaymentResultQuery
Contains the data for getting the PaymentResult from a previous payment.
toString() - Method in class com.worldpay.websocket.api.payment.terminal.Paypoint
The paypoint the request has been performed on.
toString() - Method in class com.worldpay.websocket.api.payment.transaction.CurrencyConversion
Holds data about any on-terminal currency conversion.
toString() - Method in class com.worldpay.websocket.api.payment.transaction.Transaction
Holds the information about values used on the transaction.
toString() - Method in class com.worldpay.websocket.api.registration.PosRegistrationResponse
 
Transaction - Class in com.worldpay.websocket.api.payment.transaction
Holds the information about values used on the transaction.
Transaction(amount, currencyCode, cashbackAmount, gratuityAmount, donationAmount, dcc) - Constructor for class com.worldpay.websocket.api.payment.transaction.Transaction
Holds the information about values used on the transaction.
TransactionTypeSerializer - Class in com.worldpay.websocket.api.payment
Handles the serialization and deserialization of the TransactionType to/from JSON.

U

UnhandledError - Exception in com.worldpay.error
Class which is received when an Unhandled error is encountered
UnhandledError(errorType, reason) - Constructor for exception com.worldpay.error.UnhandledError
Class which is received when an Unhandled error is encountered

V

VoiceAuthorisationComplete - Class in com.worldpay.payment.model
Contains all the data to be sent when voice authorisation is required during a payment
VoiceAuthorisationComplete(merchantTransactionReference, authorisationCode) - Constructor for class com.worldpay.payment.model.VoiceAuthorisationComplete
Contains all the data to be sent when voice authorisation is required during a payment
VoiceAuthorisationRequired - Class in com.worldpay.websocket.api.payment.action
Contains the voice authorisation data that is required during a payment
VoiceAuthorisationRequired(action, merchant, referralContacts) - Constructor for class com.worldpay.websocket.api.payment.action.VoiceAuthorisationRequired
Contains the voice authorisation data that is required during a payment
A C D E G H I J L M O P Q R S T U V 
Skip navigation links