Transaction Void

API: Ws_Transaction_Void

This web service cancels or voids any transaction which has been created via a web service, allowing you to remove uncleared authorisations.

Record Description

Tag	Type	Minimum Length	Maximum Length	Description	Request	Response
<WSID>	N	1	19	Web service ID. Must be unique for every request. For details, see the FAQs.	Mandatory	Mandatory
<IssCode>	AN	1	4	Thredd Issuer (Program Manager) Code. Assigned by Thredd.	Mandatory	Mandatory
<TxnCode>	AN	1	2	The Transaction Code. See Transaction Codes. Default value 12	Mandatory	Mandatory
<ClientCode>	AN	1	64	User ID of the customer using the service. Only applicable to systems using member logins. Returned in the response if present in the request. Note: Legacy field. Not used.	Optional	Conditional
<AuthType>	AN	1	1	Parameter to specify how the card is authenticated. See Authentication Methods.	Mandatory	Omit
<PAN>	AN	14	19	Card Number. Unique card identifier.	Conditional	Omit
<Track2>	AN	1	40	The card’s Track 2. Mandatory in request if `<PAN>` and `<PublicToken>` are not present or when `<AuthType>` is ‘7’.	Conditional	Omit
<PublicToken>	AN	1	9	The card’s public token, Mandatory in request if `<PAN>` and `<Track2>` are not present. Mandatory in the response.	Conditional	Mandatory
<DOB>	YYYY-MM- DD	10	10	Date of Birth. Mandatory if value of `<AuthType>` is ‘2’ or ‘6’.	Conditional	Omit
<CVV>	AN	3	3	Card Verification Value The Card Verification Value (CVV) on a credit card or debit card is a 3 digit number on VISA, MasterCard and Discover branded credit and debit cards. Cardholder's are typically required to enter the CVV during any online or cardholder not present transactions. CVV numbers are also known as CSC numbers (Card Security Code), as well as CVV2 numbers, which are the same as CVV numbers, except that they have been generated by a 2nd generation process that makes them harder to guess., the 3-digit code printed on the back of the card. Mandatory if the value of `<AuthType>` is ‘3’.	Conditional	Omit
<AccCode>	AN	0	6	Access code or passcode. If provided, must be 6 digits, leading zeroes are acceptable. Leave empty if not required. Mandatory if the value of `<AuthType>` is ‘4’.	Conditional	Omit
<LastName>	AN	1	20	Cardholder's last name for authenticating the cardholder if the value of `<AuthType>` is ‘6’.	Conditional	Omit
<LocDate>	YYYY-MM- DD	10	10	The local current date in year-month-date format.	Mandatory	Mandatory
<LocTime>	HHMMSS	6	6	The local current time, in hour-minute-second format.	Mandatory	Mandatory
<OrgItemId>	AN	1	20	The unique item ID of the transaction to void.	Mandatory	Mandatory
<Note>	AN	1	1000	Optional description of the void.	Optional	Omit
<SysDate>	YYYY-MM-DD	10	10	The system processing date.	Omit	Mandatory
<ItemId>	AN	1	20	The unique item ID returned for this void.	Omit	Mandatory
<ActionCode>	AN	3	3	The action code for the response. See Action Codes.	Omit	Mandatory

Request

Copy

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:hyp="http://www.globalprocessing.ae/HyperionWeb">
   <soapenv:Header>
      <hyp:AuthSoapHeader>
         <hyp:strUserName>******</hyp:strUserName>
         <hyp:strPassword>******</hyp:strPassword>
      </hyp:AuthSoapHeader>
   </soapenv:Header>
   <soapenv:Body>
      <hyp:Ws_Transaction_Void>
         <hyp:WSID>2021123456789</hyp:WSID>
         <hyp:IssCode>PMT</hyp:IssCode>
         <hyp:TxnCode>12</hyp:TxnCode>
         <hyp:ClientCode></hyp:ClientCode>
         <hyp:AuthType>1</hyp:AuthType>
         <hyp:PAN></hyp:PAN>
         <hyp:Track2></hyp:Track2>
         <hyp:PublicToken>123456789</hyp:PublicToken>
         <hyp:DOB></hyp:DOB>
         <hyp:CVV></hyp:CVV>
         <hyp:AccCode></hyp:AccCode>
         <hyp:LastName></hyp:LastName>
         <hyp:LocDate>2013-01-01</hyp:LocDate>
         <hyp:LocTime>120000</hyp:LocTime>
         <hyp:OrgItemId>1234</hyp:OrgItemId>
         <hyp:Note>Transaction Void - 1234</hyp:Note>
      </hyp:Ws_Transaction_Void>
   </soapenv:Body>
</soapenv:Envelope>

Response

Copy

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Body>
      <Ws_Transaction_VoidResponse xmlns="http://www.globalprocessing.ae/HyperionWeb">
         <Ws_Transaction_VoidResult>
            <WSID>2021123456789</WSID>
            <IssCode>PMT</IssCode>
            <TxnCode>12</TxnCode>
            <PublicToken>123456789</PublicToken>
            <LocDate>2013-01-01</LocDate>
            <LocTime>173400</LocTime>
            <ClientCode/>
            <OrgItemId>1234</OrgItemId>
            <SysDate>2013-01-01</SysDate>
            <ItemId>4321</ItemId>
            <ActionCode>000</ActionCode>
         </Ws_Transaction_VoidResult>
      </Ws_Transaction_VoidResponse>
   </soap:Body>
</soap:Envelope>