Elavon downloads and stores cookies on your device when you visit our website. We use these cookies to better understand and improve your browsing experience by identifying most visited pages, personalising content, and measuring site performance.

Essential cookies enable core functionality such as page navigation and access to secure areas. The website cannot function properly without these cookies; they can only be disabled by changing your browser preferences.

Performance cookies help us to improve our website by collecting and reporting information on its usage (for example, which of our pages are most frequently visited).

These cookies and similar technologies gather information about your browsing habits. They remember that you've visited a website and share this information with other organisations, such as advertisers and platforms on which we advertise.
They do this in order to provide you with ads that are more relevant to you and your interests. Although these cookies and similar technologies can track your visits to other websites, they don't usually know who you are.
Without these cookies, online advertisements you encounter will be less relevant to you and your interests.


Cookie Settings

Elavon Financial Services DAC. Registered in Ireland – Number 418442.
Registered Office: Block F1, Cherrywood Business Park, Dublin 18, D18 W2X7, Ireland.
Elavon Financial Services DAC, trading as Elavon Merchant Services, is regulated by the Central Bank of Ireland.
 
Elavon Financial Services DAC. Registered in Ireland with Companies Registration Office. The liability of the member is limited. United Kingdom branch registered in England and Wales under the number BR022122.
Elavon Financial Services DAC, trading as Elavon Merchant Services, is a credit institution authorised and regulated by the Central Bank of Ireland.  Authorised by the Prudential Regulation Authority.  Subject to regulation by the Financial Conduct Authority and limited regulation by the Prudential Regulation Authority.  Details about the extent of our regulation by the Prudential Regulation Authority are available from us on request.

Simplify supports a **Virtual Keyboard** message on touch screen devices. This message displays up to three lines of text, a virtual keyboard, and an input field showing formatted user input.

Mask and UserChar subfields of API 5001 in the request control how the input field is initialized, the data allowed for user input, and how the data will be formatted. See under Request for more information.

If the customer presses the Enter key, any text entered on the virtual keyboard is returned in API 5001 in the response, formatted as defined by the Mask (except no Input Mode masking).

## Field 5001 Format

### Request

| Field Name | Length | Description |
|--------------|----------|--------------------------------|
| TTT | 3 | Tag (always = 030) |
| LLL | 3 | Length of the following data |
| Title1 | Var. | Title 1 |
| FS | 1 | Field separator (Hex 1C) |
| Title2 | Var. | Title 2 |
| FS | 1 | Field separator (Hex 1C) |
| Title3 | Var. | Title 3 |
| FS | 1 | Field separator (Hex 1C) |
| Mode | 1 | Input Mode (Password Flag):<ul><li> 0=Normal (display characters as entered)</li><li>1=Password mode (characters are replaced by \* in display)</li></ul> |
| FS | 1 | Field separator (Hex 1C) |
| Mask | Var. | Defines data types allowed as input and how input will be formatted. See further below.|
| FS | 1 | Field separator (Hex 1C) |
| UserChar | Var. | Defines characters allowed as input. Only supported for Masks containing ‘/u’ and/or ‘/U’; else blank. See further below. |

#### Mask

The mask is a string normal, the format characters are always preceded by '/'. The input mask can be set using *GL\_Widget\_SetMask, GL\_Widget\_SetMaskById* or *ingenico::graphics::Widget::setMask*

:::::notice{note}

The default charset is UTF8, to change the charset use the function *GL\_GraphicLib\_SetCharset* or *ingenico::graphics::GraphicLib::setCharset*).
:::::


:::::notice{important}
 
If the default charset is UTF8 and the POS sends a non-UTF8 string all non-UTF8 characters will be replaced by '?'.
:::::


For the following masks, the fill character is 1 (by default **'\_'**):

(*GL\_Widget\_SetFillChar1* or *ingenico::graphics::Widget::setFillChar1*)

- **/b** : accepts a character in binary

- **/o** : accepts a character in octal

- **/d** : accepts a character in decimal

- **/x** : accepts a hexadecimal character

- **/a** : accepts an alphanumeric character

- **/c** : accepts any character

- **/u** : accepts all characters in the range of allowed characters defined by the user
 
 (*GL\_Widget\_SetUserChar* or *ingenico::graphics::Widget::setUserChar*)

For the following masks, the fill character is 2 (by default **'0'**):

(*GL\_Widget\_SetFillChar2* or *ingenico::graphics::Widget::setFillChar2*)

- **/B** : accepts a character in binary

- **/O** : accepts a character in octal

- **/D** : accepts a character in decimal

- **/X** : accepts a hexadecimal character

- **/A** : accepts an alphanumeric character

- **/C** : accepts any character

- **/U** : accepts all characters in the range of allowed characters defined by the user

 (*GL\_Widget\_SetUserChar* or *ingenico::graphics::Widget::setUserChar* )

