Getting Started Guide Lindorff invoice and instalment solution via Netaxept

Transcription

1 Getting Started Guide Lindorff invoice and instalment solution via Netaxept Version 1.2 You are able to offer Lindorff as a payment method to your webshop customers via Netaxept. Lindorff is an invoice and instalment based payment method which allows the consumer to pay their purchase with a bill at once (= invoice) or by utilizing a part payment option (= instalment). This guide gives you the instructions needed for a fluent implementation of Lindorff via Netaxept. Please forward this guide to the party responsible for the technical API implementation at your webshop, if necessary. For more information related to Lindorff, please visit and For any issues concerning the implementation of Lindorff via Netaxept, please contact your contact person at Nets or Netaxept Customer Support for your country Contents 1 LINDORFF INVOICE AND INSTALMENT SOLUTION VIA NETAXEPT INVOICE AND INSTALMENT REQUIREMENTS FOR USING LINDORFF SIGN AGREEMENT AND ACTIVATE PAYMENT METHOD APPLYING AGREEMENT RECEIVING CREDENTIALS ACTIVATING PAYMENT METHOD CUSTOMIZING THE PAYMENT METHOD PERFORM THE TECHNICAL API INTEGRATION IMPLEMENTING MANDATORY PARAMETERS Goods list Customer information Other requirements and restrictions FOLLOWING THE PAYMENT FLOW Original payments Credited payments TEST THE IMPLEMENTATION IN TEST ENVIRONMENT START ACCEPTING PAYMENTS IN PRODUCTION UPDATING THE PRODUCTION CREDENTIALS RECEIVING SETTLEMENTS AND MATCHING TRANSACTIONS Page 1/13

2 1 Lindorff invoice and instalment solution via Netaxept 1.1 Invoice and instalment Lindorff is a white label payment solution which can be highly customized to fit your webshop's look and feel and special needs. There are two options to utilize Lindorff via Netaxept. Option Invoice Description If the consumer selects an invoice as the payment option, they will receive an invoice from Lindorff after the payment phase and pay the whole sum of the purchase at once by the due date. Any interest or extra fees are not added to the purchase by Lindorff, i.e. the consumer gets a short interest free payment period for the purchase. Instalment If the consumer selects an instalment as the payment option, they will pay the sum of the purchase in parts according to the payment plan agreed with Lindorff. In part payment option there are interest and specific extra fees included in the total sum of the purchase by Lindorff. In Netaxept there is a payment method called "Lindorff" which covers both of the above mentioned payment options. The choice whether to pay the purchase at once or in many parts, the consumer will make during the payment process in the page hosted by Lindorff. Although choosing an invoice, Lindorff sends the consumer information regarding the possibility to pay in instalments along with the invoice, allowing the consumer to change the invoice to instalment and choose the payment schedule that best suits for them from the given options. 1.2 Requirements for using Lindorff There are some requirements for the merchants who want to implement Lindorff to their webshops via Netaxept. Merchants having only call center service via Netaxept cannot utilize Lindorff in their businesses. Lindorff can only be used in webshops and in physical POS environment. For the time being only webshops having a Finnish business ID can implement Lindorff via Netaxept. The supported payment currency is euro. Lindorff via Netaxept is available only to private persons, not B2B business. Also, there are requirements for the consumers to be able to pay their purchases using Lindorff. The consumer needs to have a Finnish social security number, a permanent and official address in Finland and 20 years of age. If the consumer has frozen their own credit or made their address information secret, they cannot use Lindorff as a payment method. Page 2/13

