Payment Manager User Guide

Payment Manager User Guide

INTRODUCTION


Foreword

Due to the administrative interface, the client can control all transactions that are transmitted by its representatives or clients to the PayFacto server. With this tool the client can assigns users, who may then generate reports, helping them to take on the following responsibilities :

  • Identifying all transactions transmitted to the payment server;
  • Generating exception reports to identify future improvements to internal or external processes;
  • As needed, performing demographic analyses of the client base by using their products and services;
  • Identifying the best methods to launch new products on the market;
  • Monitoring possible hardware and software-related problems in order to correct more quickly, thereby ensuring prevention.

With this tool, a customer administrator is able to create a security structure to determine which employees are authorized to query the data required by the payment server. These designated users can then generate reports specifically for their needs. This document includes two parts: the first part is intended for the customer administrator and the second for users. The following are required for the proper functioning of the system.


Required Material

The Payment Manager requires the use of a browser with 128 bits encryption. To know which browsers are supported by the payment manager, please consult the document “List of supported browsers”.


Login

Follow these steps to begin your work session :

Enter your account ID and password, and then click on Login.

You only have three chances to successfully enter your password. After the third attempt, your account will be deactivated and you will have to contact PayFacto Solution customer service to reactivate it.

If you log in for the first time or if your password has been changed by an administrator, you will have to change your password. The following screen appears:

You must choose a password that contains between 8 and 30 characters including at least one letter and one number. You must also choose a password different from the last 4 used passwords.

Password will expire after 90 days and unused accounts for more than 90 days will be deactivated.

Repeat the password one more time then click on “Change password”.

The main menu appears :

The main menu includes two elements: Customer Administrator and User

To ensure understanding of the customer administrator role, the following pages explain the options available to the client in addition to the procedure to successfully enter data.


Customer Administrator

When you click on Customer Administrator, the following window opens :

This menu includes ten submenus so that the customer administrator can operate :

1. User groups
Allows creating security groups to manage access to the payment manager.

2. Users
Allows creating users so that they may access the payment manager.

3. Client table management.
Allows recording the various merchants’ addresses.

4. Transactions
Allows issuing refunds on credit transactions and managing the batch payment solution.

5. Users list
Allows displaying a list of all users.

6. Redirection configuration.
Allows configuring certain parameters for merchants integrated within the redirection solution.

7. Personalized fields.
Allows configuring personalized fields.

8. API keys
Allows generating a specific API key for the merchant.

9. ApplePay configuration
Allows generating the certificate request and upload the signed certificate.

10. Group for Token Sharing
Allows configuring the sharing of tokens between merchants.


User Groups


When you click on User Groups, the following screen appears:

This screen is connected to the “group” concept. As such, all users sharing the same profile are grouped together and have the same rights. It is mandatory to add a user group prior to creating users, because users are always linked to a group.

The User Groups screen includes the following three buttons :

  • Add: Add a user group;
  • Modify: Modify a user group;
  • Delete: Delete a user group.

Add


When you click on Add, the following screen appears :

This screen includes two fields :

  • Group name : Enter a name that best represents the users in the group, such as “Accounting”.
  • Level : The choice is always “User” because a customer administrator may only add users. If you wish to add another user with administrator rights, you must contact PayFacto Solution’s customer service.


Once you have selected the level, the functions available for this level appear at the bottom of the screen. Assigning functions to a group ensures that group users can access the data they are permitted to access. The functions that you choose will be posted in the left-hand menu when the user connects to the network.
To assign functions to a group, proceed as follows :

1. Enter a meaningful name for the group you are creating;

2. Select the user level from the dropdown list;

3. Select the functions to which the group has access by clicking on the adjacent boxes;

4. Click on Create.

The following message will appear :


This message indicates that the update was successful. Click on OK to return to the User Groups screen.


Modify

If you click on Modify, you will obtain the same screen as with the Add option except that the fields have already been selected. Change the group name or functions and click on Modify. You will return to the User Groups screen once your action is complete.


