POST api/Entities/Changes/Merchant

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
POLiEntityID	globally unique identifier	None.
SubMerchantPrefix	string	None.
MerchantGroup	string	None.
Currency	string	None.
BankListCode	string	None.
TimeZone	integer	None.
Aggregated	boolean	None.
AllowRUReconciliation	boolean	None.
Hosted	boolean	None.
SelfSignup	boolean	None.
IsImportant	boolean	None.
Segment	string	None.
SegmentOther	string	None.
LegalName	string	None.
AuthorisedToApproveChanges	boolean	None.
AuthorisedToRejectChanges	boolean	None.
MerchantDetails	ContactDetailsItem	None.
BusinessManager	ContactDetailsItem	None.
TechnicalPerson	ContactDetailsItem	None.
Payments	ContactDetailsItem	None.
Administrator	ContactDetailsItem	None.
Finance	ContactDetailsItem	None.
Fraud	ContactDetailsItem	None.
Address	MerchantAddress	None.
TransactionActivity	TransactionActivity	None.
GoLiveInitiated	boolean	None.
GoLiveCheckList	GoLiveCheckList	None.
BypassGoLiveCheckList	boolean	None.
GoLiveInProgress	boolean	None.
BankAccounts	Collection of AccountDetailsItem	None.
RefundsDetails	Collection of RefundConfiguration	None.
BankAccountHistory	Collection of AccountDetailsItem	None.
TariffName	string	None.
Preferences	PreferencesItem	None.
POLiLinkConfiguration	POLiLinkConfigItem	None.
XeroConfiguration	XeroConfigItem	None.
HostedConfiguration	HostedConfigItem	None.
BillingEntityGroup	BillingStructureEntityGroup	None.
BillingStructure	BillingStructureToEntity	None.
PayIdBillingStructure	PayIdBillingStructureToEntity	None.
PayIDConfiguration	PayIDConfiguration	None.
WaaveConfiguration	WaaveConfiguration	None.
AkahuConfiguration	AkahuConfiguration	None.
MccCodes	Collection of MccCodeList	None.
BankPerTransactionLimits	Collection of BankPerTransactionLimit	None.
BankPerTransactionLimitsHistory	Collection of BankPerTransactionLimit	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

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 'BankAccounts[0]'.

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 'BankAccounts[0]'.

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

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>