--- title: "Merchant Update" method: POST path: "/api/valor/update" --- # Merchant Update `POST /api/valor/update` ## Headers - `Authorization` string, required - `isv-secret-key` string ## Request body - object - `businessType` string — Should be sent as business type - `userType` string, required — Should be set as '4' - User type for the merchant - `isTxnAllowed` string, required — Should be set isTxnAllowed default as '1' - `legalName` string, required — Max length is 48 char - varchar (Ex: Quick book dba, Valor Cafe ) - `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) - `legalState` string, required — State 2 chars of capital (Ex: New York - NY, California - CA) - `dbaName` string, required — Max length is 48 char - varchar (Ex: SRM Hardware LLC, Merchant Firm Cafe) - `firstName` string, required — Max length is 35 char - varchar (First name of the Mechant) - `mobile` string, required — Phone number- 10 digit Numeric (Ex: 5247896523) - `lastName` string, required — Max length is 35 char - varchar (Last name of the Mechant) - `ownerName` string, required — Boarded by ISO & Sub-ISO name - varchar - `emailId` string, required — Merchant email id - Varchar (Ex: test@domain.com, Max length of 64chars) - `userName` string, required — Merchant user name (Alphanumeric length of 35 chars) - `legalAddress` string, required — Legal Address should be max 45 chars - Alphanumeric - `legalCity` string, required — City should be allowed max 50 chars of string (Ex: New York, San Francisco) - `legalCountry` string, required — Legal country should be mention default set us US - `legalTimezone` string, required — Sent with (3 char eg: EST,AST,PST,HST,MST) - `legalZipCode` string, required — Legal zip code should be 5 digits (Numeric - Ex: 10001, 90002) - `role` string, required — Should be set as '10' it is related to role of Merchant - `sicCode` string, required - `storeData` object[], required - `id` string, required — Store id of Merchant (Max length is 11 char) - `storeName` string, required — Store name of Merchant (Max length is 15 char) - `storeAddress` string, required — Store address should be max 25 chars - Alphanumeric - `storeCity` string, required — Store city should be allowed max 25 chars of string (Ex: New York, San Francisco) - `storeState` string, required — Store state 2 chars of capital (Ex: New York - NY, California - CA) - `storeCountry` string, required — Store country should be mention default set us US - `storeZipCode` string, required — Store zip code should be 5 digits (Numeric - Ex: 10001, 90002) - `storeTimezone` string, required — Sent with (3 char eg: EST,AST,PST,HST,MST) - `superVisorName` string, required — Name of the supervisor (Max length is 25 char) - `superVisorEmail` string, required — Supervisor email id - Varchar (Ex: test@domain.com, Max length of 50 chars) - `superVisorContact` string, required — Supervisor contact number 10 digit Numeric (Ex: 5247896523) - `mccCode` string, required — It should be 4 digit MCC (Ex: 8765, 5993) - `descriptors` string, required — It should be max length 100 chars - `epiData` object[] - `id` string, required — Merchant EPI profile ID (Max length of 11 chars) - `epi` string, required — EPI is an end point identifier, Identify the device on valor infrastructure, it's a 10 digit number starts with 2 - `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 — The processor which supports the merchant to be specified in this field, ProcessorID should be mentioned (Tsys : 1, FD : 2) - `epiLabel` string, required — Label description for the device /terminal. Max length 15 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, required — 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` string, 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, 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 - `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` string — This field is related to the ACH vendor: if the vendor is ACHECK21, assign 1; if the vendor is ACHBANKING, assign 2. - `client_id` string — Provide the name_on_account for ACHECK21 (Numeric Max Length for 10) - `status` string — Provide the status for ACHECK21/ACHBANKING (status as 1) - `name_on_account` string — Provide the name_on_account for ACHBANKING (Alphanumeric Max length of 50) - `auth_token` string — This value is required when the vendor ID is 2. Provide the auth_token for ACHBANKING ( Numeric Max length 10) - `app_key` string — This value is required when the vendor ID is 2. Provide the app_key for ACHBANKING (Alphanumeric Max length 128) - `tsys_gen2` string — Enable gen2 for tsys ( 0 or 1) - `gen2_code` string — Gen2 code for tsys (Alphanumeric Max length 10) - `c_name3` string — This field is related to the gift card vendor: if the vendor is Valutec, assign 1; if the vendor is Factor4, assign 2. - `tid3` string — Provide the Terminal ID value for Valutec (Numeric Max length 10) - `ClientID` string — Provide the Client ID values for Valutec (Numeric Max length 10) - `location4` string — Provide the location_Payroc4 values for Factor4 (Alphanumeric Max length 15) - `integration_auth4` string — Provide the integration_authPayroc4 values for Factor4 (Alphanumeric Max length 64) - `integration_pwd4` string — Provide the integration_pwdPayroc4 values for Factor4 (Alphanumeric Max length 64) - `mid_flexfactor` string — This field is related to flexfactor, provide mid_flexfactor (Alphanumeric Max length 64) - `tid_flexfactor` string — Retrieving data. Wait a few seconds and try to cut or copy again. - `site_id_flexfactor` string — This field is related to flexfactor, provide site_id_flexfactor (Alphanumeric Max length 64) - `app_key_flexfactor` string — This field is related to flexfactor, provide app_key_flexfactor (Alphanumeric Max length 128) - `app_secret_flexfactor` string — This field is related to flexfactor, provide app_secret_flexfactor (Alphanumeric Max length 256) - `source_epi` string — Source EPI is an end point identifier, Identify the device on valor infrastructure, it's a 10 digit number starts with 2 - `selectedState` string, required - `vat_number` string — Accepts alphanumeric characters only (no special characters allowed). Max length: 20 characters. - `processor` string, required — Update the processor params 1 or 2 (TSYS - 1 and FD - 2) - `rollUp` string, required — Set value 0 or 1 (This value allows merchants to access the virtual terminal free of charge for 6 months) - `selectedState` string, required — The State which is selected to be sent on it with the State code - `s4f` string, required - `associate_user_name` string - `isv_user_name` string[] — To associate with ISV - `remove_isv_user_name` string[] — To remove the associated ISV ## 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)