corda / net.corda.finance.flows / CashPaymentFlow

CashPaymentFlow

open class CashPaymentFlow : AbstractCashFlow<Result>

Initiates a flow that sends cash to a recipient.

Parameters

amount - the amount of a currency to pay to the recipient.

recipient - the party to pay the currency to.

issuerConstraint - if specified, the payment will be made using only cash issued by the given parties.

anonymous - whether to anonymous the recipient party. Should be true for normal usage, but may be false

notary - if not specified, the first notary of the network map is selected for testing purposes.

Types

PaymentRequest

class PaymentRequest : AbstractRequest

Constructors

<init>

CashPaymentFlow(amount: <ERROR CLASS><Currency>, recipient: <ERROR CLASS>)
CashPaymentFlow(amount: <ERROR CLASS><Currency>, recipient: <ERROR CLASS>, anonymous: Boolean)

A straightforward constructor that constructs spends using cash states of any issuer.

CashPaymentFlow(amount: <ERROR CLASS><Currency>, recipient: <ERROR CLASS>, anonymous: Boolean, notary: <ERROR CLASS>)
CashPaymentFlow(request: PaymentRequest)CashPaymentFlow(amount: <ERROR CLASS><Currency>, recipient: <ERROR CLASS>, anonymous: Boolean, progressTracker: <ERROR CLASS>, issuerConstraint: Set<<ERROR CLASS>> = emptySet(), notary: <ERROR CLASS>? = null)

Initiates a flow that sends cash to a recipient.

Properties

amount

val amount: <ERROR CLASS><Currency>

the amount of a currency to pay to the recipient.

anonymous

val anonymous: Boolean

whether to anonymous the recipient party. Should be true for normal usage, but may be false

issuerConstraint

val issuerConstraint: Set<<ERROR CLASS>>

if specified, the payment will be made using only cash issued by the given parties.

notary

val notary: <ERROR CLASS>?

if not specified, the first notary of the network map is selected for testing purposes.

recipient

val recipient: <ERROR CLASS>

the party to pay the currency to.

Inherited Properties

progressTracker

open val progressTracker: <ERROR CLASS>

Functions

call

open fun call(): Result

Inherited Functions

finaliseTx

fun finaliseTx(tx: <ERROR CLASS>, sessions: Collection<<ERROR CLASS>>, message: String): <ERROR CLASS>