PosGatewayService Web Service

PosGatewayService

Click here for a complete list of operations.

DoTransaction

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 /hps.exchange.posgateway/posgatewayservice.asmx HTTP/1.1
Host: api2.heartlandportico.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: ""

<?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>
    <PosRequest clientType="string" clientVer="string" xmlns="http://Hps.Exchange.PosGateway">
      <Ver1.0>
        <Header>
          <GatewayToken>string</GatewayToken>
          <LicenseId>int</LicenseId>
          <SiteId>int</SiteId>
          <DeviceId>int</DeviceId>
          <UserName>string</UserName>
          <Password>string</Password>
          <CredentialToken>string</CredentialToken>
          <SiteTrace>string</SiteTrace>
          <DeveloperID>string</DeveloperID>
          <VersionNbr>string</VersionNbr>
          <OptionalPosData>string</OptionalPosData>
          <ClerkID>string</ClerkID>
          <GPSCoordinates>
            <Latitude>decimal</Latitude>
            <Longitude>decimal</Longitude>
          </GPSCoordinates>
          <ClientTxnId>string</ClientTxnId>
          <UniqueDeviceId>string</UniqueDeviceId>
          <SAFData>
            <SAFIndicator>N or Y or </SAFIndicator>
            <SAFOrigDT>dateTime</SAFOrigDT>
          </SAFData>
          <SecretAPIKey>string</SecretAPIKey>
          <PosReqDT>dateTime</PosReqDT>
          <DeviceConfiguration>
            <Capabilities>string</Capabilities>
            <Attributes>string</Attributes>
            <SerialNbr>string</SerialNbr>
            <TxnMCC>string</TxnMCC>
          </DeviceConfiguration>
          <x_global_transaction_id>string</x_global_transaction_id>
          <x_global_transaction_source>string</x_global_transaction_source>
          <CustomHashReq>N or Y or </CustomHashReq>
          <UPIAuthNetwork>N or Y or </UPIAuthNetwork>
          <SDKNameVersion>string</SDKNameVersion>
          <RetryInd>N or Y or </RetryInd>
        </Header>
        <Transaction />
      </Ver1.0>
    </PosRequest>
  </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>
    <PosResponse rootUrl="string" xmlns="http://Hps.Exchange.PosGateway">
      <Ver1.0>
        <Header>
          <LicenseId>int</LicenseId>
          <SiteId>int</SiteId>
          <DeviceId>int</DeviceId>
          <SiteTrace>string</SiteTrace>
          <GatewayTxnId>long</GatewayTxnId>
          <GatewayRspCode>int</GatewayRspCode>
          <GatewayRspMsg>string</GatewayRspMsg>
          <RspDT>dateTime</RspDT>
          <TokenData>
            <TokenRspCode>int</TokenRspCode>
            <TokenRspMsg>string</TokenRspMsg>
            <TokenValue>string</TokenValue>
          </TokenData>
          <AdditionalDuplicateData>
            <OriginalGatewayTxnId>long</OriginalGatewayTxnId>
            <OriginalRspDT>dateTime</OriginalRspDT>
            <OriginalClientTxnId>string</OriginalClientTxnId>
            <OriginalUniqueDeviceId>string</OriginalUniqueDeviceId>
            <Originalx_global_transaction_id>string</Originalx_global_transaction_id>
            <OriginalAuthCode>string</OriginalAuthCode>
            <OriginalRefNbr>string</OriginalRefNbr>
            <OriginalAuthAmt>decimal</OriginalAuthAmt>
            <OriginalCardType>string</OriginalCardType>
            <OriginalCardNbrLast4>string</OriginalCardNbrLast4>
            <OriginalDeviceId>int</OriginalDeviceId>
          </AdditionalDuplicateData>
          <ClientTxnId>string</ClientTxnId>
          <UniqueDeviceId>string</UniqueDeviceId>
          <BatchId>int</BatchId>
          <BatchSeqNbr>int</BatchSeqNbr>
          <PDLNotification>N or Y or </PDLNotification>
          <x_global_transaction_id>string</x_global_transaction_id>
          <x_global_transaction_source>string</x_global_transaction_source>
          <CustomHash>string</CustomHash>
          <BatchItemNbr>int</BatchItemNbr>
          <MerchCurrencyCode>string</MerchCurrencyCode>
          <MerchCurrencyText>string</MerchCurrencyText>
          <RetryInd>N or Y or </RetryInd>
        </Header>
        <Transaction />
      </Ver1.0>
    </PosResponse>
  </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 /hps.exchange.posgateway/posgatewayservice.asmx HTTP/1.1
