Void Method

Description

The Void method performs a reversal on a CardNotPresent transaction in the Authorized state, or a MasterPass transaction.

Action

http://www.ecentricswitch.co.za/paymentgateway/v1/Void

Style

Document

Input (Literal)

The input of this method is the document element VoidRequest having the structure defined by the following table.

ELEMENT	TYPE	SIZE(MAX)	DESCRIPTION
MessageHeader
MessageDateTime	datetime		The message timestamp.
MessageID	string	50	A unique identifier to identify the message.
Channel	string	50	An identifier to identify the source of the message.
VoidRequest Required
MerchantID Required	string	50	A unique identifier to identify the merchant. Also known as Merchant GUID.
TransactionID Required	string	50	A unique identifier provided by the merchant on the API call to identify the transaction.
PreviousTransactionID Required	string	50	A unique identifier to identify a preceding transaction (Authorize).
TransactionDateTime	datetime		The transaction timestamp.
SaleReconID	string	100	A unique identifier for reconciliation purposes.
ReconID	string	50	A unique identifier for reconciliation purposes.
OrderNumber	string	50	The transaction order or reference number. Note: Only Alphanumeric characters i.e. [a..z], [A..Z], [0..9] are allowed. NO spaces or special characters are allowed. The first 12 characters of this field will be sent to the acquirer/bank as the Retrieval Reference Number (RRN). Therefore the first 12 characters must be unique. Duplicate RRN’s may cause transaction failures.
InitialAuthRef	string	50	The reference from an initial "PreAuthorizeResponse". Used only for partial void as part of an existing PreAuthorize
ReplacementAmount	string		Used only for partial void as part of an existing PreAuthorize
PaymentService Required	PaymentServiceType		The target payment service.

Output (Literal)

The output of this method is the document element VoidResponse having the structure defined by the following table.

ELEMENT	TYPE	SIZE(MAX)	DESCRIPTION
MessageHeader Required
MessageDateTime	datetime		The message timestamp.
MessageID	string	50	A unique identifier to identify the message.
Channel	string	50	An identifier to identify the source of the message.
VoidResponse Required
TransactionID Required	string	50	A unique identifier to identify the transaction.
TransactionDateTime Required	datetime		The transaction timestamp.
ReconID Required	string	50	A unique identifier for reconciliation purposes.
AuthCode Required	string	50	The result code definition.
TransactionStatus Required	TransactionStatusType		The transaction status (Success and Failure)
ResponseDetail Required	ResponseDetail		The transaction result code.

Sample Message

Request

Body

 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:="http://www.ecentricswitch.co.za/paymentgateway/v1">
     <soapenv:Header>
         <MessageHeader></MessageHeader>
     </soapenv:Header>
     <soapenv:Body>
         <VoidRequest>
              <MerchantID>8B67BF88-BB8D-4EB5-ADFC-0F5C97C7ED67</MerchantID>
 		<MerchantUserID>978e566b-d62a-42c0-9843-381b3588f333</MerchantUserID>
             <TransactionID>12488644-27de-4472-b245-e09f6080a68a</TransactionID>
             <PreviousTransactionID>afd65315-e7b3-4abd-bfb9-e63d5dbff447</PreviousTransactionID>
 	   <Amount>50</Amount>
             <OrderNumber>MR89130176</OrderNumber>
             <CurrencyCode>ZAR</CurrencyCode>
             <PaymentService>CardNotPresent</PaymentService>
         </VoidRequest>
     </soapenv:Body>
 </soapenv:Envelope>

Response

Body

<s:Envelope
	xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
	<s:Header>
		<h:MessageHeader
			xmlns:h="http://www.ecentricswitch.co.za/paymentgateway/v1"
			xmlns="http://www.ecentricswitch.co.za/paymentgateway/v1"
			xmlns:xsd="http://www.w3.org/2001/XMLSchema"
			xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
			<MessageDateTime>2024-11-07T12:30:47.057</MessageDateTime>
			<MessageID>7AE92FD8-3183-4652-8691-500FEC383CCE</MessageID>
			<Channel xsi:nil="true"/>
		</h:MessageHeader>
	</s:Header>
	<s:Body
		xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
		xmlns:xsd="http://www.w3.org/2001/XMLSchema">
		<VoidResponse xmlns="http://www.ecentricswitch.co.za/paymentgateway/v1">
			<TransactionID>12488644-27de-4472-b245-e09f6080a68a</TransactionID>
			<TransactionDateTime>2024-11-07T12:30:46.94</TransactionDateTime>
			<SaleReconID xsi:nil="true"/>
			<ReconID/>
			<TransactionStatus>Success</TransactionStatus>
			<ResponseDetail>
				<Source>Acquirer</Source>
				<Code>00</Code>
				<Description>Approved or completed successfully</Description>
				<ClientMessage>Approved.</ClientMessage>
			</ResponseDetail>
		</VoidResponse>
	</s:Body>
</s:Envelope>