Package au.com.woolworths.village.sdk.model

Types

AcceptTermsAndConditionsRequest
Link copied to clipboard
interface AcceptTermsAndConditionsRequest
Basket
Link copied to clipboard

Basket of items associated with a payment request.

interface Basket : Serializable
CardPaymentInstrument
Link copied to clipboard
interface CardPaymentInstrument : PaymentInstrument
ChallengeResponse
Link copied to clipboard

The response to a step up challenge

interface ChallengeResponse
ChargePaymentAgreementRequest
Link copied to clipboard

Data required to charge against a PaymentAgreement

interface ChargePaymentAgreementRequest
CommonPaymentAgreementRequest
Link copied to clipboard

Common properties of the PaymentAgreement request

interface CommonPaymentAgreementRequest
CreatePaymentAgreementRequest
Link copied to clipboard

Request containing the details of the PaymentAgreement to create

interface CreatePaymentAgreementRequest : CommonPaymentAgreementRequest
CreatePaymentRequestResult
Link copied to clipboard

The result from creating a new Payment Request.

interface CreatePaymentRequestResult
CreatePaymentSessionRequest
Link copied to clipboard

Request containing the details of the PaymentSession

interface CreatePaymentSessionRequest
CreatePaymentSessionResult
Link copied to clipboard

The result of creating a PaymentSession

interface CreatePaymentSessionResult
CreditCard
Link copied to clipboard

An added credit card

interface CreditCard : CardPaymentInstrument
CreditCardStepUp
Link copied to clipboard

Details of what step up is required to use a CreditCard

interface CreditCardStepUp
CustomerPaymentRequest
Link copied to clipboard

Detailed information for a single Payment Request

interface CustomerPaymentRequest : Payment
CustomerPreferences
Link copied to clipboard

Available preference settings for a customer

interface CustomerPreferences
CustomerTransactionDetails
Link copied to clipboard

Detailed information for a single transaction

interface CustomerTransactionDetails : CustomerTransactionSummary
CustomerTransactions
Link copied to clipboard
interface CustomerTransactions : Serializable
CustomerTransactionSummaries
Link copied to clipboard

List of customer transactions

interface CustomerTransactionSummaries : CustomerTransactions
CustomerTransactionSummary
Link copied to clipboard

Summary information of a transaction performed by a customer

interface CustomerTransactionSummary : TransactionSummary
CustomerUpdatePaymentSessionRequest
Link copied to clipboard

Request to update the customer messages to the merchant in the PaymentSession

interface CustomerUpdatePaymentSessionRequest
DynamicPayload
Link copied to clipboard

A payload of key/value pairs that is can be validated by a schema.

interface DynamicPayload
GiftCard
Link copied to clipboard

An added gift card.

interface GiftCard : CardPaymentInstrument
GiftCardStepUp
Link copied to clipboard

Details of what step up is required to use a GiftCard

interface GiftCardStepUp
HealthCheck
Link copied to clipboard

Result of checking the health of the API server

interface HealthCheck
IndividualPaymentInstrument
Link copied to clipboard
interface IndividualPaymentInstrument : PaymentInstrument
MerchantPayload
Link copied to clipboard

Payload provided by the merchant to support other types of messaging.

interface MerchantPayload : Serializable
MerchantPaymentDetails
Link copied to clipboard

Detailed information for a single Payment Request

interface MerchantPaymentDetails : MerchantPaymentSummary
MerchantPayments
Link copied to clipboard
interface MerchantPayments : Serializable
MerchantPaymentSummaries
Link copied to clipboard

List of payments made involving a merchant.

interface MerchantPaymentSummaries : MerchantPayments
MerchantPaymentSummary
Link copied to clipboard

Summary information for a single Payment Request

interface MerchantPaymentSummary : Payment
MerchantSchema
Link copied to clipboard

Details about a particular schema

interface MerchantSchema
MerchantSchemas
Link copied to clipboard
interface MerchantSchemas
MerchantSchemaSummaries
Link copied to clipboard

List of merchant schemas

interface MerchantSchemaSummaries : MerchantSchemas
MerchantSchemaSummary
Link copied to clipboard

Summary information about a MerchantSchema

interface MerchantSchemaSummary
MerchantTransactionDetails
Link copied to clipboard

Detailed information for a single transaction

interface MerchantTransactionDetails : MerchantTransactionSummary
MerchantTransactions
Link copied to clipboard
interface MerchantTransactions : Serializable
MerchantTransactionSummaries
Link copied to clipboard

List of merchant transactions.

