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

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 tipRequested: 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.

UserInput

data class UserInput(val tipPercent: Double) : TransactionUserInput

Optional user input for payment transaction processing.

Properties

displayName

val displayName: String

identifier

val identifier: String

iso18013RequestInfoIdentifier

val iso18013RequestInfoIdentifier: String

kbJwtResponseClaimName

val kbJwtResponseClaimName: String

openId4VpMdocResponseNamespace

val openId4VpMdocResponseNamespace: String

sampleData

val sampleData: CannedTransactionData<PaymentTransaction.Payload>

Sample transaction data for this transaction type

Functions

generateMdocResponseElements

open suspend override fun generateMdocResponseElements(transactionData: TransactionData<PaymentTransaction.Payload>, credential: Credential, userInput: TransactionUserInput?, docRequestId: Int?): Map<String, DataItem>

generateSdJwtResponseClaims

open suspend override fun generateSdJwtResponseClaims(transactionData: TransactionData<PaymentTransaction.Payload>, credential: Credential, userInput: TransactionUserInput?, docRequestId: Int?): Map<String, JsonElement>

getMdocResponseNamespace

fun getMdocResponseNamespace(protocol: TransactionProtocol): String

isApplicable

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

parseCbor

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

parseIso18013Request

open override fun parseIso18013Request(dataItem: DataItem): PaymentTransaction.Payload

parseJson

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

parseOpenId4VpRequest

open override fun parseOpenId4VpRequest(jsonString: String): PaymentTransaction.Payload

serializeIso18013Request

open override fun serializeIso18013Request(payload: PaymentTransaction.Payload): DataItem

serializeOpenId4VpRequest

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

verifyMdocResponse

open suspend override fun verifyMdocResponse(transactionData: TransactionData<PaymentTransaction.Payload>, responseElements: Map<String, DataItem>)

verifySdJwtResponse

open suspend override fun verifySdJwtResponse(transactionData: TransactionData<PaymentTransaction.Payload>, responseClaims: Map<String, JsonElement>)