DigitalPayCreatePaymentAgreementRequest

The JSON request structure of the Create Payment Agreement endpoint.

interface DigitalPayCreatePaymentAgreementRequest : 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

billingAddress
Link copied to clipboard

Customer billing address for this payment agreement

abstract val billingAddress: DigitalPayAddress
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.

This property is only required if the 'immediateCharge' property is true.

abstract val orderNumber: String?
paymentAgreement
Link copied to clipboard

Detail of the payment agreement to be created

abstract val paymentAgreement: DigitalPayRequestPaymentAgreement