- **//** : accepts the character '/'

Example: The mask "0x/x/x/x/x" accept strings containing a decimal number coded on 4 hex digits preceded by "0x".

:::::notice{important}
If a *GL\_Widget\_SetText* or *ingenico::graphics::Widget::setText* was done before it is not taken into account. Always specify the input mask before loading the default content of the field.
:::::


#### UserChar

User character definition. Defines characters allowed as input. Only supported for Masks containing ‘/u’ and/or ‘/U’, This subfield calls GL_Widget_SetUserChar or ingenico::graphics::Widget::setUserChar. 

Example: the Mask plus UserChar "/u/u/u/u<FS>1234" accept strings containing all characters from 1 to 4.

### Response

| Field Name | Length | Description |
|----------------|----------|------------------------------------------------------------------------------|
| TTT | 3 | Tag (always = 030) |
| LLL | 3 | Length of the following data |
| ActionButton | Var. | If field 11 Completion Code = 000 (success), returns code for key pressed:<ul><li>777=Enter (green) key </li><li>888=Cancel (red) key</li></ul> |
| FS | 1 | Field separator (Hex 1C) |
| Data | Var. | If ActionButton =777 (Enter), returns formatted input text (if any). |

## Request

The following request tells Simplify to display the screen shown below. Buttons at the bottom of the screen (on the left) provide access to virtual keyboards for entering alphabetic and other characters.

| API Field \#, Value | Description |
|----------|----------------------|
| 0001,36 | Transaction Type |
| 0011,xxx.. | User Data. See :magic-link[Simplify-Controlled Field Definitions]{id="simplify-controlled-field-definitions"}. |
| 5001,\[see value below\]| Non-Financial Data<ul><li>030=Tag</li><li>057=Length of data</li><li>Enter Email Address=Title1</li><li>0=Normal input mode (input displayed)</li><li>/c/c/c/c/c/c/c/c/c/c/c/c/c/c/c/c=Mask</li></ul> |
 
5001,030057Enter Email AddressFSFSFS0FS/c/c/c/c/c/c/c/c/c/c/c/c/c/c/c/cFS


::image{id="/content/dam/developer-portal-solutions/en-us/elavon/media/images/products/simplify/image19.jpeg" alt="sample Enter email screen"}


## Response

| API Field \#, Value | Description |
|---------------------------------------------------------------------------------|----------------------------------------------------|
| 0001,36 | Transaction Type |
| 0011,xxx.. | User Data. See :magic-link[Simplify-Controlled Field Definitions]{id="simplify-controlled-field-definitions"}. |
| 5001,030019777FStest@elavon.com | Non-financial Data<ul><li>030=Tag</li><li>019=Length of data</li><li>777=Enter key pressed</li><li>test@elavon.com=User input</li></ul>|
| 5002,80378002	|Device serial number (if present) |

## Additional Request Samples (field 5001)

| Value in Field 5001 | Screen Use |
|-------|--------|
| 030049Enter AmountFSFSFS0 FS/d/d/d/d/d/d/d/d/d/d/D./D/D US$FS| Prompt for dollar amount |
| 030041Enter Date (YYMMDD)FSFSFS0FS/d/d///d/d///d/dFS| Prompt for date|
| 030039Enter Time (HHMMSS)FSFSFS0FS/d/d:/d/d:/d/dFS| Prompt for time |
| 030036Enter PasswordFSFSFS1FS/c/c/c/c/c/c/c/cFS| Prompt for password|

Tag 030 - Virtual Keyboard

Alliance Offers

Data as a Service

Invitation to Apply

Accounts

Bank Holidays

Card Activation

Card Controls

Commercial Credit Cards

Credit Card Account Details

Credit Card Accounts Overview

Credit Card Alerts

Credit Card Application Status

Credit Card APRs

Credit Card Payments

Credit Card Qualified Offers

Credit Card Statements

Credit Card Transactions

Data Sharing for Marketing Purposes

Digital Wallets

Make a Payment - Coming Soon

Rewards Accelerator

Rewards Automatic Redemption

Rewards Balance Summary

Rewards Redemption Coming Soon

Rewards Redemption Accounts

Rewards Redemptions

Rewards Transactions Earned and Redeemed

Travel Notifications

User Profile

3DSecure2

Avvance

CheckoutJs

Commerce SDK

Converge

Disputes Management

Dynamic Currency Conversion

eBoarding

Elavon Cloud Payments Interface

Fusebox

Hosted Payment Page

In Person Payments on Opayo

Leads

Lightbox payment modal

Online Payments on Opayo

Opayo

Opayo Direct

Opayo Forms

Opayo Reporting API

Opayo Server

Opayo Shared API

Payment Method Gateway

Payments Core 365

Simplify

viaconex

