XX 20: Backoffice Rewards Management

23.21. XX 20: Backoffice Rewards Management#

Design status:

Accepted

Implementation status:

Removed

DD shepherd:

TBD

Historical contributors:

Sebastian, Christian Grothoff

First published:

2021-05-13

Last substantive change:

2024-02-08

Implementation evidence:

merchant (2024-02-05, 2024-02-09), taler-typescript-core (2024-02-07, 2024-03-07)

Warning

Reward and reserve management APIs were removed in 2024. The body below is retained for historical context and is non-normative.

23.21.1. Summary#

This document describe the complete list features for rewards and reserve management and how will be shown.

23.21.2. Motivation#

User will use the backoffice to manage reserve and authorize

23.21.3. Requirements#

User should use the backoffice to:

  • creating new reserves

  • listing active reserves

  • authorize rewards for a reserve

  • list all rewards for an active reserve

  • check rewards status

23.21.4. Proposed Solution#

23.21.4.1. Listing reserves#

../_images/backoffice-reserve-list.svg

Can be filtered with optional arguments:

  • after: if present will brings reserve created after specified date

  • active: if present will bring reserve active (or inactive), otherwise all

  • failures: if present will bring all reserves that have different initial balance reported by the exchange (or equal), otherwise all

columns:

  • initial: if the exchange and merchant-backend disagree in the initial balance (failure) the cell will be red and have a tooltip with more information

  • actions: delete button will be disabled on failure or committed > 0, new_reward button will be disabled on picked_up == initial or failure

23.21.4.2. Create new reserve#

../_images/backoffice-reserve-create.svg

fields:

  • initial balance must be >0 and the current currency

  • exchange should be a known exchange of the merchant backend

  • wire method should be one of the current supported of the instance

If there is an error in the creation a Notification message will be shown

23.21.4.3. Authorize Reward#

The merchant can authorize rewards clicking in the plus (+) button that will bring the next popup

../_images/backoffice-reward-create.svg

after confirm it will continue with a success page:

../_images/backoffice-reward-create.confirmation.svg

23.21.4.4. Details of reserve#

../_images/backoffice-reserve-details.svg

Rewards sorted from newer to older

When the reserve has not yet funded

../_images/backoffice-reserve-details.unfunded.svg