Additional API Actions

1. Initiate Clearing

Clearing for transactions can be initiated via the Web Service similar to a payment transaction. Clearing will will be executed directly. If clearing was not successful for at least one terminal, the gateway will send false in the response.

<ipgapi:IPGApiActionRequest 
		xmlns:a1="http://ipg-online.com/ipgapi/schemas/a1" 
		xmlns:ipgapi="http://ipg-online.com/ipgapi/schemas/ipgapi">
	<a1:Action>
		</a1:InitiateClearing>
	</a1:Action>
</ipgapi:IPGApiActionRequest>

<ipgapi:IPGApiActionResponse
xmlns:ipgapi="http://ipg-online.com/ipgapi/schemas/ipgapi"
xmlns:a1="http://ipg-online.com/ipgapi/schemas/a1"
	xmlns:v1="http://ipg-online.com/ipgapi/schemas/v1">
<ipgapi:successfully>false</ipgapi:successfully>
</ipgapi:IPGApiActionResponse>

2. Inquiry Order

The action InquiryOrder allows you to get details about previously processed transactions of a specific order. You therefore need to submit the corresponding OrderId. The response contains information about all transactions belonging to the corresponding OrderId:

<soapenv:Envelope 
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:ipg="http://ipg-online.com/ipgapi/schemas/ipgapi" 
xmlns:a1="http://ipg-online.com/ipgapi/schemas/a1" 
xmlns:v1="http://ipg-online.com/ipgapi/schemas/v1"> 
   <soapenv:Header/>
   <soapenv:Body>
      <ipg:IPGApiActionRequest>
         <a1:Action>
            <a1:InquiryOrder>
            		<a1:OrderId>A-504a5ebf-6424-41af-bfd1-8f9eaca23378</a1:OrderId>
            		<a1:StoreId>1109950006</a1:StoreId>
         </a1:InquiryOrder>
         </a1:Action>
      </ipg:IPGApiActionRequest>
   </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Header/>
   <SOAP-ENV:Body>
      <ipgapi:IPGApiActionResponse xmlns:a1="http://ipg-online.com/ipgapi/schemas/a1" xmlns:ipgapi="http://ipg-online.com/ipgapi/schemas/ipgapi" xmlns:v1="http://ipg-online.com/ipgapi/schemas/v1">
         <ipgapi:successfully>true</ipgapi:successfully>
         <ipgapi:OrderId>A-504a5ebf-6424-41af-bfd1-8f9eaca23378</ipgapi:OrderId>
         <v1:Billing/>
         <v1:Shipping/>
         <a1:TransactionValues>
            <v1:CreditCardTxType>
               <v1:Type>sale</v1:Type>
            </v1:CreditCardTxType>
            <v1:CreditCardData>
               <v1:CardNumber>401200...1004</v1:CardNumber>
               <v1:ExpMonth>12</v1:ExpMonth>
               <v1:ExpYear>24</v1:ExpYear>
               <v1:Brand>VISA</v1:Brand>
            </v1:CreditCardData>
            <v1:Payment>
               <v1:ChargeTotal>15</v1:ChargeTotal>
               <v1:Currency>978</v1:Currency>
            </v1:Payment>
            <v1:TransactionDetails>
               <v1:OrderId>A-504a5ebf-6424-41af-bfd1-8f9eaca23378</v1:OrderId>
               <v1:TDate>1677686964</v1:TDate>
               <v1:TransactionOrigin>ECI</v1:TransactionOrigin>
            </v1:TransactionDetails>
            <ipgapi:IPGApiOrderResponse>               <ipgapi:ApprovalCode>Y:309372:4484275011:YYYM:418881</ipgapi:ApprovalCode>
<ipgapi:AVSResponse>YYY</ipgapi:AVSResponse>
<ipgapi:Brand>VISA</ipgapi:Brand>
<ipgapi:OrderId>A-504a5ebf-6424-41af-bfd1-8f9eaca23378</ipgapi:OrderId>
<ipgapi:IpgTransactionId>84484275011</ipgapi:IpgTransactionId>
<ipgapi:PayerSecurityLevel>1</ipgapi:PayerSecurityLevel>
<ipgapi:PaymentType>CREDITCARD</ipgapi:PaymentType>
<ipgapi:ProcessorApprovalCode>309372</ipgapi:ProcessorApprovalCode>
<ipgapi:ProcessorCCVResponse>M</ipgapi:ProcessorCCVResponse>
<ipgapi:ReferencedTDate>1677686964</ipgapi:ReferencedTDate>               <ipgapi:SchemeTransactionId>234567891234560</ipgapi:SchemeTransactionId>
<ipgapi:TDate>1677686964</ipgapi:TDate>
<ipgapi:TDateFormatted>2023.03.01 17:09:24 (CET)</ipgapi:TDateFormatted>
<ipgapi:TerminalID>80000012</ipgapi:TerminalID>
</ipgapi:IPGApiOrderResponse>
            <a1:TraceNumber>418881</a1:TraceNumber>
            <a1:Brand>VISA</a1:Brand>
            <a1:TransactionType>SALE</a1:TransactionType>
            <a1:TransactionState>CAPTURED</a1:TransactionState>
            <a1:UserID>1</a1:UserID>
            <a1:SubmissionComponent>API</a1:SubmissionComponent>
         </a1:TransactionValues>
      </ipgapi:IPGApiActionResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

