POST api/Entities/Add/MerchantGroup

Request Information

URI Parameters

None.

Body Parameters

NewMerchantGroupItem
NameDescriptionTypeAdditional information
VAR

string

None.

EntityCommonName

string

None.

EntityCode

string

None.

TimeZone

integer

None.

FinancialInstitutionListID

integer

None.

IsSuperMerchant

boolean

None.

DailyLimit

decimal number

None.

IndividualLimit

decimal number

None.

AuthenticationCode

string

None.

SubMerchantPrefix

string

None.

BillingStructureID

integer

None.

BypassGoLiveCheckList

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "VAR": "sample string 1",
  "EntityCommonName": "sample string 2",
  "EntityCode": "sample string 3",
  "TimeZone": 4,
  "FinancialInstitutionListID": 1,
  "IsSuperMerchant": true,
  "DailyLimit": 6.0,
  "IndividualLimit": 7.0,
  "AuthenticationCode": "sample string 8",
  "SubMerchantPrefix": "sample string 9",
  "BillingStructureID": 10,
  "BypassGoLiveCheckList": true
}

application/xml, text/xml

Sample:
<NewMerchantGroupItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ConsoleAPI.Internal.Models.Entities">
  <AuthenticationCode>sample string 8</AuthenticationCode>
  <BillingStructureID>10</BillingStructureID>
  <BypassGoLiveCheckList>true</BypassGoLiveCheckList>
  <DailyLimit>6</DailyLimit>
  <EntityCode>sample string 3</EntityCode>
  <EntityCommonName>sample string 2</EntityCommonName>
  <FinancialInstitutionListID>1</FinancialInstitutionListID>
  <IndividualLimit>7</IndividualLimit>
  <IsSuperMerchant>true</IsSuperMerchant>
  <SubMerchantPrefix>sample string 9</SubMerchantPrefix>
  <TimeZone>4</TimeZone>
  <VAR>sample string 1</VAR>
</NewMerchantGroupItem>

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

Response Information

Resource Description

EntityValidationResult
NameDescriptionTypeAdditional 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>