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:einvoice [2018/11/12 17:08]
thiago123 Updated for release of version 5.6
merchant:existing_merchant:selfcare_system:einvoice [2019/04/03 14:03]
thiago123 Release 5.8
Line 4: Line 4:
  
 \\ \\
-The **eInvoice** provides merchants with the ability to create and send links to request payments from customers. The merchant pre-configures a payment ​informing ​the basic details and the elements that should appear on the customer'​s notification,​ identifies the customer and then the merchant can send an e-mail using the %SelfCare system, or manually by its own means.+The **eInvoice** ​feature ​provides merchants with the ability to create and send links to request payments from customers. ​ 
 +The merchant ​"pre-configures" ​a payment ​providing ​the basic details and the elements that should appear on the customer'​s notification,​ identifies the customerand then the merchant can send an e-mail using the %SelfCare system, or manually ​(there'​s also the option of using our XML API for this) by its own means.
  
 <WRAP important 100%> <WRAP important 100%>
- 
 The Merchant needs to have a terminal configured to work with Hosted Payment Pages. Only terminals with this configuration enabled will allow the use of the eInvoice feature. The Merchant needs to have a terminal configured to work with Hosted Payment Pages. Only terminals with this configuration enabled will allow the use of the eInvoice feature.
- 
 </​WRAP>​ </​WRAP>​
  
-**Create eInvoice**+===== Search and Manage Invoice Payment Requests =====
  
-  * __Without a list of items__.+Each payment link generated can be found using the filter in the searchAmong those filter options, you ca use:
  
-%merchant_selfcare_paymentLinkNoItemsCreation +  * **Merchant Ref** 
-\\+  * **Customer Name** 
 +  * **Customer E-mail** 
 +  * **Status** 
 +  *- //Open// - still not paid successfuly  
 +  *- //​Complete//​ - successfuly paid (or with a pending capture) 
 +  *- //​Cancelled//​ - cancelled by the merchant before payment or expiration 
 +  *- //Expired// - passed the expiration date (automatically changes to expired) 
 +  * **Amount** 
 +  * **Creation Date** 
 +  * **Expiration Date** 
 +   
 +All of those option allow the user to choose among different comparators (ranges for quantities, values and dates, or matching types for names and identifiers).  
 +Explore the filters and create your own searches - you can safe your searches using the SAVE option, on the left side below the filters.
  
-  ​__With ​a list of items__.+Once your filters are as you need, just select the SEARCH option and the result is going to be paginates to your right below the search. 
 + 
 +%merchant-selfcare-paymentLink-search 
 + 
 +On the resulting list you see a few fields which are useful to identify the payment link. 
 + 
 +  ​**Merchant ref** 
 +  * **Customer** 
 +  * **Creation Date** 
 +  * **Expiration Date** 
 +  * **Auth Type** 
 +  * **Status** 
 +  * **Amount** ​  
 +   
 +%merchant-selfcare-paymentLink-actions 
 + 
 +If you want more details or perform ​different action over an existing payment link, at the further right column of the search result you can find the ACTIONS ​list for each payment link. Depending on the status of the payment link, different actions are possible. 
 + 
 +  * **View**: Allows the user to check details but not change them. Might be achieve by clicking on the ACTION column and choosing the VIEW option for a specific payment link or by clicking on the MERCHANT REF (table link) of the same payment link. Applicable for COMPLETE, CANCELLED and EXPIRED payment links. 
 +  * **Edit**: Allows the user to check and edit details. Might be achieve by clicking on the ACTION column and choosing the EDIT option for a specific payment link or by clicking on the MERCHANT REF (table link) of the same payment link. Applicable only for OPEN payment links. 
 +  * **Cancel**: Allows the user to cancel. In the ACTION column, choose the CANCEL option for a specific payment link. Applicable only for OPEN payment links. 
 +  * **Send**: Allows the user to send (or resend). In the ACTION column, choose the SEND option for a specific payment link. Applicable only for OPEN payment links. 
 +  * **Copy**: Allows the user to create a new payment link from an existing one. In the ACTION column, choose the COPY. Applicable for all statuses. It only open a form copying most of the data of the selected payment link, so you can more easily create a new one from it. 
 +  * **Email Preview**: Allows the user to see how the e-mail send by the platform is going to look like in the customer'​s email. In the ACTION column, choose the EMAIL PREVIEW. Applicable for all statuses. 
 + 
 +===== Create an Invoice Payment Request ===== 
 + 
 +To create a new payment link, you only need to provide a few details. 
 + 
 +%merchant-selfcare-paymentLink-creation1 
 + 
 +Depending on your needs, you might want to break down the payment in items. 
 + 
 +%merchant-selfcare-paymentLink-creation2 
 + 
 +Also, if your terminal does allow the use of enhanced data, you might need to provide a few more information. 
 + 
 +<WRAP important 100%> 
 +The enhanced data option is only going to be presented in your screen if your terminal does allow that feature. 
 +If you are not sure about this or want to know more about the benefits ​of using enhanced data in your payments, contact our support team. 
 +</​WRAP>​
  
