multipaz-doctypes/org.multipaz.documenttype.knowntypes/PaymentTransaction

PaymentTransaction

object PaymentTransaction : TransactionType<PaymentTransaction.Payload>

Payment transaction as defined by Specification of Strong Customer Authentication (SCA) Implementation with the Wallet

Types

CborData

data class CborData(val transactionDataHashesAlg: List<Long>?, val payload: PaymentTransaction.Payload)

Represents the wrapper envelope for a CBOR-serialized payment transaction.

Frequency

enum Frequency : Enum<PaymentTransaction.Frequency>

Standard banking frequency codes used to define how often a recurring payment occurs.

JsonData

@Serializable

data class JsonData(val type: String, val credentialIds: List<String>, val transactionDataHashesAlg: List<String>?, val payload: PaymentTransaction.Payload)

Represents the wrapper envelope for a JSON-serialized payment transaction.

MitOptions

@Serializable

data class MitOptions(val amountVariable: Boolean?, val minAmount: Double?, val maxAmount: Double?, val totalAmount: Double?, val initialAmount: Double?, val initialAmountNumber: Long?, val apr: Double?)

Merchant-Initiated Transaction (MIT) configurations for variable or conditional recurring payments.

Payee

@Serializable

data class Payee(val name: String, val id: String, val logo: String? = null, val website: String? = null)

Represents the merchant or individual receiving the payment.

Payload

@Serializable

data class Payload(val transactionId: String, val currency: String, val amount: Double, val payee: PaymentTransaction.Payee, val dateTime: Instant? = null, val pisp: PaymentTransaction.Pisp? = null, val executionDate: LocalDate? = null, val amountEstimated: Boolean? = null, val amountEarmarked: Boolean? = null, val sctInst: Boolean? = null, val recurrence: PaymentTransaction.Recurrence? = null, val mitOptions: PaymentTransaction.MitOptions? = null)

The core detail schema of a payment transaction.

Pisp

@Serializable

data class Pisp(val legalName: String, val brandName: String, val domainName: String)

Details of the Payment Initiation Service Provider (PISP) executing the payment request.

Recurrence

@Serializable

data class Recurrence(val frequency: PaymentTransaction.Frequency, val startDate: LocalDate? = null, val endDate: LocalDate? = null, val number: Long? = null)

Configures the timeline and interval parameters of a recurring payment sequence.

Properties

displayName

val displayName: String

identifier

val identifier: String

kbJwtResponseClaimName

val kbJwtResponseClaimName: String

mdocRequestInfoKeyName

val mdocRequestInfoKeyName: String

mdocResponseNamespace

val mdocResponseNamespace: String

sampleData

val sampleData: CannedTransactionData<PaymentTransaction.Payload>

Sample transaction data for this transaction type

Functions

applyCbor

open suspend override fun applyCbor(transactionData: TransactionData<PaymentTransaction.Payload>, credential: Credential): Map<String, DataItem>

applyJson

open suspend fun applyJson(transactionData: TransactionData<PaymentTransaction.Payload>, credential: Credential): JsonElement?

isApplicable

open suspend override fun isApplicable(transactionData: TransactionData<PaymentTransaction.Payload>, credential: Credential): Boolean

parseCbor

open override fun parseCbor(serialized: ByteString): TransactionData<PaymentTransaction.Payload>

parseJson

open override fun parseJson(serialized: ByteString): TransactionData<PaymentTransaction.Payload>

serializeCbor

open override fun serializeCbor(payload: PaymentTransaction.Payload, hashAlgorithms: List<Algorithm>?): ByteString

serializeJson

open override fun serializeJson(payload: PaymentTransaction.Payload, credentialIds: List<String>, hashAlgorithms: List<Algorithm>?): String