Void Transaction Request

A Void Transaction request is used to cancel a previously authorized transaction before the batch is closed and sent to the processor. The host system must use data from the original transaction to allow the terminal to locate and process the Void request.

Request Body

application/xml

RegisterId*string

Alphanumeric reference field.

TPN?string

Alphanumeric TPN field.

PaymentType*string

Identifies the EDC type.

Value in"Credit" | "Debit" | "Check" | "Gift" | "Loyalty"

AuthKey?string

Authorizes the Host system to use the SPIn Web Service.

TransType*string

Identifies the type of transaction to run – Void.

Value in"Void"

Amount*string

Base dollar amount of the original transaction.

RefId*string

Must match the RefId from the original transaction.

MerchantId?string

Optional for regular transactions when Multi MID (MMID) is not enabled; mandatory when MMID is enabled in which case the MerchantId must be the TPN (Terminal Provider Number) mapped to the target MID to ensure the transaction is routed correctly.

CustomerEmail?string

Customer email address used for prefill purposes.

CustomerMobile?string

Customer mobile number used for prefill purposes.

IsTxnStatusScreenRequired?boolean

Indicates whether the terminal should display the transaction status screen after processing.

Response Body

`application/xml`

curl -X GET "https://example.com" \  -H "Content-Type: application/xml" \  -d '<request>    <AuthKey/>    <RegisterId>1</RegisterId>    <TPN/>    <PaymentType>Credit</PaymentType>    <TransType>Void</TransType>    <Amount>11.00</Amount>    <RefId>3</RefId>    <MerchantId/>    <CustomerEmail/>    <CustomerMobile/>    <IsTxnStatusScreenRequired>true</IsTxnStatusScreenRequired>  </request>'

<response>
  <RefId>2</RefId>
  <RegisterId>3</RegisterId>
  <TPN>yourTPN</TPN>
  <ResultCode>0</ResultCode>
  <Message>Success</Message>
  <PaymentType>Credit</PaymentType>
  <AuthCode>yourAuthCode</AuthCode>
  <PNRef>yourPNRef</PNRef>
  <ExtData>InvNum=1,CardType=VISA,BatchNum=1,Tip=0.00,CashBack=0.00,Fee=0.00,AcntLast4=1234,Name=Dejavoo,TotalAmt=1.00,EntryType=Swipe,TaxCity=0.00,TaxState=0.00,TaxAmount=0.00</ExtData>
</response>

Void Transaction Request

Request Body

Response Body

200application/xml

`application/xml`