POST api/Entities/Add/SubMerchant

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
SuperMerchant	string	None.
SupportDetails	ContactDetailsItem	None.
EntityCode	string	None.
EntityCommonName	string	None.
EntityType	string	None.
Status	string	None.
EntityGoLiveDate	date	None.
EntityInactiveDate	date	None.
RegNo	string	None.
RegNoLabel	string	None.
IsTestMerchantAccount	boolean	None.
OperatingCountry	string	None.
HasPendingChanges	boolean	None.
HasPendingBankAccountChanges	boolean	None.
QueryDuration	time interval	None.
ReadOnly	boolean	None.
IsDeleteable	boolean	None.
TimeZoneID	integer	None.
ReconciliationGroupID	string	None.
IsAggregated	boolean	None.
IsTestBankAccountConfigured	boolean	None.
FIListHasTestBank	boolean	None.
FinancialInstitutionListName	string	None.
BypassGoLiveCheckList	boolean	None.
IsShoppingCartMerchant	boolean	None.
MccCode	string	None.
MccTitle	string	None.

Request Formats

application/json, text/json

Sample:

{
  "SuperMerchant": "sample string 1",
  "SupportDetails": {
    "Name": "sample string 1",
    "ContactNumber": "sample string 2",
    "Email": "sample string 3",
    "MerchantGroupID": "sample string 4",
    "EntityCode": "sample string 5",
    "EntityCommonName": "sample string 6",
    "StatementEntityID": 7,
    "ContactType": "sample string 8",
    "URL": "sample string 9",
    "Mobile": "sample string 10",
    "Empty": false
  },
  "EntityCode": "sample string 2",
  "EntityCommonName": "sample string 3",
  "EntityType": "sample string 4",
  "Status": "sample string 5",
  "EntityGoLiveDate": "2026-04-07T20:12:16.6264431+10:00",
  "EntityInactiveDate": "2026-04-07T20:12:16.6264431+10:00",
  "RegNo": "sample string 6",
  "RegNoLabel": "sample string 7",
  "IsTestMerchantAccount": true,
  "OperatingCountry": "sample string 9",
  "HasPendingChanges": true,
  "HasPendingBankAccountChanges": true,
  "QueryDuration": "00:00:00.1234567",
  "ReadOnly": true,
  "IsDeleteable": true,
  "TimeZoneID": 14,
  "ReconciliationGroupID": "sample string 15",
  "IsAggregated": true,
  "IsTestBankAccountConfigured": true,
  "FIListHasTestBank": true,
  "FinancialInstitutionListName": "sample string 19",
  "BypassGoLiveCheckList": true,
  "IsShoppingCartMerchant": true,
  "MccCode": "sample string 22",
  "MccTitle": "sample string 23"
}

application/xml, text/xml

Sample:

<NewSubMerchantItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ConsoleAPI.Internal.Models.Entities">
  <BypassGoLiveCheckList>true</BypassGoLiveCheckList>
  <EntityCode>sample string 2</EntityCode>
  <EntityCommonName>sample string 3</EntityCommonName>
  <EntityGoLiveDate>2026-04-07T20:12:16.6264431+10:00</EntityGoLiveDate>
  <EntityInactiveDate>2026-04-07T20:12:16.6264431+10:00</EntityInactiveDate>
  <EntityType>sample string 4</EntityType>
  <FIListHasTestBank>true</FIListHasTestBank>
  <FinancialInstitutionListName>sample string 19</FinancialInstitutionListName>
  <HasPendingBankAccountChanges>true</HasPendingBankAccountChanges>
  <HasPendingChanges>true</HasPendingChanges>
  <IsAggregated>true</IsAggregated>
  <IsDeleteable>true</IsDeleteable>
  <IsShoppingCartMerchant>true</IsShoppingCartMerchant>
  <IsTestBankAccountConfigured>true</IsTestBankAccountConfigured>
  <IsTestMerchantAccount>true</IsTestMerchantAccount>
  <MccCode>sample string 22</MccCode>
  <MccTitle>sample string 23</MccTitle>
  <OperatingCountry>sample string 9</OperatingCountry>
  <QueryDuration>PT0.1234567S</QueryDuration>
  <ReadOnly>true</ReadOnly>
  <ReconciliationGroupID>sample string 15</ReconciliationGroupID>
  <RegNo>sample string 6</RegNo>
  <RegNoLabel>sample string 7</RegNoLabel>
  <Status>sample string 5</Status>
  <TimeZoneID>14</TimeZoneID>
  <SupportDetails>
    <ContactNumber>sample string 2</ContactNumber>
    <ContactType>sample string 8</ContactType>
    <Email>sample string 3</Email>
    <EntityCode>sample string 5</EntityCode>
    <EntityCommonName>sample string 6</EntityCommonName>
    <MerchantGroupID>sample string 4</MerchantGroupID>
    <Mobile>sample string 10</Mobile>
    <Name>sample string 1</Name>
    <StatementEntityID>7</StatementEntityID>
    <URL>sample string 9</URL>
  </SupportDetails>
  <SuperMerchant>sample string 1</SuperMerchant>
</NewSubMerchantItem>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'NewSubMerchantItem'.

Response Information

Resource Description

EntityValidationResult

Name	Type	Additional information
Success	boolean	None.
ChangesFound	boolean	None.
Pending	boolean	None.
Errors	Collection of ItemValidation	None.

Response Formats

application/json, text/json

Sample:

{
  "Success": true,
  "ChangesFound": true,
  "Pending": true,
  "Errors": [
    {
      "FieldName": "sample string 1",
      "Message": "sample string 2"
    },
    {
      "FieldName": "sample string 1",
      "Message": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:

<EntityValidationResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ConsoleAPI.Internal.Models.Entities">
  <ChangesFound>true</ChangesFound>
  <Errors>
    <ItemValidation>
      <FieldName>sample string 1</FieldName>
      <Message>sample string 2</Message>
    </ItemValidation>
    <ItemValidation>
      <FieldName>sample string 1</FieldName>
      <Message>sample string 2</Message>
    </ItemValidation>
  </Errors>
  <Pending>true</Pending>
  <Success>true</Success>
</EntityValidationResult>