ApService Web Service

ApService

Click here for a complete list of operations.

RetrieveMerchantLogHistory

Retrieve a list of changes made to a merchant log.

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /services/APService.asmx HTTP/1.1
Host: services.encompass-suite.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://aocsolutions.com/EncompassWebServices/RetrieveMerchantLogHistory"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <RetrieveMerchantLogHistory xmlns="http://aocsolutions.com/EncompassWebServices/">
      <user>
        <OrgGroupLoginId>string</OrgGroupLoginId>
        <Username>string</Username>
        <Password>string</Password>
      </user>
      <request>
        <BankNumber>string</BankNumber>
        <CompanyNumber>string</CompanyNumber>
        <MerchantLogUniqueId>string</MerchantLogUniqueId>
      </request>
    </RetrieveMerchantLogHistory>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <RetrieveMerchantLogHistoryResponse xmlns="http://aocsolutions.com/EncompassWebServices/">
      <RetrieveMerchantLogHistoryResult>
        <ResponseCode>Success or Failed or InvalidUserCredentials or AwaitingApproval or InvalidUserDefinedFieldname or NoPrivilege or MerchantLogNotFound or StandardFieldValidationFailed or UserDefinedFieldValidationFailed or InvalidOrganization or UnavailableAtThisTime or InsufficientCreditLimit or NotFound or InvalidProductCode</ResponseCode>
        <History>
          <MerchantLogHistory>
            <MerchantLogUniqueId>string</MerchantLogUniqueId>
            <ChangeDate>dateTime</ChangeDate>
            <Status>Closed or Open or Reconciled or Matched or Expired or Error or WaitingForApproval or Overdrawn or InsufficientFunds or Pending or Unvalidated or WaitingForFileApproval or Rejected</Status>
            <Amount>decimal</Amount>
            <MerchantCode>string</MerchantCode>
            <MerchantName>string</MerchantName>
            <AccountNo>string</AccountNo>
            <PaymentMethod>string</PaymentMethod>
            <OperationName>string</OperationName>
            <LastUpdatedApplication>string</LastUpdatedApplication>
            <MccCode>string</MccCode>
            <DeliveryAddress>string</DeliveryAddress>
            <DeliveryMethod>None or Email or Fax or Both</DeliveryMethod>
            <IsAccountViewEnabled>boolean</IsAccountViewEnabled>
            <AccountViewPIN>string</AccountViewPIN>
            <AccountViewPINFails>int</AccountViewPINFails>
            <ActiveFromDate>string</ActiveFromDate>
            <ActiveToDate>string</ActiveToDate>
            <ResendNotification>boolean</ResendNotification>
            <Currency>string</Currency>
            <ExpirationDate>dateTime</ExpirationDate>
            <ExpirationReminderDate>dateTime</ExpirationReminderDate>
            <HasTransaction>boolean</HasTransaction>
            <UserDefinedFields xsi:nil="true" />
          </MerchantLogHistory>
          <MerchantLogHistory>
            <MerchantLogUniqueId>string</MerchantLogUniqueId>
            <ChangeDate>dateTime</ChangeDate>
            <Status>Closed or Open or Reconciled or Matched or Expired or Error or WaitingForApproval or Overdrawn or InsufficientFunds or Pending or Unvalidated or WaitingForFileApproval or Rejected</Status>
            <Amount>decimal</Amount>
            <MerchantCode>string</MerchantCode>
            <MerchantName>string</MerchantName>
            <AccountNo>string</AccountNo>
            <PaymentMethod>string</PaymentMethod>
            <OperationName>string</OperationName>
            <LastUpdatedApplication>string</LastUpdatedApplication>
            <MccCode>string</MccCode>
            <DeliveryAddress>string</DeliveryAddress>
            <DeliveryMethod>None or Email or Fax or Both</DeliveryMethod>
            <IsAccountViewEnabled>boolean</IsAccountViewEnabled>
            <AccountViewPIN>string</AccountViewPIN>
            <AccountViewPINFails>int</AccountViewPINFails>
            <ActiveFromDate>string</ActiveFromDate>
            <ActiveToDate>string</ActiveToDate>
            <ResendNotification>boolean</ResendNotification>
            <Currency>string</Currency>
            <ExpirationDate>dateTime</ExpirationDate>
            <ExpirationReminderDate>dateTime</ExpirationReminderDate>
            <HasTransaction>boolean</HasTransaction>
            <UserDefinedFields xsi:nil="true" />
          </MerchantLogHistory>
        </History>
        <Description>string</Description>
      </RetrieveMerchantLogHistoryResult>
    </RetrieveMerchantLogHistoryResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /services/APService.asmx HTTP/1.1
