POST api/Entities/Add/Merchant

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
EntityCommonName	string	None.
EntityCode	string	None.
MerchantGroup	string	None.
BankListCode	string	None.
UseMerchantRef	boolean	None.
NudgeFailureEmail	boolean	None.
CompletedEmail	boolean	None.
Important	boolean	None.
AuthenticationCode	string	None.
RegNo	string	None.
IsTestMerchantAccount	boolean	None.
RegistrationNumberLabel	string	None.
Aggregated	boolean	None.
SegmentCode	string	None.
SupportDetails	ContactDetailsItem	None.
Preferences	NewMerchantPreferences	None.
Account	AccountDetailsItem	None.
MerchantAddressDetails	MerchantAddress	None.
IsCustomerGroup	boolean	None.
MccCode	string	None.

Request Formats

application/json

Sample:

An exception has occurred while using the formatter 'JsonMediaTypeFormatter' to generate sample for media type 'application/json'. Exception message: Self referencing loop detected for property 'CurrentAccountDetails' with type 'ConsoleAPI.Internal.Models.Entities.AccountDetailsItem'. Path 'Account'.

text/json

Sample:

An exception has occurred while using the formatter 'JsonMediaTypeFormatter' to generate sample for media type 'text/json'. Exception message: Self referencing loop detected for property 'CurrentAccountDetails' with type 'ConsoleAPI.Internal.Models.Entities.AccountDetailsItem'. Path 'Account'.

application/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: Object graph for type 'ConsoleAPI.Internal.Models.Entities.AccountDetailsItem' contains cycles and cannot be serialized if reference tracking is disabled.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: Object graph for type 'ConsoleAPI.Internal.Models.Entities.AccountDetailsItem' contains cycles and cannot be serialized if reference tracking is disabled.

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

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>