--- title: "EPI Add" method: POST path: "/api/valor/createEPI" --- # EPI Add `POST /api/valor/createEPI` ## Headers - `Authorization` string, required - `isv-secret-key` string ## Request body - object - `newUserId` string, required — Merchant User ID (Max length of 11 chars) - `mp_id` string, required — It is a merchant profile id which is respective to the particular merchant (Max length of 11 chars) - `storeData` object[], required - `id` string — The unique id refers to a particular store of the merchant - `epiData` object[] - `device` string, required —

The model description of the device to be boarded for that merchant. Have to pass the 'Device ID'

Device Name Device ID
VL100 130
VL110 145
VL500 136
VP100 207
RCKT 274
Virtual Terminal 139
VP500 235
VL100 Pro 540
VL550 533
VP550 412
VP550E 524
VP800 527
VL300 519
VP350 530
N950 622
VP550C 737
X800 738
- `deviceType` string, required —

The type description of the device / terminal Possible Options.

Device Name Device Type
VL100, VP100, VL100 Pro, VL300 Desktop POS
VL500, VP500, VP550, VP550E, VP800, VP350, N950, VP550C, X800 Smart POS
VL110 Handheld POS
RCKT DONGLE
Virtual Terminal Soft POS
VL550 Portable
- `processor` string, required — Update the processor params 1 or 2 (TSYS - 1 and FD - 2) - `epiLabel` string, required — Label description for the device /terminal. Max length 48 char - `batch_number` string - `features` object - `tip` object - `enabled` boolean, required - `value` integer[], required - `surcharge` object - `enabled` boolean, required - `value` string, required - `tax` object - `enabled` boolean, required - `value` string, required - `processorData` object[] - `mid` string, required — Merchant id related to the surcharge profile. If the epi is to be boarded on Traditional profile set it as "null" - `mid1` string, json, required — Merchant id related to the traditional profile. If the epi is to be boarded on surcharge Profile sets it as "null" - `vNumber` string, required — vNumber mapped to the particular device / terminal in surcharge profile. If the epi is to be boarded on Traditional profile set it as "null" - `vNumber1` string, json, required — vNumber mapped to the particular device / terminal in traditional profile. If the epi is to be boarded on a Surcharge profile, set it as "null" - `storeNo` string, required — Store number of the particular device / terminal in surcharge profile. If the epi is to be boarded on traditional Profile set it as "null" - `storeNo1` string, json, required — Store number of the particular device / terminal in traditional profile. If the epi is to be boarded on a Surcharge profile, set it as "null" - `termNo` string, required — Terminal number of the particular device / terminal in surcharge profile. If the epi is to be boarded on traditional Profile set it as "null" - `termNo1` string, json — Terminal number of the particular device / terminal in traditional profile. If the epi is to be boarded on a Surcharge profile, set it as "null" - `association` string, required — Association number for the particular device / terminal in surcharge profile. If the epi is to be boarded on a traditional Profile set it as "null" - `association1` string, json, required — Association number for the particular device / terminal in traditional profile. If the epi is to be boarded on a Surcharge profile, set it as "null" - `chain` string, required — Chain number for the particular device / terminal in surcharge profile. If the epi is to be boarded on a traditional Profile set it as "null" - `chain1` string, json, required — Chain number for the particular device / terminal in traditional profile. If the epi is to be boarded on a Surcharge profile, set it as "null" - `agent` string, required — Agent code number for the particular device / terminal in surcharge profile. If the epi is to be boarded on a traditional Profile set it as "null" - `agent1` string, json, required — Agent code number for the particular device / terminal in traditional profile. If the epi is to be boarded on a Surcharge profile, set it as "null" - `EbtNo` string, json, required — Ebt number for the particular device / terminal in surcharge profile. If the epi is to be boarded on a traditional Profile set it as "null" - `EbtNo1` string, json, required — Ebt number for the particular device / terminal in traditional profile. If the epi is to be boarded on a Surcharge profile, set it as "null" - `binnumber` string, required — Bin number for the particular device / terminal in surcharge profile. If the epi is to be boarded on a traditional Profile set it as "null" - `binnumber1` string, json, required — Bin number for the particular device / terminal in traditional profile. If the epi is to be boarded on a Surcharge profile, set it as "null" - `agentBank` string, required — Agent bank number for the particular device / terminal in surcharge profile. If the epi is to be boarded on a traditional Profile set it as "null" - `agentBank1` string, json, required — Agent bank number for the particular device / terminal in traditional profile. If the epi is to be boarded on a Surcharge profile, set it as "null" - `industry` string, required — The industry type on which the terminal / terminal in surcharge profile. If the epi is to be boarded on a traditional Profile set it as "null" - `industry1` string, json, required — The industry type on which the terminal / device to be boarded in traditional profile. If the epi is to be boarded on a surcharge Profile set it as "null" - `EBTcash` integer, required — The EBT cash on which the terminal / device to be boarded in traditional profile. If the epi is to be boarded on a surcharge Profile set it as 0 or 1 - `EBTcash1` integer, required — The EBT cash on which the terminal / device to be boarded in traditional profile. If the epi is to be boarded on a surcharge Profile set it as 0 or 1 - `EBTfood` integer — The EBT food on which the terminal / device to be boarded in traditional profile. If the epi is to be boarded on a surcharge Profile set it as 0 or 1 - `EBTfood1` integer, required — The EBT food on which the terminal / device to be boarded in traditional profile. If the epi is to be boarded on a surcharge Profile set it as 0 or 1 - `surchargeIndicator` integer, required — The value '0' means % and 1 means dollar - `surchargePercentage` string, required — If the epi is to be boarded on a traditional Profile set it as "null". Surcharge indicator % means the value should be (3.000) and dollar (3.00) - `label` string, required — The storename on which the device/terminal created is mapped on this field - `programType` string, required — If program type set as "surcharge" or "cashdiscount". - `vendor` integer - `client_id` string - `status` integer - `name_on_account` string - `auth_token` string — This value is required when the vendor ID is 2 - `app_key` string — This value is required when the vendor ID is 2 - `tsys_gen2` string - `gen2_code` string - `c_name3` string — If the parameter value is 1, it represents Valuetec; 2 it represents Factor4. - `tid3` string — This property belongs to Valuetec Gift card - `ClientID` string — This property belongs to Valuetec Gift card - `tid4` string - `clientID4` string - `location4` string - `integration_auth4` string - `integration_pwd4` string - `mid_flexfactor` string - `tid_flexfactor` string - `site_id_flexfactor` string - `app_key_flexfactor` string - `app_secret_flexfactor` string - `selectedState` string, required — The State which is selected to be sent on it with the State code - `s4f` string, required — 1 (sf4) or 2 (traditional) - `rollUp` string, required — Set value 0 or 1 (This value allows merchants to access the virtual terminal free of charge for 6 months) - `processor` string, required — Update the processor params 1 or 2 (TSYS - 1 and FD - 2) - `associate_user_name` string — ISO user name (Alphanumeric length of 35 chars) ## Response `200` 200 - object ## Other responses - `400` — 400 --- [API](https://skmtc.net/valorpaytech/apis/ecommerce-api.md) · [All operations](https://skmtc.net/valorpaytech/apis/ecommerce-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/valorpaytech/ecommerce-api/revisions/c6468b606325/schema)