ApService Web Service

ApService

Click here for a complete list of operations.

QueryMerchantLogs

Query merchant logs.

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/QueryMerchantLogs"

<?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>
    <QueryMerchantLogs xmlns="http://aocsolutions.com/EncompassWebServices/">
      <user>
        <OrgGroupLoginId>string</OrgGroupLoginId>
        <Username>string</Username>
        <Password>string</Password>
      </user>
      <request>
        <BankNumber>string</BankNumber>
        <CompanyNumber>string</CompanyNumber>
        <MaxReturned>int</MaxReturned>
        <AccountNo>string</AccountNo>
        <CardAccountId>string</CardAccountId>
        <Status>string</Status>
        <DeliveryStatus>string</DeliveryStatus>
        <CreateDate>dateTime</CreateDate>
        <CreateDate2>dateTime</CreateDate2>
        <Amount>decimal</Amount>
        <Amount2>decimal</Amount2>
        <BillingCurrency>string</BillingCurrency>
        <CreatedByLastName>string</CreatedByLastName>
        <UserDefinedFields>
          <UserDefinedField>
            <FieldName>string</FieldName>
            <ValueAsString>string</ValueAsString>
          </UserDefinedField>
          <UserDefinedField>
            <FieldName>string</FieldName>
            <ValueAsString>string</ValueAsString>
          </UserDefinedField>
        </UserDefinedFields>
        <MerchantCode>string</MerchantCode>
        <CustomerCode>string</CustomerCode>
        <ExpiringNoDays>int</ExpiringNoDays>
        <ExpiringNoDays2>int</ExpiringNoDays2>
        <HasTransaction>boolean</HasTransaction>
        <LastOperation>string</LastOperation>
        <LastStatusChangeDate>dateTime</LastStatusChangeDate>
        <LastStatusChangeDate2>dateTime</LastStatusChangeDate2>
        <MerchantName>string</MerchantName>
        <PaymentMethod>string</PaymentMethod>
        <Source>string</Source>
      </request>
    </QueryMerchantLogs>
  </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>
    <QueryMerchantLogsResponse xmlns="http://aocsolutions.com/EncompassWebServices/">
      <QueryMerchantLogsResult>
        <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>
        <MerchantLogUniqueIds>
          <string>string</string>
          <string>string</string>
        </MerchantLogUniqueIds>
        <Description>string</Description>
      </QueryMerchantLogsResult>
    </QueryMerchantLogsResponse>
  </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>
    <QueryMerchantLogs xmlns="http://aocsolutions.com/EncompassWebServices/">
      <user>
        <OrgGroupLoginId>string</OrgGroupLoginId>
        <Username>string</Username>
        <Password>string</Password>
      </user>
      <request>
        <BankNumber>string</BankNumber>
        <CompanyNumber>string</CompanyNumber>
        <MaxReturned>int</MaxReturned>
        <AccountNo>string</AccountNo>
        <CardAccountId>string</CardAccountId>
        <Status>string</Status>
        <DeliveryStatus>string</DeliveryStatus>
        <CreateDate>dateTime</CreateDate>
        <CreateDate2>dateTime</CreateDate2>
        <Amount>decimal</Amount>
        <Amount2>decimal</Amount2>
        <BillingCurrency>string</BillingCurrency>
        <CreatedByLastName>string</CreatedByLastName>
        <UserDefinedFields>
          <UserDefinedField>
            <FieldName>string</FieldName>
            <ValueAsString>string</ValueAsString>
          </UserDefinedField>
          <UserDefinedField>
            <FieldName>string</FieldName>
            <ValueAsString>string</ValueAsString>
          </UserDefinedField>
        </UserDefinedFields>
        <MerchantCode>string</MerchantCode>
        <CustomerCode>string</CustomerCode>
        <ExpiringNoDays>int</ExpiringNoDays>
        <ExpiringNoDays2>int</ExpiringNoDays2>
        <HasTransaction>boolean</HasTransaction>
        <LastOperation>string</LastOperation>
        <LastStatusChangeDate>dateTime</LastStatusChangeDate>
        <LastStatusChangeDate2>dateTime</LastStatusChangeDate2>
        <MerchantName>string</MerchantName>
        <PaymentMethod>string</PaymentMethod>
        <Source>string</Source>
      </request>
    </QueryMerchantLogs>
  </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>
    <QueryMerchantLogsResponse xmlns="http://aocsolutions.com/EncompassWebServices/">
      <QueryMerchantLogsResult>
        <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>
        <MerchantLogUniqueIds>
          <string>string</string>
          <string>string</string>
        </MerchantLogUniqueIds>
        <Description>string</Description>
      </QueryMerchantLogsResult>
    </QueryMerchantLogsResponse>
  </soap12:Body>
</soap12:Envelope>