OpenPayPaymentRequest

The JSON request structure of the Openpay Payments endpoint

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

channel
Link copied to clipboard

The channel from which this charge is originating, eg. Online, In-Store.

abstract val channel: String
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?
merchantTransactedAt
Link copied to clipboard

The merchants transaction date and time. The timestamp format is ISO8601.

abstract val merchantTransactedAt: String?
orderNumber
Link copied to clipboard

The merchant order number of the transaction.

abstract val orderNumber: String
payments
Link copied to clipboard

List of payments

abstract val payments: List<OpenPayPayments>
storeData
Link copied to clipboard

OpenPay store data

abstract val storeData: OpenPayStoreData
tradingAccountId
Link copied to clipboard

The unique identifier for the merchants trading account.

abstract val tradingAccountId: String?
transactionType
Link copied to clipboard

The container transaction type to use for openpay instruments

abstract val transactionType: OpenPayPaymentRequestTransactionType