TMS APIs

Type Enumerations


Account Type   

VI Visa
MC MasterCard
AX AmericanExpress
DI Discover
DN Diners
AC ACH
DB DEBIT
EB EBT
JC JCB
UP UNION_PAY
IN INTERAC
OT OTHER
Authenticate Terminal   

authenticate-terminal Type of the request/response
Communication Protocol Type   

http-rsa HTTP-RSA
tls-11 TLS11
tls-12 TLS12
Configuration Type   

CC Contact
CL Contactless
Content Type   

contactEMVData Contact EMV configuration of the terminal
contactlessEMVData Contactless EMV configuration of the terminal
Default Industry Type   

RE Retail. Indicates that a terminal is used in the retail industry.
RS Restaurant. Indicates that a terminal is used in the restaurant industry.
Encryption mode   

legacy Legacy mode is used to encrypt the password.
advanced AES-key is used to encrypt the password.
Encryption Type   

N Indicates that encryption is not used
I Indicates that RSA encryption is handled internally by the gateway
T Indicates that RSA encryption is handled externally using FirstData TransArmor
Entry Mode Policy   

Manual Indicates that card data is entered manually.
Swipe Indicates that card data is held with a magnetic stripe.
EMV Contact Indicates that EMV contact card is used with a chip.
EMV Contactesst Indicates that EMV contactless card is used with a chip.
Format   

Format Type   

generic Generic (JSON) data format
ingenico Format of the Ingenico configuration file
verifone Format of the Verifone configuration file
Initialize Terminal   

initialize-terminal Type of the request/response
IP Address Type   

D Indicates that IP address is dynamic (DHCP)
S Indicates that IP address is static
Key Type   

mac MAC key
p2pe P2PE key
Merchant Info   

merchant-info Type of the request/response
Offline Transaction Mode   

XX No offline processing.
SX Offline sale is enabled and offline credit is disabled.
XC Offline sale is disabled and offline credit is enabled.
SC Offline sale and credit are enabled.
Operation Type   

S Standalone. Indicates that the terminal generates a transaction itself (i.e., the amount and type of card is entered manually, and the data is sent to the gateway).
A Attached. Indicates that the terminal communicates with the server to obtain a list of transactions.
C Cloud. Indicates that terminal is in the cloud mode.
M Managed. Indicates that both sale and credit offline operations are allowed.
Receipt Policy   

POS The receipt is printed from POS.
Terminal The receipt is printed via terminal.
Email The receipt is sent to the customer via email.
No receipt The receipt isn’t required.
Receipt Printing Order Type   

C Customer then merchant. Indicates that receipt will be printed for the customer first.
M Merchant then customer. Indicates that receipt will be printed for the merchant first.
O Customer only. Indicates that receipt will be printed for the customer only.
Resource Type   

A Application
L Library
R Kernel
F File
K Key
Security   

True When passwordFile=True and secretKeyFile=True.
Key When passwordFile=True and secretKeyFile=False
Password When passwordFile=False and secretKeyFile=True
False When passwordFile=False and secretKeyFile=False
Status   

A Active. For physical terminals indicates that the terminal has been registered and activated. The terminal is in merchant's possession. However to process return or exchange order, the terminal has to be deactivated. For virtual terminals indicates that the terminal has been created and it is active.
I Inactive. For physical terminals indicates that the terminal has been deactivated. The terminal is in merchant's possession and can be returned or exchanged. For virtual terminals indicates that the terminal has been deactivated.
F In Fullfillment. For physical terminals only; indicates that the terminal is at the fulfillment facility getting prepared for deployment.
G Assigned. Indicates that the terminal is associated with the physical device, which is in pending fulfillment and deployment.
U Unassigned. Indicates that no physical device is yet associated with the terminal. It is possible to place an order for this terminal.
P Provisioned. For physical terminals only; indicates that the terminal is provisioned and ready for deployment. At this stage it is not possible to re-provision the terminal without unlocking it.
M In Migration Out. For physical terminals only; indicates that the terminal is in migration, in other words the physical device is getting reassigned from one terminal in the system to another.
D Disconnected. Indicates that terminal is disconnected from the system.
O Onboarding.
C Discarded.
N In Migration In.
Task Type   

IX Install application
IR Install resource
RX Remove resource
UC Upload summary log
UL Upload crash log
Terminal Device Status Type   

Active Indicates that the terminal is active
Error (Connectivity) Indicates that there is no internet connection
Error (Unregistered) Indicates that the terminal got reset on the server
Error (Non Activated) Indicates that the terminal is either provisioned or in fulfillment
Terminal Mode   

I Integration.
D Demo.
T Test
P Prod
Terminal Model   

i01_ict250 iCT250
i02_isc250 iSC250
i03_isc480 iSC480
i04_ipp350 iPP350
i05_iwl252 iWL252
i06_ict220 iCT220
i07_icm122 iCM122
i08_imp352 iMP352
i09_ismp4 iSMP4
i10_ipp320 iPP320
Theme Type   

BD Blue Indicates that the blue color theme is to be shown on a terminal screen.
SX Silver Indicates that the silver color theme is to be shown on a terminal screen.
Time Zone Type   

705 EST. Indicates Eastern Time Zone.
706 CST. Indicates Central Time Zone.
707 MST. Indicates Mountain Time Zone.
708 PST. Indicates Pacific Time Zone.
Upload Log Type   

S Summary log
C Crash log


Copyright © United Thinkers. (UniPay - Payment Gateway Software)
All Logos and Trademarks used or mentioned on this page are copyrighted property of their respective owners and are used for display purposes only.