If your Store is activated for the Fraud Detect product, you will find the score value in the element FraudScore as shown in the example below:

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Header/>
   <SOAP-ENV:Body>
      <ipgapi:IPGApiActionResponse xmlns:ipgapi="http://ipg-online.com/ipgapi/schemas/ipgapi" xmlns:a1="http://ipg-online.com/ipgapi/schemas/a1" xmlns:v1="http://ipg-online.com/ipgapi/schemas/v1">
         <ipgapi:successfully>true</ipgapi:successfully>
         <ipgapi:OrderId>VT-6d3c8793-f5cb-44c4-99a9-1209f8681693</ipgapi:OrderId>
         <v1:Billing/>
         <v1:Shipping/>
         <a1:TransactionValues>
            <v1:CreditCardTxType>
               <v1:Type>preauth</v1:Type>
            </v1:CreditCardTxType>
            <v1:CreditCardData>
               <v1:CardNumber>4035*****4977</v1:CardNumber>
               <v1:ExpMonth>12</v1:ExpMonth>
               <v1:ExpYear>27</v1:ExpYear>
               <v1:Brand>VISA</v1:Brand>
            </v1:CreditCardData>
            <v1:Payment>
               <v1:ChargeTotal>10</v1:ChargeTotal>
               <v1:Currency>840</v1:Currency>
            </v1:Payment>
            <v1:TransactionDetails>
               <v1:OrderId>VT-6d3c8793-f5cb-44c4-99a9-1209f8681693</v1:OrderId>
               <v1:Ip>127.0.0.1</v1:Ip>
               <v1:TDate>1498202166</v1:TDate>
               <v1:TransactionOrigin>ECI</v1:TransactionOrigin>
            </v1:TransactionDetails>
            <ipgapi:IPGApiOrderResponse>
               <ipgapi:ApprovalCode>Y:471142:0096409818:PPX0:000056</ipgapi:ApprovalCode>
               <ipgapi:AVSResponse>PPX</ipgapi:AVSResponse>
               <ipgapi:Brand>VISA</ipgapi:Brand>
               <ipgapi:FraudScore>102</ipgapi:FraudScore>
               <ipgapi:OrderId>VT-6d3c8793-f5cb-44c4-99a9-1209f8681693</ipgapi:OrderId>
               <ipgapi:IpgTransactionId>8383410710</ipgapi:IpgTransactionId>
               <ipgapi:PaymentType>CREDITCARD</ipgapi:PaymentType>
               <ipgapi:ProcessorApprovalCode>471142</ipgapi:ProcessorApprovalCode>
               <ipgapi:ProcessorCCVResponse>0</ipgapi:ProcessorCCVResponse>
               <ipgapi:ReferencedTDate>1498202166</ipgapi:ReferencedTDate>
               <ipgapi:TDate>1498202166</ipgapi:TDate>
               <ipgapi:TDateFormatted>2017.06.23 09:16:06 (CEST)</ipgapi:TDateFormatted>
               <ipgapi:TerminalID>1287451</ipgapi:TerminalID>
            </ipgapi:IPGApiOrderResponse>
            <a1:TraceNumber>000204</a1:TraceNumber>
            <a1:Brand>VISA</a1:Brand>
            <a1:TransactionType>PREAUTH</a1:TransactionType>
            <a1:TransactionState>DECLINED</a1:TransactionState>
            <a1:UserID>54001110</a1:UserID>
            <a1:SubmissionComponent>VT</a1:SubmissionComponent>
         </a1:TransactionValues>
         <a1:TransactionValues>
            <v1:CreditCardTxType>
               <v1:Type>postauth</v1:Type>
            </v1:CreditCardTxType>
            <v1:CreditCardData>
               <v1:Brand>VISA</v1:Brand>
            </v1:CreditCardData>
            <v1:Payment>
               <v1:ChargeTotal>10</v1:ChargeTotal>
               <v1:Currency>978</v1:Currency>
            </v1:Payment>
            <v1:TransactionDetails>
               <v1:OrderId>VT-6d3c8793-f5cb-44c4-99a9-1209f8681693</v1:OrderId>
               <v1:Ip>127.0.0.1</v1:Ip>
               <v1:TDate>1498203371</v1:TDate>
               <v1:TransactionOrigin>ECI</v1:TransactionOrigin>
            </v1:TransactionDetails>
            <ipgapi:IPGApiOrderResponse>
               <ipgapi:ApprovalCode>N:-50653:Sent invalid currency or no currencies were setup for this store.</ipgapi:ApprovalCode>
               <ipgapi:Brand>VISA</ipgapi:Brand>
               <ipgapi:OrderId>VT-6d3c8793-f5cb-44c4-99a9-1209f8681693</ipgapi:OrderId>
               <ipgapi:IpgTransactionId>8383410730</ipgapi:IpgTransactionId>
               <ipgapi:PaymentType>CREDITCARD</ipgapi:PaymentType>
               <ipgapi:ReferencedTDate>1498203371</ipgapi:ReferencedTDate>
               <ipgapi:TDate>1498203371</ipgapi:TDate>
               <ipgapi:TDateFormatted>2017.06.23 09:36:11 (CEST)</ipgapi:TDateFormatted>
            </ipgapi:IPGApiOrderResponse>
            <a1:Brand>VISA</a1:Brand>
            <a1:TransactionType>POSTAUTH</a1:TransactionType>
            <a1:TransactionState>DECLINED</a1:TransactionState>
            <a1:SubmissionComponent>CONNECT</a1:SubmissionComponent>
         </a1:TransactionValues>
         <a1:TransactionValues>
            <v1:CreditCardTxType>
               <v1:Type>postauth</v1:Type>
            </v1:CreditCardTxType>
            <v1:CreditCardData/>
            <v1:Payment>
               <v1:ChargeTotal>10</v1:ChargeTotal>
               <v1:Currency>840</v1:Currency>
            </v1:Payment>
            <v1:TransactionDetails>
               <v1:OrderId>VT-6d3c8793-f5cb-44c4-99a9-1209f8681693</v1:OrderId>
               <v1:Ip>127.0.0.1</v1:Ip>
               <v1:TDate>1498203386</v1:TDate>
               <v1:TransactionOrigin>ECI</v1:TransactionOrigin>
            </v1:TransactionDetails>
            <ipgapi:IPGApiOrderResponse>
               <ipgapi:ApprovalCode>Y:576275:0096397936:PPX :0718432585</ipgapi:ApprovalCode>
               <ipgapi:AVSResponse>PPX</ipgapi:AVSResponse>
               <ipgapi:OrderId>VT-6d3c8793-f5cb-44c4-99a9-1209f8681693</ipgapi:OrderId>
               <ipgapi:IpgTransactionId>8383410731</ipgapi:IpgTransactionId>
               <ipgapi:PaymentType>CREDITCARD</ipgapi:PaymentType>
               <ipgapi:ProcessorApprovalCode>576275</ipgapi:ProcessorApprovalCode>
               <ipgapi:ProcessorReceiptNumber>2585</ipgapi:ProcessorReceiptNumber>
               <ipgapi:ProcessorCCVResponse></ipgapi:ProcessorCCVResponse>
               <ipgapi:ProcessorTraceNumber>071843</ipgapi:ProcessorTraceNumber>
               <ipgapi:ReferencedTDate>1498203386</ipgapi:ReferencedTDate>
               <ipgapi:TDate>1498203386</ipgapi:TDate>
               <ipgapi:TDateFormatted>2017.06.23 09:36:26 (CEST)</ipgapi:TDateFormatted>
            </ipgapi:IPGApiOrderResponse>
            <a1:TransactionType>POSTAUTH</a1:TransactionType>
            <a1:TransactionState>DECLINED</a1:TransactionState>
            <a1:SubmissionComponent>CONNECT</a1:SubmissionComponent>
         </a1:TransactionValues>
      </ipgapi:IPGApiActionResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

