Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
merchant:existing_merchant:selfcare_system:subscriptions [2019/05/23 16:10] robinc Added Subscriptions Editing section |
merchant:existing_merchant:selfcare_system:subscriptions [2022/03/18 11:50] (current) lezlieh update with secure token |
||
|---|---|---|---|
| Line 12: | Line 12: | ||
| The **Subscription** and **Stored Subscription** features are located under the "**Customers**" tab in the **SelfCare ** system. | The **Subscription** and **Stored Subscription** features are located under the "**Customers**" tab in the **SelfCare ** system. | ||
| - | <html><img class="imageReplace img_small" src= " | + | {{ :merchant:existing_merchant:selfcare_system:subscriptions_tab.png |}} |
| - | data/media/nuvei_create_subscriptions.png"/></html> | + | |
| \\ | \\ | ||
| Line 19: | Line 18: | ||
| * Every subscription will have a payment plan or schedule of some kind. This will determine how often payment is taken and how much is taken each time. | * Every subscription will have a payment plan or schedule of some kind. This will determine how often payment is taken and how much is taken each time. | ||
| - | * The **Subscription** feature requires the use of **Secure Cards**, so remember to register secure cards before trying to register a subscription. | + | * The **Subscription** feature requires the use of **Secure Tokens**, so remember to register secure tokens before trying to register a subscription. |
| * To register an actual subscription, a **Stored Subscription** is necessary. | * To register an actual subscription, a **Stored Subscription** is necessary. | ||
| Line 25: | Line 24: | ||
| ===== Stored Subscriptions Registration ===== | ===== Stored Subscriptions Registration ===== | ||
| - | In order to be able to set up a subscription, it is necessary to set up a **Secure Card** and a **Stored Subscription** first. | + | In order to be able to set up a subscription, it is necessary to set up a **Secure Token** and a **Stored Subscription** first. |
| <html><img class="imageReplace img_small" src= " | <html><img class="imageReplace img_small" src= " | ||
| Line 55: | Line 54: | ||
| ===== Subscriptions Registration ===== | ===== Subscriptions Registration ===== | ||
| - | 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 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. | + | {{ :merchant:existing_merchant:selfcare_system:subscriptions_tab.png |}} |
| - | Then click on the "**Create Subscription**" button. Fill in the details and make sure that you complete all the fields: | ||
| - | * 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. | + | ==== Status Meaning ==== |
| - | 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. | + | * __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__ - 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 the customer. Cannot be searched by Merchant Reference. Can be searched in adnvanced filter. | ||
| - | <html><img class="imageReplace img_small" src= " | + | In order to be able to create a new subscription, you need to select the option "Create Subscription". |
| - | data/media/nuvei_create_subscriptions.png"/></html> | + | |
| - | \\ | + | {{ :merchant:existing_merchant:selfcare_system:new_subscription.png |}} |
| - | <html><img class="imageReplace img_small" src= " | + | |
| - | data/media/nuvei_subscription_details.png"/></html> | + | |
| - | \\ | + | After that, fill in the details and make sure that you complete all the mandatory fields: |
| - | Please see below the example of a common **Error message** occurring during a new subscription creation process, due to incomplete details entered: | + | * Merchant Ref - You need to name your subscription with a unique reference. |
| - | "There are errors in your form. Please review and retry". | + | * Stored Subscription - Choose a valid secure token to charge the subscription. |
| + | * Notification Language - To be used when sending 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 unital charge of a subscription (i.e. admin fee, one off setup fee, etc). | ||
| + | |||
| + | An error message will appear if there are any incomplete details or incorrect details. | ||
| + | |||
| + | Once all the details have been entered, click on the "Create" 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. | ||
| - | \\ | ||
| - | <html><img class="imageReplace img_small" src= " | ||
| - | data/media/nuvei_subscription_error_form.png"/></html> | ||
| ===== 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 create subscription, click on the "**View**" action link in the actions column. You will be presented with the edit page of that subscription. |
| - | <html><img class="imageReplace img_small" src= " | + | A few of the fields won't be editable: |
| - | data/media/nuvei_edit_subscriptions.png"/></html> | + | |
| - | \\ | + | * In the **Customer Data** details tab you will be able to change the Secure Token, Notification Language and Recurring Amount. |
| - | 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. | + | {{ :merchant:existing_merchant:selfcare_system:view_and_edit_subscription.png |}} |
| - | You can also **amend**: | + | In the **Subscription Info** details tab, you will be able to set a Period Limit (if not previously set), set a quantity of periods to be skipped, change the subscription's period limits and its status. |
| - | * 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. | + | |
| - | <html><img class="imageReplace img_small" src= " | + | <WRAP center box info 100%> |
| - | data/media/nuvei_subscription_edit.png"/></html> | + | You can reactivate subscriptions, suspend active ones, complete them, or even cancel/delete). |
| + | </WRAP> | ||
| - | \\ | + | 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. |
| - | 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. | + | |
| - | <html><img class="imageReplace img_small" src= " | + | ===== Subscriptions Deleting ===== |
| - | data/media/nuvei_subscriptions_cancel.png"/></html> | + | |
| + | If you would like to delete a previously saved subscription, just click on the “Delete” link in the Action column (“…”). | ||
| - | \\ | + | {{ :merchant:existing_merchant:selfcare_system:view_and_edit_subscription.png |}} |
| - | Then you will return to the "Subscriptions" list: | + | ===== Subscriptions Exporting ===== |
| - | <html><img class="imageReplace img_small" src= " | + | If you would like to export the details of your subscription, click on the "Export as CSV" link on top of the search result table. |
| - | data/media/nuvei_subscriptions_susbended.png"/></html> | + | |
| - | ===== Subscriptions Deleting ===== | + | {{:merchant:existing_merchant:selfcare_system:merchant_system_subscription_period_limit.png |}} |
| - | + | ===== Subscriptions Payment History ===== | |
| - | If you would like to delete a previously saved subscription, click on the "Delete" link, next to the chosen subscription's details. | + | |
| - | A message will appear, asking you to confirm that you really want to delete this subscription. You should click OK to proceed. | + | |
| - | <html><img class="imageReplace img_small" src= " | + | If you would like to see the payment history of a specific subscription, click on the **View Payment History** link in the actions column. |
| - | data/media/nuvei_subscriptions_delete.png"/></html> | + | |
| - | **Status Meaning** | + | {{ :merchant:existing_merchant:selfcare_system:view_and_edit_subscription.png |}} |
| - | * __Active__ - Subscription is still active and customer will be charged on next Payment Date. | + | After that you will be presented with another screen where you can see payments related to subscription that are still open (Open Transactions) or settled (Closed Transactions). If you click on the actions, you will be able to void/refund them or by clicking on the Order ID, you will be able to see the transaction details. |
| - | * __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. | + | |
| - | ===== Subscriptions Editing ===== | + | {{ :merchant:existing_merchant:selfcare_system:void_or_refund_subscription.png |}} |
| - | 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. | ||
| - | A few of the fields will not be editable: | + | ===== Subscriptions With Enhanced Data ===== |
| - | * In the **Customer Data** details tab you will able to change the Secure Card, Notification Language, and Recurring Amount. | + | 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 Enhanced Data Templates) or add the data which should be used for details on payment in the subscription itself… | ||
| - | {{:merchant:existing_merchant:selfcare_system:merchant_system_subscription_action.jpg |}} | + | __During registration__ |
| - | * In the Subscription Info details tab you wil 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. | + | {{ :merchant:existing_merchant:selfcare_system:enhanced_data_-_new_subscription.png |}} |
| - | {{:merchant:existing_merchant:selfcare_system:merchant_system_subscription_period_limit.png |}} | + | __After registration, clicking on the subscription (or on "VIEW" action "..." option).__ |
| - | Once you make sure all the amended details are correct and you wish to save the new subscription with the changes, click on the **Save** button in the bottom right corner. | + | {{ :merchant:existing_merchant:selfcare_system:enhanced_data_-_edit_subscription.png |}} |