Multi MID Merchant Boarding refers to the process of registering a single business (merchant) with multiple Merchant IDs (MIDs) under the same parent account or structure. This is commonly used in environments where different store locations, business lines, or departments need to be tracked and processed separately, while still being part of one main (parent) entity. In Multi MID Merchant Boarding, the parent merchant account creates multiple child MIDs for purposes like.
| Use Case | Example |
|---|---|
| Multiple Storefronts | One parent owns multiple physical stores or online brands |
| Separate Processing Rules | Each MID has different pricing, MCC codes, or surcharge programs |
| Financial Tracking | Track sales and settlements by department, location, or franchise |
| Device/Terminal Mapping | Assign separate MIDs for each terminal or register |
Multi MID Boarding API Request
TSYS Processor
{
"is_parent": "1",
"legalName": "Valor Store",
"dbaName": "Valor Store LLC",
"firstName": "123",
"lastName": "PORTAL",
"ownerName": "Boarded by name",
"emailId": "[email protected]",
"userName": "parent_boarding_demo",
"mobile": "8327287578",
"legalAddress": "Test Address",
"legalCity": "CLIFFSIDE PARK",
"legalState": "NJ",
"legalCountry": "US",
"legalZipCode": "07000",
"legalTimezone": "EST",
"role": "10",
"userType": "4",
"isTxnAllowed": "1",
"businessType": "Direct Marketing",
"moduleList": [
1,
3,
6,
15,
17,
18,
19,
20,
24,
25,
29
],
"selectedState": "NY",
"rollUp": "0",
"associate_user_name": "",
"storeData": [
{
"storeName": "test store name one",
"storeAddress": "test address for the store 1",
"storeCity": "MARICOPA",
"storeState": "AZ",
"storeCountry": "US",
"storeZipCode": "85138",
"storeTimezone": "EST",
"superVisorName": "Parent Supervisor",
"superVisorEmail": "[email protected]",
"superVisorContact": "5208396263",
"mccCode": "0154",
"descriptors": "ISO ACCESS PVT LTD",
"storeDBA": "Parent Store DBA",
"epiData": [
{
"device": "145",
"deviceType": "Handheld POS",
"processor": "1",
"epiLabel": "label for 145 device",
"processorData": []
},
{
"device": "235",
"deviceType": "Smart POS",
"processor": "1",
"epiLabel": "label for 145 device",
"processorData": []
}
]
}
],
"ChildData": [
[
{
"user_name": "child_boarding_demo",
"email": "[email protected]",
"firstName": "child riya",
"Last_name": "test ",
"Phone": "8870086595",
"processor": "1",
"device": "145",
"programType": "1",
"mccCode": "0171",
"processor_data": {
"mid": "887000003193",
"mid1": "",
"vNumber": "75021674",
"vNumber1": "",
"storeNo": "5999",
"storeNo1": "",
"termNo": "1515",
"termNo1": "",
"association": "949006",
"association1": "",
"chain": "111111",
"chain1": "",
"agent": "0001",
"agent1": "",
"EbtNo": "",
"EbtNo1": "",
"binnumber": "999991",
"binnumber1": "",
"agentBank": "000000",
"agentBank1": "",
"industry": "Retail",
"industry1": "",
"EBTcash": 0,
"EBTcash1": 0,
"EBTfood": 0,
"EBTfood1": 0,
"surchargeIndicator": 0,
"surchargePercentage": "4.00",
"label": "MERCHANT PORTAL LOGIN",
"programType": "surcharge"
},
"profile_name": "demo_answer_profile_child_1"
}
],
[
{
"user_name": "child_two_boarding_demo",
"email": "[email protected]",
"firstName": "child riya",
"Last_name": "test ",
"Phone": "8870086595",
"processor": "1",
"device": "235",
"programType": "1",
"mccCode": "1711",
"processor_data": {
"mid": "887000003194",
"mid1": "",
"vNumber": "75021675",
"vNumber1": "",
"storeNo": "5999",
"storeNo1": "",
"termNo": "1515",
"termNo1": "",
"association": "949006",
"association1": "",
"chain": "111111",
"chain1": "",
"agent": "0001",
"agent1": "",
"EbtNo": "",
"EbtNo1": "",
"binnumber": "999991",
"binnumber1": "",
"agentBank": "000000",
"agentBank1": "",
"industry": "Retail",
"industry1": "",
"EBTcash": 0,
"EBTcash1": 0,
"EBTfood": 0,
"EBTfood1": 0,
"surchargeIndicator": 0,
"surchargePercentage": "4.00",
"label": "MERCHANT PORTAL LOGIN",
"programType": "surcharge"
},
"profile_name": "demo_answer_profile_child_3"
}
]
]
}
FD Processor
{
"is_parent": "1",
"legalName": "Valor Store",
"dbaName": "Valor Store LLC",
"firstName": "123",
"lastName": "PORTAL",
"ownerName": "Boarded by name",
"emailId": "[email protected]",
"userName": "parent_boarding_demo",
"mobile": "8327287578",
"legalAddress": "Test Address",
"legalCity": "CLIFFSIDE PARK",
"legalState": "NJ",
"legalCountry": "US",
"legalZipCode": "07000",
"legalTimezone": "EST",
"role": "10",
"userType": "4",
"isTxnAllowed": "1",
"businessType": "Direct Marketing",
"moduleList": [
1,
3,
6,
15,
17,
18,
19,
20,
24,
25,
29
],
"selectedState": "NY",
"rollUp": "0",
"associate_user_name": "",
"storeData": [
{
"storeName": "test store name one",
"storeAddress": "test address for the store 1",
"storeCity": "MARICOPA",
"storeState": "AZ",
"storeCountry": "US",
"storeZipCode": "85138",
"storeTimezone": "EST",
"superVisorName": "Parent Supervisor",
"superVisorEmail": "[email protected]",
"superVisorContact": "5208396263",
"mccCode": "0154",
"descriptors": "ISO ACCESS PVT LTD",
"storeDBA": "Parent Store DBA",
"epiData": [
{
"device": "145",
"deviceType": "Handheld POS",
"processor": "1",
"epiLabel": "label for 145 device",
"processorData": []
},
{
"device": "235",
"deviceType": "Smart POS",
"processor": "1",
"epiLabel": "label for 145 device",
"processorData": []
}
]
}
],
"ChildData": [
[
{
"user_name": "child_boarding_demo",
"email": "[email protected]",
"firstName": "child riya",
"Last_name": "test ",
"Phone": "8870086595",
"processor": "2",
"device": "145",
"programType": "1",
"mccCode": "0171",
"processor_data": {
"surchargePercentage": "3.846",
"groupId": "",
"groupId1": "40001",
"midFD": "",
"midFD1": "RCTST00000506356",
"termNoFD": "",
"termNoFD1": "OM134524",
"EbtNoFD": "",
"EbtNoFD1": "RCTST00000506357",
"website": "",
"website1": "www.abc.com",
"mid3": "",
"termNo3": "",
"location_id": "",
"client_key": "",
"c_name": "",
"EBTfood": 1,
"EBTfood1": 0,
"EBTcash": 0,
"EBTcash1": 0,
"surchargeIndicator": 0,
"label": "UNIVERSAL ROOFING SPECIALISTS",
"programType": "surcharge"
},
"profile_name": "demo_answer_profile_child_1"
}
],
[
{
"user_name": "child_two_boarding_demo",
"email": "[email protected]",
"firstName": "child riya",
"Last_name": "test ",
"Phone": "8870086595",
"processor": "2",
"device": "235",
"programType": "1",
"mccCode": "1711",
"processor_data": {
"surchargePercentage": "3.846",
"groupId": "",
"groupId1": "40001",
"midFD": "",
"midFD1": "RCTST00000506356",
"termNoFD": "",
"termNoFD1": "OM134524",
"EbtNoFD": "",
"EbtNoFD1": "RCTST00000506357",
"website": "",
"website1": "www.abc.com",
"mid3": "",
"termNo3": "",
"location_id": "",
"client_key": "",
"c_name": "",
"EBTfood": 1,
"EBTfood1": 0,
"EBTcash": 0,
"EBTcash1": 0,
"surchargeIndicator": 0,
"label": "UNIVERSAL ROOFING SPECIALISTS",
"programType": "surcharge"
},
"profile_name": "demo_answer_profile_child_3"
}
]
]
}
Query Parameters
| Fields | Type | Length | Mandatory/Optional | Example Value | Description |
|---|---|---|---|---|---|
| is_parent | Number | 1 | Mandatory | 1 | Multi Merchant parent boarding |
| legalName | String | 15 | Mandatory | Valor Cafe | Ex: Quick book dba, Valor Cafe |
| dbaName | String | 15 | Mandatory | Valor Store LLC | Ex: SRM Hardware LLC, Merchant Firm Cafe |
| firstName | String | 15 | Mandatory | MERCHANT | First name of the Merchant |
| lastName | String | 15 | Mandatory | PORTAL | Last name of the Merchant |
| ownerName | String | 15 | Mandatory | MERCHANT PORTAL | Boarded by ISO & Sub-ISO name |
| emailId | String | 50 | Mandatory | [email protected] | Merchant email id |
| userName | String | 35 | Mandatory | merchat310823 | Merchant user name |
| mobile | String | 10 | Mandatory | 8327287578 | Merchant phone number- 10 digit Numeric |
| legalAddress | String | 100 | Mandatory | Test Address | Legal Address should be max 100 chars - Alphanumeric |
| legalCity | String | 50 | Mandatory | CLIFFSIDE PARK | City should be allowed max 50 chars of string (Ex: New York, San Francisco) |
| legalState | String | 2 | Mandatory | NJ | State 2 chars of capital (Ex: New York - NY, California - CA) |
| legalCountry | String | 2 | Mandatory | US | Legal country should be mention default set us US |
| legalZipCode | String | 5 | Mandatory | 07010 | Legal zip code should be 5 digits (Numeric - Ex: 10001, 90002) |
| legalTimezone | String | 3 | Mandatory | EST | Time zone (3 char eg: EST, AST ,PST, HST, MST) |
| role | String | 2 | Optional | 10 | Should be set as '10' it is related to role of Merchant |
| userType | string | 1 | Mandatory | 4 | Should be set as '4' - User type for the merchant |
| isTxnAllowed | string | 1 | Mandatory | 1 | Should be set isTxnAllowed default as '1' |
| businessType | string | 10 | Mandatory | Oil Company/Automated | Should be sent as business type |
| selectedState | string | 2 | Mandatory | NJ | State 2 chars of capital (Ex: New York - NY, California - CA) |
| rollUp | string | 1 | Mandatory | 0 | Set value 0 or 1 (This value allows merchants to access the virtual terminal free of charge for 6 months) |
| associate_user_name | string | 35 | Optional | Tesst45 | ISO user name (Alphanumeric length of 35 chars) |
| storeName | string | 15 | Mandatory | EL TRI MX RESTA | Add Store name of Merchant (Max length is 15 char) |
| storeAddress | string | 100 | Mandatory | 4100 JOHNSTON ST | Store address should be max 100 chars - Alphanumeric |
| storeCity | string | 50 | Mandatory | LAFAYETTE | Store city should be allowed max 50 chars of string (Ex: New York, San Francisco) |
| storeState | string | 2 | Mandatory | LA | Store state 2 chars of capital (Ex: New York - NY, California - CA) |
| storeCountry | string | Mandatory | US | Store country should be mention default set us US | |
| storeZipCode | string | 5 | Mandatory | 70503 | Store zip code should be 5 digits (Numeric - Ex: 10001, 90002) |
| storeTimezone | string | 3 | Mandatory | EST | Store time zone (3 char eg: EST,AST,PST,HST,MST) |
| superVisorName | string | 25 | Mandatory | EL TRI MX RESTA | Name of the supervisor (Max length is 25 char) |
| superVisorEmail | string | 50 | Mandatory | [email protected] | Supervisor email id - Varchar (Ex: [email protected], Max length of 50 chars) |
| superVisorContact | string | 10 | Mandatory | 3377040344 | Supervisor contact number 10 digit Numeric (Ex: 5247896523) |
| mccCode | string | 4 | Mandatory | 5812 | It should be 4 digit MCC (Ex: 8765, 5993) |
| descriptors | string | 25 | Mandatory | ISO ACCESS PVT LTD | It should be 25 chars |
| storeDBA | string | 15 | Mandatory | Parent Store DBA | Max length is 15 char - varchar (Ex: SRM Hardware LLC, Merchant Firm Cafe) |
| device | string | Mandatory | 145 | The model description of the device to be boarded for that merchant. Have to pass the 'Device ID' | |
| deviceType | string | Mandatory | Handheld POSprocessor | The type description of the device / terminal Possible Options. | |
| processor | string | 1 | Mandatory | 1 | Update the processor params 1 or 2 (TSYS - 1 and FD - 2) |
| epiLabel | string | 15 | Optional | label for 145 device | Label description for the device /terminal. Max length 15 char |
| processorData | array | Mandatory | [] | Parent processorData should be empty array | |
| user_name | string | 35 | Mandatory | Child merchant one | Child EPI user name (Alphanumeric length of 35 chars) |
| string | 50 | Mandatory | [email protected] | Child EPI email id - Varchar (Ex: [email protected], Max length of 50 chars) | |
| firstName | string | 15 | Mandatory | MERCHANT | Max length is 15 char - varchar (First name of the Child EPI) |
| Last_name | string | 15 | Mandatory | PORTAL | Max length is 15 char - varchar (Last name of the Child EPI) |
| Phone | string | 10 | Mandatory | 8327287578 | Child EPI phone number- 10 digit Numeric (Ex: 5247896523) |
| processor | string | 1 | Mandatory | 1 | Update the processor params 1 or 2 (TSYS - 1 and FD - 2). The processor value should be similar with the parent device processor value |
| device | string | Mandatory | 145 | The model description of the device to be boarded for that merchant. Have to pass the 'Device ID'.The device value should be similar with the parent device value | |
| programType | string | Mandatory | 1 | 1 (cash discount) or 2 (traditional) | |
| mccCode | string | 4 | Mandatory | 0171 | It should be 4 digit MCC (Ex: 8765, 5993) |
| processor_data | object | Mandatory | |||
| mid | string | Mandatory | 887000003193 | Merchant id related to the surcharge profile. If the epi is to be boarded on Traditional profile set it as "null" | |
| mid1 | string | Mandatory | "" | Merchant id related to the traditional profile. If the epi is to be boarded on surcharge Profile sets it as "null" | |
| vNumber | string | Mandatory | 75021674 | 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 | Mandatory | "" | 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 | Mandatory | 5999 | 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 | Mandatory | "" | 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 | Mandatory | 1515 | 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 | Mandatory | "" | 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 | Mandatory | 949006 | 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 | Mandatory | "" | 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 | Mandatory | 111111 | 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 | Mandatory | "" | 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 | Mandatory | |||
| agent1 | string | Mandatory | |||
| industry | string | Mandatory | Direct Marketing | 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 | Mandatory | "" | 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" | |
| EBTfood | int32 | Mandatory | Defaults to 0 | EBT food related to the surcharge profile. If the epi is to be boarded on Traditional profile set it as 0 or 1 | |
| EBTfood1 | int32 | Mandatory | Defaults to 0 | EBT food related to the traditional profile. If the epi is to be boarded on surcharge Profile sets it as 0 or 1 | |
| EBTcash | int32 | Mandatory | Defaults to 0 | EBT cash related to the surcharge profile. If the epi is to be boarded on Traditional profile set it as 0 or 1 | |
| EBTcash1 | int32 | Mandatory | Defaults to 0 | EBT cash related to the traditional profile. If the epi is to be boarded on surcharge Profile sets it as 0 or 1 | |
| EbtNo | int32 | Mandatory | |||
| EbtNo1 | int32 | Mandatory | |||
| binnumber | string | Mandatory | |||
| binnumber1 | string | Mandatory | |||
| surchargePercentage | string | Mandatory | "" | If the epi is to be boarded on a surcharge Profile set it as "null" | |
| label | string | Mandatory | MERCHANT PORTAL LOGIN | The storename on which the device/terminal created is mapped on this field | |
| surchargeIndicator | int32 | Mandatory | Defaults to 0 | The value '0' means % and 1 means dollar | |
| programType | string | Mandatory | surcharge | If program type set as "surcharge" or "cashdiscount". | |
| profile_name | string | 15 | Mandatory | Merchant profile | Child EPI profile name (Alphanumeric length of 35 chars) |
| ChildData | Arrayof arrayof object | Mandatory | If user add more than 1 device, the childData structure should be array of arrayof objects. Eg: ChildData : [[{user_name : child Merchant one }], [{user_name:child Merchant two}]] |