3. Inquiry Transaction

The action InquiryTransaction allows you to get details about a previously processed transaction. You therefore need to either submit the merchantTransactionId if you have assigned one or alternatively the ipgTransactionId:

<soapenv:Envelope 
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:ipg="http://ipg-online.com/ipgapi/schemas/ipgapi" 
xmlns:a1="http://ipg-online.com/ipgapi/schemas/a1" 
xmlns:v1="http://ipg-online.com/ipgapi/schemas/v1"> 
   <soapenv:Header/>
   <soapenv:Body>
      <ipg:IPGApiActionRequest>
         <a1:Action>
            <a1:InquiryTransaction>
               <!--Optional:-->
               <a1:StoreId>12072591</a1:StoreId>
               <!--You have a CHOICE of the next 3 items at this level-->
               <a1:OrderId>C-38fd1bcd-1d67-4248-b9d5-d30376d92163</a1:OrderId>
               <a1:TDate>1453814407</a1:TDate>
              </a1:InquiryTransaction>
         </a1:Action>
      </ipg:IPGApiActionRequest>
   </soapenv:Body>
</soapenv:Envelope>

The response contains the same elements as in the InquiryOrder example above.

4. Get Last Orders

This action provides a query interface for information on the latest orders that have been submitted in order to support in-app reporting.

