Skip to main content
Create a prepaid recurring payment agreement with an app party. The client locks funds upfront for a fixed period, enabling subsequent pay-outs without additional on-chain approvals. Invoked through the two-phase transaction flow with:
  • operation = TRANSACTION_OPERATION_REQUEST_RECURRING_PREPAID
  • params.request_recurring_prepaid = RequestRecurringPrepaidParams { … }

Params

string
required
Party ID of the app receiving the recurring payments.
string
required
Payment amount per cycle.
string
required
Amount of Canton Coin locked upfront as prepayment.
uint32
required
How many days the prepayment remains locked.
string
required
Maximum total amount the app can draw over the lifetime of the agreement.
string (optional)
Human-readable description.
string (optional)
Client-supplied reference.

See also

  • RequestRecurringPayasyougo β€” alternative flow with no upfront lock.
  • GetAmulets β€” pick amulets that satisfy locked_amount.
  • GetAgentConfig β€” read subscription_app_party and recurring_payment_package_name for the provider’s recurring-payment setup.