3 2 Sign agreement and activate payment method 2.1 Applying agreement Besides signing the Netaxept agreement, you need to make a separate agreement with Lindorff. Contact Lindorff Sales at FI/suomi/yrityksesta/yhteystiedot for more information. 2.2 Receiving credentials After the Lindorff agreement has been processed, the contact person named in the Lindorff agreement will be provided the necessary credentials for both test and production environments. These credentials will contain the store ID and secret key, and they are sent by Lindorff. There are no generic test credentials that all merchants could use in test environment. It means that all merchants will be provided unique credentials for testing purposes as well. 2.3 Activating payment method Activate Lindorff by adding the credentials received from Lindorff in Netaxept Admin. The merchant is responsible for activating the payment method and ensuring that all information entered is correct. Use the merchant ID and login password received from Nets to log in to Netaxept Admin. Test environment: Production environment: Go to the "Options" => "Agreement" tab and activate the payment method by selecting "Lindorff" from the drop down list and click "Add". Choose "EUR" as currency and then enter credentials received from Lindorff in the corresponding fields. 2.4 Customizing the payment method During the on boarding process Lindorff makes merchant specific customization for the payment method to make sure it meets your webshop's requirements and needs. For example, the available payment options for a given amount are configurable and can vary depending on the circumstances. When the minimum sum of the purchase is met, the option to select to pay the purchase in many parts becomes available. Make sure your webshop's payment method description offers accurate information on how the purchase can be paid in your webshop using Lindorff. Besides the payment method description, the payment method's general credit terms should be available for consumers. These are available in Lindorff site during the payment process, and also, you can offer the consumer the possibility to read these from your webshop's terms of delivery page. In that case, fetch the general credit terms at Page 3/13

4 3 Perform the technical API integration Implement the technical API in accordance with Netaxept's API instructions: There are some special requirements that need to be taken account when implementing Lindorff in Netaxept. These requirements are described next in this document. 3.1 Implementing mandatory parameters Goods list In the Register call there is a Goods object, under the Order object, which is a mandatory object for all invoice and instalment payment methods implemented in Netaxept. The Goods object contains an array of Item objects, each containing a set of parameters which are listed in the table below. One Item object represents one product line / item. For each item, quantity and amount are required. In addition, either title or article number need to be specified. Parameter name Validation Required / Optional ArticleNumber String Required if title is missing Title String Required if ArticleNumber is missing Description Unique identifier for the item. Descriptive name or description for the item. Amount Integer Required The price of the individual item including VAT. It can have maximum of two decimal places. The price needs to be described as the lowest monetary unit for the given currency. Example: 100,00 euros is noted as "10000". When accumulating the total sum of each item, it must match the sum specified for the transaction as a whole. Quantity Integer Required Quantity of items bought in the specific Item object. IsVatIncluded Boolean Optional Specifies whether the VAT is included in the item price. Value can be either "true" or "false". VAT Float Optional The value added tax percentage (VAT%) for the item. Use the "." character as a delimiter. Example: VAT 24% should be set as or 24 In the Refund call the VAT% for the item to be refunded should match the VAT% of the corresponding original item. For the time being if Netaxept Admin is used for refunding Lindorff payments, VAT% in the original payment cannot be used at all or it needs to be set as "0". Instead, if you make refunds via API, you can specify whatever VAT% you want. When working with REST interface, the format of the above mentioned parameters needs special formatting. As the number of items is variable, you need to send a parameter "numberofgoods" indicating Page 4/13

5 how many product lines / items should be expected in the Goods list. Then, indexed from 1 up to "numberofgoods", pass the parameters as amount_n, articlenumber_n etc. where "N" is the serial number of the item. In Web service interface, numberofgoods parameter is not needed Customer information Besides sending a Goods list along the Lindorff payment, you need to provide contact information of the consumer for Lindorff to be an option. The following parameters are mandatory information. Other customer information is optional but can be passed in the Register call to make filling the form in Lindorff site easier for the consumer. Parameter name customeraddress1 customerpostcode customertown customercountry Description The consumer's delivery postal address. The consumer's delivery postal code. The consumer's delivery city. The consumer's delivery country. The value must be given on the format of ISO Alpha 2. For example: "FI" for Finland Other requirements and restrictions For the time being Lindorff is supported only in Netaxept payment window but not in the merchant hosted payment window. It means that only merchants who have made their integration towards Netaxept using Service Type = "B" can utilize Lindorff in their webshops. Only regular payments are supported by Lindorff, i.e. Lindorff cannot be used in recurring and easy payment implementations. Field Order Number Description Order number can be max 32 characters and will be forwarded to Lindorff. It will not be visible to the consumer but will be included in the YourReference field in the batch reports you will receive from Lindorff. We strongly recommend you to generate a unique order number for each Lindorff transaction, since with this value, you are able to match batch reports received from Lindorff to transactions found in Netaxept and in your own systems. Transaction Recon Reference Currency Code Amount Transaction recon reference can be max 32 characters and will be forwarded to Lindorff. It will be included in the PurchaseNumber field that the consumer will see in their Lindorff invoice. Use the value "EUR". All payments need to be done in euros. You will agree the min and max purchase amounts with Lindorff during the on boarding process. Amount can have maximum of two decimal places. 3.2 Following the payment flow Original payments Payment flow of the successful payment goes as follows. Page 5/13