Delete

To delete a group, select the group you wish to delete and click on Delete. The dialogue box below will appear and you will be asked to confirm the deletion.

If you click on OK, the group is permanently deleted. However, if you click on Cancel, the deletion will not be carried out.

A user group cannot be deleted if it contains users. In this case, an alert message appears stating that the group cannot be deleted because it contains users.

Click on OK to return to the User Group screen.


Users

When you click on Users, the following screen appears :

The page displays the list of all users (first and last names) associated with the merchant as well as the user ID of the person to register.

The User screen includes the three following buttons:

  • Add: Add a user;
  • Modify: Modify a user;
  • Delete: Delete a user.

As you can see, these buttons are identical to those found on the User Groups screen. The previous step created user groups while this step creates the users that make up the groups.


Add

Click on Add to register a user. The screen below appears :

This screen contains eight fields :

1. Account ID : This field assigns a code to a person who will be part of the group. It can contain up to 30 characters.

2. Password : The password is tied to the user ID and validates access to data. It must contain between 8 and 30 characters including at least one letter and one number.

3. First name : First name of the person related to the user ID.

4. Last name : Last name of the person related to the user ID.

5. Language : Language normally used by the user, either English or French. The payment manager will be displayed in the selected language following authentication by the user.

6. Group : This field is used to select the group to which the user belongs.

7. Logon status : Indicates whether the member’s status is active or inactive. A work session cannot be started if the user is inactive.

8. Merchant : Places a user in charge of one or several merchants. Click on the box of the merchant that you wish to assign to the user.

Once the fields are filled in, click on Create.

A user group must be created before it is possible to add a user.

Modify

To modify a user, select the user and then click on Modify. The following screen will appear :

The following modifications can be performed :

  • First name and last name, if they are erroneous;
  • Password, if user forgets his password;
  • Language, if the user prefers another language;
  • Group, if you wish to change the user’s group;
  • Logon Status, if you wish to change the user’s status to inactive or active;
  • Merchant, if you wish to modify the access to merchants.

Click on Modify to return to the User screen, Once the modifications are complete.


Delete

Select the user to be deleted and click on Delete. The following dialogue box will appear, requesting that you confirm the deletion.

If you click on OK, the user will be permanently deleted. However, if you click on Cancel, the deletion will not occur.

If you have deleted the only user taking care of certain merchants, ensure that the merchants are redistributed to other users.

Client Table Management


When you click on Client Table Management, the following screen appears :


Click on Client Addresses. The following window appears :

The Client Addresses screen includes a list of all addresses associated with the client as well as the three following buttons:

  • Add: Add an address.
  • Modify: Modify an address.
  • Delete: Delete an address.

Add

The first step in adding an address is to select a merchant from the dropdown list as shown in the image below.


Once you have selected a merchant, click on Add and the following screen will appear :



This screen includes thirteen fields :

1- Displayed name : Enter the name of the place of business.
2- Person : Enter the name of the person.
3- Responsibility position : Enter the title of the person in charge of this area.
4- Address : Enter the address of the place of business.
5- City : Enter the name of the city.
6- Province : Enter the name of the province.
7- Country : Enter the name of the country.
8- Postal code : Enter the postal code.
9- Phone number : Enter the main telephone number.
10- Phone number 2 and 3 : May be used for a telephone number in another city than the address specified or for a 1-800 telephone number. Formats should be as follows:

Other city :City @ tel. No.(e.g., Montreal @ 514-555-5555)
1-800 No. :OTHER_QC @ tel. No.(e.g., OTHER_QC @ 1-888-555-5555)



11- Fax number : Enter the fax number.
12- E-mail : Enter the business e-mail address or the address of the person in charge.

Once all of the fields have been filled in, click on the Add link
The following message will appear:

This message indicates that the addition has been successful. Click on OK to return to the Client Addresses screen.

Edit

Modify

To modify an address, select an address and click on Modify. The following screen will appear :

