ApService Web Service

ApService

Click here for a complete list of operations.

RetrieveMerchant

Retrieve a merchant.

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

<?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>
    <RetrieveMerchant xmlns="http://aocsolutions.com/EncompassWebServices/">
      <user>
        <OrgGroupLoginId>string</OrgGroupLoginId>
        <Username>string</Username>
        <Password>string</Password>
      </user>
      <request>
        <BankNumber>string</BankNumber>
        <CompanyNumber>string</CompanyNumber>
        <MerchantCode>string</MerchantCode>
        <MerchantUniqueId>string</MerchantUniqueId>
      </request>
    </RetrieveMerchant>
  </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>
    <RetrieveMerchantResponse xmlns="http://aocsolutions.com/EncompassWebServices/">
      <RetrieveMerchantResult>
        <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>
        <MerchantCode>string</MerchantCode>
        <MerchantUniqueId>string</MerchantUniqueId>
        <Name>string</Name>
        <Status>Active or Inactive</Status>
        <PaymentMethod>MerchantChargedCard or AutomaticallyChargedCard or TransactionalFunding or ACH or Check or BankCheck or Encircle or Wire or DynamicCard or BankTransfer</PaymentMethod>
        <NotificationMethod>None or Email or Fax or Both</NotificationMethod>
        <Address>string</Address>
        <City>string</City>
        <StateTerritory>string</StateTerritory>
        <Zip>string</Zip>
        <Country>string</Country>
        <EmailAddresses>
          <string>string</string>
          <string>string</string>
        </EmailAddresses>
        <CcEmailAddresses>
          <string>string</string>
          <string>string</string>
        </CcEmailAddresses>
        <Phone>string</Phone>
        <Fax>string</Fax>
        <TaxPayerId>string</TaxPayerId>
        <CardNumber>string</CardNumber>
        <SystemManagedCreditLimit>boolean</SystemManagedCreditLimit>
        <UseSingleUseAccounts>boolean</UseSingleUseAccounts>
        <RemitTemplate>string</RemitTemplate>
        <BillingCurrency>string</BillingCurrency>
        <Note>string</Note>
        <MccCode>string</MccCode>
        <SingleUseAccountViewPIN>string</SingleUseAccountViewPIN>
        <OneCard>boolean</OneCard>
        <ACHAccountNumber>string</ACHAccountNumber>
        <ACHRoutingNumber>string</ACHRoutingNumber>
        <PaymentGatewayId>string</PaymentGatewayId>
        <IsExactMatch>boolean</IsExactMatch>
        <PoolSource>string</PoolSource>
        <CreateDate>dateTime</CreateDate>
        <LastUpdatedDate>dateTime</LastUpdatedDate>
        <EnrollmentData>
          <FirstName>string</FirstName>
          <LastName>string</LastName>
          <MCC>string</MCC>
          <DBA>string</DBA>
          <ProcessingBank>FifthThird or FdmsSouth or FdmsNorth or GlobalEast or Elavon or Tsys</ProcessingBank>
          <MerchantNumber>string</MerchantNumber>
          <BankIdNumber>string</BankIdNumber>
          <ChainCode>string</ChainCode>
          <StoreNumber>string</StoreNumber>
          <TerminalNumber>string</TerminalNumber>
          <TerminalIdentificationNumber>string</TerminalIdentificationNumber>
          <CityCode>string</CityCode>
          <MerchantLocationNumber>string</MerchantLocationNumber>
          <AgentNumber>string</AgentNumber>
        </EnrollmentData>
        <MerchantLevelSettingOverrides>
          <UseMerchantLevelOverrides>boolean</UseMerchantLevelOverrides>
          <ExpirationDays>int</ExpirationDays>
          <ExpirationReminderDays>int</ExpirationReminderDays>
          <AutoReconcilePercentAbove>int</AutoReconcilePercentAbove>
          <AutoReconcilePercentBelow>int</AutoReconcilePercentBelow>
          <CardLimitPadPercentage>int</CardLimitPadPercentage>
          <CardLimitPadDollars>int</CardLimitPadDollars>
          <AggregateInvoices>boolean</AggregateInvoices>
          <HonorCreditInvoices>boolean</HonorCreditInvoices>
          <InvoiceMatching>boolean</InvoiceMatching>
          <CriMatch>boolean</CriMatch>
          <Level3AugmentData>boolean</Level3AugmentData>
        </MerchantLevelSettingOverrides>
      </RetrieveMerchantResult>
    </RetrieveMerchantResponse>
  </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>
    <RetrieveMerchant xmlns="http://aocsolutions.com/EncompassWebServices/">
      <user>
        <OrgGroupLoginId>string</OrgGroupLoginId>
        <Username>string</Username>
        <Password>string</Password>
      </user>
      <request>
        <BankNumber>string</BankNumber>
        <CompanyNumber>string</CompanyNumber>
        <MerchantCode>string</MerchantCode>
        <MerchantUniqueId>string</MerchantUniqueId>
      </request>
    </RetrieveMerchant>
  </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>
    <RetrieveMerchantResponse xmlns="http://aocsolutions.com/EncompassWebServices/">
      <RetrieveMerchantResult>
        <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>
        <MerchantCode>string</MerchantCode>
        <MerchantUniqueId>string</MerchantUniqueId>
        <Name>string</Name>
        <Status>Active or Inactive</Status>
        <PaymentMethod>MerchantChargedCard or AutomaticallyChargedCard or TransactionalFunding or ACH or Check or BankCheck or Encircle or Wire or DynamicCard or BankTransfer</PaymentMethod>
        <NotificationMethod>None or Email or Fax or Both</NotificationMethod>
        <Address>string</Address>
        <City>string</City>
        <StateTerritory>string</StateTerritory>
        <Zip>string</Zip>
        <Country>string</Country>
        <EmailAddresses>
          <string>string</string>
          <string>string</string>
        </EmailAddresses>
        <CcEmailAddresses>
          <string>string</string>
          <string>string</string>
        </CcEmailAddresses>
        <Phone>string</Phone>
        <Fax>string</Fax>
        <TaxPayerId>string</TaxPayerId>
        <CardNumber>string</CardNumber>
        <SystemManagedCreditLimit>boolean</SystemManagedCreditLimit>
        <UseSingleUseAccounts>boolean</UseSingleUseAccounts>
        <RemitTemplate>string</RemitTemplate>
        <BillingCurrency>string</BillingCurrency>
        <Note>string</Note>
        <MccCode>string</MccCode>
        <SingleUseAccountViewPIN>string</SingleUseAccountViewPIN>
        <OneCard>boolean</OneCard>
        <ACHAccountNumber>string</ACHAccountNumber>
        <ACHRoutingNumber>string</ACHRoutingNumber>
        <PaymentGatewayId>string</PaymentGatewayId>
        <IsExactMatch>boolean</IsExactMatch>
        <PoolSource>string</PoolSource>
        <CreateDate>dateTime</CreateDate>
        <LastUpdatedDate>dateTime</LastUpdatedDate>
        <EnrollmentData>
          <FirstName>string</FirstName>
          <LastName>string</LastName>
          <MCC>string</MCC>
          <DBA>string</DBA>
          <ProcessingBank>FifthThird or FdmsSouth or FdmsNorth or GlobalEast or Elavon or Tsys</ProcessingBank>
          <MerchantNumber>string</MerchantNumber>
          <BankIdNumber>string</BankIdNumber>
          <ChainCode>string</ChainCode>
          <StoreNumber>string</StoreNumber>
          <TerminalNumber>string</TerminalNumber>
          <TerminalIdentificationNumber>string</TerminalIdentificationNumber>
          <CityCode>string</CityCode>
          <MerchantLocationNumber>string</MerchantLocationNumber>
          <AgentNumber>string</AgentNumber>
        </EnrollmentData>
        <MerchantLevelSettingOverrides>
          <UseMerchantLevelOverrides>boolean</UseMerchantLevelOverrides>
          <ExpirationDays>int</ExpirationDays>
          <ExpirationReminderDays>int</ExpirationReminderDays>
          <AutoReconcilePercentAbove>int</AutoReconcilePercentAbove>
          <AutoReconcilePercentBelow>int</AutoReconcilePercentBelow>
          <CardLimitPadPercentage>int</CardLimitPadPercentage>
          <CardLimitPadDollars>int</CardLimitPadDollars>
          <AggregateInvoices>boolean</AggregateInvoices>
          <HonorCreditInvoices>boolean</HonorCreditInvoices>
          <InvoiceMatching>boolean</InvoiceMatching>
          <CriMatch>boolean</CriMatch>
          <Level3AugmentData>boolean</Level3AugmentData>
        </MerchantLevelSettingOverrides>
      </RetrieveMerchantResult>
    </RetrieveMerchantResponse>
  </soap12:Body>
</soap12:Envelope>