Elavon Payment Gateway- Secure Data Vault User Guide

Transcription

1 Elavon Payment Gateway- Secure Data Vault User Guide Version 1.1

2 1 About This Guide This section outlines the purpose and aim of the guide, target audience, any source materials or terminology used, and a general document description. Please note that this document is regarded as confidential and is for customer use only. It has been supplied under the conditions of your payment-processing contract. 1.1 Purpose The purpose of this Guide is to give assistance to Users using Elavon Payment Gateway Reporting. 1.2 Audience The target audience for this guide is Reporting users. 1.3 Prerequisites In order to use this guide, you should have experience with and knowledge of the following concepts: Correct use of the Elavon Auth service, as outlined in the Elavon Auth Developer's Guide 1.4 Related Documents In addition to this guide, you can also refer to the following documents in the Elavon Payment Gateway documentation set for information about the Elavon Auth service: Elavon Auth Response Code Reporting User Guide 1.5 Terminology The terminology specific to the Reporting application is as follows: Expression Acquiring bank Transaction Authorisation Definition Your bank, with which you have a merchant services contract. A transaction is a request sent to Elavon Payment Gateway. Transactions can be used to authorise or refund an amount on a credit or debit card. It can also be used to void or settle an amount on a card. The process of submitting the request to your bank in real time to authorise the payment i.e. mark the funds on the card holders account.

3 Expression Batches Settlement Settled Pending Definition The process of collecting all valid authorisations for your account and submitting these to the bank for settlement, to be funded to your bank. When the acquiring bank (your bank) pay/move the funds to your bank account. Once the transactions have been sent to the bank for settlement they are known as "settled" transactions. All transactions that have not yet been settled. These may be transactions that are: waiting to be settled by Elavon Payment Gateway automatically (occurs at 12 every night) need to be manually settled by you (delayed settlement) voided(cancelled) or have failed and will not be settled Delayed Void A delayed transaction is a transaction that will not be settled automatically by Elavon Payment Gateway. This transaction must be manually settled within 28 days on the Elavon Payment Gateway systems. Please note that you may incur exception charges from your bank depending on how long you take to settle the transaction. Check with your acquiring bank for these terms and conditions when using delayed settlement. If a transaction is still pending i.e. not yet settled then it is possible to void it. A void means that the transaction will be cancelled and therefore not settled. A transaction can only be voided when it is pending. Note: that the funds are still marked on the card-holders account but will not be debited. Rebate A rebate depends on the original authorisation that was processed, and so you do not need the card number to refund the money onto the card. You can rebate up to 115% of the original amount. Note: This limitation does not apply to Irish Laser debit cards. You can rebate a transaction for up to 180 days from when the original transaction took place. Refund Similar to a rebate, the refund is a transaction that refunds monies to the cardholder and will debit your account. A refund is not

4 Expression Definition dependent on an original transaction and so you will need the card number to process the refund. Terminal Account Declined Referral A Referral B A facility for processing a transaction online. A section of Reporting in which you can process a credit card payment. You can have multiple sub accounts set up on your main account. By default you will be set up with a sub-account called "moto". You can set up further sub-accounts, for example "call centre". This is a response that you can receive when a transaction is sent for authorisation. When an authorisation is declined, this means that the issuing bank of the card holder have decided not to allow the transaction to go ahead. Payment will not be taken from the card. This is a response that you can receive when a transaction is sent for authorisation. When an authorisation receives a Referral A the card has been marked as lost, stolen or cancelled. Payment will not be taken. This is a response that you can receive when a transaction is sent for authorisation. When an authorisation receives a Referral B, the issuing bank of the card holder will not allow the transaction to go through automatically and is requesting that you call their authorisation centre to process the payment. 1.6 Conventions Elavon Payment Gateway documentation uses the following conventions:

5 Note: Tips or advice for the user. Caution: Important note. Potential financial impact. Convention Description Example Orange Italic or Plain Type Hyperlinks and crossreferences For more information see Table 1. Italics Names of other guides Elavon Auth Developer s Guide Courier New Courier New BOLD CAPS Program code, screen messages,directory files, and file names Placeholder for element names,field values, or user input Error and warning messages <comments></comments> card_holder_name 101 / REFERRAL B

6 2 Reporting Login and Homepage This chapter describes the following: Login Homepage 2.1 Login Navigate to the URL The Login screen is displayed. To Login: 1. In the Client id field, enter your client id as supplied by Elavon Payment Gateway. 2. In the Username field, enter your username. 3. In the Password field, enter your password. 4. Click login.

7 2.2 Navigation Menu The main menu of the Reporting homepage is located in the top panel of the screen as below. Navigation menus. Explanation of main menu options: Field Name Home Transactions Explanation This brings you to the Reporting homepage. In this section you can view the transactions that have been authorised but not yet sent for settlement. You can also view and download the transactions that have been sent to your acquiring bank for settlement. The transactions are bundled into batches which are typically created Monday through Friday. For more information on your specific bank batch times contact Elavon Payment Gateway support. Terminal You can use the Terminal to process Sales, Refunds and Manual transaction types. Note: The Manual transaction type will not be setup as default on your account. Reports In the reports section you can view reports that have been generated throughout the Reporting application.

8 Field Name Explanation A history of the previous twenty five reports ran will be viewable in this section. It also gives you the option of downloading your reports to Excel. Settings Search on Log out In this section you can change your login password and view your general information. This section allows you to search for individual transactions based on specific search criteria. Allows you to end your session and securely log out of Reporting.

9 3 Reporting Customers From the main menu of Reporting, click on the Customer tab to access Reporting Secure DataVault. Elavon Payment Gateway provides a card storage system called Secure DataVault which can be used to securely store card details on the Level 1 PCI Compliant Elavon Payment Gateway system. Once the card numbers have been added to Secure DataVault, you can no longer view any of the sensitive card details themselves however, using tokens, you can raise payments against these stored card details at a later date. Click Customers.

