The money a booking holds against a stored card is called a deposit throughout yoyaku, and a deposit is only one of the two things it can turn into. The other is the no-show fee. One word should cover both, and the word is guarantee: an amount held in case something goes wrong, later claimed or released.

What this renames, in yoyaku's own vocabulary (kessai's payment kind is renamed separately, in kessai issue 3614434, and yoyaku's rename does not depend on it):

  • the workflow actions yoyaku_authorize_deposit, yoyaku_capture_deposit and yoyaku_release_deposit, and their labels;
  • the example workflow's node names, so "Release deposit" and "Release deposit hold" both read "Release guarantee";
  • the process variable yoyaku_deposit_outcome, and yoyaku_deposit_amount;
  • the resource fields caution_enabled, caution_amount and caution_mode, which carry a third word for the same idea;
  • the documentation, which has a deposits page and a deposit-gateway design page, and the French translation, where caution is the term used throughout.

It is a wide rename: around 400 mentions of deposit and 35 of caution_ across code, config, docs and templates, plus 31 French strings. Pre-1.0 and reinstall-only, so the field rename needs no migration, but it does need a release-note line.

The part that is not just a rename: if a guarantee covers both outcomes, its amount is the larger of the deposit and the no-show fee, not the deposit alone, and a no-show becomes a capture of that hold rather than a fresh charge against the stored card. The two are mutually exclusive in practice, since a visitor who never arrived cannot have damaged anything, so the larger of the two is the right size. That is also what the checkout already computes for a free booking that needs a card on file. Capturing a hold that was authorized near arrival is far more likely to succeed than a fresh charge after the event, which can be declined for insufficient funds or a cancelled card.

Doing that supersedes #3614433: Yoyaku reads a payment's meaning off a kessai constant instead of labelling its own payments: there is no longer a no-show charge wearing the checkout payment's kind, only a guarantee that is captured or released, so settlement can keep answering for the checkout payment alone.

Ordering note: #3614439: The confirm-failure exit abandons a payment, and the rejection path never releases the guarantee adds the missing release to the rejection path under today's names, so it should land first and this rename should carry its node along.

Issue fork yoyaku-3614440

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

Comments

mably created an issue. See original summary.

  • mably committed a2d0d4a0 on 1.x
    task: #3614440 Rename the deposit vocabulary to guarantee, and let one...
mably’s picture

Status: Active » Fixed

Now that this issue is closed, review the contribution record.

As a contributor, attribute any organization that helped you, or if you volunteered your own time.

Maintainers, credit people who helped resolve this issue.

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.