020-backoffice-rewards-management.rst (2689B)
1 XX 20: Backoffice Rewards Management 2 #################################### 3 4 :Design status: Accepted 5 :Implementation status: Removed 6 :DD shepherd: TBD 7 :Historical contributors: Sebastian, Christian Grothoff 8 :First published: 2021-05-13 9 :Last substantive change: 2024-02-08 10 :Implementation evidence: merchant (2024-02-05, 2024-02-09), taler-typescript-core (2024-02-07, 2024-03-07) 11 12 .. warning:: 13 14 Reward and reserve management APIs were removed in 2024. The body below is 15 retained for historical context and is non-normative. 16 17 Summary 18 ======= 19 20 This document describe the complete list features for rewards and reserve 21 management and how will be shown. 22 23 Motivation 24 ========== 25 26 User will use the backoffice to manage reserve and authorize 27 28 Requirements 29 ============ 30 31 User should use the backoffice to: 32 33 * creating new reserves 34 * listing active reserves 35 * authorize rewards for a reserve 36 * list all rewards for an active reserve 37 * check rewards status 38 39 Proposed Solution 40 ================= 41 42 Listing reserves 43 ---------------- 44 45 .. image:: ../images/backoffice-reserve-list.svg 46 :width: 400 47 48 49 Can be filtered with optional arguments: 50 51 * after: if present will brings reserve created after specified date 52 53 * active: if present will bring reserve active (or inactive), otherwise all 54 55 * failures: if present will bring all reserves that have different initial 56 balance reported by the exchange (or equal), otherwise all 57 58 columns: 59 60 * initial: if the exchange and merchant-backend disagree in the initial balance 61 (failure) the cell will be red and have a tooltip with more information 62 63 * actions: delete button will be disabled on failure or committed > 0, new_reward 64 button will be disabled on picked_up == initial or failure 65 66 67 Create new reserve 68 ------------------ 69 70 .. image:: ../images/backoffice-reserve-create.svg 71 :width: 400 72 73 fields: 74 75 * initial balance must be >0 and the current currency 76 77 * exchange should be a known exchange of the merchant backend 78 79 * wire method should be one of the current supported of the instance 80 81 If there is an error in the creation a Notification message will be shown 82 83 Authorize Reward 84 ---------------- 85 86 The merchant can authorize rewards clicking in the plus (+) button that will bring 87 the next popup 88 89 .. image:: ../images/backoffice-reward-create.svg 90 :width: 400 91 92 after confirm it will continue with a success page: 93 94 .. image:: ../images/backoffice-reward-create.confirmation.svg 95 :width: 400 96 97 Details of reserve 98 ------------------ 99 100 .. image:: ../images/backoffice-reserve-details.svg 101 :width: 400 102 103 Rewards sorted from newer to older 104 105 When the reserve has not yet funded 106 107 .. image:: ../images/backoffice-reserve-details.unfunded.svg 108 :width: 400