tyro ecommerce portal guide...5 | tyro ecommerce portal guide 2. provide appropriate details for new...

Tyro eCommerce Portal Guide

Better business banking

Version 2.0.0 November, 2020

Accessing the Tyro eCommerce Portal 1Signing into your Tyro eCommerce Portal 1Reset your password 2Managing payments 2

Dashboard 3

Transactions 4Payments (Virtual Terminal) 4Authorisations 7Refunds 8

Customers 9Invoices 10 Plans 15Subscriptions 16 Coupons 17

Account Settings 19Account Settings 19User Management 22API Keys 24Webhooks 25Data Export 25

2020 © Tyro Payments Limited ACN 103 575 042. All rights reserved.

The information has been collated by Tyro Payments Limited ACN 103 575 042 for information purposes only and does not constitute advice. The inclusion of links does not imply endorsement or support by Tyro of any of the linked information, services, products, or providers. Tyro does not accept any responsibility for any errors, omissions, or reliability of such content and any use thereof is solely at the user’s risk. Please undertake your own assessment before relying on it. Specifications are subject to change without notice.

Contents

Insi

de

thi

s gu

ide

1 | Tyro eCommerce Portal Guide

This section will help you to sign into the Tyro eCommerce Portal to manage all features of the platform.

Accessing the Tyro eCommerce Portal

You can log into the Tyro eCommerce Portal by entering your email address and password that you registered with and selecting “Log in”.

If you do not have a Tyro eCommerce account, you can apply for an account by contacting our sales team through: https://www.tyro.com/get-started/.

To log into Tyro eCommerce:1. Navigate to https://ecommerce.tyro.com

2. Enter the registered Email Address and Password.3. Click Log In.

Accessing the Tyro eCommerce PortalIntroduction

Tyro eCommerce is a cloud-based, Level 1 PCI-DSS compliant payment gateway from Tyro, powered by Simplify Commerce by Mastercard.

The Tyro eCommerce Portal enables businesses to quickly and easily take payments across multiple channels and manage online payments from one simple platform that includes a variety of intuitive online payment features, and the ability to host web store checkout payments using a Hosted Payments Form, or through Shopping Cart Plugins.

Documentation about the Hosted Payments Form and Simplify APIs for developers is found here: https://ecommerce.tyro.com/commerce/docs/tools/hosted-payments

https://www.tyro.com/get-started/

https://ecommerce.tyro.com

https://ecommerce.tyro.com/commerce/docs/tools/hosted-payments


Reset your password

If you have forgotten your password you can reset it by clicking “Reset my password” which generates a “Forgot your password?” window and then you can enter the email address associated with your account. By selecting “Submit”, Tyro will send a password reset email to the entered address if it matches a registered user account.

Managing payments

You can use the Tyro eCommerce Portal to manage your online payments and integration with your online store – if you are also using the hosted payments capabilities.

The self-service portal gives you access to Tyro’s easy-to-use eCommerce features while enabling you to manage your online payments. The portal is web-based, does not require software installation, and can be accessed from a device wherever there is internet access.


The first thing you will see after logging into the Tyro eCommerce Portal is the business dashboard. The focal point to the Tyro eCommerce Portal, the dashboard provides you with a summary of your online transactions. The dashboard summary view by default shows total number of transactions and total volume of payments received for the last seven days. You can change this default time period to a custom date range using the calendar or change the default through Account Settings > Merchant Settings.

Transaction data updates in real time. You can select the “View” link next to “Net Payments” or “Total Transactions” to be taken directly to the payment data. “Net Payments” is the total of your payments received less any refunds made.

The “Recent Analytics” on the dashboard provides a snapshot of your transaction activity for a given time period.

You can change the data displayed in the chart by selecting between “Payments” and “Transactions”.

Dashboard

From the dashboard, you can select between a range of payment and business management features available in the portal: • Select Transactions to manage payments, authorisations and refunds as well as

make payments using the virtual terminal.• Select Customers to save and manage customer payment details, create recurring

payment plans and subscriptions, as well as send and manage invoices.• Select Account Settings to view and edit your account settings.• Select Developers to configure your Hosted Payments Form, access APIs and SDKs

