v1

latestOpenAPI 3.1.02026-08-0425501.2 MB

Merchant Add - Surcharge (Tsys)

post/api/valor/create?surchargetsys

Headers

Authorizationstring

Generated bearer token for Admin login <a target="_blank" href="/reference/merchant-create-bearer-token"><b>Generate Bearer Token</b></a>

isv-secret-keystring

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 Merchant)

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

Merchnat phone number- 10 digit Numeric (Ex: 5247896523)

legalAddressstring required

Legal Address should be max 45 chars - Alphanumeric

legalCitystring required

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

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)

rolestring required

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

legalTimezonestring required

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

userTypestring required

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

isTxnAllowedstring required

Should be set isTxnAllowed default as '1'

businessTypestring

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

moduleListinteger[] required

<table> <tbody><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> </tbody></table>

selectedStatestring required

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

processorstring required

Update the processor params 1 (TSYS - 1)

programTypestring required

1 (cash discount) or 2 (traditional)

rollUpstring required

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

associate_user_namestring

ISO user name (Alphanumeric length of 35 chars)

ActivationNotificationboolean

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_namestring[]

Response

200

object required