v1

latestOpenAPI 3.1.02026-08-0425501.2 MB

Merchant Add - Traditional (Tsys)

post/api/Valor/create

Request body

legalNamestring required

Max length is 48 char - varchar (Ex: Quick book dba, Valor Cafe )

dbaNamestring required

Max length is 48 char - varchar (Ex: SRM Hardware LLC, Merchant Firm Cafe)

firstNamestring required

Max length is 35 char - varchar (First name of the Mechant)

lastNamestring required

Max length is 35 char - varchar (Last name of the Mechant)

ownerNamestring required

Boarded by ISO & Sub-ISO name - varchar

emailIdstring required

Merchant email id - Varchar (Ex: test@domain.com, Max length of 64 chars)

userNamestring required

Merchant user name (Alphanumeric length of 35 chars)

mobilestring required

Mobile number of the merchant,max length is 10 digit

legalCitystring required

City should be allowed max 50 chars of string (Ex: New York, San Francisco)

legalAddressstring

Legal Address should be max 45 chars - Alphanumeric

legalStatestring required

State 2 chars of capital (Ex: New York - NY, California - CA)

legalCountrystring required

Legal country should be mention default set us US

legalZipCodestring required

Legal zip code should be 5 digits (Numeric - Ex: 10001, 90002)

legalTimezonestring required

Time zone (3 char eg: EST, AST ,PST, HST, MST)

roleinteger required

Should be set as '10' it is related to role of Merchant

userTypeinteger required

Should be set as '4' - User type for the merchant

isTxnAllowedinteger required

Should be set isTxnAllowed default as '1'

businessTypestring required

Should be sent as business type (varchar - Ex: Retail, Direct Marketing)

moduleListinteger[] required

<table class="valor_module_table"> <tr> <th>Module</th> <th>Module ID</th> </tr> <tr> <td>User Management</td> <td>1</td> </tr> <tr> <td>Transactions</td> <td>3</td> </tr> <tr> <td>Settings</td> <td>6</td> </tr> <tr> <td>Virtual Terminal</td> <td>14</td> </tr> <tr> <td>Device Management</td> <td>15</td> </tr> <tr> <td>Engage My Customers</td> <td>17</td> </tr> <tr> <td>Promotions</td> <td>18</td> </tr> <tr> <td>Valor Shield RT</td> <td>19</td> </tr> <tr> <td>Contact Us</td> <td>20</td> </tr> <tr> <td>Support</td> <td>24</td> </tr> <tr> <td>My Tickets</td> <td>25</td> </tr> <tr> <td>Vault</td> <td>29</td> </tr> </table>

passCodestring required

The password of the office login on which the merchant to be boarded

mailIdstring required

E-mail id of the parent ISO account - Varchar (Ex: test@domain.com, Max length of 50 chars)

SubmailIdstring required

Submail / the username of the Sub ISO office - Varchar (Ex: test@domain.com, Max length of 50 chars)

selectedStatestring required

State 2 chars of capital (Ex: New York - NY, California - CA)

processorinteger required

Update the processor params 1 (TSYS - 1)

rollUpinteger required

Set value 0 or 1 (This value allows merchants to access the virtual terminal free of charge for 6 months)

programTypestring required

1 (cash discount) or 2 (traditional)

ActivationNotificationboolean required

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.

Response

200

statusboolean

messagestring

Mp_idinteger

newUserIdinteger

datastring

Example response

{
  "status": true,
  "message": "User Added Successfully",
  "Mp_id": 18910,
  "newUserId": 38894,
  "StoreID": {
    "22442": [
      "2319917210"
    ]
  },
  "data": "Success"
}