and other developer documentation including Shopping Cart Plugins.

Tip!

Tyro eCommerce provides you with useful extra information on

entry fields marked by an ‘i’.

Select the ‘i’ for more information.


All transactions initiated from the Tyro Portal, Hosted Payments and Shopping Cart Plugins are tokenised.

This means that all card numbers entered by the cardholder are immediately replaced with a unique token for processing. All cards stored on file for recurring payments are stored in a tokenised state for both cardholder and business security.

In the portal, you will never see your customers’ full card numbers keeping sensitive card information and data safe. This also makes it easier for you to maintain PCI-DSS compliance. CVC numbers are never stored.

Payments (Virtual Terminal)

The virtual terminal allows you to accept, manage or refund a card payment from a device wherever there is internet access. The transactions are secure and tokenised.

TransactionsYou can also use the virtual terminal to save customer details along with customer cards on file when processing a payment or initiating a payment on a previously saved customer. Receipts are emailed to the customer after a transaction is made successfully using the virtual terminal.

From the navigation bar, simply select Transactions and then Payments.Your payment history is shown in reverse chronological order and you can refine the list by applying a filter.

To make a new payment, follow these steps:1. Click the New Payment button. The virtual terminal screen appears to enable

manual payment creation.


2. Provide appropriate details for new payment in the following fields. Note: Mandatory fields are marked with an asterisk (*). You can enter a new card number to charge a new customer or select an existing customer to charge their card on file.

3. If desired, you can add customer card details such as the customer’s name,email and address to record these details with the transaction.

4. Click Run Payment to execute the payment. 5. If the payment was successful, the message ‘Your payment has been created

successfully’ appears at the top of the screen. 6. For unsuccessful payment, ‘Your payment request was declined’ as appear on

the screen.

Field Name Description

AmountEnter the new payment amount.Select the currency from the drop-down menu.

Description Enter the details of the new payment.

Pay using (Credit Card/Customer Card)

To take payment, select ‘Credit Card’, enter the card number, expiry date and CVC number.If you are taking payment for a previously saved customer, click ‘Customer Card’ and select the saved customer from the customer search field. The payment will be charged to the customer’s stored card.


Customer card on file

If you wish to save a new customer with a card on file, an email address for the customer is required. The card number is immediately replaced with a unique token (tokenisation). A full address is not required to be saved for a customer. You may choose to save the customer’s address if, for example, a service is to be completed or goods are to be regularly shipped.

Transaction history

To view the detail of a certain transaction, you can simply select the transaction from the list of payments. The status of the transaction indicates if it was successful, declined or subsequently refunded.

From this screen, you can also refund a payment transaction to the customer if required.

The payment channel will indicate the initiation channel of the transaction. Availablechannels available are: eCommerce, virtual terminal and hosted payments. Eachpayment has a unique ID and reference number.


To add a new authorisation, follow these steps:1. Navigate to Transactions > Authorisation and select the “New Authorisation”

button. The virtual terminal screen appears to enable manual authorisation creation.

2. You can use this feature to authorise funds on a new customer card or on acustomer card stored on file.

3. Provide appropriate details for new Authorisation in the following fields.

3. Click “Run Authorisation” to add new authorisation.

Valid status for an authorisation are as follows: • Approved: The authorisation was approved by the card issuer. • Declined: The authorisation was declined by the card issuer.

The authorisation, if approved, may also show “Captured” or “Reversed”.

• Captured: The transaction has been completed successfully and the funds havebeen charged to the customer’s card. Captured does not mean that the money has settled yet to the business.

• Reversed: The authorisation has been cancelled and the authorised amount hasbeen released to the customer.

Authorisations

You can authorise a customer’s card in advance of completing a transaction.

A successful authorisation validates that the card has enough funds to complete the transaction and secures the funds without charging the card. You can capture the authorised amount when you are ready to complete the transaction. Tyro eCommerce expires any authorisation that are not captured after seven days.

You can capture the full amount and can also reverse the authorisation if needed, which removes the authorisation from the customer’s account.