Host: api2.heartlandportico.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>
    <PosRequest clientType="string" clientVer="string" xmlns="http://Hps.Exchange.PosGateway">
      <Ver1.0>
        <Header>
          <GatewayToken>string</GatewayToken>
          <LicenseId>int</LicenseId>
          <SiteId>int</SiteId>
          <DeviceId>int</DeviceId>
          <UserName>string</UserName>
          <Password>string</Password>
          <CredentialToken>string</CredentialToken>
          <SiteTrace>string</SiteTrace>
          <DeveloperID>string</DeveloperID>
          <VersionNbr>string</VersionNbr>
          <OptionalPosData>string</OptionalPosData>
          <ClerkID>string</ClerkID>
          <GPSCoordinates>
            <Latitude>decimal</Latitude>
            <Longitude>decimal</Longitude>
          </GPSCoordinates>
          <ClientTxnId>string</ClientTxnId>
          <UniqueDeviceId>string</UniqueDeviceId>
          <SAFData>
            <SAFIndicator>N or Y or </SAFIndicator>
            <SAFOrigDT>dateTime</SAFOrigDT>
          </SAFData>
          <SecretAPIKey>string</SecretAPIKey>
          <PosReqDT>dateTime</PosReqDT>
          <DeviceConfiguration>
            <Capabilities>string</Capabilities>
            <Attributes>string</Attributes>
            <SerialNbr>string</SerialNbr>
            <TxnMCC>string</TxnMCC>
          </DeviceConfiguration>
          <x_global_transaction_id>string</x_global_transaction_id>
          <x_global_transaction_source>string</x_global_transaction_source>
          <CustomHashReq>N or Y or </CustomHashReq>
          <UPIAuthNetwork>N or Y or </UPIAuthNetwork>
          <SDKNameVersion>string</SDKNameVersion>
          <RetryInd>N or Y or </RetryInd>
        </Header>
        <Transaction />
      </Ver1.0>
    </PosRequest>
  </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>
    <PosResponse rootUrl="string" xmlns="http://Hps.Exchange.PosGateway">
      <Ver1.0>
        <Header>
          <LicenseId>int</LicenseId>
          <SiteId>int</SiteId>
          <DeviceId>int</DeviceId>
          <SiteTrace>string</SiteTrace>
          <GatewayTxnId>long</GatewayTxnId>
          <GatewayRspCode>int</GatewayRspCode>
          <GatewayRspMsg>string</GatewayRspMsg>
          <RspDT>dateTime</RspDT>
          <TokenData>
            <TokenRspCode>int</TokenRspCode>
            <TokenRspMsg>string</TokenRspMsg>
            <TokenValue>string</TokenValue>
          </TokenData>
          <AdditionalDuplicateData>
            <OriginalGatewayTxnId>long</OriginalGatewayTxnId>
            <OriginalRspDT>dateTime</OriginalRspDT>
            <OriginalClientTxnId>string</OriginalClientTxnId>
            <OriginalUniqueDeviceId>string</OriginalUniqueDeviceId>
            <Originalx_global_transaction_id>string</Originalx_global_transaction_id>
            <OriginalAuthCode>string</OriginalAuthCode>
            <OriginalRefNbr>string</OriginalRefNbr>
            <OriginalAuthAmt>decimal</OriginalAuthAmt>
            <OriginalCardType>string</OriginalCardType>
            <OriginalCardNbrLast4>string</OriginalCardNbrLast4>
            <OriginalDeviceId>int</OriginalDeviceId>
          </AdditionalDuplicateData>
          <ClientTxnId>string</ClientTxnId>
          <UniqueDeviceId>string</UniqueDeviceId>
          <BatchId>int</BatchId>
          <BatchSeqNbr>int</BatchSeqNbr>
          <PDLNotification>N or Y or </PDLNotification>
          <x_global_transaction_id>string</x_global_transaction_id>
          <x_global_transaction_source>string</x_global_transaction_source>
          <CustomHash>string</CustomHash>
          <BatchItemNbr>int</BatchItemNbr>
          <MerchCurrencyCode>string</MerchCurrencyCode>
          <MerchCurrencyText>string</MerchCurrencyText>
          <RetryInd>N or Y or </RetryInd>
        </Header>
        <Transaction />
      </Ver1.0>
    </PosResponse>
  </soap12:Body>
</soap12:Envelope>