# Reefpay Web Portal Guide

## Getting Started

Welcome to the Reefpay Web Portal user guide. This user guide provides an overview of the features and capabilities of Reefpay Web Portal and walks you through the various screens to help you get familiar with all the Web Portal's functionality.

Before you can access the Web Portal, you'll need your user account set up. Contact your system administrator for more information on user accounts.

## Login

### Enter Username and Password

Use your username and password to login to the Web Portal at [Reefpay Web Portal](https://portal.paradisepayments.net).

If this link does not work, go to [portal signin] on your internet browser. The Web Portal supports both Google Chrome and Microsoft Edge. Contact your administrator if you use a different browser.

![Login screen. Enter username and password](/assets/login.0230dccb1cf096d96b4ad60028e8d16051afb1d3ad4c7f43f29c3efb09a98a37.86b977bb.png)

### Multi Factor Authentication

If you have multi factor authentication (MFA) selected, you are directed on how to request and enter a verification code before you log in.

For MFA:

1. Choose to have the verification code sent to your phone or email.
2. Select **Send Code**.
3. Enter the verification code.
4. Select **Verify**.


![Receive verification code](/assets/two-factor-send-code.7eeacee7fa4bf6fbbe6e8c082a8e8819db3df66c663f367e2a13599e8c10de65.86b977bb.png)
![Enter and send verification code](/assets/two-factor-enter-code.df0b89086877c013847db9192f7315d96676dfdd8f3d5e222543ea0cc5559b85.86b977bb.png)

After you sign in, the main UI screen appears. Continue to the next section for an overview of the top navigation bar.

## Site Navigation

Use the navigation bar at the top of the UI screen to move between different screens within the UI.

![Screens available from the Navigation bar](/assets/top-nav.7bf612def89700390a41712d71331df0d519ea1f7ac152fd4b3395ab2e386312.86b977bb.png)

The screens available from the top navigation bar include:

* **Reports**: See reports on transactions and batches and close batch reports
* **Accounts**: Create and view merchant accounts and applications
* **Users**: Add new users and define user roles
* **Terminal**: Perform credit card transactions


## Reports

The **Reports** screen includes tabs for both **Transactions** and **Batches**.

### Reports tab

The **Reports** screen will default to the **Transactions** tab. From this screen, you can view a transactions details or **Void** a transaction that has not settled as part of its batch of transactions.

![Reports, Transactions main screen](/assets/transactions-main.b752e45b5ef65b2ee92f88f735b8c43035f39f10f10316d5aa297926a115cfb3.86b977bb.png)

### Search for Transaction

Use the search bar to search for a specific transaction.

1. Use the Date Period dropdown menu to the right of the search bar to select a date range for your search.
2. Select the **filter icon** on the right side of the search bar to filter your search by specific **Transaction Types**, **Networks**, and **Response** types.


![Filters](/assets/transaction-filters.a4feee6467caee4b7f306165595d30207a3c41181ef43bcc3e18e3a65d68e381.86b977bb.png)

### Transaction Details

To see more information about a specific transaction, select its row on the table.

The **Transaction Details** screen appears and shows four sections of transaction information:

1. Transaction Details
2. Token Details
3. Billing Information
4. Shipping Information
5. System


![Transaction Details overview screen](/assets/transaction-details-overview.ae9df13e610f20ed3b965c5efe3da8182107aab0be6d8e370026c6d62ce21b05.86b977bb.png)

This overview screen opens with expanded sections. Scroll to see all information on the different sections.

The first section, **Transaction Details**, has information about the transaction request and processor response.

To review items on other sections, scroll or collapse the sections.

![Transaction Details other sections](/assets/transaction-details-other-sections.d1fdd84833f5f132b8ecfce4da99a6b2d37ecbec290beaaa4c4722256af90d13.86b977bb.png)

### Batches

To see a report of closed and open batches, select **Batches**.

![Reports, Batches main screen](/assets/batches-main.c72d86a03cd114b262b20f1e94d9a737dc22bae941335e343d55e88acd05778f.86b977bb.png)

To see more details about a specific batch, select the row.

![Reports, Batches detail](/assets/batches-detail.c7821224525b5939edcaa949e44e33a8e0d6f2f7a823c954f9fa19bdd19c61c8.86b977bb.png)

To close an open batch, elect **Close Batch**.

> **Attention**
Batch settlements are for TSYS processor only.
Fiserv Nashville and Omaha perform host batch and settle every transaction every 25 minutes.


## Accounts

On the **Accounts** section, you can review and modify client profiles and submit a client application to begin to onboard a client.

### Applications

On the Applications screen, you can create and submit a client application to onboard a client to Reefpay.

#### Review Applications

To view the status of an pending application or an application still in draft form, select the row of the client application.

The Application Details window shows which parts of the application are still incomplete.

#### New application

We'll now walk through the steps to create a new client application to onboard a client to Reefpay API.

To start a new application, first Select **New Application**.

Complete all text boxes and select **Submit**.

![Accounts New Application](/assets/new-application.9a2844b546693eba4b14d2bda2b10516ad29010337a436e07c6d72bfb278176e.86b977bb.png)

### Merchants

Select **Merchants** to view active merchants.

![Accounts](/assets/accounts-merchants.5e618ba6cfa89246852af33b9da588566277d572fa4e9a6c4663229e27c8c85b.86b977bb.png)

Select the row of the merchant to see the Merchant Details screen.

The Merchant Details screen has three sections: **Hosts**, **Contacts**, **API**.

![Merchant Details](/assets/merchant-details.8d56cad60e3b66cfd391b4272c1982a7282dbfe4c8259974310b9504ce67bb98.86b977bb.png)

## Users Screen

The **Users** screen defaults to the **Users** tab. Here you can view and search for users.

![Users screen](/assets/users-users-overview.1775e472022edab85ac2416ca2fc07b7282c377f51b793519d475182161be050.86b977bb.png)

Select a specific user to see the user details screen.

![Specific user](/assets/user-details.9f7f4ec4258aaeb7fa422a85dbfe174fedc6a615fd63c790413a57237da99171.86b977bb.png)

### Update a user profile

Select **Edit** to open the **Edit User** screen.

![Edit user screen](/assets/users-edit.62fdcc0b2c2fae82861e51ebb04584417ed94607f70de2040130a39622c43c2e.86b977bb.png)

Make any needed updates to the user profile and select **Save**.

## Terminal Screen

On the **Terminal** screen, you can send payment transactions.

![Terminal screen](/assets/terminal-main.5b6212c1d5c37489f4b0de3d1e4a56e3294ed606743ea6bd88c9129f62fb520e.86b977bb.png)

### Transaction Type

The credit or debit processor currently active on your account determines which options appear on the **Transaction Type** dropdown menu.

The six transaction types are:

* **Sale**: Request a credit card sale.
* **Authorize**: Request an authorization, which confirms a credit cardholder’s ability to pay.
* **Capture**: Request capture of an authorization after you've provided the service/good to the customer. To receive funds, add a reference to the approved authorization on a capture request.
* **Refund**: Request to return money to a credit cardholder after the associated batch payment is closed.
* **Void**: Void a transaction before settlement.


### Send a request

To request a transaction:

1. Complete all required text boxes.
2. Verify information is correct.
3. After you’ve entered all information, the **Blue Button** at the bottom right of screen becomes active.
4. Select the **Blue Button** to submit the transaction request.


![Send Transaction Request](/assets/transaction-send.88a593b74e0c353ba1c69c8231fd8e4b44ffb21041ab6733f8d75f65822887d8.86b977bb.png)

## Changelog

| Editor | Date | Description | Version |
|  --- | --- | --- | --- |
| Jason Gannon | Aug 12, 2023 | Initial Draft | 0.1 |