📘
Please contact your local support team for more information
This functionality is not enabled by default, as it requires additional configuration.
Please do not use this functionality to regularly request the result of transactions you have processed but store the API transaction response instead.

5. Latest orders of a Store

This query returns “the last n orders of the given store”.

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP-ENV:Header/>
    <SOAP-ENV:Body>
        <ns5:IPGApiActionRequest xmlns:ns5="http://ipg-online.com/ipgapi/schemas/ipgapi" xmlns:ns2="http://ipg-online.com/ipgapi/schemas/v1" xmlns:ns3="http://ipg-online.com/ipgapi/schemas/a1"> 
            <ns3:Action>
                <ns3:GetLastOrders>
                    <ns3:Count>5</ns3:Count>
                </ns3:GetLastOrders>
            </ns3:Action>
        </ns5:IPGApiActionRequest>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

6. Latest orders of a Store within a given date range

This query returns “the last n orders of the given store within the given date-range".
It could also be used for pagination.
Both dates DateFrom and DateTo are to be specified, in the form of xs:dateTime

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP-ENV:Header/>
    <SOAP-ENV:Body>
        <ns5:IPGApiActionRequest xmlns:ns5="http://ipg-online.com/ipgapi/schemas/ipgapi" xmlns:ns2="http://ipg-online.com/ipgapi/schemas/v1" xmlns:ns3="http://ipg-online.com/ipgapi/schemas/a1"> 
            <ns3:Action>
                <ns3:GetLastOrders>
                    <ns3:Count>5</ns3:Count>
                    <ns3:DateFrom>2014-04-05T10:23:37.143+02:00</ns3:DateFrom>
                    <ns3:DateTo>2014-05-05T10:23:37.143+02:00</ns3:DateTo>
                </ns3:GetLastOrders>
            </ns3:Action>
        </ns5:IPGApiActionRequest>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

7. All orders of a Store after a given Order ID

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP-ENV:Header/>
    <SOAP-ENV:Body>
        <ns5:IPGApiActionRequest xmlns:ns5="http://ipg-online.com/ipgapi/schemas/ipgapi" xmlns:ns2="http://ipg-online.com/ipgapi/schemas/v1" xmlns:ns3="http://ipg-online.com/ipgapi/schemas/a1"> 
            <ns3:Action>
                <ns3:GetLastOrders>
                    <ns3:Count>2</ns3:Count>
                    <ns3:OrderID>Test SGSDAO.ConversionDate 1382020873203</ns3:OrderID>
                </ns3:GetLastOrders>
            </ns3:Action>
        </ns5:IPGApiActionRequest>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope

8. Response

All query methods return the same structure as a result.

The success-status is returned by <ipgapi:successfully>true</ipgapi:successfully>
<ipgapi:ResultInfo>/ <a1:MoreResultsAvailable>true</a1:MoreResultsAvailable> tells if there are more results available.
o The service is stateless, therefore subsequent queries for pagination have to use either…
o GetLastOrders (storeID, count, dateFrom, dateTo) w/ dateTo set to the last order's order_date of the previous resultset OR
o GetLastOrders ( storeID, count, orderId) w/ orderId set to the last order of the previous resultset
List of orders <ipgapi:OrderValues>, consisting of
o OrderId – the orders’ unique id
o <a1:TransactionValues> transactions
o <v1:Basket> the basket
 with basket-items <v1:Item>
 and each item with item-options <v1:Option>