Host: services.encompass-suite.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <RetrieveMerchantLogHistory xmlns="http://aocsolutions.com/EncompassWebServices/">
      <user>
        <OrgGroupLoginId>string</OrgGroupLoginId>
        <Username>string</Username>
        <Password>string</Password>
      </user>
      <request>
        <BankNumber>string</BankNumber>
        <CompanyNumber>string</CompanyNumber>
        <MerchantLogUniqueId>string</MerchantLogUniqueId>
      </request>
    </RetrieveMerchantLogHistory>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <RetrieveMerchantLogHistoryResponse xmlns="http://aocsolutions.com/EncompassWebServices/">
      <RetrieveMerchantLogHistoryResult>
        <ResponseCode>Success or Failed or InvalidUserCredentials or AwaitingApproval or InvalidUserDefinedFieldname or NoPrivilege or MerchantLogNotFound or StandardFieldValidationFailed or UserDefinedFieldValidationFailed or InvalidOrganization or UnavailableAtThisTime or InsufficientCreditLimit or NotFound or InvalidProductCode</ResponseCode>
        <History>
          <MerchantLogHistory>
            <MerchantLogUniqueId>string</MerchantLogUniqueId>
            <ChangeDate>dateTime</ChangeDate>
            <Status>Closed or Open or Reconciled or Matched or Expired or Error or WaitingForApproval or Overdrawn or InsufficientFunds or Pending or Unvalidated or WaitingForFileApproval or Rejected</Status>
            <Amount>decimal</Amount>
            <MerchantCode>string</MerchantCode>
            <MerchantName>string</MerchantName>
            <AccountNo>string</AccountNo>
            <PaymentMethod>string</PaymentMethod>
            <OperationName>string</OperationName>
            <LastUpdatedApplication>string</LastUpdatedApplication>
            <MccCode>string</MccCode>
            <DeliveryAddress>string</DeliveryAddress>
            <DeliveryMethod>None or Email or Fax or Both</DeliveryMethod>
            <IsAccountViewEnabled>boolean</IsAccountViewEnabled>
            <AccountViewPIN>string</AccountViewPIN>
            <AccountViewPINFails>int</AccountViewPINFails>
            <ActiveFromDate>string</ActiveFromDate>
            <ActiveToDate>string</ActiveToDate>
            <ResendNotification>boolean</ResendNotification>
            <Currency>string</Currency>
            <ExpirationDate>dateTime</ExpirationDate>
            <ExpirationReminderDate>dateTime</ExpirationReminderDate>
            <HasTransaction>boolean</HasTransaction>
            <UserDefinedFields xsi:nil="true" />
          </MerchantLogHistory>
          <MerchantLogHistory>
            <MerchantLogUniqueId>string</MerchantLogUniqueId>
            <ChangeDate>dateTime</ChangeDate>
            <Status>Closed or Open or Reconciled or Matched or Expired or Error or WaitingForApproval or Overdrawn or InsufficientFunds or Pending or Unvalidated or WaitingForFileApproval or Rejected</Status>
            <Amount>decimal</Amount>
            <MerchantCode>string</MerchantCode>
            <MerchantName>string</MerchantName>
            <AccountNo>string</AccountNo>
            <PaymentMethod>string</PaymentMethod>
            <OperationName>string</OperationName>
            <LastUpdatedApplication>string</LastUpdatedApplication>
            <MccCode>string</MccCode>
            <DeliveryAddress>string</DeliveryAddress>
            <DeliveryMethod>None or Email or Fax or Both</DeliveryMethod>
            <IsAccountViewEnabled>boolean</IsAccountViewEnabled>
            <AccountViewPIN>string</AccountViewPIN>
            <AccountViewPINFails>int</AccountViewPINFails>
            <ActiveFromDate>string</ActiveFromDate>
            <ActiveToDate>string</ActiveToDate>
            <ResendNotification>boolean</ResendNotification>
            <Currency>string</Currency>
            <ExpirationDate>dateTime</ExpirationDate>
            <ExpirationReminderDate>dateTime</ExpirationReminderDate>
            <HasTransaction>boolean</HasTransaction>
            <UserDefinedFields xsi:nil="true" />
          </MerchantLogHistory>
        </History>
        <Description>string</Description>
      </RetrieveMerchantLogHistoryResult>
    </RetrieveMerchantLogHistoryResponse>
  </soap12:Body>
</soap12:Envelope>