6 Start the payment process by sending the information required for the payment to Netaxept by means of the Register call. The structure of the Register call differs depending on whether you want the consumer to select the payment method on your webshop site or on Netaxept's payment window. Option Payment method selected in your webshop Payment method selected on Netaxept's payment window Description In this option, Netaxept payment window is skipped, and the consumer is directed directly from your webshop to Lindorff site for finishing the payment process. To get this work, send the payment method name "Lindorff" inside the "paymentmethodactionlist" element along the Register call. In this option, the consumer is directed from your webshop to Netaxept's payment window where they will see all payment methods that are available to your webshop via Netaxept. After the consumer has selected Lindorff as the payment method, they are directed to Lindorff site for finishing the payment process. If you want to define the order of the payment methods on Netaxept's payment window, send the "paymentmethodactionlist" element along the Register call and list all the payment methods in the desired order. Otherwise, the use of this element is not necessary for this option. Example of the Register call: Purchase 120 which contains two items with the following info (payment method is selected in the webshop and Netaxept payment window is skipped) pencils, cost 0,50 each, incl. VAT 24% 2. Shipping, cost 20, incl. VAT 0% ansaction&amount=12000&currencycode=eur&redirecturl= aymentmethodactionlist=[{"paymentmethod":"lindorff"}]&numberofgoods=2&amount_1=50&title_1=pencil&quan tity_1=200&articlenumber_1=1&vat_1=24&isvatincluded_1=true&amount_2=2000&title_2=shipping&quantity_2=1 &articlenumber_2=2&vat_2=0&isvatincluded_2=true&customerfirstname=bill&customerlastname=buyer&custom eraddress1=testadress&customerpostcode=00510&customertown=helsinki&customercountry=fi Page 6/13

7 After the Register call, you need to perform the Terminal call to send the consumer either to the Netaxept's payment window or directly to Lindorff site for the payment. Lindorff site is responsive for all web and mobile devices and is divided into different parts. On the top of the page the consumer can see purchase information with different items / product lines. The first part shows available payment options for a given amount. When the minimum sum of the purchase configured for your webshop is met, the option to select to pay the purchase in many parts becomes available. When choosing instalment option, the consumer sees purchase specific costs and the payment plan, and is able to read the Standard European Consumer Credit Information. Page 7/13

8 The second part shows the consumer s information. If you have passed all customer information to Netaxept along the Register call, the consumer information is already filled by default. If some information is missing, the consumer is asked to provide it for Lindorff to make a credit decision. In the example below, all other customer information was sent along the Register call except social security number so the consumer is asked to enter it in this site. Page 8/13

9 The third part shows the summary of the purchase and the consumer is able to read the payment method's general credit terms and the Standard European Consumer Credit Information. Without accepting the general credit terms, the consumer is not able to confirm the payment. After confirming the payment, the consumer needs to verify their identity using their bank credentials or other strong authentication unless otherwise agreed with Lindorff. The consumer will be redirected to the page where they are asked to choose the verification method. Page 9/13