<?xml version="1.0" encoding="UTF-8"?><ipgapi:IPGApiActionResponse xmlns:ipgapi="http://ipg-online.com/ipgapi/schemas/ipgapi" xmlns:a1="http://ipg-online.com/ipgapi/schemas/a1" xmlns:v1="http://ipg-online.com/ipgapi/schemas/v1">
    <ipgapi:successfully>true</ipgapi:successfully>
    <ipgapi:ResultInfo>
        <a1:MoreResultsAvailable>true</a1:MoreResultsAvailable>
    </ipgapi:ResultInfo>
    <ipgapi:OrderValues>
        <a1:OrderId>A-00ddff18-b210-428b-804f-150b2567dbc9</a1:OrderId>
        <a1:OrderDate>2015-09-30T13:43:44.000+02:00</a1:OrderDate>
        <v1:Basket>
            <v1:Item>
                <v1:ID>d160c63e-7e9e-4a4a-bd5e-ae50a9133bf7</v1:ID>
                <v1:Description>katharistiko</v1:Description>
                <v1:ChargeTotal>25</v1:ChargeTotal>
                <v1:Quantity>1</v1:Quantity>
            </v1:Item>
        </v1:Basket>
        <v1:Billing/>
        <v1:Shipping/>
        <a1:TransactionValues>
            <v1:CreditCardTxType>
                <v1:Type>sale</v1:Type>
            </v1:CreditCardTxType>
            <v1:CreditCardData>
                <v1:CardNumber>5185****9001</v1:CardNumber>
                <v1:ExpMonth>04</v1:ExpMonth>
                <v1:ExpYear>27</v1:ExpYear>
                <v1:Brand>MASTERCARD</v1:Brand>
            </v1:CreditCardData>
            <v1:Payment>
                <v1:ChargeTotal>25</v1:ChargeTotal>
                <v1:Currency>978</v1:Currency>
            </v1:Payment>
            <v1:TransactionDetails>
                <v1:OrderId>A-00ddff18-b210-428b-804f-150b2567dbc9</v1:OrderId>
                <v1:TDate>1443620624</v1:TDate>
                <v1:TransactionOrigin>RETAIL</v1:TransactionOrigin>
            </v1:TransactionDetails>
            <ipgapi:IPGApiOrderResponse>               
                <ipgapi:ApprovalCode>Y:024309:0782287817:PPXX:796023</ipgapi:ApprovalCode>
                <ipgapi:AVSResponse>PPX</ipgapi:AVSResponse>
                <ipgapi:Brand>MASTERCARD</ipgapi:Brand>
                <ipgapi:Country>GRC</ipgapi:Country>
                <ipgapi:OrderId>A-00ddff18-b210-428b-804f-150b2567dbc9</ipgapi:OrderId>
                <ipgapi:PayerSecurityLevel>N</ipgapi:PayerSecurityLevel>
                <ipgapi:PaymentType>CREDITCARD</ipgapi:PaymentType>
                <ipgapi:ProcessorApprovalCode>024309</ipgapi:ProcessorApprovalCode>
                <ipgapi:ProcessorCCVResponse>X</ipgapi:ProcessorCCVResponse>
                <ipgapi:TDate>1443620624</ipgapi:TDate>
                <ipgapi:TDateFormatted>2015.09.30 15:43:44 (CEST)</ipgapi:TDateFormatted>
                <ipgapi:TerminalID>90000001</ipgapi:TerminalID>
            </ipgapi:IPGApiOrderResponse>
            <a1:TraceNumber>796023</a1:TraceNumber>
            <a1:TransactionState>SETTLED</a1:TransactionState>
            <a1:UserID>1</a1:UserID>
            <a1:SubmissionComponent>API</a1:SubmissionComponent>
        </a1:TransactionValues>
    </ipgapi:OrderValues>
    <ipgapi:OrderValues>
        <a1:OrderId>A-85a682a4-8481-48a3-b94c-a612fdc3a528</a1:OrderId>
        <a1:OrderDate>2015-09-29T15:45:46.000+02:00</a1:OrderDate>
        <v1:Basket>
            <v1:Item>
                <v1:ID>5105971d-b5fd-482b-be35-cb8a6569f7c7</v1:ID>
                <v1:Description>efimerida</v1:Description>
                <v1:ChargeTotal>12.15</v1:ChargeTotal>
                <v1:Quantity>1</v1:Quantity>
            </v1:Item>
        </v1:Basket>
        <v1:Billing/>
        <v1:Shipping/>
        <a1:TransactionValues>
            <v1:CreditCardTxType>
                <v1:Type>sale</v1:Type>
            </v1:CreditCardTxType>
            <v1:CreditCardData>
                <v1:CardNumber>4060.....8009</v1:CardNumber>
                <v1:ExpMonth>02</v1:ExpMonth>
                <v1:ExpYear>27</v1:ExpYear>
                <v1:Brand>VISA</v1:Brand>
            </v1:CreditCardData>
            <v1:Payment>
                <v1:ChargeTotal>12.15</v1:ChargeTotal>
                <v1:Currency>978</v1:Currency>
            </v1:Payment>
            <v1:TransactionDetails>
                <v1:OrderId>A-85a682a4-8481-48a3-b94c-a612fdc3a528</v1:OrderId>
                <v1:TDate>1443541546</v1:TDate>
                <v1:TransactionOrigin>RETAIL</v1:TransactionOrigin>
            </v1:TransactionDetails>
            <ipgapi:IPGApiOrderResponse>               
                <ipgapi:ApprovalCode>Y:201846:0782126690:PPXX:796005</ipgapi:ApprovalCode>
                <ipgapi:AVSResponse>PPX</ipgapi:AVSResponse>
                <ipgapi:Brand>VISA</ipgapi:Brand>
                <ipgapi:Country>GRC</ipgapi:Country>
                <ipgapi:OrderId>A-85a682a4-8481-48a3-b94c-a612fdc3a528</ipgapi:OrderId>
                <ipgapi:PayerSecurityLevel>V</ipgapi:PayerSecurityLevel>
                <ipgapi:PaymentType>CREDITCARD</ipgapi:PaymentType>
                <ipgapi:ProcessorApprovalCode>201846</ipgapi:ProcessorApprovalCode>              
                <ipgapi:ProcessorCCVResponse>X</ipgapi:ProcessorCCVResponse>
                <ipgapi:TDate>1443541546</ipgapi:TDate>
                <ipgapi:TDateFormatted>2015.09.29 17:45:46 (CEST)</ipgapi:TDateFormatted>
                <ipgapi:TerminalID>90000001</ipgapi:TerminalID>
            </ipgapi:IPGApiOrderResponse>
            <a1:TraceNumber>796005</a1:TraceNumber>
            <a1:TransactionState>SETTLED</a1:TransactionState>
            <a1:UserID>1</a1:UserID>
            <a1:SubmissionComponent>API</a1:SubmissionComponent>
        </a1:TransactionValues>
    </ipgapi:OrderValues>
    <ipgapi:OrderValues>
        <a1:OrderId>A-787829af-2baa-408e-881e-3f43f584496e</a1:OrderId>
        <a1:OrderDate>2015-09-29T13:58:15.000+02:00</a1:OrderDate>
        <v1:Basket>
            <v1:Item>
                <v1:ID>bd5c1138-e734-4379-89a7-075c1ac31bd0</v1:ID>
                <v1:Description>taigara</v1:Description>
                <v1:ChargeTotal>3.5</v1:ChargeTotal>
                <v1:Quantity>1</v1:Quantity>
            </v1:Item>
        </v1:Basket>
        <v1:Billing/>
        <v1:Shipping/>
        <a1:TransactionValues>
            <v1:CreditCardTxType>
                <v1:Type>sale</v1:Type>
            </v1:CreditCardTxType>
            <v1:CreditCardData>
                <v1:CardNumber>5167.....7382</v1:CardNumber>
                <v1:ExpMonth>07</v1:ExpMonth>
                <v1:ExpYear>18</v1:ExpYear>
                <v1:Brand>MASTERCARD</v1:Brand>
            </v1:CreditCardData>
            <v1:Payment>
                <v1:ChargeTotal>3.5</v1:ChargeTotal>
                <v1:Currency>978</v1:Currency>
            </v1:Payment>
            <v1:TransactionDetails>
                <v1:OrderId>A-787829af-2baa-408e-881e-3f43f584496e</v1:OrderId>
                <v1:TDate>1443535095</v1:TDate>
                <v1:TransactionOrigin>RETAIL</v1:TransactionOrigin>
            </v1:TransactionDetails>
            <ipgapi:IPGApiOrderResponse>                <ipgapi:ApprovalCode>Y:328188:0782108096:PPXX:795995</ipgapi:ApprovalCode>
                <ipgapi:AVSResponse>PPX</ipgapi:AVSResponse>
                <ipgapi:Brand>MASTERCARD</ipgapi:Brand>
                <ipgapi:Country>GRC</ipgapi:Country>
                <ipgapi:OrderId>A-787829af-2baa-408e-881e-3f43f584496e</ipgapi:OrderId>
                <ipgapi:PayerSecurityLevel>N</ipgapi:PayerSecurityLevel>
                <ipgapi:PaymentType>CREDITCARD</ipgapi:PaymentType>
                <ipgapi:ProcessorApprovalCode>328188</ipgapi:ProcessorApprovalCode>
                <ipgapi:ProcessorCCVResponse>X</ipgapi:ProcessorCCVResponse>
                <ipgapi:TDate>1443535095</ipgapi:TDate>
                <ipgapi:TDateFormatted>2015.09.29 15:58:15 (CEST)</ipgapi:TDateFormatted>
                <ipgapi:TerminalID>90000001</ipgapi:TerminalID>
            </ipgapi:IPGApiOrderResponse>
            <a1:TraceNumber>795995</a1:TraceNumber>
            <a1:TransactionState>SETTLED</a1:TransactionState>
            <a1:UserID>1</a1:UserID>
            <a1:SubmissionComponent>API</a1:SubmissionComponent>
        </a1:TransactionValues>
    </ipgapi:OrderValues>
    <ipgapi:OrderValues>
        <a1:OrderId>A-0606cb2c-d947-4557-855e-98722fc100f8</a1:OrderId>
        <a1:OrderDate>2015-09-28T21:34:01.000+02:00</a1:OrderDate>
        <v1:Basket>
            <v1:Item>
                <v1:ID>a3686a1e-e2dd-4f2b-aab0-2131af33c141</v1:ID>
                <v1:Description>κρασι</v1:Description>
                <v1:ChargeTotal>12.8</v1:ChargeTotal>
                <v1:Quantity>1</v1:Quantity>
            </v1:Item>
        </v1:Basket>
        <v1:Billing/>
        <v1:Shipping/>
        <a1:TransactionValues>
            <v1:CreditCardTxType>
                <v1:Type>sale</v1:Type>
            </v1:CreditCardTxType>
            <v1:CreditCardData>
                <v1:CardNumber>5185.....9001</v1:CardNumber>
                <v1:ExpMonth>04</v1:ExpMonth>
                <v1:ExpYear>27</v1:ExpYear>
                <v1:Brand>MASTERCARD</v1:Brand>
            </v1:CreditCardData>
            <v1:Payment>
                <v1:ChargeTotal>12.8</v1:ChargeTotal>
                <v1:Currency>978</v1:Currency>
            </v1:Payment>
            <v1:TransactionDetails>
                <v1:OrderId>A-0606cb2c-d947-4557-855e-98722fc100f8</v1:OrderId>
                <v1:TDate>1443476041</v1:TDate>
                <v1:TransactionOrigin>RETAIL</v1:TransactionOrigin>
            </v1:TransactionDetails>
            <ipgapi:IPGApiOrderResponse>                <ipgapi:ApprovalCode>Y:021474:0782015139:PPXX:795975</ipgapi:ApprovalCode>
                <ipgapi:AVSResponse>PPX</ipgapi:AVSResponse>
                <ipgapi:Brand>MASTERCARD</ipgapi:Brand>
                <ipgapi:Country>GRC</ipgapi:Country>
                <ipgapi:OrderId>A-0606cb2c-d947-4557-855e-98722fc100f8</ipgapi:OrderId>
                <ipgapi:PayerSecurityLevel>N</ipgapi:PayerSecurityLevel>

