sdk/au.com.woolworths.village.sdk.model.digitalpay/DigitalPayRequestPaymentAgreement

DigitalPayRequestPaymentAgreement

interface DigitalPayRequestPaymentAgreement : Serializable

Functions

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String

Properties

chargeAmount

The amount that will be charged at the frequency specified in the payment agreement.

abstract val chargeAmount: BigDecimal

chargeFrequency

The payment agreement charge frequency.

abstract val chargeFrequency: PaymentAgreementChargeFrequency

endDate

The payment agreement end date and time. The timestamp format is ISO8601.

abstract val endDate: String?

immediateCharge

A flag to indicate if a charge transaction must be performed at the time of payment agreement creation.

This in convenient in the cases where a customer wants to process a first charge transaction immediately at payment agreement creation.

abstract val immediateCharge: Boolean

paymentInstrumentId

The payment agreement payment instrument id that will be used for the charges.

abstract val paymentInstrumentId: String

startDate

The payment agreement start date and time. The timestamp format is ISO8601.

abstract val startDate: String?

stepUpToken

The step-up token is used to track additional credit card information (eg. CVV and expiry) attached to the payment instrument.

It's only valid for a predefined time and if an expired step-up token is used during validation, the validation of that instrument will fail and the user will have to get a new step-up token before retrying the API call. A step-up token is returned in the response of a credit card iframe. This property is only required for credit card instruments and only if specific credit card information (eg. CVV and expiry) is required during the API call.

abstract val stepUpToken: String

type

The payment agreement type.

abstract val type: PaymentAgreementType