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).

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 **Tactile Keypad** message on all Tetra devices. This message displays up to three lines of text and an input field showing formatted user input. Allowed input consists of numbers keyed on the device keypad.

A Mask subfield in API 5001 in the request defines how the input field is initialized, the maximum number of digits allowed in user input, and how the input will be formatted. A Direction subfield can be used to determine the direction in which the input field is filled. API 5001 must be terminated with a field separator. See under Request for more information.

If the customer presses the Enter key, the user input is returned in the response, formatted as defined by the Mask. 

## API 5001 Format

### Request
|Subfield Name	|Length	|Description|
|---------------|-------|-----------|
|TTT	|3	|Tag (always = 031)|
|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): 0=Normal (display characters as entered) 1=Password Mode (characters are replaced by * in display)|
|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.	|Blank (not supported)|
|FS	|1	|Field separator (Hex 1C)|
|Direction	|1	|Direction in which the input field is filled (see further below):<ul><li>0 – from right to left</li><li>1 – from left to right</li></ul>|
|FS	|1	|Field separator (Hex 1C)|


### Mask

The Mask functionality supported for this message is a subset of that supported for the Virtual Keyboard message (see under Tag 030 for detailed description). It can contain format constants ('$', '(', ')', '-', etc.) and format characters. The only format characters supported are /d and /D:
- **/d** accepts a numeric character (decimal). Initialized as a blank space.
- **/D** accepts a numeric character (decimal). Initialized as 0. 

Example: The initial display for Mask = $/d/d/d/D./D/D is $   0.00 

### Direction

A value of 1 (left to right) is only valid if Mask is defined. If Direction is blank, invalid, or not present, a default of 0 (right to left) is used. 

Example: If Mask = $/d/d/d/D./D/D and Direction = 0, and user enters 5000, the formatted input will be $  50.00.

:::::notice{important}
If Direction = 1 and user enters 5000, formatted input for the above Mask will be $5000.
:::::

 
### Response
|Subfield Name |Length |Description|
|------------- |-------|-----------|
|TTT	|3	|Tag (always = 031)|
|LLL	|3	|Length of the following data|
|ActionButton	|Var.	|If API 0011 Completion Code = 000 (success), returns code for key pressed: - 777=Enter (green) key - 888=Cancel (red) key|
|FS	|1	|Field separator (Hex 1C)|
|Data	|Var.	|If ActionButton =777 (Enter), returns formatted input text (if any).|


## Sample Message
### Request
The following request tells Simplify to display the following screen. As user input is entered, it is formatted onscreen as defined by the Mask (or by Input Mode, if used). 

|API Field #, Value	|Description|
|-------------------|-----------|
|0001,36	|Transaction Type| 
|0011,xxxxx..	|User Data. See :magic-link[Simplify-Controlled Field Definitions]{id="simplify-controlled-field-definitions"}.|
|5001,[see value below]|Non-Financial Data - 031=Tag - 033=Length of data - Donate Today=Title1 - 0=Normal input mode (input displayed) - $/d/d/d/D./D/D=Mask - 0=Direction (right to left) - 5=Timeout (in seconds) for data input field.|

5001,031033Donate TodayFSFSFS0FS$/d/d/d/D./D/DFSFS0FS
 
 


::image{id="/content/dam/developer-portal-solutions/en-us/elavon/media/images/products/simplify/Tag031screenshot.png" alt="sample Donation screen"}


### Response

|API Field #, Value	|Description|
|-------------------|-----------|
|0001,36	|Transaction Type|
|0011,xxxxx..	|User Data. See :magic-link[Simplify-Controlled Field Definitions]{id="simplify-controlled-field-definitions"}.|
|5001,031012777\<FS\>$ 5.00|Non-Financial Data - 031=Tag - 012=Length of data - 777=Enter key pressed - $ 5.00=Formatted user input>
|5002,12189383	|Device serial number (if present)|


## Additional Request Sample (API 5001)
|Value in API 5001	|Screen Use|
|-------------------|----------|
|031064Sign Up For RewardsFSEnter MobileFSFS0FS(/d/d/d) /d/d/d - /d/d/d/dFSFS1FS	|Prompt for phone number.|

Tag 031 - Tactile Keypad

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 Disputes - Coming Soon

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

Elavon Payment Gateway

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 030 - Virtual Keyboard

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