corda / net.corda.finance.flows / CashPaymentFlow

CashPaymentFlow

@StartableByRPC 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: Amount<Currency>, recipient: Party)
CashPaymentFlow(amount: Amount<Currency>, recipient: Party, anonymous: Boolean)

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

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

Initiates a flow that sends cash to a recipient.

Properties

amount

val amount: Amount<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<Party>

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

notary

val notary: Party?

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

recipient

val recipient: Party

the party to pay the currency to.

Inherited Properties

progressTracker

open val progressTracker: ProgressTracker

Override this to provide a ProgressTracker. If one is provided and stepped, the framework will do something helpful with the progress reports e.g record to the audit service. If this flow is invoked as a subflow of another, then the tracker will be made a child of the current step in the parent. If it's null, this flow doesn't track progress.

Functions

call

open fun call(): Result

This is where you fill out your business logic.

Inherited Functions

finaliseTx

fun finaliseTx(tx: SignedTransaction, extraParticipants: Set<Party>, message: String): SignedTransaction

Extension Functions

contextLogger

fun Any.contextLogger(): Logger

When called from a companion object, returns the logger for the enclosing class.