Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
merchant:existing_merchant:selfcare_system:subscriptions [2018/07/20 12:30]
127.0.0.1 external edit
merchant:existing_merchant:selfcare_system:subscriptions [2019/07/18 08:24] (current)
Line 54: Line 54:
 If you would like to set up a a new subscription,​ go to "​**Subscriptions**"​ in the drop down menu. If you would like to set up a a new subscription,​ go to "​**Subscriptions**"​ in the drop down menu.
  
-All the previously registered subscriptions are listed in this section, and you can view their details. ​You can also search for subscriptions ​by "Merchant reference" ​or by other criteria in the **Advanced filter**.+All the previously registered subscriptions are listed in this section, and you can view their details. ​ 
 +Depending on the subscription'​s status, you can find it by clicking on the specific status tab or to see all, click "All".
  
-In order to be able to create a new subscription,​ you need to save a subscription template in the **Stored Subscriptions** section first.+%subscription_creation 
 +\\
  
-Then click on the "**Create Subscription**" button. Fill in the details and make sure that you complete all the fields: +**Status Meaning**
-  * Merchant Ref  (you need to name your subscription with a unique reference) +
-  * Choose the Stored Subscription +
-  * Choose the Secure Card +
-  * Choose the Notification Language for receipts +
-  * Start date and End date of the subscription +
-  * Recurring amount (this amount can never be of "​0"​ value) +
-  * Set up price (i.e. admin fee, one off set up fee, etc. The amount can be 0, if required).+
  
-An error message ​will appear if there are any incomplete details, as can be seen on the images below.+  * __Active__ - Subscription is still active and customer ​will be charged ​on next Payment Date. 
 +  * __Suspended__ - Subscription is suspended for the moment and no charges will be taken from the customer. 
 +  * __Completed__ - The subscription has been completed or the merchant has put it to completed early. The customer will not be charged and this subscription can still be searched by Merchant Reference. 
 +  * __Deleted__ - Subscription is deleted, no charges to the customer. Can not be found by merchant Reference anymore. Can be searched in advanced filter. 
 +  * __Cancelled__ - Subscription has been cancelled, no further charges to customer. Can not be searched by Merchant Reference. Can be searched in advanced filter.
  
-Once all the details have been entered, click on the "​Create"​ button in the bottom right corner to save the subscription details, for future use. You can view the details of your new subscription in the list of all subscriptions under "​**Subscriptions**"​ menu, under "​**Customers**"​ tab. 
  
-%subscription_creation+In order to be able to create a new subscription,​ you need select the option "​Create Subscription"​. ​
  
-\\ 
 %subscription2_creation %subscription2_creation
- 
 \\ \\
-Please see below the example of a common **Error message** occurring during a new subscription creation process, due to incomplete details entered: 
-"There are errors in your form. Please review and retry"​. 
  
-\\ +After that, fill in the details and make sure that you complete all the mandatory fields: 
-%subscription3_creation+ 
 +  * Merchant Ref - You need to name your subscription with a unique reference 
 +  * Stored Subscription - Choose the Stored Subscription which defines the subscription'​s behavior 
 +  * Secure Card - Choose a valid secure card to charge the subscription 
 +  * Notification Language - To be used when send the receipt notifications for the customer 
 +  * Start Date and End Date - Limits to process the subscription 
 +  * Recurring Amount - This amount can never be of "​0"​ when editable 
 +  * Setup Price - The amount can be 0, if required. Defines the initial charge of a subscription (i.e. admin fee, one off set up fee, etc).  
 + 
 +An error message will appear if there are any incomplete details or incorrect data. 
 + 
 +Once all the details have been entered, click on the "​Create Subscription"​ button in the bottom right corner to save the subscription details.  
 +You can view the details of your new subscription in the list of all subscriptions click on the actions column and then "​View"​ action. 
 + 
 + 
  
 ===== Subscriptions Editing ===== ===== Subscriptions Editing =====
    
-If you would like to edit a previously created subscription,​ click on the "**Edit**" link next to the subscription ​details.+If you would like to edit a previously created subscription,​ click on the "**View**" ​action ​link in the actions column. 
 +You will be presented with the edit page of that subscription.
  
-%subscription_edit_image+A few of the fields won't be editable:
  
 +  * In the **Customer Data** details tab you will be able to change the Secure Card, Notification Language and Recurring Amount.
 +
 +%subscription_edit_image
 \\ \\