interface MerchantTransactionSummaries : MerchantTransactions
MerchantTransactionSummary
Link copied to clipboard

Summary information of the resulting transaction

interface MerchantTransactionSummary : TransactionSummary
MerchantUpdatePaymentSessionRequest
Link copied to clipboard

Request to update a PaymentSession for a merchant.

interface MerchantUpdatePaymentSessionRequest
NewPaymentRequest
Link copied to clipboard

The details of the payment to be created.

interface NewPaymentRequest
NewPaymentRequestQRCode
Link copied to clipboard

Request to create a new QRCode for a Payment Request

interface NewPaymentRequestQRCode : Serializable
Payment
Link copied to clipboard

Properties common to all Payments and Payment Requests

interface Payment : Serializable
PaymentAgreement
Link copied to clipboard

Properties of a Payment Agreement

interface PaymentAgreement : Serializable
PaymentAgreementBillingAddress
Link copied to clipboard

The customer's billing address

interface PaymentAgreementBillingAddress
PaymentAgreementChargeFrequency
Link copied to clipboard

Frequency with which the payment agreement is charged

PaymentAgreements
Link copied to clipboard

List of payments agreements.

interface PaymentAgreements
PaymentAgreementStepUp
Link copied to clipboard
interface PaymentAgreementStepUp
PaymentAgreementType
Link copied to clipboard

Type of payment agreement

enum PaymentAgreementType : Enum<PaymentAgreementType>
PaymentInstrument
Link copied to clipboard

Common properties to all PaymentInstruments

interface PaymentInstrument
PaymentInstrumentAddition
Link copied to clipboard

Initiate the addition of a new payment instrument for this customer.

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

interface PaymentInstrumentAddition : Serializable
PaymentInstrumentAdditionResult
Link copied to clipboard

The result of trying to initiate the addition of a new PaymentInstrument

interface PaymentInstrumentAdditionResult : Serializable
PaymentInstruments
Link copied to clipboard

List of grouped payment instruments.

interface PaymentInstruments : Serializable
PaymentPreferences
Link copied to clipboard

Payment preferences for a customer

interface PaymentPreferences
PaymentSession
Link copied to clipboard

A session between a customer and a merchant

interface PaymentSession
PaypalDetails
Link copied to clipboard
interface PaypalDetails
PaypalStatusEnum
Link copied to clipboard
enum PaypalStatusEnum : Enum<PaypalStatusEnum>
PosPayload
Link copied to clipboard

Payload describing the specific POS system.

interface PosPayload : Serializable
Preferences
Link copied to clipboard

Map of general preferences.

typealias Preferences = kotlin.collections.Map<kotlin.String, kotlin.collections.Map<kotlin.String, kotlin.String>>
QRCode
Link copied to clipboard

Detail of a QR code

interface QRCode
QRCodePaymentReferenceType
Link copied to clipboard

Types of QRCodes that can be generated by the API.

enum QRCodePaymentReferenceType : Enum<QRCodePaymentReferenceType>
SecondaryInstrumentOrder
Link copied to clipboard
enum SecondaryInstrumentOrder : Enum<SecondaryInstrumentOrder>
SecondaryInstrumentPreferences
Link copied to clipboard
interface SecondaryInstrumentPreferences
SecondaryPaymentInstrument
Link copied to clipboard

Used to identify other PaymentInstruments to be used as part of a payment.

interface SecondaryPaymentInstrument
TermsAndConditionsAcceptance
Link copied to clipboard

The Terms and Condtions the customer has accepted.

interface TermsAndConditionsAcceptance
TermsAndConditionsAcceptances
Link copied to clipboard

List of terms and conditions acceptances

interface TermsAndConditionsAcceptances
TokenizePaypalResponse
Link copied to clipboard

The JSON response structure of the Tokenize PayPalApi endpoint.

interface TokenizePaypalResponse
TransactionRefundDetails
Link copied to clipboard

Request payload containing the refund reason and instructions

interface TransactionRefundDetails
TransactionSummary
Link copied to clipboard

Summary information of a transaction

interface TransactionSummary : Payment
TransactionType
Link copied to clipboard
enum TransactionType : Enum<TransactionType>
UpdatePaymentAgreementRequest
Link copied to clipboard

Request containing the details of the PaymentAgreement to update

interface UpdatePaymentAgreementRequest : CommonPaymentAgreementRequest
WalletContents
Link copied to clipboard

All the possible PaymentInstruments that a customer might have in a wallet.

interface WalletContents : PaymentInstruments