ApService Web Service

ApService

Click here for a complete list of operations.

RetrieveMerchantLog

Retrieve 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: demoservices.wrightexpresscorpcard.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://aocsolutions.com/EncompassWebServices/RetrieveMerchantLog"

<?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>
    <RetrieveMerchantLog 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>
    </RetrieveMerchantLog>
  </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>
    <RetrieveMerchantLogResponse xmlns="http://aocsolutions.com/EncompassWebServices/">
      <RetrieveMerchantLogResult>
        <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>
        <Description>string</Description>
        <MerchantLog>
          <MerchantLogUniqueId>string</MerchantLogUniqueId>
          <MerchantCode>string</MerchantCode>
          <Note>string</Note>
          <TotalPaymentAmount>decimal</TotalPaymentAmount>
          <CustomerCode>string</CustomerCode>
          <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>
          <CreateDate>dateTime</CreateDate>
          <LastUpdatedDate>dateTime</LastUpdatedDate>
          <ReconciliationStatus>NotReconciled or ReconciledAutomatically or ReconciledManually</ReconciliationStatus>
          <Invoices>
            <Invoice xsi:nil="true" />
            <Invoice xsi:nil="true" />
          </Invoices>
          <UserDefinedFields>
            <UserDefinedField xsi:nil="true" />
            <UserDefinedField xsi:nil="true" />
          </UserDefinedFields>
          <Card>
            <CardNumber>string</CardNumber>
            <CardSecurityCode>string</CardSecurityCode>
            <ExpirationDate>dateTime</ExpirationDate>
            <EmailPIN>string</EmailPIN>
          </Card>
          <ActiveFromDate>dateTime</ActiveFromDate>
          <ActiveToDate>dateTime</ActiveToDate>
          <MccCode>string</MccCode>
          <DeliveryMethod>None or Email or Fax or Both</DeliveryMethod>
          <DeliveryAddress>string</DeliveryAddress>
          <BankTransferBatchReferenceNumber>string</BankTransferBatchReferenceNumber>
          <BankTransferTransactionId>string</BankTransferTransactionId>
          <BankTransferPaymentStatus>string</BankTransferPaymentStatus>
        </MerchantLog>
      </RetrieveMerchantLogResult>
    </RetrieveMerchantLogResponse>
  </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: demoservices.wrightexpresscorpcard.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>
    <RetrieveMerchantLog 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>
    </RetrieveMerchantLog>
  </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>
    <RetrieveMerchantLogResponse xmlns="http://aocsolutions.com/EncompassWebServices/">
      <RetrieveMerchantLogResult>
        <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>
        <Description>string</Description>
        <MerchantLog>
          <MerchantLogUniqueId>string</MerchantLogUniqueId>
          <MerchantCode>string</MerchantCode>
          <Note>string</Note>
          <TotalPaymentAmount>decimal</TotalPaymentAmount>
          <CustomerCode>string</CustomerCode>
          <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>
          <CreateDate>dateTime</CreateDate>
          <LastUpdatedDate>dateTime</LastUpdatedDate>
          <ReconciliationStatus>NotReconciled or ReconciledAutomatically or ReconciledManually</ReconciliationStatus>
          <Invoices>
            <Invoice xsi:nil="true" />
            <Invoice xsi:nil="true" />
          </Invoices>
          <UserDefinedFields>
            <UserDefinedField xsi:nil="true" />
            <UserDefinedField xsi:nil="true" />
          </UserDefinedFields>
          <Card>
            <CardNumber>string</CardNumber>
            <CardSecurityCode>string</CardSecurityCode>
            <ExpirationDate>dateTime</ExpirationDate>
            <EmailPIN>string</EmailPIN>
          </Card>
          <ActiveFromDate>dateTime</ActiveFromDate>
          <ActiveToDate>dateTime</ActiveToDate>
          <MccCode>string</MccCode>
          <DeliveryMethod>None or Email or Fax or Both</DeliveryMethod>
          <DeliveryAddress>string</DeliveryAddress>
          <BankTransferBatchReferenceNumber>string</BankTransferBatchReferenceNumber>
          <BankTransferTransactionId>string</BankTransferTransactionId>
          <BankTransferPaymentStatus>string</BankTransferPaymentStatus>
        </MerchantLog>
      </RetrieveMerchantLogResult>
    </RetrieveMerchantLogResponse>
  </soap12:Body>
</soap12:Envelope>