AmountEnter the new payment amount.Select the currency from the drop-down menu.

Description Enter the details of the new payment.

Pay using (Credit Card/Customer Card)

To make a new authorisation, select ‘Credit Card’, enter the card number, expiry date and CVC number.If you are making an authorisation for a previously saved customer, click ‘Customer Card’ and select the saved customer from the customer search field. The authorisation will be made to the customer’s stored card.


Refund allows you to return funds from a previous payment back to the customer.

To issue a refund, follow below steps:1. From the portal menu, navigate to Transactions and select the transaction

in question.2. Choose the payment from the list of payments.3. Click on the payment and the transaction details and options will appear. 4. Click Refund in the upper-right hand corner.5. Provide appropriate details for the refund in the following fields.

If the refund was successful, the message “Your refund has been processed successfully” appears as a banner at the top of the screen.

You can also view all of your refund statuses and search for refunds by clicking Transactions and then Refunds.

Refunds


AmountEnter the refund amount.For partial refund, enter a partial amount (if applicable).

Reason The reason for the refund will be saved for your records.

6. Click Make Refund to execute the refund.


You can also use Tyro eCommerce to track your transaction history by customer. Once you save a customer in Tyro eCommerce, the platform tracks that customer’s transaction history for the registered card number.

To review a customer’s payment history, navigate to Customers in the navigation bar at the left of the Tyro eCommerce Portal and you will see a list of the saved customers. You can select a customer and view all their transaction, invoices page and outstanding and active subscription plans for that customer. You can also update items from this screen.

You can easily update and manage individual customers in the customer list. To edit a customer, select a customer from the list which will allow you to:1. update or delete the customer record2. update the card details on file3. create a new payment for the customer4. view all subscriptions for that customer 5. add a recurring payment plan to the customer6. send an online invoice for your customer to complete a payment

Creating a new customer

1. From the “Customer” list, select New Customer to create a new customer.2. The new customer page appears.

3. Provide appropriate details for new customer in the following fields.

Customers


Customer Name Enter the name of the customer.

Email Address Enter the email address of the customer.

Card Details Enter the card details of the customer.


You can also select a customer and view their details, card details, payments, subscription. You can also update items from this screen.

Invoices

You can create, manage and track invoices from the eCommerce Portal by selecting ‘Customers’ and then ‘Invoices.’ You can view your invoices summarised and filtered by the status of the invoice. Open invoices will show as overdue if past the pay-by date.

Valid invoices contains information such as the invoice date and due date, invoice number, items, taxes and amounts and business information.

Once an invoice is sent, you can easily view, cancel, edit or resend the invoice or mark it as paid (if payment has already been received). If the invoice is edited or cancelled, you can select ‘send notification to customer’ so the customer is notified of any changes.


6. You can also select to add your predefined taxes to invoices on each invoice item. The selected tax rules will automatically calculate the tax payable on each item and apply it to the invoice.

7. To set up and manage tax. Follow below steps: a) Click Manage Taxes in in the top right corner of the page. b) Click Add Tax to set the new tax value into the portal.

Add a new invoice

To create a new invoice, follow below steps:1. From the Portal menu, Navigate to Customers > Invoices. 2. Click New Invoice button. 3. The new invoice remains as a draft until it is saved or sent. Tyro eCommerce

automatically generates a sequential invoice number and applies it to the invoice if you do not enter one.

4. You can add your own reference number if you wish. Your business informationand branding are automatically populated on the invoice. (Note: You can manage your business settings in the ‘Account Settings’ tab)

5. Provide details for new coupon in the following fields.


Invoice numberThe invoice number is a unique identification number for each invoice. Note: Any combination of numbers and characters is acceptable.

Reference number

Enter the reference number. You can use the reference number field to match the invoice to an external system.Note: Any combination of numbers and characters is acceptable.

Supplied date Enter the date on which the invoice items were supplied.

Due date Enter the date by which the invoice is to be paid.

Late Fee Enter an additional amount that will be added to the invoice if the payment is made after the due date.

Choose existing customer or enter name

Choose an existing customer or enter a name.You can choose a customer from your saved customers or you can manually populate the invoice with customer details.

