Skip to content
← Open Cap Table Protocol OCP Canton SDK

Reference

PaymentStreams.paymentStreamChangeProposal

Approve, apply, or reject PaymentStreamChangeProposal contracts tied to an active payment stream amendment workflow.

When terms change on an active stream, a PaymentStreamChangeProposal contract captures the amendment. These builders emit exercises on that template: approve (stakeholder consent), apply (bind the change onto a specific active stream cid), or reject.

Receiver

ocp.PaymentStreams.paymentStreamChangeProposal

buildApproveCommand

  • changeProposalContractId (required)
  • actor (required)

Returns: Command — PaymentStreamChangeProposal_Approve.

buildApplyCommand

  • changeProposalContractId (required)
  • actor (required)
  • activePaymentStreamCid (required) — Target stream to receive the amendment.

Returns: Command — PaymentStreamChangeProposal_Apply.

buildRejectCommand

  • changeProposalContractId (required)
  • actor (required)
  • description (optional) — stored as null when omitted

Returns: Command — PaymentStreamChangeProposal_Reject.

Errors

Thin wrappers; submission errors come from the participant.

See also

Source