--- title: "Merchant Add - Worldpay" method: POST path: "/api/valor/create?Worldpayadd" --- # Merchant Add - Worldpay `POST /api/valor/create?Worldpayadd` ## Headers - `Authorization` string, required - `isv-secret-key` string ## Request body - object - `legalName` string, required — Max length is 48 char - varchar (Ex: Quick book dba, Valor Cafe ) - `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) - `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 64 chars) - `userName` string, required — Merchant user name (Alphanumeric length of 35 chars) - `mobile` string, required — Merchnat phone number- 10 digit Numeric (Ex: 5247896523) - `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) - `legalState` string, required — State 2 chars of capital (Ex: New York - NY, California - CA) - `legalCountry` string, required — Legal country should be mention default set us US - `legalZipCode` string, required — Legal zip code should be 5 digits (Numeric - Ex: 10001, 90002) - `legalTimezone` string, required — Time zone (3 char eg: EST, AST ,PST, HST, MST) - `role` string — Should be set as '10' it is related to role of Merchant - `userType` integer, required — Should be set as '4' - User type for the merchant - `isTxnAllowed` string, required — Should be set isTxnAllowed default as '1' - `businessType` string, required — Should be sent as business type (varchar - Ex: Retail, Direct Marketing) - `storeData` object[], required - `storeName` string, required — Store name of Merchant (Max length is 48 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 — Store time zone (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 - `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 - `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[] - `midWorldpay` string, required — Merchant id related to the surcharge profile. If the epi is to be boarded on Traditional profile set it as "" - `midWorldpay1` string, json — Merchant id related to the traditional profile. If the epi is to be boarded on surcharge Profile sets it as "" - `termNoWorldpay` string, required — termNo mapped to the particular device / terminal in surcharge profile. If the epi is to be boarded on Traditional profile set it as "" - `termNoWorldpay1` string, json — termNo mapped to the particular device / terminal in surcharge profile. If the epi is to be boarded on Traditional profile set it as "" - `bankIdWorldpay` string, required — bankIdWorldpay mapped to the particular device / terminal in surcharge profile. If the epi is to be boarded on Traditional profile set it as "" - `bankIdWorldpay1` string, json — bankIdWorldpay mapped to the particular device / terminal in Traditional profile. If the epi is to be boarded on surcharge profile set it as "" - `EBTcash` integer — EBT cash related to the surcharge profile. If the epi is to be boarded on Traditional profile set it as 0 or 1 - `EBTcash1` integer, required — EBT cash related to the surcharge profile. If the epi is to be boarded on Traditional profile set it as 0 or 1 - `EBTfood` integer, required — EBT food related to the surcharge profile. If the epi is to be boarded on Traditional profile set it as 0 or 1 - `EBTfood1` integer, required — EBT food related to the traditional profile. If the epi is to be boarded on surcharge Profile sets it as 0 or 1 - `EbtNoWorldpay` string — Ebt number for the particular device / terminal in surcharge profile - `EbtNoWorldpay1` string — Ebt number for the particular device / terminal in traditional profile - `surchargeIndicator` integer — The value '0' means % and 1 means dollar - `surchargePercentage` string — 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". - `c_nameWorldpay3` string, required — This field is related to the gift card vendor: if the vendor is Valutec, assign 1; if the vendor is Factor4, assign 2. - `tidWorldpay3` string, required — Provide the Terminal ID value for Valutec (Numeric Max length 10) - `clientID_Worldpay` string, required — Provide the Client ID values for Valutec (Numeric Max length 36) - `tidWorldpay4` string — Provide the tidPayroc4 values for Factor4 (Numeric Max length 10) - `clientID_Worldpay4` string — Provide the clientID_Payroc4 values for Factor4 (Alphanumeric Max length 36) - `location_Worldpay4` string — Provide the location_Payroc4 values for Factor4 (Alphanumeric Max length 15) - `integration_authWorldpay4` string — Provide the integration_authWorldpay4 values for Factor4 (Alphanumeric Max length 64) - `integration_pwdWorldpay4` string — Provide the integration_pwdWorldpay4 values for Factor4 (Alphanumeric Max length 64) - `vendor` integer — 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) - `auth_token` string — This value is required when the vendor ID is 2. Provide the auth_token for ACHBANKING ( Numeric Max length 10) - `name_on_account` string — Provide the name_on_account for ACHBANKING (Alphanumeric Max length of 50) - `app_key` string — This value is required when the vendor ID is 2. Provide the app_key for ACHBANKING (Alphanumeric Max length 128) - `mid_flexfactor` string — This field is related to flexfactor, provide mid_flexfactor (Alphanumeric Max length 64) - `tid_flexfactor` string — This field is related to flexfactor, provide tid_flexfactor (Alphanumeric Max length 8) - `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) - `selectedState` string, required - `moduleList` integer[], required —
Module Module ID
User Management 1
Transactions 3
Settings 6
Virtual Terminal 14
Device Management 15
Engage My Customers 17
Promotions 18
Valor Shield RT 19
Contact Us 20
Support 24
My Tickets 25
Vault 29
- `selectedState` string, required — State 2 chars of capital (Ex: New York - NY, California - CA) - `processor` string, required — Update the processor params 11 - `rollUp` string, required — Set value 0 or 1 (This value allows merchants to access the virtual terminal free of charge for 6 months) - `programType` string, required — 1 (cash discount) or 2 (traditional) - `associate_user_name` string — ISO user name (Alphanumeric length of 35 chars) - `ActivationNotification` string — If the ActivationNotification is set to true, it indicates that an activation email will be sent to the merchant. If set to false, it means that no activation email will be sent. - `isv_user_name` string[] ## 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)