Billing address Enter the customer’s billing address.


8. The subtotal can be updated with a discount or any applied late fees. 9. Click Send to send the invoice to their customer.

You will be shown details of the invoice that was sent and the invoice will be added to the list of current invoices.


10. Customers will then receive the invoice in their email on file. 11. The customer can then “View and Pay Invoice” via a secure webpage hosted byTyro eCommerce.


12. To pay the invoice, the customer selects “Pay Invoice” in their browser. 14. After paying the invoice, the customer will be presented with a payment receipt,and sent a copy by email. If configured, the customer can also receive an additional note from you.

13. A modal window will appear on the customer’s browser, where the customercan enter their card details and complete payment. Once an invoice is sent, you can easily edit the invoice and resend, cancel the

invoice, mark the invoice as paid if payment has already been received, or add a late fee to the invoice.

If the invoice is edited or cancelled, you can select ‘Send a confirmation email to my customer’ so the customer is notified of any changes.


Plans

The subscription feature is available in the ‘Customers’ section of the Tyro eCommerce Portal. Simply select ‘Customers’ then ‘Plans’ and you can create a new plan or view, edit, and delete existing plans.

After a plan has been created, you can set a subscription for any saved customer to that plan. Subscription payments can be set up weekly, monthly or at custom intervals. With subscription payments, you can designate a plan name, amount, and trial period.

If you set more than one plan for a single customer, their plan amounts are combined and pro-rated into a single billing cycle. If you prefer to separate these billing cycles, it is recommended you create a more additional profiles for each customer, for each subscription.

To add new recurring plan, follow below steps:1. From the eCommerce Portal menu, Navigate to Customers > Plans.

The plans page will appear.2. Click New Plan. The new recurring plan screen appears.

3. Provide appropriate details for new plan in the following fields.


4. Click Add Plan to add new plan.


Plan Name Enter the name of the plan.

Plan Amount Enter the amount that the customer will be charged at each billing cycle.

Bill Every Select the billing cycle from the drop-down menu.

Free Trial PeriodSelect a free trial period from the drop-down menu. Free trial period is the period of time the customer will not be charged.

Billing Duration

Select one of the following:• Auto renew until cancelled: Customer will be billed until the

plan is cancelled. • Fixed number of billing cycle: Customer will be billed a specific number of times.

Send Recurring Payment Reminder

This will send an email reminder to the customer for the upcoming bill cycle.Note: The “Bill Every” plan period must be at least 8 days to enable this option.

4. Click Add Subscription to add a new subscription for the selected customer.5. You can also view next subscription payment and past subscription details for

specific customer.

Note: If the customer has active subscriptions and another is added, the billing cycle and amounts for the existing subscription will be merged and pro-rated with the new invoice.

Subscriptions

A subscription is an amount of money that a customer pays at regular intervals – automatically debited from their card on file.

Some examples for subscriptions would be:• Fitness club memberships• Weekly/monthly cleaning services• Weekly telehealth services• Meal delivery services

To add a new subscription to a customer, you must use an existing payment plan, or create a new one.

To add a subscription to a customer, follow below steps:1. From the Portal menu, Navigate to Customers > Customers.2. Choose a customer to apply the subscription to and select Add Subscription.3. Provide appropriate details for taxes in the following fields:

Field Value Description

Quantity Set a plan quantity for the subscription.

Existing plan Select the existing plan to subscribe the customer to.

Coupon Select a coupon you would like to apply to the subscription.


To edit a subscription, follow the steps below:1. From the Portal menu, Navigate to Customers > Subscriptions.2. Choose the customer subscription you would like to change.3. Select the pencil icon for the subscription you would like to edit.

4. Change the details of the subscription.

Coupons

The coupon feature is available in the “Customers” section of the eCommerce Portal and enables you to apply a discount to a recurring payment subscription. Simply select “Customers” and then “Coupons” and you can create new coupons and view, edit or delete existing coupons.

The coupon feature in Tyro eCommerce enables you to apply a discount to a payment subscription.

Coupons can be set up to discount a purchase by a percentage or a dollar amount.


