DigitalPayChargePaymentAgreementRequest

The JSON request structure of the Charge Payment Agreement endpoint.

interface DigitalPayChargePaymentAgreementRequest : Serializable

Functions

equals
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
hashCode
Link copied to clipboard
open override fun hashCode(): Int
toString
Link copied to clipboard
open override fun toString(): String

Properties

amount
Link copied to clipboard

The amount that will be charged against the payment instrument linked to the payment agreement.

abstract val amount: BigDecimal
clientReference
Link copied to clipboard

A merchant application specific reference number.

This number should uniquely identify the transaction in the merchant’s system.

abstract val clientReference: String
customerRef
Link copied to clipboard

A merchant application specific reference number.

This number should uniquely identify the customer in the merchant’s system.

abstract val customerRef: String?
fraudPayload
Link copied to clipboard

Digital Pay fraud payload

abstract val fraudPayload: DigitalPayFraudPayload?
orderNumber
Link copied to clipboard

The merchant order number of the transaction.

abstract val orderNumber: String
paymentToken
Link copied to clipboard

The payment token of the payment agreement.

The payment token is a unique identifier for the payment agreement.

abstract val paymentToken: String
transactionType
Link copied to clipboard

Transaction type containers to use for all instruments.

abstract val transactionType: DigitalPayTransactionType