POST api/Entities/Changes/MerchantGroup

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
MerchantGroupName	string	None.
VAR	string	None.
IsSuperMerchant	boolean	None.
SubMerchantPrefix	string	None.
BypassGoLiveCheckList	boolean	None.
MerchantDetails	ContactDetailsItem	None.
TimeZone	integer	None.
BillingEntityGroup	BillingStructureEntityGroup	None.
BillingStructure	BillingStructureToEntity	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.
IsShoppingCartMerchant	boolean	None.
MccCode	string	None.
MccTitle	string	None.

Request Formats

application/json, text/json

Sample:

{
  "MerchantGroupName": "sample string 1",
  "VAR": "sample string 2",
  "IsSuperMerchant": true,
  "SubMerchantPrefix": "sample string 4",
  "BypassGoLiveCheckList": true,
  "MerchantDetails": {
    "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
  },
  "TimeZone": 6,
  "BillingEntityGroup": {
    "BillingStructureEntityGroupID": 1,
    "Name": "sample string 2",
    "BillingStructureID": 3,
    "BillingStructureName": "sample string 4",
    "IsAggregated": true,
    "StartDate": "2026-04-07T20:06:49.2926677+10:00",
    "EndDate": "2026-04-07T20:06:49.2926677+10:00",
    "FeeFreePeriodEnd": "2026-04-07T20:06:49.2926677+10:00",
    "MemberCount": 8,
    "GroupEntities": [
      {
        "BillingStructureEntityGroupEntryID": 1,
        "BillingStructureEntityGroupID": 2,
        "POLiEntityID": "0c12b609-e85d-4827-bd80-5d1ee20e7112",
        "EntityCommonName": "sample string 4",
        "StartDate": "2026-04-07T20:06:49.2926677+10:00",
        "EndDate": "2026-04-07T20:06:49.2926677+10:00",
        "IsDefault": true
      },
      {
        "BillingStructureEntityGroupEntryID": 1,
        "BillingStructureEntityGroupID": 2,
        "POLiEntityID": "0c12b609-e85d-4827-bd80-5d1ee20e7112",
        "EntityCommonName": "sample string 4",
        "StartDate": "2026-04-07T20:06:49.2926677+10:00",
        "EndDate": "2026-04-07T20:06:49.2926677+10:00",
        "IsDefault": true
      }
    ]
  },
  "BillingStructure": {
    "BillingStructureToEntityID": 1,
    "BillingStructureID": 2,
    "BillingStructureName": "sample string 3",
    "POLiEntityID": "b71863a7-4925-4617-b9e3-ef41f3d6be18",
    "EntityCommonName": "sample string 5",
    "EntityCode": "sample string 6",
    "BillingStructureEntityGroupID": 1,
    "BillingGroupName": "sample string 7",
    "IsAggregated": true,
    "StartDate": "2026-04-07T20:06:49.2926677+10:00",
    "EndDate": "2026-04-07T20:06:49.2926677+10:00",
    "FeeFreePeriodEnd": "2026-04-07T20:06:49.2926677+10:00",
    "StatusCode": "sample string 11",
    "ActiveDate": "2026-04-07T20:06:49.2926677+10:00"
  },
  "EntityCode": "sample string 7",
  "EntityCommonName": "sample string 8",
  "EntityType": "sample string 9",
  "Status": "sample string 10",
  "EntityGoLiveDate": "2026-04-07T20:06:49.2926677+10:00",
  "EntityInactiveDate": "2026-04-07T20:06:49.2926677+10:00",
  "RegNo": "sample string 11",
  "RegNoLabel": "sample string 12",
  "IsTestMerchantAccount": true,
  "OperatingCountry": "sample string 14",
  "HasPendingChanges": true,
  "HasPendingBankAccountChanges": true,
  "QueryDuration": "00:00:00.1234567",
  "ReadOnly": true,
  "IsDeleteable": true,
  "TimeZoneID": 19,
  "ReconciliationGroupID": "sample string 20",
  "IsAggregated": true,
  "IsTestBankAccountConfigured": true,
  "FIListHasTestBank": true,
  "FinancialInstitutionListName": "sample string 24",
  "IsShoppingCartMerchant": true,
  "MccCode": "sample string 26",
  "MccTitle": "sample string 27"
}

application/xml, text/xml

Sample:

<MerchantGroupInfoItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ConsoleAPI.Internal.Models.Entities">
  <BypassGoLiveCheckList>false</BypassGoLiveCheckList>
  <EntityCode>sample string 7</EntityCode>
  <EntityCommonName>sample string 8</EntityCommonName>
  <EntityGoLiveDate>2026-04-07T20:06:49.2926677+10:00</EntityGoLiveDate>
  <EntityInactiveDate>2026-04-07T20:06:49.2926677+10:00</EntityInactiveDate>
  <EntityType>sample string 9</EntityType>
  <FIListHasTestBank>true</FIListHasTestBank>
  <FinancialInstitutionListName>sample string 24</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 26</MccCode>
  <MccTitle>sample string 27</MccTitle>
  <OperatingCountry>sample string 14</OperatingCountry>
  <QueryDuration>PT0.1234567S</QueryDuration>
  <ReadOnly>true</ReadOnly>
  <ReconciliationGroupID>sample string 20</ReconciliationGroupID>
  <RegNo>sample string 11</RegNo>
  <RegNoLabel>sample string 12</RegNoLabel>
  <Status>sample string 10</Status>
  <TimeZoneID>19</TimeZoneID>
  <BillingEntityGroup xmlns:d2p1="http://schemas.datacontract.org/2004/07/ConsoleAPI.Internal.Models.BillingStructure">
    <d2p1:BillingStructureEntityGroupID>1</d2p1:BillingStructureEntityGroupID>
    <d2p1:BillingStructureID>3</d2p1:BillingStructureID>
    <d2p1:BillingStructureName>sample string 4</d2p1:BillingStructureName>
    <d2p1:EndDate>2026-04-07T20:06:49.2926677+10:00</d2p1:EndDate>
    <d2p1:FeeFreePeriodEnd>2026-04-07T20:06:49.2926677+10:00</d2p1:FeeFreePeriodEnd>
    <d2p1:GroupEntities>
      <d2p1:BillingStructureEntityGroupEntry>
        <d2p1:BillingStructureEntityGroupEntryID>1</d2p1:BillingStructureEntityGroupEntryID>
        <d2p1:BillingStructureEntityGroupID>2</d2p1:BillingStructureEntityGroupID>
        <d2p1:EndDate>2026-04-07T20:06:49.2926677+10:00</d2p1:EndDate>
        <d2p1:EntityCommonName>sample string 4</d2p1:EntityCommonName>
        <d2p1:IsDefault>true</d2p1:IsDefault>
        <d2p1:POLiEntityID>0c12b609-e85d-4827-bd80-5d1ee20e7112</d2p1:POLiEntityID>
        <d2p1:StartDate>2026-04-07T20:06:49.2926677+10:00</d2p1:StartDate>
      </d2p1:BillingStructureEntityGroupEntry>
      <d2p1:BillingStructureEntityGroupEntry>
        <d2p1:BillingStructureEntityGroupEntryID>1</d2p1:BillingStructureEntityGroupEntryID>
        <d2p1:BillingStructureEntityGroupID>2</d2p1:BillingStructureEntityGroupID>
        <d2p1:EndDate>2026-04-07T20:06:49.2926677+10:00</d2p1:EndDate>
        <d2p1:EntityCommonName>sample string 4</d2p1:EntityCommonName>
        <d2p1:IsDefault>true</d2p1:IsDefault>
        <d2p1:POLiEntityID>0c12b609-e85d-4827-bd80-5d1ee20e7112</d2p1:POLiEntityID>
        <d2p1:StartDate>2026-04-07T20:06:49.2926677+10:00</d2p1:StartDate>
      </d2p1:BillingStructureEntityGroupEntry>
    </d2p1:GroupEntities>
    <d2p1:IsAggregated>true</d2p1:IsAggregated>
    <d2p1:MemberCount>8</d2p1:MemberCount>
    <d2p1:Name>sample string 2</d2p1:Name>
    <d2p1:StartDate>2026-04-07T20:06:49.2926677+10:00</d2p1:StartDate>
  </BillingEntityGroup>
  <BillingStructure xmlns:d2p1="http://schemas.datacontract.org/2004/07/ConsoleAPI.Internal.Models.BillingStructure">
    <d2p1:ActiveDate>2026-04-07T20:06:49.2926677+10:00</d2p1:ActiveDate>
    <d2p1:BillingGroupName>sample string 7</d2p1:BillingGroupName>
    <d2p1:BillingStructureEntityGroupID>1</d2p1:BillingStructureEntityGroupID>
    <d2p1:BillingStructureID>2</d2p1:BillingStructureID>
    <d2p1:BillingStructureName>sample string 3</d2p1:BillingStructureName>
    <d2p1:BillingStructureToEntityID>1</d2p1:BillingStructureToEntityID>
    <d2p1:EndDate>2026-04-07T20:06:49.2926677+10:00</d2p1:EndDate>
    <d2p1:EntityCode>sample string 6</d2p1:EntityCode>
    <d2p1:EntityCommonName>sample string 5</d2p1:EntityCommonName>
    <d2p1:FeeFreePeriodEnd>2026-04-07T20:06:49.2926677+10:00</d2p1:FeeFreePeriodEnd>
    <d2p1:IsAggregated>true</d2p1:IsAggregated>
    <d2p1:POLiEntityID>b71863a7-4925-4617-b9e3-ef41f3d6be18</d2p1:POLiEntityID>
    <d2p1:StartDate>2026-04-07T20:06:49.2926677+10:00</d2p1:StartDate>
    <d2p1:StatusCode>sample string 11</d2p1:StatusCode>
  </BillingStructure>
  <BypassGoLiveCheckList>true</BypassGoLiveCheckList>
  <IsSuperMerchant>true</IsSuperMerchant>
  <MerchantDetails>
    <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>
  </MerchantDetails>
  <MerchantGroupName>sample string 1</MerchantGroupName>
  <SubMerchantPrefix>sample string 4</SubMerchantPrefix>
  <TimeZone>6</TimeZone>
  <VAR>sample string 2</VAR>
</MerchantGroupInfoItem>

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 'MerchantGroupInfoItem'.

Response Information

Resource Description

ApiPostResultOfEntityValidationResult

Name	Type	Additional information
Success	boolean	None.
ErrorCode	PostError	None.
ErrorMessage	string	None.
Result	EntityValidationResult	None.

Response Formats

application/json, text/json

Sample:

{
  "Success": true,
  "ErrorCode": 0,
  "ErrorMessage": "sample string 2",
  "Result": {
    "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:

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