ApService Web Service

ApService

Click here for a complete list of operations.

CreateMerchantLog

Submit a merchant log for AP processing.

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

<?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>
    <CreateMerchantLog 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>
        <TotalPaymentAmount>decimal</TotalPaymentAmount>
        <CustomerCode>string</CustomerCode>
        <Invoices>
          <Invoice>
            <InvoiceNumber>string</InvoiceNumber>
            <InvoiceDate>dateTime</InvoiceDate>
            <InvoiceAmount>decimal</InvoiceAmount>
            <Description>string</Description>
            <TaxAmount>decimal</TaxAmount>
            <DiscountAmount>decimal</DiscountAmount>
            <UserDefinedFields xsi:nil="true" />
            <ReferenceNumber>string</ReferenceNumber>
            <PaymentCode>string</PaymentCode>
            <PaymentDate>dateTime</PaymentDate>
            <FreeFormText>string</FreeFormText>
            <FreightAmount>decimal</FreightAmount>
            <LineItems xsi:nil="true" />
          </Invoice>
          <Invoice>
            <InvoiceNumber>string</InvoiceNumber>
            <InvoiceDate>dateTime</InvoiceDate>
            <InvoiceAmount>decimal</InvoiceAmount>
            <Description>string</Description>
            <TaxAmount>decimal</TaxAmount>
            <DiscountAmount>decimal</DiscountAmount>
            <UserDefinedFields xsi:nil="true" />
            <ReferenceNumber>string</ReferenceNumber>
            <PaymentCode>string</PaymentCode>
            <PaymentDate>dateTime</PaymentDate>
            <FreeFormText>string</FreeFormText>
            <FreightAmount>decimal</FreightAmount>
            <LineItems xsi:nil="true" />
          </Invoice>
        </Invoices>
        <Note>string</Note>
        <UserDefinedFields>
          <UserDefinedField>
            <FieldName>string</FieldName>
            <ValueAsString>string</ValueAsString>
          </UserDefinedField>
          <UserDefinedField>
            <FieldName>string</FieldName>
            <ValueAsString>string</ValueAsString>
          </UserDefinedField>
        </UserDefinedFields>
        <FinancialCodes>
          <FinancialCode>
            <CodeName>string</CodeName>
            <ValueAsString>string</ValueAsString>
          </FinancialCode>
          <FinancialCode>
            <CodeName>string</CodeName>
            <ValueAsString>string</ValueAsString>
          </FinancialCode>
        </FinancialCodes>
        <ActiveFromDate>dateTime</ActiveFromDate>
        <ActiveToDate>dateTime</ActiveToDate>
        <MccCode>string</MccCode>
        <DeliveryMethod>None or Email or Fax or Both</DeliveryMethod>
        <DeliveryAddress>string</DeliveryAddress>
        <AlternateMerchantCode>string</AlternateMerchantCode>
        <BillingCurrency>string</BillingCurrency>
        <LocalCurrency>string</LocalCurrency>
        <CreditLimit>decimal</CreditLimit>
        <MinAmount>decimal</MinAmount>
        <BackupCardNumber>string</BackupCardNumber>
        <MccGroupProfileName>string</MccGroupProfileName>
        <AuthHoldDays>int</AuthHoldDays>
        <IsExactMatch>boolean</IsExactMatch>
        <RequireCardOnFile>boolean</RequireCardOnFile>
        <Country>string</Country>
        <PoolName>string</PoolName>
        <PaymentSchedule>
          <PaymentScheduleItem>
            <ActiveFromDate>dateTime</ActiveFromDate>
            <ActiveToDate>dateTime</ActiveToDate>
            <Amount>decimal</Amount>
            <CreditLimit>decimal</CreditLimit>
          </PaymentScheduleItem>
          <PaymentScheduleItem>
            <ActiveFromDate>dateTime</ActiveFromDate>
            <ActiveToDate>dateTime</ActiveToDate>
            <Amount>decimal</Amount>
            <CreditLimit>decimal</CreditLimit>
          </PaymentScheduleItem>
        </PaymentSchedule>
        <PaymentMethod>MerchantChargedCard or AutomaticallyChargedCard or TransactionalFunding or ACH or Check or BankCheck or Encircle or Wire or DynamicCard or BankTransfer</PaymentMethod>
        <TokenUsage>string</TokenUsage>
        <AchOrWirePaymentInfo>
          <BankAccountNumber>string</BankAccountNumber>
          <BankRoutingNumber>string</BankRoutingNumber>
          <BankAccountType>string</BankAccountType>
          <AchCreditFormat>Default or CCD or PPD or CTX</AchCreditFormat>
          <SwiftCode>string</SwiftCode>
          <IntermediaryBankRoutingNumber>string</IntermediaryBankRoutingNumber>
          <IntermediarySwiftCode>string</IntermediarySwiftCode>
        </AchOrWirePaymentInfo>
        <CheckPaymentInfo>
          <Payee>string</Payee>
          <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>
          <CheckNumber>string</CheckNumber>
        </CheckPaymentInfo>
        <RemitTemplate>string</RemitTemplate>
        <CustomerAccountNo>string</CustomerAccountNo>
        <AuthResetFrequency>Daily or Cycle or Monthly or Quarterly or Yearly or NoExpiration or Disabled</AuthResetFrequency>
        <NumAuthsAllowed>int</NumAuthsAllowed>
      </request>
    </CreateMerchantLog>
  </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>
    <CreateMerchantLogResponse xmlns="http://aocsolutions.com/EncompassWebServices/">
      <CreateMerchantLogResult>
        <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>
        <MerchantLogUniqueId>string</MerchantLogUniqueId>
        <Card>
          <CardNumber>string</CardNumber>
          <CardSecurityCode>string</CardSecurityCode>
          <ExpirationDate>dateTime</ExpirationDate>
          <EmailPIN>string</EmailPIN>
        </Card>
      </CreateMerchantLogResult>
    </CreateMerchantLogResponse>
  </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>
    <CreateMerchantLog 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>
        <TotalPaymentAmount>decimal</TotalPaymentAmount>
        <CustomerCode>string</CustomerCode>
        <Invoices>
          <Invoice>
            <InvoiceNumber>string</InvoiceNumber>
            <InvoiceDate>dateTime</InvoiceDate>
            <InvoiceAmount>decimal</InvoiceAmount>
            <Description>string</Description>
            <TaxAmount>decimal</TaxAmount>
            <DiscountAmount>decimal</DiscountAmount>
            <UserDefinedFields xsi:nil="true" />
            <ReferenceNumber>string</ReferenceNumber>
            <PaymentCode>string</PaymentCode>
            <PaymentDate>dateTime</PaymentDate>
            <FreeFormText>string</FreeFormText>
            <FreightAmount>decimal</FreightAmount>
            <LineItems xsi:nil="true" />
          </Invoice>
          <Invoice>
            <InvoiceNumber>string</InvoiceNumber>
            <InvoiceDate>dateTime</InvoiceDate>
            <InvoiceAmount>decimal</InvoiceAmount>
            <Description>string</Description>
            <TaxAmount>decimal</TaxAmount>
            <DiscountAmount>decimal</DiscountAmount>
            <UserDefinedFields xsi:nil="true" />
            <ReferenceNumber>string</ReferenceNumber>
            <PaymentCode>string</PaymentCode>
            <PaymentDate>dateTime</PaymentDate>
            <FreeFormText>string</FreeFormText>
            <FreightAmount>decimal</FreightAmount>
            <LineItems xsi:nil="true" />
          </Invoice>
        </Invoices>
        <Note>string</Note>
        <UserDefinedFields>
          <UserDefinedField>
            <FieldName>string</FieldName>
            <ValueAsString>string</ValueAsString>
          </UserDefinedField>
          <UserDefinedField>
            <FieldName>string</FieldName>
            <ValueAsString>string</ValueAsString>
          </UserDefinedField>
        </UserDefinedFields>
        <FinancialCodes>
          <FinancialCode>
            <CodeName>string</CodeName>
            <ValueAsString>string</ValueAsString>
          </FinancialCode>
          <FinancialCode>
            <CodeName>string</CodeName>
            <ValueAsString>string</ValueAsString>
          </FinancialCode>
        </FinancialCodes>
        <ActiveFromDate>dateTime</ActiveFromDate>
        <ActiveToDate>dateTime</ActiveToDate>
        <MccCode>string</MccCode>
        <DeliveryMethod>None or Email or Fax or Both</DeliveryMethod>
        <DeliveryAddress>string</DeliveryAddress>
        <AlternateMerchantCode>string</AlternateMerchantCode>
        <BillingCurrency>string</BillingCurrency>
        <LocalCurrency>string</LocalCurrency>
        <CreditLimit>decimal</CreditLimit>
        <MinAmount>decimal</MinAmount>
        <BackupCardNumber>string</BackupCardNumber>
        <MccGroupProfileName>string</MccGroupProfileName>
        <AuthHoldDays>int</AuthHoldDays>
        <IsExactMatch>boolean</IsExactMatch>
        <RequireCardOnFile>boolean</RequireCardOnFile>
        <Country>string</Country>
        <PoolName>string</PoolName>
        <PaymentSchedule>
          <PaymentScheduleItem>
            <ActiveFromDate>dateTime</ActiveFromDate>
            <ActiveToDate>dateTime</ActiveToDate>
            <Amount>decimal</Amount>
            <CreditLimit>decimal</CreditLimit>
          </PaymentScheduleItem>
          <PaymentScheduleItem>
            <ActiveFromDate>dateTime</ActiveFromDate>
            <ActiveToDate>dateTime</ActiveToDate>
            <Amount>decimal</Amount>
            <CreditLimit>decimal</CreditLimit>
          </PaymentScheduleItem>
        </PaymentSchedule>
        <PaymentMethod>MerchantChargedCard or AutomaticallyChargedCard or TransactionalFunding or ACH or Check or BankCheck or Encircle or Wire or DynamicCard or BankTransfer</PaymentMethod>
        <TokenUsage>string</TokenUsage>
        <AchOrWirePaymentInfo>
          <BankAccountNumber>string</BankAccountNumber>
          <BankRoutingNumber>string</BankRoutingNumber>
          <BankAccountType>string</BankAccountType>
          <AchCreditFormat>Default or CCD or PPD or CTX</AchCreditFormat>
          <SwiftCode>string</SwiftCode>
          <IntermediaryBankRoutingNumber>string</IntermediaryBankRoutingNumber>
          <IntermediarySwiftCode>string</IntermediarySwiftCode>
        </AchOrWirePaymentInfo>
        <CheckPaymentInfo>
          <Payee>string</Payee>
          <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>
          <CheckNumber>string</CheckNumber>
        </CheckPaymentInfo>
        <RemitTemplate>string</RemitTemplate>
        <CustomerAccountNo>string</CustomerAccountNo>
        <AuthResetFrequency>Daily or Cycle or Monthly or Quarterly or Yearly or NoExpiration or Disabled</AuthResetFrequency>
        <NumAuthsAllowed>int</NumAuthsAllowed>
      </request>
    </CreateMerchantLog>
  </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>
    <CreateMerchantLogResponse xmlns="http://aocsolutions.com/EncompassWebServices/">
      <CreateMerchantLogResult>
        <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>
        <MerchantLogUniqueId>string</MerchantLogUniqueId>
        <Card>
          <CardNumber>string</CardNumber>
          <CardSecurityCode>string</CardSecurityCode>
          <ExpirationDate>dateTime</ExpirationDate>
          <EmailPIN>string</EmailPIN>
        </Card>
      </CreateMerchantLogResult>
    </CreateMerchantLogResponse>
  </soap12:Body>
</soap12:Envelope>