9. Get Last Transactions

This action provides a query interface for information on the latest transactions that have been submitted in order to support in-app reporting.

This functionality is not enabled by default, as it requires additional configuration.

Please contact your local support team for more information.

❗️
Please do not use this functionality to regularly request the result of transactions you have processed but store the API transaction response instead.

10. Latest transactions of a Store

This query returns “the last n transactions of the given store”.

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP-ENV:Header/>
    <SOAP-ENV:Body>
        <ns5:IPGApiActionRequest 
xmlns:ns5="http://ipg-online.com/ipgapi/schemas/ipgapi" 
xmlns:ns2="http://ipg-online.com/ipgapi/schemas/a1" 
xmlns:ns3="http://ipg-online.com/ipgapi/schemas/v1"> 
            <ns2:Action>
                <ns2:GetLastTransactions>
                    <ns2:count>2</ns2:count>
                </ns2:GetLastTransactions>
            </ns2:Action>
        </ns5:IPGApiActionRequest>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

11. All transactions of a Store after given Transaction ID

This interface is intended to support pagination of large result-sets. It returns "The last n transactions of the given store before a given transaction (by transactionId {orderId, TDate})"

A transactionID consists of the tuple
• OrderId the ID of the transactions’ order
• TDate the date of the transaction

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP-ENV:Header/>
    <SOAP-ENV:Body>
        <ns5:IPGApiActionRequest xmlns:ns5="http://ipg-online.com/ipgapi/schemas/ipgapi" xmlns:ns2="http://ipg-online.com/ipgapi/schemas/a1" xmlns:ns3="http://ipg-online.com/ipgapi/schemas/v1"> 
            <ns2:Action>
                <ns2:GetLastTransactions>
                    <ns2:count>2</ns2:count>
                    <ns2:OrderId>A-eb65437a-c538-4cdd-82b3-d316ae160c22</ns2:OrderId>
                    <ns2:TDate>1407373211</ns2:TDate>
                </ns2:GetLastTransactions>
            </ns2:Action>
        </ns5:IPGApiActionRequest>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