10 By clicking on Customers, the following screen will appear. From this screen you will be able to: 1. Search currently stored Customers. 2. Add new Customers. 2. To add a new payer click Add Customer. 1.To search for existing Customers, enter known details then click Search. 3.1 Customer Setup Click on New Customers in the menu. The New Customer model screen is displayed.

11 Format and Length of fields: Note: Please be aware that "" means a space. The mandatory fields are marked with a star; these are required in order for the transaction to process. Field Explanation Format Length Customer Ref * Type * The Customer Reference is used to identify this Customer uniquely so that it can be referenced in future transactions. You may already have a customer numbering convention and if so it would be a good idea to use your customer number as the Customer Ref. If you don't, then you can try something like: surname initial number. (Only letters, digits, dots, spaces, dashes and underscores are allowed.) The Customer Reference needs to be recognizable for future transactions The type of customer/customer and is a mandatory field. You may have different categories of Customer, e.g. Personal, Business, etc. a-z A-Z 0-9 _ a-z A-Z 0-9 _ Name * The Customer Name. a-z A-Z 0-9 _ The address of the Customer. [A-Z a-z 0-9. _ % -] [A-Z a-z ]+\\.[a-z A-Z] 5-50 Mobile Enter the mobile phone number of the Customer. [0-9] 0-50 Home Phone Enter the Home Phone number of the Customer. [0-9] 0-50 Work Phone Enter the Work Phone number of the Customer. [0-9] 0-50 Fax Enter the fax number of the Customer. [0-9] 0-50 Company Enter the company name of the Customer. a-z A-Z 0-9 _ 0-50 Address Enter the address of the Customer. a-z A-Z 0-9 _ City Enter the city the Customer is in a-z A-Z 0-9 _ 0-50 County Enter the county the Customer is in a-z A-Z 0-9 _ 0-50 Country Select the billing country from the drop down. Predefined Predefin ed

12 After the details are submitted the Customer Profile screen is displayed:

13 3.2 Adding Credit/Debit Cards To add a credit or debit card to the Customer's profile: 1) Click on the Add Payment Method at the bottom of the Customer Profile screen. The following model will appear: 2) Give the card a reference so that you can uniquely identify it later. You are only allowed to enter card details for card types (Visa, MasterCard, etc.) covered by your Merchant Service Agreement with your acquiring bank. 3) Enter the card details on this screen and click Save.

14 After adding Card Details, the Customer Profile screen should now look like this: 3.3 Customer Actions Depending on your User permissions, you may have some or all of the following Actions available to you at the bottom of the Customer Profile screen: Explanation of Field Titles on the Customer screen. Title Edit Delete New Schedule Take Payment History Description Click on Edit to update the Customer details. If you wish to delete a Customer payment method, click on Delete. This will permanently delete the Customers details. This will give you the option of setting up a Scheduled Payment. This is used to create a schedule of regular payments from a stored card from a customer. By clicking on Take Payment, you will be able to process a payment using the Customers stored Credit Card details. You may view the Customer s previous transactions by clicking on History.

15 4 Taking a Payment In this section we will discuss how to take a payment from a Customer. To do this, you will need to search for the Customers Profile. This can be done by entering in the Customers details into the search menu. Enter Customers Details. Then click Search. This will bring up the Customers profile. To take a Payment, click Take Payment Click Take Payment.

16 After clicking Take Payment, the following model will appear: Customer Ref is the unique identifier which was set when set when creating the Customer. 1. Enter a Payment Ref. 2. Select account. 3. Enter Amount. Payment Method Ref is the unique identifier which was set when set when adding the Customers card details. If you wish to process a delayed transaction deselect Automatically settle to the Bank. More information on Delayed Transactions can be found in the Reporting User Guide. For the fields in the Take a Payment interface, the length and format is as below: Note: Please be aware that "" means a space. The mandatory fields are marked with a star(*); these are required in order for the transaction to process. Field Explanation Format Length Payment Ref * Amount * Comment 1 This field can be used to identify a customer's payment. The amount must never contain decimal places; it is in cent value i.e. to process 10.00, type 1000 for ALL currencies. Free text field; can be used to store information that will be relevant for your own reconciliation purposes. a-z A-Z 0-9 _ a-z A-Z 0-9 ' ", +. _ - & \ % ( ) * : $ & # [ ] = 0-255

17 Field Explanation Format Length Customer Number Product ID Variable Ref Free text field; can be used to store information that will be relevant for your own reconciliation/reporting purposes. Free text field; can be used to store information that will be relevant for your own reconciliation/reporting purposes. Free text field; can be used to store information that will be relevant for your own reconciliation/reporting purposes. a-z A-Z 0-9 _., 0-50 a-z A-Z 0-9 _., 0-50 a-z A-Z 0-9 _., 0-50

18 4.1 Viewing Payment Details After the Payment has been processed, full details on the transaction can be viewed by clicking View Payment Click View Payment. This it will show a full breakdown of the transaction. If you wish to void or rebate a transaction, details can be found in the Reporting User Guide.

19 Elavon Financial Services Limited is registered in Ireland Number Registered Office: Block E, 1st Floor, Cherrywood Business Park, Loughlinstown, Co. Dublin, Ireland. Elavon Financial Services Limited is regulated by the Central Bank of Ireland. United Kingdom branch registered in England and Wales under the number BR Elavon Merchant Services is a trading name of Elavon Financial Services Limited. Directors: Kurt Adams (USA), John Collins, Craig Gifford (USA), Bryan Calder (USA), Pamela Joseph (USA), Declan Lynch, John McNally, Malcolm Towlson