XML API

Access Online Transactions

Account Transfers

Account Validation

ACH Originations

Bank Information

Card as a Service

Card as a Service API

Check Payables

Core Banking API

Corporate Account Information

Corporate Credit Cards

Corporate Onboarding

Corporate Statements

Custody

Data Toolbox

Data Toolbox - Accounts

Data Toolbox - Documents

Data Toolbox - Transactions

Disbursements via Zelle

U.S. Bank Flexible Capital Platform

Freight Payment Customer Profiles

Freight Payment Transactions

Instant payments

Investment Accounting

Money Movement API

PaySmart

Payee Choice

Payee Token+

Personal Loans

Positive Pay

Push to Card

Receivables

Reference API

RTP® - Real-Time Payments

Tokenized Payments

Treasury Builder

U.S. Bank FBO Account

Virtual Account Reporting

Virtual Card Payments

Voyager Accounts

Voyager Cards

Voyager Drivers

Voyager Transactions

Voyager Vehicles

Wire Transfers

Simplify Overview

Ingenico Developer Guide 2.03.02x.121 Ver. 21-30

Simplify Introduction

Supported Hardware

General Guidelines

Message and Communications Protocols

Versioning

Financial Messages

Overview and Guidelines

Sale Message (Tran Type 02)

Auth Only Message (Tran Type 01)

Prior Auth Sale Message (Tran Type 07)

Incremental Authorization Message (Tran Type 75)

Full Authorization Reversal Message (Tran Type 61)

Partial Authorization Reversal Message (Tran Type 76)

Return Message (Tran Type 09)

Void Return Message (Tran Type 17)

Void Sale Message (Tran Type 11)

EBT Messages (Tran Types 02, 09, 11, 17, 24)

Gift Card Messages (Tran Types 01, 02, 07, 09, 11, 17, 24)

Inquiry Message (Tran Type 22)

 DCC Inquiry Message (Tran Type 46)

Token Request Message (Tran Type 37)

Cancel Message (Tran Type 80)

Health Message (Tran Type 73)

Batch Close Message (Tran Type 13)

Batch Inquiry Message (Tran Type 14)

Non-Financial Messages

Non-Financial Messages (Tran Type 36)

Signature Message (Tran Types 36-01, 36-02)

Version Number Inquiry Message (Tran Type 36-06) 

Initiate HEM/IngEstate Message (Tran Type 36-07)

Scrolling Receipt Request Message (Tran Type 36-10)

Scrolling Receipt Stop Message (Tran Type 36-11)

Exit Reversal Mode Message (Tran Type 36-12)

Informational Prompting Message (Tran Type 36-14)

System Command Message (Tran Type 36-15)

Allow Pre-Tendering Message (Tran Type 36-40)

Print Request Message (Tran Type 36-45)

Status Message (Tran Type 36-51)

POS SAF Processing

Offline Transaction Processing

Stand-In Response

Store and Forward Transactions 

EMV Considerations

EMV Tags and other EMV-related Response Fields

EMV Offline Situations

ICC (Chip) Declines and Simplify Reversal Mode

Pay-At-Table

Transaction Flow

Pay-At-Table API Fields

Messaging

Pay-At-Table Message Overview

Login Message (Tran Type 39-01)

Get Check Info Message (Tran Type 39-02)

Controlling screen flow after check selection

Check Detail Message (Tran Type 39-07)

Make Payment Message (Tran Type 39-05)

Print Receipt Message (Tran Type 39-06)

Simplify Payment Process

Logout/Disconnect Message (Tran Type 39-04)

Recovery

Informational Prompting

General information for all tags

Generic messaging

Tag 010 - Text with Optional Buttons

Tag 011 - Static and Scrolling Text with Optional Buttons

Tag 012 - Text and Graphics with Optional Buttons

Tag 013 - Fast Graphics Download

Tag 014 - Text and Camera Image

Tag 020 - Scrolling Text 

Tag 031 - Tactile Keypad

Tag 040 - Radio Buttons 

Tag 050 - Check Boxes

Tag 060 - Slider Message

Tag 070 - Scrolling Text with Radio Buttons

Tag 071 - Scrolling Text with Virtual Buttons

Tag 072 - Scrolling Text with Configurable Buttons

Dynamic Currency Conversion (DCC)

P2PE

Auto Signature

Pre-Tendering

Simplify-Generated Messages

On-Device SAF

Supported Functionality

On-Device SAF Transaction Lifecycle

POS Inquiry with On-Device SAF Enabled

Simplify-Generated Messages for On-Device SAF

SAF Sample Messages

Simplify-Controlled Field Definitions

Developer Guide Release Notes

Ingenico Download Configuration and Troubleshooting Guide 2.03.02x.121 Ver. 21-30

Navigation and Data Entry on Ingenico PIN Pads