Generic Transaction Type for Voids and Returns

The Tag SubsequentTransaction allows you to submit Voids and Refunds independently from which payment method had been used for the original payment transaction.

You can initiate such transactions by referencing to a previous transaction using one of the following options:
• IPGTransactionId
• MerchantTransactionId

Void: IPG Transaction ID & Merchant Transaction ID

The following XML document represents an example of a Void transaction using the minimum set of elements for IPGTransactionId (1st tab), as well as an example for a MerchantTransactionId(2nd tab).

<ns5:IPGApiOrderRequest 
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"> 
    	<ns2:SubsequentTransaction>
    		<ns2:IpgTransactionId>1234567890</ns2:IpgTransactionId>
    			<ns2:Options>
    				<ns2:StoreId>120995000</ns2:StoreId>
    			</ns2:Options>
    			<ns2:TransactionType>VOID</ns2:TransactionType>
   		</ns2:SubsequentTransaction>
	</ns5:IPGApiOrderRequest>

<ns5:IPGApiOrderRequest 
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"> 
    		<ns2:SubsequentTransaction>
    			<ns2:ReferencedMerchantTransactionId>TEST123456</ns2:ReferencedMerchantTransactionId>
    			<ns2:Options>
    				<ns2:StoreId>44036000750</ns2:StoreId>
    			</ns2:Options>
    			<ns2:TransactionType>VOID</ns2:TransactionType>
   		</ns2:SubsequentTransaction>
	</ns5:IPGApiOrderRequest>

Return: IPG Transaction ID & Merchant Transaction ID

The following XML document represents an example of a Return transaction using the minimum set of elements for IPG Transaction ID (1st tab), as well as an example for a Merchant ID (2nd tab).

<ns5:IPGApiOrderRequest 
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">
    <ns2:SubsequentTransaction>
        <ns2:IpgTransactionId>123456789</ns2:IpgTransactionId>
        <ns2:Options>
            <ns2:StoreId>120995000</ns2:StoreId>
        </ns2:Options>
        <ns2:TransactionType>RETURN</ns2:TransactionType>
        <ns2:Payment>
            <ns2:ChargeTotal>1.00</ns2:ChargeTotal>
            <ns2:Currency>978</ns2:Currency>
        </ns2:Payment>
    </ns2:SubsequentTransaction>
</ns5:IPGApiOrderRequest>

<ns5:IPGApiOrderRequest 
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">
    <ns2:SubsequentTransaction>
        <ns2:ReferencedMerchantTransactionId>TEST000380</ns2:ReferencedMerchantTransactionId>
        <ns2:Options>
            <ns2:StoreId>44036000750</ns2:StoreId>
        </ns2:Options>
        <ns2:TransactionType>RETURN</ns2:TransactionType>
        <ns2:Payment>
            <ns2:ChargeTotal>1.00</ns2:ChargeTotal>
            <ns2:Currency>978</ns2:Currency>
        </ns2:Payment>
    </ns2:SubsequentTransaction>
</ns5:IPGApiOrderRequest>

API Products

Point of Sale

Developer

Resources