Modifications include the following steps :

  1. Modify the fields requested.
  2. Click on Modify.


The following message will appear once your action is complete.

This message indicates that the modification has been successful. Click on OK to return to the Client Addresses screen.


Delete

To perform a deletion, select the location by clicking on the business name and then click on Delete.
If the address that appears is the one you wish to delete, click on Delete.
The following message will appear :

This message indicates that the deletion was successful. Click on OK to return to the Client Addresses screen.


Transactions

The transaction option on the main customer administrator screen is used to issue reimbursements for credit card purchase transactions for e-business merchants.
If you click on Transaction, the following screen will appear :


Refund

The refund option allows for reimbursement of purchase transaction made by credit card for Internet merchants, unattended and MOTO.
Click on Internet active.
The following window will appear :

Click on Refund and the following form will appear :

This form will display a list of transactions that you can refund. The more detailed the information you provide by filling in the fields, the more accurate your search will be. The most important fields to fill in are the date fields.
Only Internet purchase transactions can be reimbursed. MOTO and POS terminal transactions cannot be refunded through the payment manager.

Once you have finished filling out the search form, click on Display transaction and the list of transactions that can be refunded based on your criteria will appear on the screen:

Below are the steps to follow for refund :

1- Click on the transaction number located in the first column of the report. The following screen will appear:

The amount is posted by default. You can refund an amount less than or equal to the amount of the transaction.

2- Enter the amount of the refund.
3- Enter a new 12-digit invoice number.
4- Click on Refund.

You will receive a note stating that the transaction was either accepted or declined. If the transaction has been approved, an authorization number will also be displayed.

Edit

Batch payment

The Batch payment option allows making payment using a batch process.
For more details about this feature, please refer to document “Batch payment” in the vault documentary of the payment manager.


Redirection Configuration

Only for merchants using the redirection mode, this page configures the options attached with inputting and sending a confirmation email originating from the PayFacto solution.

In redirection mode, the transaction receipt sent by e-mail has the CT- Payment support e-mail address as sender, by default. One of the payment manager’s options enables the customer administrator to choose if the payment solution sends a confirmation email and to modify the address of the source.

If the email input checkbox is checked, the customer administrator can configure an email address that will be used when sending the confirmation email. The e-mail sent will still be issued by the PayFacto solution, but it will list the sender address chosen by the customer administrator. This provides the individuals receiving the receipt to have a contact address pointing straight at the merchant.

If the checkbox is not checked, any address entered on the same line will not be taken into account. Also, the CTPayment solution will not display an input field for an email on the redirection page. No confirmation email will be sent by the PayFacto solution.

Please note that only merchants who are integrated into redirection will benefit from configuring the sender email address. The option will be available to the others but it will not work in their environment.

To access this option, select Customer Administrator and then Redirection Configuration.

The following screen will appear:


Email Input Checkbox