10 After the verification, the page with text "Preparing payment method" page will be flashed on the screen and the consumer is redirected back to Lindorff site where they will be told whether the payment is accepted or not. From that page, the consumer is automatically redirected back to your webshop. However, if that doesn't happen, the consumer is advised to click the "Back to the store" button. After the consumer has seen the text "Payment accepted" in Lindorff site, Netaxept will run automatically the Confirmation call towards Lindorff to confirm that the consumer returned correctly to your webshop and that your webshop is able to handle the purchase correctly. After finishing this step successfully, Lindorff starts batch settlement and invoicing process for the purchase. This additional step doesn't require any API integration from your side. However, you should be aware of that although Lindorff shows "Payment accepted" text, it doesn't necessary mean the batch settlement and invoicing process has been started. Netaxept will perform the authorisation and capture (Sale call) automatically for Lindorff payment after it has been registered so you don't need to implement these functions. To make sure that the transaction has the correct status and the payment has succeeded, or if you are unsure which payment method the consumer has used for the payment, you can implement the Callback and Query functions as part of the payment process. Through the Callback you will receive a transaction ID whenever the transaction has a new status. Based on this, you can do the Query call to get the new status for the transaction. The instructions how to implement the Callback function are available at: After the successful payment, Lindorff will send the invoice to the consumer by . In addition, the consumer can download the invoice from Lindorff's online service at Credited payments Start the credit process by sending the Process(Credit) call to Netaxept via API. Both full and partial credits are supported when doing the credit via API. For the time being only full credits are supported when crediting Lindorff payments manually via Netaxept Admin. Also, note that if you are using TransactionReconReference when running partial credits, you are not able to make more than one partial credit by using the same TransactionReconReference for certain payment. In Page 10/13

11 practice, it means that the TransactionReconReference needs to be unique among these partial credits or the value needs to be omitted when doing more than one credit. When crediting the full amount, the Goods list object can be ignored, as can the amount. When doing partial credit, you need to send the Goods list object along the Process(Credit) call to Netaxept. The parameter values in the Goods list need to be comparable between the original payment and the credit, i.e. if there have been e.g. two items in the original Goods list with VAT24% and VAT0%, then the same items and VAT% need to be present in the Process(Credit) call too. Item prices may of course vary depending on the amount to be credited. Example of the Credit call: Amount to be credited 120 which contains two items with the following info pencils, cost 0,50 each, incl. VAT 24% 2. Shipping, cost 20, incl. VAT 0% ansactionamount=12000&transactionid=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx&numberofgoods=2&amount_1=50&titl e_1=pencil&quantity_1=200&articlenumber_1=1&vat_1=24&isvatincluded_1=true&amount_2=2000&title_2=shipp ing&quantity_2=1&articlenumber_2=2&vat_2=0&isvatincluded_2=true After the credit process, the transaction status is set as credited in Netaxept and the credit is added to batch reporting. In Netaxept Admin you can view history and detailed information of all successful and failed original and credited payments. Page 11/13

12 4 Test the implementation in test environment Testing is intended to ensure that the API implementation works as intended at your webshop. The response codes are available at codes In the test environment, you can use the test credentials available at when you are making the payment and acting as a consumer in Lindorff site. After entering the information in the Lindorff site, you will be redirected to the separate page for verifying your identity. In the test environment, choose "Lindorff bank". You are then directed to the site that is used to test strong identification. It mimics the functionality of a normal internet bank or e identification service. In this site, you can execute a successful, failed or cancelled payment. Page 12/13

13 5 Start accepting payments in production 5.1 Updating the production credentials Before going live with Lindorff, update the production credentials and production URL address in your Netaxept API implementation. Test credentials will not work in the production environment. Activate Lindorff in the production environment by adding the corresponding production credentials received from Lindorff in Netaxept Admin. The merchant is responsible for activating the payment method and ensuring that all information entered is correct. 5.2 Receiving settlements and matching transactions You will receive the settlement for Lindorff payments from Lindorff. The cut off time of the settlement for Finnish merchants is 00:00 Finnish time. After the cut off time, Lindorff will create the settlement batch for the payments captured and/or credited within the last 24 hours in your webshop and pay it to your company's bank account as one compiled settlement batch. The settlement batch will be paid to your company's bank account on the next banking day. It means that transactions made on Friday, Saturday and Sunday will be included in the same settlement batch and paid to your company's bank account on Monday if it is a banking day. Lindorff will generate a unique batch reference number for each settlement batch. The reference option that best fits to your business will be agreed between you and Lindorff during the on boarding process. The batch reference number can be seen on your company's account statement and in Lindorff's online service (a web based user interface), but not in Netaxept or in Nets Merchant Portal. To be able to match batch reports received from Lindorff to the transactions found in Netaxept and in your own systems, you need to generate a unique order number for each transaction. This value will be shown in the YourReference field in Lindorff's reports. Page 13/13