ApService Web Service

ApService

Click here for a complete list of operations.

DisputeTransaction

Dispute a transaction.

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

<?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>
    <DisputeTransaction xmlns="http://aocsolutions.com/EncompassWebServices/">
      <user>
        <OrgGroupLoginId>string</OrgGroupLoginId>
        <Username>string</Username>
        <Password>string</Password>
      </user>
      <request>
        <BankNumber>string</BankNumber>
        <CompanyNumber>string</CompanyNumber>
        <AccountNumber>string</AccountNumber>
        <TransactionReferenceNumber>string</TransactionReferenceNumber>
        <MerchantLogUniqueId>string</MerchantLogUniqueId>
        <DisputeAmount>decimal</DisputeAmount>
        <DisputeRecpients>string</DisputeRecpients>
        <DisputeReason>IncorrectAmountBilled or ChargedMoreThanOnce or Other</DisputeReason>
        <DisputeReasonOtherDescription>string</DisputeReasonOtherDescription>
        <CloseDispute>boolean</CloseDispute>
      </request>
    </DisputeTransaction>
  </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>
    <DisputeTransactionResponse xmlns="http://aocsolutions.com/EncompassWebServices/">
      <DisputeTransactionResult>
        <ResponseCode>Failed or Success or NotFound or InvalidLogonCredentials or NoDisputePrivilege</ResponseCode>
        <Description>string</Description>
      </DisputeTransactionResult>
    </DisputeTransactionResponse>
  </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>
    <DisputeTransaction xmlns="http://aocsolutions.com/EncompassWebServices/">
      <user>
        <OrgGroupLoginId>string</OrgGroupLoginId>
        <Username>string</Username>
        <Password>string</Password>
      </user>
      <request>
        <BankNumber>string</BankNumber>
        <CompanyNumber>string</CompanyNumber>
        <AccountNumber>string</AccountNumber>
        <TransactionReferenceNumber>string</TransactionReferenceNumber>
        <MerchantLogUniqueId>string</MerchantLogUniqueId>
        <DisputeAmount>decimal</DisputeAmount>
        <DisputeRecpients>string</DisputeRecpients>
        <DisputeReason>IncorrectAmountBilled or ChargedMoreThanOnce or Other</DisputeReason>
        <DisputeReasonOtherDescription>string</DisputeReasonOtherDescription>
        <CloseDispute>boolean</CloseDispute>
      </request>
    </DisputeTransaction>
  </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>
    <DisputeTransactionResponse xmlns="http://aocsolutions.com/EncompassWebServices/">
      <DisputeTransactionResult>
        <ResponseCode>Failed or Success or NotFound or InvalidLogonCredentials or NoDisputePrivilege</ResponseCode>
        <Description>string</Description>
      </DisputeTransactionResult>
    </DisputeTransactionResponse>
  </soap12:Body>
</soap12:Envelope>