Transaction type

Request

Response

Card

Sale

<request>
  <AuthKey>zbhRAW9N6x</AuthKey>
  <RefId>8671b858c3</RefId>
  <TPN>z11cantab01</TPN>
  <PaymentType>Card</PaymentType>
  <TransType>Sale</TransType>
  <Amount>8.74</Amount>
  <GetReceipt>Both</GetReceipt>
  <PrintReceipt>Both</PrintReceipt>
</request>
<xmp>
  <response>
    <RefId>8671b858c3</RefId>
    <TransNum>1</TransNum>
    <InvNum>0001160</InvNum>
    <ResultCode>0</ResultCode>
    <RespMSG>APPROVED%2d000</RespMSG>
    <Message>Approved</Message>
    <AuthCode>007201</AuthCode>
    <PaymentType>Card</PaymentType>
    <Voided>false</Voided>
    <TransType>Purchase</TransType>
    <TID>10002033</TID>
    <MID>10002033</MID>
    <SN>WP20031Q21000123</SN>
    <HostSpecific>TS: 20210929005247,Sequence Number: 0001160,Approved 000 Thank You,TID:10002033</HostSpecific>
    <ExtData>Amount=8.74,InvNum=0001160,CardType=VISA,BatchNum=231,Tip=0.00,CashBack=0.00,Fee=0.00,AcntLast4=2062,BIN=460684,Name=A%20GIFT%20FOR%20YOU%2f%20%20%20%20%20%20%20%20%20%20%20,SVC=0.00,TotalAmt=8.74,DISC=0.00,Donation=0.00,SHFee=0.00,RwdPoints=0,RwdBalance=0,RwdIssued=,EBTFSLedgerBalance=,EBTFSAvailBalance=,EBTFSBeginBalance=,EBTCashLedgerBalance=,EBTCashAvailBalance=,EBTCashBeginBalance=,RewardCode=,AcqRefData=,ProcessData=,RefNo=,RewardQR=,Language=English,EntryType=Swipe,table_num=0,clerk_id=,ticket_num=,ControlNum=,TaxCity=0.00,TaxState=0.00,TaxReducedState=0.00,Cust1=,Cust1Value=,Cust2=,Cust2Value=,Cust3=,Cust3Value=,AcntFirst4=4606,TaxAmount=0.00,AVSRsp=,CVVRsp=</ExtData>
    <Sign>...</Sign>
    <Receipt>...</Receipt>
    <CVMResult>2</CVMResult>
  </response>
</xmp>

Return

<request>
  <AuthKey>zbhRAW9N6x</AuthKey>
  <RefId>9505f3b28a</RefId>
  <TPN>z11cantab01</TPN>
  <PaymentType>Card</PaymentType>
  <TransType>Return</TransType>
  <Amount>8.74</Amount>
  <GetReceipt>Both</GetReceipt>
  <PrintReceipt>Both</PrintReceipt>
</request>

<xmp>
  <response>
    <RefId>9505f3b28a</RefId>
    <TransNum>2</TransNum>
    <InvNum>0001161</InvNum>
    <ResultCode>0</ResultCode>
    <RespMSG>APPROVED%2d000</RespMSG>
    <Message>Approved</Message>
    <AuthCode>007202</AuthCode>
    <PaymentType>Card</PaymentType>
    <Voided>false</Voided>
    <TransType>Refund</TransType>
    <TID>10002033</TID>
    <MID>10002033</MID>
    <SN>WP20031Q21000123</SN>
    <HostSpecific>TS: 20210929010208,Sequence Number: 0001161,Approved 000 Thank You,TID:10002033</HostSpecific>
    <ExtData>Amount=8.74,InvNum=0001161,CardType=VISA,BatchNum=231,Tip=0.00,CashBack=0.00,Fee=0.00,AcntLast4=2062,BIN=460684,Name=A%20GIFT%20FOR%20YOU%2f%20%20%20%20%20%20%20%20%20%20%20,SVC=0.00,TotalAmt=8.74,DISC=0.00,Donation=0.00,SHFee=0.00,RwdPoints=0,RwdBalance=0,RwdIssued=,EBTFSLedgerBalance=,EBTFSAvailBalance=,EBTFSBeginBalance=,EBTCashLedgerBalance=,EBTCashAvailBalance=,EBTCashBeginBalance=,RewardCode=,AcqRefData=,ProcessData=,RefNo=,RewardQR=,Language=English,EntryType=Swipe,table_num=0,clerk_id=,ticket_num=,ControlNum=,TaxCity=0.00,TaxState=0.00,TaxReducedState=0.00,Cust1=,Cust1Value=,Cust2=,Cust2Value=,Cust3=,Cust3Value=,AcntFirst4=4606,TaxAmount=0.00,AVSRsp=,CVVRsp=</ExtData>
    <Sign>...</Sign>
    <Receipt>...</Receipt>
    <CVMResult>2</CVMResult>
  </response>
