PayFacto API - v1.0 - Payment Manager - Virtual Terminal - User Guide

PayFacto API - v1.0 - Payment Manager - Virtual Terminal - User Guide

Virtual Terminal

The virtual terminal is a simple, efficient and secure way to execute online payments for merchants who do not have e-commerce websites. 

๐ŸŒ

  Accessing the Virtual Terminal

The virtual terminal is contained in the interface of the Payment Manager. For details on accessing and using the Payment Manager itself, see the Payment Manager User Guide.

1

Open a session in the Payment Manager

Depending on your security level, either the "Customer Administrator" and "User" menu, or only the "User" menu, will appear.

2

Click on "User"

A submenu appears, including a "Virtual terminal" option.

3

Click on "Virtual Terminal"

The virtual terminal input screen appears, with a Merchant selector at the top.

๐Ÿ’ณ

  Credit Card Transaction

Transaction Types

The virtual terminal can execute two types of financial transactions with a credit card: Purchase and Refund.

โš ๏ธ

Only a client-administrator can execute a refund.

Merchant Selection

Select a merchant to execute the transaction. If only one merchant is defined, it is listed by default. If more than one merchant is defined, the first one is listed by default. To change the default merchant, click "Modify Preferences", select the merchant, and click "Save".

Field Descriptions

Field Description
Type Select the type of transaction to execute: Purchase or Refund.
Amount Enter the amount of the purchase or refund, as dollars and cents (e.g., 434.36).
Card Number Enter the credit card number without spaces.
Expiration Date Enter the expiration date found on the card: two digits for the month in the first box, two digits for the year in the second box.
Verification Code Optional. If activated, enter the three digits on the back of the card (VISA and MasterCard only). If the option is not activated, this field will not appear.
Invoice Number Enter the invoice number, up to twelve digits.

Processing

Fill out all the fields, then click "Submit." A "Transaction in progressโ€ฆ" message appears while the transaction is processed.

Result โ€” Success

Once the transaction is completed successfully, the return code will always be 00. The results screen displays the transaction details (authorization number, transaction number, invoice number, amount, card type, card number, expiration date, date and time, TPV, terminal).

  • Return: Returns to the input screen with all fields reset to blank.
  • Print: Displays a new page with the transaction receipt, which can be printed using your browser's print function.

Result โ€” Failure

If the transaction is not completed successfully, a return code appears with a summary reason on the results screen. Consult the return codes document for full details on the reason and the recommended next action.

  • Redo: Returns to the input screen keeping the previously entered information, so you can retry without re-entering the data. This option does not work in Firefox โ€” the fields will be reset to empty instead.
  • Return: Returns to the input screen with all fields reset to empty.
  • Print: Displays a new page with the transaction receipt, which can be printed using your browser's print function.
๐Ÿ”‘

  Debit Card Transaction (PIN Keypad)

Executing transactions with a PIN keypad is optional and requires a PIN keypad. A PIN keypad can also be used for credit card and loyalty program transactions.

Transaction Types

The virtual terminal can execute two types of financial transactions using a debit card: Purchase and Refund. Only a client-administrator can execute a refund.

Merchant Selection

When selecting the merchant, a "Client TPV number" field is added, associated with the PIN keypad. To change the default merchant and/or TPV number, click "Modify Preferences", select the merchant and Client TPV number, and click "Save."

Field Descriptions

  • Type: Select the type of transaction to execute โ€” Purchase or Refund.
  • Amount: Enter the amount of the purchase or refund, as dollars and cents (e.g., 434.36).
  • Invoice Number: Enter the invoice number, up to twelve digits.

Processing

Once all the information is entered, click "Submit." A "Transaction in progressโ€ฆ" message appears. The remaining operations are executed using the PIN keypad โ€” follow the instructions displayed on the keypad.

Result โ€” Success

Once completed successfully, the return code will always be 00. The results screen displays the transaction details (transaction type, authorization number, transaction number, invoice number, amount, card type, card number, expiration date, date and time, TPV, terminal, account type).

  • Return: Returns to the input screen with all fields reset to blank.
  • Print: Displays a new page with the transaction receipt.

Result โ€” Failure

Several return codes may appear if the transaction is not completed. Consult the return codes document for details on the reason and subsequent actions.

  • Redo: Returns to the input screen keeping the previously entered information. Does not work in Firefox โ€” fields reset to empty instead.
  • Return: Returns to the input screen with all fields reset to empty.
  • Print: Displays a new page with the transaction receipt.
๐Ÿ“‹

  Personalized Fields

Personalized fields are generic-information fields that let you add additional information for each transaction. They are configurable to meet your needs.

Configuration

In the "Customer Administrator" menu, click "Personalized fields." If only one merchant is defined it's shown by default; if multiple merchants are defined, select one to configure.

Add a Field

When configuring for the first time, the only option is to add a field. Click "Add a field" to open the field form.

Field Description
Name Name of the field, as it will be displayed in the virtual terminal.
Type Text or List. "Text" allows entering a string of alphanumeric characters. "List" allows selecting a value from a dropdown.
Length Maximum number of characters for the field. For a "List" field, this is automatically set to 50.
Show on receipt If selected, the field appears on the transaction receipt.
Perform a sum The "Trx list - personalized fields" report will sum the numeric input for this field across authorized transactions.

Add a Value in a List

After adding a "List" field, add the values that will appear in the dropdown: enter the value name and press "Add." You can continue adding values โ€” the order entered doesn't matter, as values are displayed alphabetically. Each value appears with an "X" to its right for deleting it if needed.

Modify Personalized Fields

Once custom fields are created, you can edit, delete, and reorder them from the field list: click the edit icon to modify a field, the delete icon to remove it, and the up/down icons to change its display order in the virtual terminal.