-Please note that **__it'​s not possible__** to amend the **Merchant Ref** and **Stored Subscription**. 
  
-You can choose a **different Secure Card** from the list of registered secure cards.+  ​In the **Subscription Info** details tab you will be able to set a Period Limit (if not set before), Set a quantity ​of periods to be skipped, change the subscription'​s period limits and its status.  
 + 
 +<WRAP info 100%> 
 +You can reactivate suspended subscriptions,​ suspend active ones, complete them or even cancel/ delete). 
 +</​WRAP>​
  
-You can also **amend**: 
-  * The Notification Language for receipts. 
-  * Period type: weekly, bi-weekly, monthly, quarterly or annually. 
-  * Period count: ​ limited or unlimited, as well as the number of recurring transactions. 
-  * "Skip Period Count"​. 
-  * End date. 
-  * Status: ​ active, suspended, completed, cancelled. 
-  * Recurring amount. 
-  * Setup price. 
  
 %subscription2_edit_image %subscription2_edit_image
- 
 \\ \\
-Once you make sure that all the amended details are correct, and that you wish to save the new subscription with the changes, click on the  "​**Update**"​ button in the bottom right corner.\\ 
-Alternatively,​ if you do not wish to proceed with the changes, click on the "​**Cancel**"​ button. 
  
-%subscription3_edit_image 
  
 \\ \\
-Then you will return ​to the "Subscriptions" ​list: +Once you make sure that all the amended details are correct, and that you wish to save the new subscription with the changes, click on the  ​"**Save**" ​button in the bottom right corner. ​
- +
-%subscription4_edit_image+
  
 ===== Subscriptions Deleting ===== ===== Subscriptions Deleting =====
    
-If you would like to delete a previously saved subscription,​ click on the "​Delete"​ link, next to the chosen subscription'​s details+If you would like to delete a previously saved subscription, ​just click on the "​Delete"​ link in the actions column ("​**...**"​)
-A message will appear, asking ​you to confirm that you really want to delete this subscription. You should ​click OK to proceed+ 
 +%subscription_edit_image 
 + 
 +===== Subscriptions Exporting ===== 
 +  
 +If you would like to export the details of your subscriptions,​ just click on the "​Export Subscription"​ link on the top of the search result table.
  
 %subscription5_edit_image %subscription5_edit_image
  
-**Status Meaning**+===== Subscriptions Payment History ===== 
 + 
 +If you would like to see the payment history of a specific subscription,​ just click on the "View Payment History"​ link in the actions column ("**...**"). 
 + 
 +%subscription_edit_image 
 + 
 +After that you will be presented with another screen where you can see payments related to that subscriptions that are still open (Open Transactions) or settled (Closed Transactions) and if you click on the actions, you will be able to void/ refund them or clicking on the Order Id, you will be able to see the transaction details. 
 + 
 +%subscription3_edit_image 
 + 
 +===== Subscriptions With Enhanced Data ===== 
 + 
 +Enhanced Data is a new feature which allows you to provide details on a payment to achieve lower fees for your transactions. 
 +To add enhanced data to your subscription payments, you use enhanced data templates (check [[merchant:​existing_merchant:​selfcare_system:​settings:​enhanced_data_templates|Enhanced Data Templates]]) or add the data which should be used for details on payment in the subscription itself... 
 + 
 +__During registration__ 
 + 
 +%subscription7_new_enhancedData 
 + 
 +__After registration,​ clicking on the subscription (or on "​VIEW"​ action "​..."​ option).__ 
 + 
 +%subscription7_edit_enhancedData
  
-  * __Active__ - Subscription is still active and customer will be charged on next Payment Date. 
-  * __Suspended__ - Subscription is suspended for the moment and no charges will be taken from the customer. 
-  * __Completed__ - The subscription has been completed or the merchant has put it to completed early. The customer will not be charged and this subscription can still be searched by Merchant Reference. 
-  * __Deleted__ - Subscription is deleted, no charges to the customer. Can not be found by merchant Reference anymore. Can be searched in advanced filter. 
-  * __Cancelled__ - Subscription has been cancelled, no further charges to customer. Can not be searched by Merchant Reference. Can be searched in advanced filter. 
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International