</xmp>

Void

<request>
  <AuthKey>zbhRAW9N6x</AuthKey>
  <RefId>b95d20c42f</RefId>
  <TPN>z11cantab01</TPN>
  <PaymentType>Card</PaymentType>
  <TransType>Void</TransType>
  <Amount>7.82</Amount>
  <GetReceipt>Both</GetReceipt>
  <PrintReceipt>Both</PrintReceipt>
</request>
<xmp>
  <response>
    <RefId>b95d20c42f</RefId>
    <TransNum>2</TransNum>
    <InvNum>0001221</InvNum>
    <ResultCode>0</ResultCode>
    <RespMSG>APPROVED%2d000</RespMSG>
    <Message>Approved</Message>
    <AuthCode>006254</AuthCode>
    <PaymentType>Card</PaymentType>
    <Voided>false</Voided>
    <TransType>Purchase Correction</TransType>
    <TID>10002033</TID>
    <MID>10002033</MID>
    <SN>000118110290852</SN>
    <HostSpecific>TS: 20211026024531,Sequence Number: 0001224,Approved 000 Thank You,TID:10002033</HostSpecific>
    <ExtData>Amount=7.82,InvNum=0001221,CardType=VISA,BatchNum=11,Tip=0.00,CashBack=0.00,Fee=0.00,AcntLast4=2062,BIN=460684,Name=A%20GIFT%20FOR%20YOU%2f%20%20%20%20%20%20%20%20%20%20%20,SVC=0.00,TotalAmt=7.82,DISC=0.00,Donation=0.00,SHFee=0.00,RwdPoints=0,RwdBalance=0,RwdIssued=,EBTFSLedgerBalance=,EBTFSAvailBalance=,EBTFSBeginBalance=,EBTCashLedgerBalance=,EBTCashAvailBalance=,EBTCashBeginBalance=,RewardCode=,AcqRefData=,ProcessData=,RefNo=,RewardQR=,Language=English,EntryType=Manual,table_num=0,clerk_id=,ticket_num=,ControlNum=,TaxCity=0.00,TaxState=0.00,TaxReducedState=0.00,Cust1=,Cust1Value=,Cust2=,Cust2Value=,Cust3=,Cust3Value=,AcntFirst4=4606,TaxAmount=0.00,BIN=4606,AVSRsp=,CVVRsp=</ExtData>
    <Receipt>...</Receipt>
    <CVMResult>0</CVMResult>
  </response>
</xmp>

Field

Significance

Description

AuthKey

Mandatory

Specifies the Authentication Key, which authorizes Host system to use the SPin

RefId

Mandatory

Unique reference id of the payment.

TPN

Mandatory

Use “TPN” OR “RegisterId”. Unique terminal ID. Can be used to identify the terminal in SPin Proxy environment

RegisterId

Mandatory

Use “TPN” OR “RegisterId”. The value of this field reflects RegisterId field of the SPin request message

SignCapable

Optional

Requests signature from touch screen terminal

PaymentType

Mandatory

Indicates electronic data capture (EDC) type

  • Card – credit/debit card processing

TransType

Mandatory

Indicates the type of transaction to be run

  • Return

  • Sale

  • Void

Amount

Mandatory

Total amount of the transaction in decimal format

GetReceipt

Optional

This field can be used to retrieve formatted receipt data via SPin

PrintReceipt

Optional

Indicates if any of receipt copies should be printed after the transaction

Tip

Mandatory for TipAdjust / Optinal for Sale

Only for Credit operations

PosID

Unique Register ID

Alert

Optional

If request is valid, terminal will beep N times before prompting for card, where N is the value of this field