TransactionWebservice_1

TransactionWebservice_1_1

Click here for a complete list of operations.

VoucherPayment

Redeem a voucher by providing the unique activation code. The voucher must be active or have status confirmed.

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 /ICP.Mimas.SAL/transaction_1_1.asmx HTTP/1.1
Host: live.icpmimas.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.icpmimas.com/VoucherPayment"

<?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:Header>
    <AuthenticationHeader xmlns="http://www.icpmimas.com/">
      <loginLogId>long</loginLogId>
      <icpGroupId>long</icpGroupId>
      <sessionKey>string</sessionKey>
      <validUntil>dateTime</validUntil>
      <culture>string</culture>
    </AuthenticationHeader>
  </soap:Header>
  <soap:Body>
    <VoucherPayment xmlns="http://www.icpmimas.com/">
      <productCode>string</productCode>
      <terminalCode>string</terminalCode>
      <employeeCode>string</employeeCode>
      <activationCode>string</activationCode>
      <cardnumber>string</cardnumber>
      <orderRef>string</orderRef>
      <orderValue>long</orderValue>
      <trxDate>dateTime</trxDate>
      <remarks>string</remarks>
    </VoucherPayment>
  </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:Header>
    <AuthenticationHeader xmlns="http://www.icpmimas.com/">
      <loginLogId>long</loginLogId>
      <icpGroupId>long</icpGroupId>
      <sessionKey>string</sessionKey>
      <validUntil>dateTime</validUntil>
      <culture>string</culture>
    </AuthenticationHeader>
  </soap:Header>
  <soap:Body>
    <VoucherPaymentResponse xmlns="http://www.icpmimas.com/">
      <resultCode>int</resultCode>
      <resultText>string</resultText>
      <VoucherOrder>
        <OrderId>long</OrderId>
        <Status>string</Status>
        <ProductCode>string</ProductCode>
        <VoucherId>long</VoucherId>
        <SerialNumber>string</SerialNumber>
        <BatchNumber>string</BatchNumber>
        <Value>long</Value>
        <Decimals>short</Decimals>
        <Currency>string</Currency>
        <ExpiryDate>dateTime</ExpiryDate>
        <TerminalCode>string</TerminalCode>
        <EmployeeCode>string</EmployeeCode>
        <ExternalRef>string</ExternalRef>
        <SupplierRef>string</SupplierRef>
        <RequestDate>dateTime</RequestDate>
        <OrderDate>dateTime</OrderDate>
        <DeliveryDate>dateTime</DeliveryDate>
        <CancelDate>dateTime</CancelDate>
        <ConfirmDate>dateTime</ConfirmDate>
        <ExternalResult>string</ExternalResult>
        <Remarks>string</Remarks>
        <SupplierTrace>string</SupplierTrace>
        <Misc1>string</Misc1>
        <Misc2>string</Misc2>
        <Misc3>string</Misc3>
        <Misc4>string</Misc4>
        <Misc5>string</Misc5>
      </VoucherOrder>
      <VoucherText>
        <LogoImageB64>string</LogoImageB64>
        <LogoFilename>string</LogoFilename>
        <EncodeType>short</EncodeType>
        <HeaderText>
          <Text>string</Text>
          <Text>string</Text>
        </HeaderText>
        <TicketText>
          <Text>string</Text>
          <Text>string</Text>
        </TicketText>
        <UserText>
          <Text>string</Text>
          <Text>string</Text>
        </UserText>
        <FooterText>
          <Text>string</Text>
          <Text>string</Text>
        </FooterText>
      </VoucherText>
    </VoucherPaymentResponse>
  </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 /ICP.Mimas.SAL/transaction_1_1.asmx HTTP/1.1
Host: live.icpmimas.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:Header>
    <AuthenticationHeader xmlns="http://www.icpmimas.com/">
      <loginLogId>long</loginLogId>
      <icpGroupId>long</icpGroupId>
      <sessionKey>string</sessionKey>
      <validUntil>dateTime</validUntil>
      <culture>string</culture>
    </AuthenticationHeader>
  </soap12:Header>
  <soap12:Body>
    <VoucherPayment xmlns="http://www.icpmimas.com/">
      <productCode>string</productCode>
      <terminalCode>string</terminalCode>
      <employeeCode>string</employeeCode>
      <activationCode>string</activationCode>
      <cardnumber>string</cardnumber>
      <orderRef>string</orderRef>
      <orderValue>long</orderValue>
      <trxDate>dateTime</trxDate>
      <remarks>string</remarks>
    </VoucherPayment>
  </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:Header>
    <AuthenticationHeader xmlns="http://www.icpmimas.com/">
      <loginLogId>long</loginLogId>
      <icpGroupId>long</icpGroupId>
      <sessionKey>string</sessionKey>
      <validUntil>dateTime</validUntil>
      <culture>string</culture>
    </AuthenticationHeader>
  </soap12:Header>
  <soap12:Body>
    <VoucherPaymentResponse xmlns="http://www.icpmimas.com/">
      <resultCode>int</resultCode>
      <resultText>string</resultText>
      <VoucherOrder>
        <OrderId>long</OrderId>
        <Status>string</Status>
        <ProductCode>string</ProductCode>
        <VoucherId>long</VoucherId>
        <SerialNumber>string</SerialNumber>
        <BatchNumber>string</BatchNumber>
        <Value>long</Value>
        <Decimals>short</Decimals>
        <Currency>string</Currency>
        <ExpiryDate>dateTime</ExpiryDate>
        <TerminalCode>string</TerminalCode>
        <EmployeeCode>string</EmployeeCode>
        <ExternalRef>string</ExternalRef>
        <SupplierRef>string</SupplierRef>
        <RequestDate>dateTime</RequestDate>
        <OrderDate>dateTime</OrderDate>
        <DeliveryDate>dateTime</DeliveryDate>
        <CancelDate>dateTime</CancelDate>
        <ConfirmDate>dateTime</ConfirmDate>
        <ExternalResult>string</ExternalResult>
        <Remarks>string</Remarks>
        <SupplierTrace>string</SupplierTrace>
        <Misc1>string</Misc1>
        <Misc2>string</Misc2>
        <Misc3>string</Misc3>
        <Misc4>string</Misc4>
        <Misc5>string</Misc5>
      </VoucherOrder>
      <VoucherText>
        <LogoImageB64>string</LogoImageB64>
        <LogoFilename>string</LogoFilename>
        <EncodeType>short</EncodeType>
        <HeaderText>
          <Text>string</Text>
          <Text>string</Text>
        </HeaderText>
        <TicketText>
          <Text>string</Text>
          <Text>string</Text>
        </TicketText>
        <UserText>
          <Text>string</Text>
          <Text>string</Text>
        </UserText>
        <FooterText>
          <Text>string</Text>
          <Text>string</Text>
        </FooterText>
      </VoucherText>
    </VoucherPaymentResponse>
  </soap12:Body>
</soap12:Envelope>