ApService Web Service

ApService

Click here for a complete list of operations.

RetrieveMerchantExtended

Retrieve a merchant with payment methods.

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

<?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>
    <RetrieveMerchantExtended 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>
    </RetrieveMerchantExtended>
  </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>
    <RetrieveMerchantExtendedResponse xmlns="http://aocsolutions.com/EncompassWebServices/">
      <RetrieveMerchantExtendedResult>
        <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>
        <DefaultPaymentMethod>MerchantChargedCard or AutomaticallyChargedCard or TransactionalFunding or ACH or Check or BankCheck or Encircle or Wire or DynamicCard or BankTransfer</DefaultPaymentMethod>
        <Address>string</Address>
        <Address2>string</Address2>
        <Address3>string</Address3>
        <Address4>string</Address4>
        <City>string</City>
        <StateTerritory>string</StateTerritory>
        <Zip>string</Zip>
        <Country>string</Country>
        <Attention>string</Attention>
        <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>
        <Note>string</Note>
        <MccCode>string</MccCode>
        <CustomerAccountNo>string</CustomerAccountNo>
        <Program>string</Program>
        <CreateDate>dateTime</CreateDate>
        <LastUpdatedDate>dateTime</LastUpdatedDate>
        <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>
        <PaymentMethods>
          <MerchantPaymentMethodResponseItem>
            <PaymentMethod>MerchantChargedCard or AutomaticallyChargedCard or TransactionalFunding or ACH or Check or BankCheck or Encircle or Wire or DynamicCard or BankTransfer</PaymentMethod>
            <IsDefault>boolean</IsDefault>
            <NotificationMethod>None or Email or Fax or Both</NotificationMethod>
            <BankAccountNumber>string</BankAccountNumber>
            <BankRoutingNumber>string</BankRoutingNumber>
            <ACHAccountType>string</ACHAccountType>
            <AchFileDetailRecordFormat>string</AchFileDetailRecordFormat>
            <RemitTemplate>string</RemitTemplate>
            <SystemManagedCreditLimit>boolean</SystemManagedCreditLimit>
            <BillingCurrency>string</BillingCurrency>
            <UseSingleUseAccounts>boolean</UseSingleUseAccounts>
            <SingleUseAccountViewPIN>string</SingleUseAccountViewPIN>
            <SingleUseAccountViewPINRequired>Off or On or Default</SingleUseAccountViewPINRequired>
            <MccCode>string</MccCode>
            <PoolSource>string</PoolSource>
            <OneCard>boolean</OneCard>
            <IsExactMatch>boolean</IsExactMatch>
            <CardNumber>string</CardNumber>
            <PaymentGatewayId>string</PaymentGatewayId>
            <EncircleMerchantCode>string</EncircleMerchantCode>
            <EnrollmentData xsi:nil="true" />
            <CreateDate>dateTime</CreateDate>
            <LastUpdatedDate>dateTime</LastUpdatedDate>
            <SwiftCode>string</SwiftCode>
            <IntermediaryBankRoutingNumber>string</IntermediaryBankRoutingNumber>
            <IntermediarySwiftCode>string</IntermediarySwiftCode>
            <BankTransferBankAccountNumber>string</BankTransferBankAccountNumber>
            <BankTransferAccountType>string</BankTransferAccountType>
            <BankTransferPayeeName>string</BankTransferPayeeName>
            <BankTransferPayeeAddress>string</BankTransferPayeeAddress>
            <BankTransferPayeeAddress2>string</BankTransferPayeeAddress2>
            <BankTransferPayeeAddress3>string</BankTransferPayeeAddress3>
            <BankTransferPayeeAddress4>string</BankTransferPayeeAddress4>
            <BankTransferPayeeCity>string</BankTransferPayeeCity>
            <BankTransferPayeeStateCode>string</BankTransferPayeeStateCode>
            <BankTransferPayeeZipCode>string</BankTransferPayeeZipCode>
            <BankTransferPayeeCountryCode>string</BankTransferPayeeCountryCode>
            <BankTransferTransitType>string</BankTransferTransitType>
            <BankTransferTransitCode>string</BankTransferTransitCode>
            <BankTransferSwiftCode>string</BankTransferSwiftCode>
            <BankTransferBankAddress>string</BankTransferBankAddress>
            <BankTransferBankAddress2>string</BankTransferBankAddress2>
            <BankTransferBankAddress3>string</BankTransferBankAddress3>
            <BankTransferBankAddress4>string</BankTransferBankAddress4>
            <BankTransferBankCity>string</BankTransferBankCity>
            <BankTransferBankStateCode>string</BankTransferBankStateCode>
            <BankTransferBankZipCode>string</BankTransferBankZipCode>
            <BankTransferBankCountryCode>string</BankTransferBankCountryCode>
          </MerchantPaymentMethodResponseItem>
          <MerchantPaymentMethodResponseItem>
            <PaymentMethod>MerchantChargedCard or AutomaticallyChargedCard or TransactionalFunding or ACH or Check or BankCheck or Encircle or Wire or DynamicCard or BankTransfer</PaymentMethod>
            <IsDefault>boolean</IsDefault>
            <NotificationMethod>None or Email or Fax or Both</NotificationMethod>
            <BankAccountNumber>string</BankAccountNumber>
            <BankRoutingNumber>string</BankRoutingNumber>
            <ACHAccountType>string</ACHAccountType>
            <AchFileDetailRecordFormat>string</AchFileDetailRecordFormat>
            <RemitTemplate>string</RemitTemplate>
            <SystemManagedCreditLimit>boolean</SystemManagedCreditLimit>
            <BillingCurrency>string</BillingCurrency>
            <UseSingleUseAccounts>boolean</UseSingleUseAccounts>
            <SingleUseAccountViewPIN>string</SingleUseAccountViewPIN>
            <SingleUseAccountViewPINRequired>Off or On or Default</SingleUseAccountViewPINRequired>
            <MccCode>string</MccCode>
            <PoolSource>string</PoolSource>
            <OneCard>boolean</OneCard>
            <IsExactMatch>boolean</IsExactMatch>
            <CardNumber>string</CardNumber>
            <PaymentGatewayId>string</PaymentGatewayId>
            <EncircleMerchantCode>string</EncircleMerchantCode>
            <EnrollmentData xsi:nil="true" />
            <CreateDate>dateTime</CreateDate>
            <LastUpdatedDate>dateTime</LastUpdatedDate>
            <SwiftCode>string</SwiftCode>
            <IntermediaryBankRoutingNumber>string</IntermediaryBankRoutingNumber>
            <IntermediarySwiftCode>string</IntermediarySwiftCode>
            <BankTransferBankAccountNumber>string</BankTransferBankAccountNumber>
            <BankTransferAccountType>string</BankTransferAccountType>
            <BankTransferPayeeName>string</BankTransferPayeeName>
            <BankTransferPayeeAddress>string</BankTransferPayeeAddress>
            <BankTransferPayeeAddress2>string</BankTransferPayeeAddress2>
            <BankTransferPayeeAddress3>string</BankTransferPayeeAddress3>
            <BankTransferPayeeAddress4>string</BankTransferPayeeAddress4>
            <BankTransferPayeeCity>string</BankTransferPayeeCity>
            <BankTransferPayeeStateCode>string</BankTransferPayeeStateCode>
            <BankTransferPayeeZipCode>string</BankTransferPayeeZipCode>
            <BankTransferPayeeCountryCode>string</BankTransferPayeeCountryCode>
            <BankTransferTransitType>string</BankTransferTransitType>
            <BankTransferTransitCode>string</BankTransferTransitCode>
            <BankTransferSwiftCode>string</BankTransferSwiftCode>
            <BankTransferBankAddress>string</BankTransferBankAddress>
            <BankTransferBankAddress2>string</BankTransferBankAddress2>
            <BankTransferBankAddress3>string</BankTransferBankAddress3>
            <BankTransferBankAddress4>string</BankTransferBankAddress4>
            <BankTransferBankCity>string</BankTransferBankCity>
            <BankTransferBankStateCode>string</BankTransferBankStateCode>
            <BankTransferBankZipCode>string</BankTransferBankZipCode>
            <BankTransferBankCountryCode>string</BankTransferBankCountryCode>
          </MerchantPaymentMethodResponseItem>
        </PaymentMethods>
      </RetrieveMerchantExtendedResult>
    </RetrieveMerchantExtendedResponse>
  </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>
    <RetrieveMerchantExtended 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>
    </RetrieveMerchantExtended>
  </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>
    <RetrieveMerchantExtendedResponse xmlns="http://aocsolutions.com/EncompassWebServices/">
      <RetrieveMerchantExtendedResult>
        <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>
        <DefaultPaymentMethod>MerchantChargedCard or AutomaticallyChargedCard or TransactionalFunding or ACH or Check or BankCheck or Encircle or Wire or DynamicCard or BankTransfer</DefaultPaymentMethod>
        <Address>string</Address>
        <Address2>string</Address2>
        <Address3>string</Address3>
        <Address4>string</Address4>
        <City>string</City>
        <StateTerritory>string</StateTerritory>
        <Zip>string</Zip>
        <Country>string</Country>
        <Attention>string</Attention>
        <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>
        <Note>string</Note>
        <MccCode>string</MccCode>
        <CustomerAccountNo>string</CustomerAccountNo>
        <Program>string</Program>
        <CreateDate>dateTime</CreateDate>
        <LastUpdatedDate>dateTime</LastUpdatedDate>
        <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>
        <PaymentMethods>
          <MerchantPaymentMethodResponseItem>
            <PaymentMethod>MerchantChargedCard or AutomaticallyChargedCard or TransactionalFunding or ACH or Check or BankCheck or Encircle or Wire or DynamicCard or BankTransfer</PaymentMethod>
            <IsDefault>boolean</IsDefault>
            <NotificationMethod>None or Email or Fax or Both</NotificationMethod>
            <BankAccountNumber>string</BankAccountNumber>
            <BankRoutingNumber>string</BankRoutingNumber>
            <ACHAccountType>string</ACHAccountType>
            <AchFileDetailRecordFormat>string</AchFileDetailRecordFormat>
            <RemitTemplate>string</RemitTemplate>
            <SystemManagedCreditLimit>boolean</SystemManagedCreditLimit>
            <BillingCurrency>string</BillingCurrency>
            <UseSingleUseAccounts>boolean</UseSingleUseAccounts>
            <SingleUseAccountViewPIN>string</SingleUseAccountViewPIN>
            <SingleUseAccountViewPINRequired>Off or On or Default</SingleUseAccountViewPINRequired>
            <MccCode>string</MccCode>
            <PoolSource>string</PoolSource>
            <OneCard>boolean</OneCard>
            <IsExactMatch>boolean</IsExactMatch>
            <CardNumber>string</CardNumber>
            <PaymentGatewayId>string</PaymentGatewayId>
            <EncircleMerchantCode>string</EncircleMerchantCode>
            <EnrollmentData xsi:nil="true" />
            <CreateDate>dateTime</CreateDate>
            <LastUpdatedDate>dateTime</LastUpdatedDate>
            <SwiftCode>string</SwiftCode>
            <IntermediaryBankRoutingNumber>string</IntermediaryBankRoutingNumber>
            <IntermediarySwiftCode>string</IntermediarySwiftCode>
            <BankTransferBankAccountNumber>string</BankTransferBankAccountNumber>
            <BankTransferAccountType>string</BankTransferAccountType>
            <BankTransferPayeeName>string</BankTransferPayeeName>
            <BankTransferPayeeAddress>string</BankTransferPayeeAddress>
            <BankTransferPayeeAddress2>string</BankTransferPayeeAddress2>
            <BankTransferPayeeAddress3>string</BankTransferPayeeAddress3>
            <BankTransferPayeeAddress4>string</BankTransferPayeeAddress4>
            <BankTransferPayeeCity>string</BankTransferPayeeCity>
            <BankTransferPayeeStateCode>string</BankTransferPayeeStateCode>
            <BankTransferPayeeZipCode>string</BankTransferPayeeZipCode>
            <BankTransferPayeeCountryCode>string</BankTransferPayeeCountryCode>
            <BankTransferTransitType>string</BankTransferTransitType>
            <BankTransferTransitCode>string</BankTransferTransitCode>
            <BankTransferSwiftCode>string</BankTransferSwiftCode>
            <BankTransferBankAddress>string</BankTransferBankAddress>
            <BankTransferBankAddress2>string</BankTransferBankAddress2>
            <BankTransferBankAddress3>string</BankTransferBankAddress3>
            <BankTransferBankAddress4>string</BankTransferBankAddress4>
            <BankTransferBankCity>string</BankTransferBankCity>
            <BankTransferBankStateCode>string</BankTransferBankStateCode>
            <BankTransferBankZipCode>string</BankTransferBankZipCode>
            <BankTransferBankCountryCode>string</BankTransferBankCountryCode>
          </MerchantPaymentMethodResponseItem>
          <MerchantPaymentMethodResponseItem>
            <PaymentMethod>MerchantChargedCard or AutomaticallyChargedCard or TransactionalFunding or ACH or Check or BankCheck or Encircle or Wire or DynamicCard or BankTransfer</PaymentMethod>
            <IsDefault>boolean</IsDefault>
            <NotificationMethod>None or Email or Fax or Both</NotificationMethod>
            <BankAccountNumber>string</BankAccountNumber>
            <BankRoutingNumber>string</BankRoutingNumber>
            <ACHAccountType>string</ACHAccountType>
            <AchFileDetailRecordFormat>string</AchFileDetailRecordFormat>
            <RemitTemplate>string</RemitTemplate>
            <SystemManagedCreditLimit>boolean</SystemManagedCreditLimit>
            <BillingCurrency>string</BillingCurrency>
            <UseSingleUseAccounts>boolean</UseSingleUseAccounts>
            <SingleUseAccountViewPIN>string</SingleUseAccountViewPIN>
            <SingleUseAccountViewPINRequired>Off or On or Default</SingleUseAccountViewPINRequired>
            <MccCode>string</MccCode>
            <PoolSource>string</PoolSource>
            <OneCard>boolean</OneCard>
            <IsExactMatch>boolean</IsExactMatch>
            <CardNumber>string</CardNumber>
            <PaymentGatewayId>string</PaymentGatewayId>
            <EncircleMerchantCode>string</EncircleMerchantCode>
            <EnrollmentData xsi:nil="true" />
            <CreateDate>dateTime</CreateDate>
            <LastUpdatedDate>dateTime</LastUpdatedDate>
            <SwiftCode>string</SwiftCode>
            <IntermediaryBankRoutingNumber>string</IntermediaryBankRoutingNumber>
            <IntermediarySwiftCode>string</IntermediarySwiftCode>
            <BankTransferBankAccountNumber>string</BankTransferBankAccountNumber>
            <BankTransferAccountType>string</BankTransferAccountType>
            <BankTransferPayeeName>string</BankTransferPayeeName>
            <BankTransferPayeeAddress>string</BankTransferPayeeAddress>
            <BankTransferPayeeAddress2>string</BankTransferPayeeAddress2>
            <BankTransferPayeeAddress3>string</BankTransferPayeeAddress3>
            <BankTransferPayeeAddress4>string</BankTransferPayeeAddress4>
            <BankTransferPayeeCity>string</BankTransferPayeeCity>
            <BankTransferPayeeStateCode>string</BankTransferPayeeStateCode>
            <BankTransferPayeeZipCode>string</BankTransferPayeeZipCode>
            <BankTransferPayeeCountryCode>string</BankTransferPayeeCountryCode>
            <BankTransferTransitType>string</BankTransferTransitType>
            <BankTransferTransitCode>string</BankTransferTransitCode>
            <BankTransferSwiftCode>string</BankTransferSwiftCode>
            <BankTransferBankAddress>string</BankTransferBankAddress>
            <BankTransferBankAddress2>string</BankTransferBankAddress2>
            <BankTransferBankAddress3>string</BankTransferBankAddress3>
            <BankTransferBankAddress4>string</BankTransferBankAddress4>
            <BankTransferBankCity>string</BankTransferBankCity>
            <BankTransferBankStateCode>string</BankTransferBankStateCode>
            <BankTransferBankZipCode>string</BankTransferBankZipCode>
            <BankTransferBankCountryCode>string</BankTransferBankCountryCode>
          </MerchantPaymentMethodResponseItem>
        </PaymentMethods>
      </RetrieveMerchantExtendedResult>
    </RetrieveMerchantExtendedResponse>
  </soap12:Body>
</soap12:Envelope>