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