To create a new coupon, follow below steps:1. From the Portal menu, Navigate to Customer > Coupons. 2. Click the “New Coupon” button. 3. Provide the following details.

4. Click Add Coupon to add new coupon into the portal.5. Existing coupons can be updated or edited by selecting the coupon from the left-

hand column and then choosing either ‘Update Coupon’ or ‘Delete Coupon’ from the top right.


Coupon Code Enter the coupon code. For example: “Winter10Off”

Description Enter a description for the coupon.

Number of times the coupon is applied

Enter the number of times the coupon will be applied after redemption.

Max Redemption Enter the maximum number of times the coupon can be redeemed.

Start Date Enter the start date from which the coupon can be redeemed.

End Date Enter the last date the coupon can be redeemed.

Coupon Type Select whether the coupon will be applied as an “Amount” or “Percent” discount.

Amount Off Enter the coupon discount amount.

You can apply existing coupons to your customer subscription plans by attaching a coupon (discount) to the subscription. When you add a subscription plan to a customer, you can also subscribe the customer to a coupon. In the case above, customers would receive $10 off their first purchase.


Account settings house the information that you can configure for your Tyro eCommerce account and your business. It contains four subsections: Account Settings, Merchant Settings, Receipts and Developer.

Account Settings

This section allows you to update basic information about your Tyro eCommerce account, including the name that is displayed on your account, email address that is used to log in and for all communications coming from Tyro eCommerce, and password-related information.

You are asked two security questions if in case you need to reset your password. You can choose from a list of common questions, selecting the security questions for which you choose to answer.

You can also reset your password by entering your current password and new password twice to confirm accuracy. Passwords must be between 8-20 characters and contain at least one digit and one uppercase and lowercase letter.

Under ‘Preferences,’ you can customise the date range for the analytics that display on the business dashboard. The system default is seven days.

You (or your developers) can set up and use a Tyro eCommerce sandbox environment to test initial and ongoing site development. If you use a sandbox account, the ‘Delete Sandbox Data’ section allows you to clear all data you have created in the sandbox portal for testing purposes. This feature enables developers to start fresh after accumulating potentially unwanted test data. You and your developers should keep in mind that this is a permanent deletion, data cannot be retrieved. To delete sandbox data, the developer clicks ‘Delete Sandbox Data’ and confirms the deletion request.

Account Settings


Merchant Settings

This section allows you to set up branding and other customer-facing information about your business.

This information appears in electronic invoices and customer receipts.

In the ‘Branding’ section, you can upload an image to use as you company logo and select an accent colour.

To upload an image, follow below steps:1. Click Select Logo. Browse available files to select an image file.2. Use + and – controls to resize the image.

3. Click green tick to save the image. To cancel, click X.

4. Enter a hex code for the Accent Colour or use the colour picker.

5. The accent colour selected here will appear on your invoices, buy-now buttonsand hosted payment pages.

6. Click Save Brand Setting to store the changes.


Receipts

The ‘Receipts’ section allows you to manage automated email receipts after successful payments.

You can enable two kinds of email receipts:• An email receipt sent to your email address each time a payment occurs. This is

useful for awareness of recent payments. The email is sent to the ‘Account Owner’ of the Tyro eCommerce account only.

• An email receipt sent the customer’s email address after a successful payment.If the checkboxes are not checked, no email receipt is sent to the customer after a payment. (If you are using a shopping cart plugin, this configuration will not affect any emails sent by your shopping cart platform).

Developer

If you (or your developers) use a sandbox account, you can update the sandbox currency to simulate payments in the selected currency (Note: Tyro eCommerce only accepts $AUD at this time).

The selection does not affect live payments and is only used for testing.

Select the sandbox currency, and then click ‘Save’ to save changes.

After clicking ‘Save’, developers can click on ‘Dashboard’ to see the selected currency available in the Tyro eCommerce Portal.

You can make your selections and enter the details you want for Email Subject, Email header, and Email message.

Once ready you can send a sample receipt to your own email address or save receipt settings.


User Management

The User Management section allows admin users to add, modify or delete additional users on the account.