The checkbox makes it possible to display an input field of the email during the payment process using the redirection mode. If the box is checked, the field appears on the redirection page. If it is not checked, this field does not appear on the redirection page and the merchant will receive `NO' as the value of the return parameter ‘Email’.

If the merchant has a source address configured and uncheck the box, the address will be erased from the configuration and will have to be entered again when the box is reactivated.


Specify or Modify the Sender Address

The configuration option presents the list of all internet merchants who have a client. Therefore, it is possible to configure the sender e-mail address for each of these merchants. To change the sender e-mail address, choose the merchants and, in the adjacent box, enter the sender’s e-mail address. Confirm your changes by clicking on Modify.

The payment manager will verify the values entered. If the values are valid, the input age will refresh itself and display the new values entered. However, if an address is rejected, an error message is displayed, presenting the invalid e-mail address to the right of the input box of the merchant in question.

The merchant in question maintains the value preceding the change; it is always possible to enter the sender’s email address again.

If an error occurs while simultaneously modifying several merchants, only the merchants for whom an erroneous value was entered will not be updated. The changes will be applied to the merchants with a valid e-mail address.

Specify the Sender’s Display Name

In addition to the sender’s e-mail address, it is possible to indicate the name under which the e-mail is sent on the receipt. The person receiving the receipt will see the name and e-mail address of the sender, thereby facilitating the identification of the sender. This option is useful when the e-mail address used is complex and does not adequately identify the sender.

The following is an example in which the paiement@cgi.com e-mail address is posted as “Payment Solution.”

The e-mail address must be specified using the format as follows:

Name of sender <Sender e-mail >.


Reinstall default sender address

To reinstall the default sender address offered by the payment solution, simply delete the email address configured for the merchant in question and press “Modify”. From this moment, all receipts sent by this merchant will be sent with the default address of the payment solution.


Recurrence

The Recurrence option allows performing recurring transactions and manage subscriptions. For more details about this feature, please refer to document “Recurring payment” in the vault documentary of the payment manager.


Personalized fields

For more details about this feature, please refer to document “Personalized fields” in the vault documentary of the payment manager.


API keys

When you click the API keys option in the menu, the following screen appears:

Click on Add a new key in order to Generate/Manage your keys, as shown below:

You have 2 possibilities to generate a key :

1- A key for All Merchants :

2- A key per specific merchant :

For more details about this feature, please refer to document Payment_API


ApplePay Configuration

When you click on the ApplePay configuration option in the menu, the following screen is display :


For more details regarding this functionnality, please refer do the following documentation ApplePay


Group for token sharing

When you click on the group for token sharing option in the menu, the following screen is display :

You have 2 options for the tokens sharing :
1. Share tokens between every merchants of the same client. If this option is activated, all the merchants will share their tokens.

When all the tokens are shared between the merchants, all the merchants of the group can add, use, modify and delete the tokens.

2. Create a group and add merchants that will share tokens.

If there are groups configured and the check box for all merchants is checked, the share tokens between all merchants box has priority.

User

If you are a customer administrator, click on User on the main menu to access the User menu.
If you are a user, the only choice possible is the user section.
Click on User on the main menu.
The following screen will appear displaying a new menu :

The menu contains six options :

1- Reports:

  • Allows viewing or printing of the sought data.


2- Profile

  • Allows the user to modify passwords and/or language preferences.


3- Extra Search

  • Allows searching for return codes, transaction status codes and transaction codes.


4- Documentation

  • Allows viewing and downloading payment solution documentation


5- Virtual terminal

  • Allows making online transactions for merchants that have no e-commerce infrastructure.


6- Refund

  • Allows issuing refunds.


7- Recurring transactions

  • The Recurrence option allows you to perform recurring transactions and manage subscriptions. For more details about this feature, please refer to document “Recurring payment” in the vault documentary of the payment manager.

Reports

Click on Reports to view this section’s options :

Not all functions listed are necessarily displayed. Only the functions to which you have access will be displayed.

Transaction List

The first option is Transaction List. It allows you to view transactions made according to your search criteria. If you click on this option, the following screen appears:

Follow these steps to produce a report :

1- Enter the period covered by the report :

The current day’s date is entered by default. If you wish to produce a general report, click on Show report without specifying any other criteria.

2- Select the status of the transaction :
Select the status from the dropdown list, as shown below :

Choices include :

  • All transactions;
  • All accepted transactions;
  • All unauthorized transactions;
  • All cancelled transactions.



If you wish to produce the report according to a specific status, click on Show Report.

3- Return Code :
If you wish to see the list of transactions that returned a specific error code, enter the code in the “Return code” textbox :

You must select the unauthorized transactions from the “transaction status” dropdown menu; otherwise, an error message will appear on screen while the request is being processed.

4- Cashier No. :
To display the transactions made by a specific cashier, enter the cashier No. in the Register textbox :

The Register No. button displays all the cashiers that have carried out at least one transaction within the period specified in point 1. in order to help you to find the cashier No. desired.

5- Transaction type :
If required, a single transaction type can be displayed (e.g., all purchases, all refunds). Simply select the type from the following dropdown list :


6- For the merchant :
To display transactions carried out by a particular merchant, select the merchant from the dropdown list. Otherwise, leave the selection “All” and all merchants will be used in the search.


7- Entry type :
The following choice appears when you click on the dropdown list :



Select “All” if you require a report that includes all entry types. Otherwise, select a specific entry type such as Internet, POS terminal or MOTO.

8- For the batch No. :
You can enter the batch No. for which you wish to view the transactions.


9- For the card type :
Select “All” if you require a report that includes all cards or click on a specific card type. The content of the dropdown list is as follows :



10- For the invoice No. :
There are two options: enter the invoice number directly, or click on the invoice No. button. For the second choice, a new screen appears containing the invoice numbers that were used during the period selected in point 1. Click on the invoice number desired and the system will return to the Transaction List screen.


11- Authorization number :
You can enter the authorization number for which you want to view transactions.

12- From terminal Nos. xx to xx :
Enter the interval of terminals from which you desire results. All results included between these two numbers will be included.


13- List of terminals :
If the terminal numbers are not sequential, you can use this option to enter the numbers directly.

You may only use Option 11 (From terminal No. xx to xx) or Option 12 (List of terminals). A button will enable you to make your selection.

14- Select the group(s) :
This function groups your transaction by specific criteria in the report. Up to five groups can be selected. Groups can be made according to transaction date, terminal No., merchant No., posting date, card type or cashier No.

The following choices appear when the dropdown list is selected:

15- Ordered by :
This function sorts your data in the order desired. You can sort by invoice number or transaction date. The default setting is to sort data by invoice number. When the dropdown list is clicked, the following choice appears :

Once you have filled in all of your search criteria, click on “Display the Report” and a new window will appear. As shown below, the window will contain the list of transactions.


The following table contains brief descriptions of the report column headings.

TITLESDESCRIPTIONS
Merchant numberMerchant number assigned by the acquirer (transaction processor)
Terminal numberVirtual number configured at the payment server level
Bank terminal numberNumber assigned by the bank
Batch numberThe batch number in which the transaction was carried out
Card typeName of the credit card used in the transaction. (MasterCard, AMEX, Visa, etc.)
Transaction dateDate of the transaction
TimeTransaction time
Transaction numberTransaction number assigned by the payment server
Card numberCredit card number used in the transaction
Expiry dateCredit card expiry date
Return codeResponse received for the transaction. More details are available in the transaction list document
StateRepresents the state of the transaction. Here are the possible states :
0- Transaction busy or unavailable
1- Transaction in progress
2- Transaction correct
3- Transaction declined
4- Transaction cancelled
5- Transaction in the process of cancellation
6- Transaction already cancelled
7- Transaction waiting for acknowledgment
9- Transaction error
10- Transaction to be canceled at the request of the merchant
11- Transaction being canceled at the request of the merchant
12- Transaction canceled at the merchant's request
Transaction typeThe name of the card used in the transaction
CurrencyCurrency in which the transaction was carried out
Authorized amountOfficial amount approved by the bank
Authorization numberNumber assigned by the bank to authorize the transaction
Reference numberNumber assigned by the bank
Unauthorized amountAmount refused by the bank
Invoice numberNumber provided by the client

Fanbox transaction list

Allows viewing loyalty transactions to your search criteria.
For reference on required fields, please refer to point 4.1.1 List of transactions.


Ticket

The Ticket section prints a cash register receipt for your own use or to provide to your clients.

There are two ways to view or print a cash register receipt :

  • By entering the invoice number;
  • By entering the transaction number.

By Invoice Number

To produce a cash register receipt using the invoice number :

1- Enter the invoice number;
2- Click on Show report.

By Transaction Number

To produce a cash register receipt using the transaction number :

1- Enter the transaction number;
2- Click on Display the Report.


Personalized fields transaction list

Allows displaying data entered in the personalized fields.
For more details about this feature, please refer to the document “How to Use Virtual Terminal” in the vault documentary of the payment manager.


Summary

Allows you to view the summary of transactions according to your search criteria.
By clicking on Summary, the following screen appears and displays a new menu :


For information on the fields to fill in, please refer to Transaction List.
Once you have selected your data, click on Show report.

The following information can be found on this report according to the criteria selected :

  • Total authorized amounts;
  • Total unauthorized amounts;
  • Number of authorized transactions;
  • Number of unauthorized transactions;
  • Number of billable transactions;
  • Number of non-billable transactions;
  • Total number of transactions.



Fanbox summary

Allows to view a summary of the loyalty transactions.
For information on the fields to fill in, please refer to Transaction List.


Profile

When you click on the Profile option on the main menu, the following screen appears :

The Profile submenu allows the user to change their password and language preference. The following fields must be filled in :

  • Old password: Enter the current password.
  • New password: This field is used to enter the user’s new password, which must contain between 8 and 30 characters, including at least one letter and one number. You must also choose a password different from the last 4 used passwords.
  • Confirm password: Enter the new password again.
  • Language: User’s usual language.

Once the fields are filled in, click on Change Profile.

Password will expire after 90 days and unused accounts for more than 90 days will be deactivated.

When you click on the Extra Search option, the following screen appears :



There are three types of search:

  • Search by return code;
  • Search by transaction status;
  • Search by transaction code.

Search by Return Code

The steps to follow to search by return code are:

  1. Enter the return code;
  2. Click on Search.


A new window will appear:

It is essential that the code is entered as it appears on the report. The result will not be the same if 05 has been entered instead of 0005.

Click on Report all should you require the complete list of return codes.

A new window appears with a list of all the return codes.


Search by Transaction Status

To search by transaction status :

  1. Enter the transaction status;
  2. Click on Search.


A new window will open :

Note :

You must enter four characters.

Click on Report all should you require the complete list of transaction status.

A new window will open :


Search by Transaction Code

To search by transaction code :

  1. Enter the transaction code;
  2. Click on Search.


A new window will appear:

Note :

You must enter two characters.
Click on Report all should you require the complete list of transaction codes.

A new window will open :


Documentation

When you click on the Documentation option from the main menu, the following screen appears :

 This page contains the list of all PayFacto solution documentation that is available to you. To download a document, click on the blue link of the document you wish to download.
Descriptions of the documents are available by moving your mouse pointer over the document name. A description will appear after a few seconds.
If a document has been added or modified within the preceding 15 days, an X will appear in the new column.


Refund

The refund option allows for reimbursement of purchase transaction made by credit card for Internet merchants, unattended and MOTO.
For more details about this feature, please refer to section Refund above in the document.


Virtual terminal

The virtual terminal is an easy, efficient and secure way of performing online transactions for merchants that have no e-commerce infrastructure.
For more details about this feature, please refer to the document “How to Use Virtual Terminal” in the vault documentary of the payment manager.

    • Related Articles

    • Secure Payment Application User Guide

    • Hosted Payment Page

      Introduction This page aims to train future users of the secure redirection of the PayFacto payment solution. You will find in this page a description of the secure redirection service, the operation, the various call and return parameters, the ...
    • Endpoint : Recurring - Info User

      Recurring - Info User This transaction is used to get all the available information on an existing Token in PayFacto vault. Request Field Mandatory? CompanyNumber Y MerchantNumber Y CustomerNumber Y Token Y OperatorID Y Response Field Mandatory? ...
    • Endpoint : Recurring - Delete User

      Recurring - Delete User This transaction is used to delete a Token and the linked card number. Request Field Mandatory? CompanyNumber Y MerchantNumber Y CustomerNumber Y Token Y OperatorID Y Response Field Mandatory? accountNumber amount avsStatus ...
    • Endpoint : Recurring - Modify User

      Recurring - Modify User This transaction is used to modify information linked to a Token. When the value "**NO_CHANGE**" is sent in the CardNumber field along with the new expiry date, only the expiry date will be updated on our Token vault. Request ...