-%merchant_selfcare_paymentLinkCreation ​ 
 \\ \\
  
-Understanding ​the fields:+About the fields:
  
-  * **Logo**: Field to inform any logo the Merchant desires to used on a pay by link e-mail. +  * **Logo**: Field to inform any logo the Merchant desires to used on a invoice payment request ​e-mail. 
-  * **Currency**:​ Currency in which the transaction will be processed (limited to the terminal'​s currencies). +  * **Currency**:​ Currency in which the transaction will be processed (limited to the terminal'​s currencies). ​It's only going to be requested if the terminal has more than one currency enabled.
-  * **Order Id**: Order id to the pay by link generated (If not informed, the gateway generates ​one automatically).+
   * **Merchant Ref**: Merchant reference used by the merchant to identify its payment links in its way.   * **Merchant Ref**: Merchant reference used by the merchant to identify its payment links in its way.
   * **Expiration Date**: Date in which the payment link ceases to be valid.   * **Expiration Date**: Date in which the payment link ceases to be valid.
Line 36: Line 85:
   * - __Email__: E-mail of the customer in which the payment link should be receive.   * - __Email__: E-mail of the customer in which the payment link should be receive.
   * **Enable Level II Data**: this option is going to appear only for terminals with enhanced data enabled (level II and level III). It's going to allow the user to define level II data for a customer. The shipping address details, if informed, will be editable at the Hosted Payment Page, so the customer can change, but the tax information is mandatory.   * **Enable Level II Data**: this option is going to appear only for terminals with enhanced data enabled (level II and level III). It's going to allow the user to define level II data for a customer. The shipping address details, if informed, will be editable at the Hosted Payment Page, so the customer can change, but the tax information is mandatory.
-  * - __Use tax for level II data__: this field indicates that the transaction is not exempt from tax and that the merchant wants todefine ​a value, even if it's "​0"​. +  * - __Use tax for level II data__: this field indicates that the transaction is not exempt from tax and that the merchant wants to define ​a value, even if it's "​0"​. 
-  * - __Add shipping address__: enables the fields to infor the shipping address to be used at level II. It's going to be editable by the customer when in the Hosted Payment Page.+  * - __Add shipping address__: enables the fields to provide details on the shipping address to be used at level II. It's going to be editable by the customer when in the Hosted Payment Page.
   * **Add Items**: this option allows the user to define if it's necessary to add a list of items to the payment link or if not.   * **Add Items**: this option allows the user to define if it's necessary to add a list of items to the payment link or if not.
   * **Items** - In this list you can ADD or REMOVE items. This option is available after the user marks "Add Items"​.   * **Items** - In this list you can ADD or REMOVE items. This option is available after the user marks "Add Items"​.
Line 52: Line 101:
 \\ \\
  
-**Send eInvoice**+===== Send an Existing Invoice Payment Request =====
  
-%merchant_selfcare_paymentLinkSend+Once created, a payment link can be sent to a customer until it's completed, cancelled or expires. 
 +The user has two options to send the link to the customer: ​
  
 +  * While creating the link (after saving is details).
 +
 +%merchant-selfcare-paymentLink-send1
 +
 +  * After the link is created, at any given time (even after editing the details or changing the customer), as long as the link is not COMPLETE, EXPIRED OR CANCELLED.
 +
 +%merchant-selfcare-paymentLink-send2
 +  ​
 Understanding the fields: Understanding the fields:
  
-  * **E-mail Preview**: Represents the body build during the eInvoice ​creation, and how it is going to look like at the customer'​s e-mail box when opened.+  * **E-mail Preview**: Represents the body build during the Invoice Payment Request ​creation, and how it is going to look like at the customer'​s e-mail box when opened.
   * **Pay Now Button**: A fragment of HTML code already configured to redirect the customer to the merchant'​s hosted payment page.   * **Pay Now Button**: A fragment of HTML code already configured to redirect the customer to the merchant'​s hosted payment page.
   * **Pay Now URL**: Also configured to redirect the customer to the merchant'​s hosted payment page, but just the URL, without the styling to look like a button.   * **Pay Now URL**: Also configured to redirect the customer to the merchant'​s hosted payment page, but just the URL, without the styling to look like a button.
  
 If the user desires, the **Pay Now Button** is a functional fragment of HTML which can be used to any e-mail body to generate a button to redirect to the final payment page for the customer. Also, the **Pay Now URL** can be used for the same situation. If the user desires, the **Pay Now Button** is a functional fragment of HTML which can be used to any e-mail body to generate a button to redirect to the final payment page for the customer. Also, the **Pay Now URL** can be used for the same situation.
- 
-In case the user does not desire or can't provide by itself the e-mail, the SEND button can be used to send the e-mail, as presented on the **E-mail Preview**. 
  
 \\ \\
  
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International