12. Response

All query methods return the same structure as a result.

• The success-status is returned by <ipgapi:successfully>true</ipgapi:successfully>
• List of transactions <a1:TransactionValues>

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP-ENV:Header/>
    <SOAP-ENV:Body>
        <ipgapi:IPGApiActionResponse xmlns:ipgapi="http://ipg-online.com/ipgapi/schemas/ipgapi" xmlns:a1="http://ipg-online.com/ipgapi/schemas/a1" xmlns:v1="http://ipg-online.com/ipgapi/schemas/v1">
            <ipgapi:successfully>true</ipgapi:successfully>
            <a1:TransactionValues>
                <v1:CreditCardTxType>
                    <v1:Type>periodic</v1:Type>
                </v1:CreditCardTxType>
                <v1:CreditCardData>
                    <v1:CardNumber>4035*****4977</v1:CardNumber>
                    <v1:ExpMonth>12</v1:ExpMonth>
                    <v1:ExpYear>30</v1:ExpYear>
                    <v1:Brand>VISA</v1:Brand>
                </v1:CreditCardData>
                <v1:Payment>
                    <v1:ChargeTotal>1</v1:ChargeTotal>
                    <v1:Currency>978</v1:Currency>
                </v1:Payment>
                <v1:TransactionDetails>
                    <v1:OrderId>A-bcbb36ad-90ad-4ff7-ad96-b5d73dd9c5e9</v1:OrderId>
                    <v1:TDate>1407373210</v1:TDate>
                </v1:TransactionDetails>
                <ipgapi:IPGApiOrderResponse>                   
                    <ipgapi:ApprovalCode>Y:272450:0014750514:PPXM:0433836659</ipgapi:ApprovalCode>
                    <ipgapi:AVSResponse>PPX</ipgapi:AVSResponse>
                    <ipgapi:Brand>VISA</ipgapi:Brand>
                    <ipgapi:OrderId>A-bcbb36ad-90ad-4ff7-ad96-b5d73dd9c5e9</ipgapi:OrderId>
                    <ipgapi:PaymentType>CREDITCARD</ipgapi:PaymentType>                   
                    <ipgapi:ProcessorApprovalCode>272450</ipgapi:ProcessorApprovalCode>                   
                    <ipgapi:ProcessorReceiptNumber>6659</ipgapi:ProcessorReceiptNumber>
                    <ipgapi:ProcessorCCVResponse>M</ipgapi:ProcessorCCVResponse>                   
                    <ipgapi:ProcessorTraceNumber>043383</ipgapi:ProcessorTraceNumber>
                    <ipgapi:ReferencedTDate>1407373210</ipgapi:ReferencedTDate>
                    <ipgapi:TDate>1407373210</ipgapi:TDate>
                    <ipgapi:TDateFormatted>2014.08.07 03:00:10 (CEST)</ipgapi:TDateFormatted>
                    <ipgapi:TerminalID>54000667</ipgapi:TerminalID>
                </ipgapi:IPGApiOrderResponse>
                <a1:TransactionState>CAPTURED</a1:TransactionState>
                <a1:UserID>1</a1:UserID>
                <a1:SubmissionComponent>BUS</a1:SubmissionComponent>
            </a1:TransactionValues>
            <a1:TransactionValues>
                <v1:CreditCardTxType>
                    <v1:Type>periodic</v1:Type>
                </v1:CreditCardTxType>
                <v1:CreditCardData>
                    <v1:CardNumber>4035*****4977</v1:CardNumber>
                    <v1:ExpMonth>12</v1:ExpMonth>
                    <v1:ExpYear>30</v1:ExpYear>
                    <v1:Brand>VISA</v1:Brand>
                </v1:CreditCardData>
                <v1:Payment>
                    <v1:ChargeTotal>1</v1:ChargeTotal>
                    <v1:Currency>978</v1:Currency>
                </v1:Payment>
                <v1:TransactionDetails>
                    <v1:OrderId>A-52421c39-69c4-4b2d-959d-9fdcd3a9420a</v1:OrderId>
                    <v1:TDate>1407373209</v1:TDate>
                </v1:TransactionDetails>
                <ipgapi:IPGApiOrderResponse>
                    <ipgapi:ApprovalCode>Y:416502:0014750513:PPXM:4625106408</ipgapi:ApprovalCode>
                    <ipgapi:AVSResponse>PPX</ipgapi:AVSResponse>
                    <ipgapi:Brand>VISA</ipgapi:Brand>
                    <ipgapi:OrderId>A-52421c39-69c4-4b2d-959d-9fdcd3a9420a</ipgapi:OrderId>
                    <ipgapi:PaymentType>CREDITCARD</ipgapi:PaymentType>                   
                    <ipgapi:ProcessorApprovalCode>416502</ipgapi:ProcessorApprovalCode>                   
                    <ipgapi:ProcessorReceiptNumber>6408</ipgapi:ProcessorReceiptNumber>
                    <ipgapi:ProcessorCCVResponse>M</ipgapi:ProcessorCCVResponse>                   
                    <ipgapi:ProcessorTraceNumber>462510</ipgapi:ProcessorTraceNumber>
                    <ipgapi:ReferencedTDate>1407373209</ipgapi:ReferencedTDate>
                    <ipgapi:TDate>1407373209</ipgapi:TDate>
                    <ipgapi:TDateFormatted>2014.08.07 03:00:09 (CEST)</ipgapi:TDateFormatted>
                    <ipgapi:TerminalID>54000666</ipgapi:TerminalID>
                </ipgapi:IPGApiOrderResponse>
                <a1:TransactionState>CAPTURED</a1:TransactionState>
                <a1:UserID>1</a1:UserID>
                <a1:SubmissionComponent>BUS</a1:SubmissionComponent>
            </a1:TransactionValues>
        </ipgapi:IPGApiActionResponse>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Additional API Actions

📘
Please contact your local support team for more information

❗️
Please do not use this functionality to regularly request the result of transactions you have processed but store the API transaction response instead.

📘Please contact your local support team for more information

❗️Please do not use this functionality to regularly request the result of transactions you have processed but store the API transaction response instead.

API Products

Point of Sale

Developer

Resources

📘
Please contact your local support team for more information

❗️
Please do not use this functionality to regularly request the result of transactions you have processed but store the API transaction response instead.