PosGatewayService
Click here for a complete list of operations.
DoApiKeyActivation
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-c.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>
<ActivationRequest xmlns="http://Hps.Exchange.PosGateway/ActivationService">
<Header>
<ClientTxnId>string</ClientTxnId>
</Header>
<Activation>
<MerchantId>string</MerchantId>
<ApplicationId>string</ApplicationId>
<ActivationCode>string</ActivationCode>
<SerialNumber>string</SerialNumber>
<DeviceId>string</DeviceId>
</Activation>
</ActivationRequest>
</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>
<ActivationResponse xmlns="http://Hps.Exchange.PosGateway/ActivationService">
<Header>
<GatewayRspCode>int</GatewayRspCode>
<GatewayRspMsg>string</GatewayRspMsg>
<ClientTxnId>string</ClientTxnId>
</Header>
<Result>
<IsSuccess>boolean</IsSuccess>
<RspCode>string</RspCode>
<Message>string</Message>
<SecretAPIKey>string</SecretAPIKey>
</Result>
</ActivationResponse>
</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-c.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>
<ActivationRequest xmlns="http://Hps.Exchange.PosGateway/ActivationService">
<Header>
<ClientTxnId>string</ClientTxnId>
</Header>
<Activation>
<MerchantId>string</MerchantId>
<ApplicationId>string</ApplicationId>
<ActivationCode>string</ActivationCode>
<SerialNumber>string</SerialNumber>
<DeviceId>string</DeviceId>
</Activation>
</ActivationRequest>
</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>
<ActivationResponse xmlns="http://Hps.Exchange.PosGateway/ActivationService">
<Header>
<GatewayRspCode>int</GatewayRspCode>
<GatewayRspMsg>string</GatewayRspMsg>
<ClientTxnId>string</ClientTxnId>
</Header>
<Result>
<IsSuccess>boolean</IsSuccess>
<RspCode>string</RspCode>
<Message>string</Message>
<SecretAPIKey>string</SecretAPIKey>
</Result>
</ActivationResponse>
</soap12:Body>
</soap12:Envelope>