As an admin user, it is possible to personalise access on a user level and add multiple users to perform different tasks.

Business owners can use the user management settings to set up users with the following roles:• Admin• Developer• User RW (Read/Write User)• User (Read Only User)

Access levels by role:Admin: ‘Admin’ role has complete control over the account.

Developer: The ‘Developer’ role has the same access rights as an ‘Admin’ user except for the ability to Add/Remove Users and Modify Bank Details. As the name implies, the ‘Developer’ role should be granted to any developer who is building custom solutions for the business owner with Tyro’s developer tools.

User RW: The ‘Read/Write User’ has the same access rights as the ‘Developer’ role except for the ability to Access/Modify/Revoke API Keys. The role is commonly used for employees who will be taking payments from customers (e.g.. via the virtual terminal).

User: The role with the least access is the ‘Read-Only User’, who is granted ‘read-only’ access to the account and may not initiate transactions. The role is most commonly used for customer service or accounting functions.

To add a new user, follow below steps:1. From the Portal menu, navigate to Account Settings > User Management.

2. Click New User and add the necessary information.

3. Click Add User.


The user will then be sent an email containing a link to complete the registration. Until the user registers, they will be placed into a “pending registration” state.

The link contained in the email is valid for 24 hours. You can resend a new registration email if required from the within the user details page.

To delete an existing user, select the user from the list. A user details page appears. Click Delete.

Note: To delete a user, you must be an ADMIN.


API Keys

The API keys section allows developers to access, manage and create your API keys. API keys are typically not used by non-technical users. Instead, developers utilise API keys during the implementation of custom solutions for businesses.

API keys come in pairs, a public key and a private key. They are used to authenticate businesses to use Tyro’s eCommerce APIs, Hosted Payments and supported Shopping Cart Plugins.

API keys are very important and should only be shared with trusted individuals.

Developers can create up to five unique live and sandbox keys. In most cases, only one set of API keys are needed but additional keys can be used for testing or if a Tyro eCommerce feature requires a unique API key set.

To generate a new API key set, follow below steps:1. From the Portal menu, navigate to Account Settings > API Keys.2. Enter key label to identify its use for a particular Tyro feature

(example Hosted Payments).The label of an API key pair is used purely for developers to differentiate between API keys if multiple key pairs are created. To edit the label of an API key pair, simply enter a label name in the text box before creating a new API key pair or click ‘Edit Label’ and enter a label name.

3. Select the key types either ‘Sandbox’ or ‘Live’.- Sandbox API keys works in sandbox payments.- Live API keys will only work for live payments.

4. Select the Enable Hosted Payments checkbox to enable an API key pair to workwith Tyro’s Hosted Payments feature and Shopping Cart Plugins.

5. Click Generate New Key.


2. Select the data type from the Context drop down.3. Select the format for the document from the drop down.4. Select the desired date range.5. Click Download File to begin the download.

Data Export

You can export your Tyro eCommerce data to be used with applications such as Excel. The following data can be exported into CSV format: • Payments• Invoices• Customers• Orders

The data extract lists every transaction made in the date range selected, via virtual terminal, and invoices.

You can also export your transaction data to OFX Statements, which can then be imported into popular accounting software platforms such as QuickBooks.

Tyro eCommerce supports OFX 1.0 and OFX 2.1 exports, which can be used on many versions of popular accounting software platforms.

To export data, follow below steps:1. From portal menu, navigate to Account Settings > Data Export.

Webhooks

Developers put webhook information into the ‘Webhooks’ section.

To update or delete an existing webhook, click Update or Delete to the right of each webhook list.

To add a new webhook, follow the below steps: 1. From the portal menu , navigate to Account Settings > Webhooks.2. Enter the URL. Click Save.


We hope you find Tyro’s eCommerce Portal easy to use and navigate. If you have any questions or require help, email Tyro at [email protected] or call our 24/7 Australian-based Customer Support Team on 1300 966 639.

24/7 Customer Support

Better business banking

mailto:cs%40tyro.com?subject=

tyro ecommerce portal guide...5 | tyro ecommerce portal guide 2. provide appropriate details for new...

Documents