Transaction type

Request

Response

Settle

Close Batch

Settle

<request>
  <AuthKey>zbhRAW9N6x</AuthKey>
  <RefId>4963f0ab43</RefId>
  <TPN>z11test1698</TPN>
  <SignCapable>true</SignCapable>
  <TransType>Settle</TransType>
  <param>Close</param>
  <GetReceipt>Batch</GetReceipt>
  <PrintReceipt>Settle</PrintReceipt>
</request>

If there are no transactions in batch:

<xmp>
  <response>
    <RefId></RefId>
    <Message>No open batch</Message>
  </response>
</xmp>

Settled

<xmp>
  <response>
    <RefId>4963f0ab43</RefId>
    <RegisterId></RegisterId>
    <ResultCode>0</ResultCode>
    <Message>Success</Message>
    <ExtData>App=DvCredit,  ResultCode=0, BatchNum=26, Rsp=GB00026 ACCEPTED, Status=GB, NumTrans=3, TipAmt=0.00, TotalAmt=48.96, SHFee=0.00, Receipt=...</ExtData>
    <TransReport>App=DvCredit, TrnsCnt=12, SaleAmt=48.96, ReturnAmt=0.00, VoidAmt=0.00, AuthAmt=0.00, TicketAmt=0.00, ReversalAmt=0.00, CashAdvanceAmt=0.00, TotalAmt=48.96</TransReport>
  </response>
</xmp>

Clear Batch

<request>
  <TransType>Settle</TransType>
  <Param>Clear</Param>
  <RefId>15</RefId>
  <RegisterId>3539002</RegisterId>
  <AuthKey>zbhRAW9N6x</AuthKey>
  <PrintReceipt>No</PrintReceipt>
</request>
<xmp>
  <response>
    <RefId>15</RefId>
    <RegisterId>3539002</RegisterId>
    <ResultCode>0</ResultCode>
    <Message>Success</Message>
    <ExtData>App=DvCredit,  ResultCode=0, BatchNum=2, Rsp=Batch Cleared, Status=0, NumTrans=0, TipAmt=0.00, TotalAmt=0.00, SHFee=0.00, Receipt=</ExtData>
    <TransReport>App=DvCredit, TrnsCnt=0, SaleAmt=0.00, ReturnAmt=0.00, VoidAmt=0.00, AuthAmt=0.00, TicketAmt=0.00, ReversalAmt=0.00, CashAdvanceAmt=0.00, TotalAmt=0.00</TransReport>
  </response>
</xmp>

Force Batch

<request>
  <TransType>Settle</TransType>
  <Param>Force</Param>
  <RefId>16</RefId>
  <RegisterId>3539002</RegisterId>
  <AuthKey>zbhRAW9N6x</AuthKey>
  <PrintReceipt>No</PrintReceipt>
</request>
<xmp>
  <response>
    <RefId>16</RefId>
    <RegisterId>3539002</RegisterId>
    <ResultCode>0</ResultCode>
    <Message>Success</Message>
    <ExtData>App=DvCredit,  ResultCode=0, BatchNum=3, Rsp=GB00003 ACCEPTED, Status=GB, NumTrans=1, TipAmt=0.00, TotalAmt=8.49, SHFee=0.00, Receipt=</ExtData>
    <TransReport>App=DvCredit, TrnsCnt=1, SaleAmt=8.49, ReturnAmt=0.00, VoidAmt=0.00, AuthAmt=0.00, TicketAmt=0.00, ReversalAmt=0.00, CashAdvanceAmt=0.00, TotalAmt=8.49</TransReport>
  </response>
</xmp>

Field

Significance

Description

Get

AuthKey

Mandatory

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

Alert

Optional

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

FromTransNo

Mandatory

Must be used to identify the range the customer wants to retrieve

ToTransNo

Mandatory

RegisterId

Mandatory

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

TPN

Mandatory

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

TransType

Mandatory

Indicates the type of transaction to be run

  • Get

SignCapable

Optional

Requests signature from touch screen terminal

PosID

Unique Register ID

PaymentType

Mandatory

Indicates electronic data capture (EDC) type

  • Credit – credit card processing

Settle

AuthKey

Mandatory

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

TransType

Mandatory

Indicates the type of transaction to be run

  • Settle

RefId

Mandatory

Unique reference id of the payment.

Get receipt

Optional

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

Print receipt

Optional

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

Param

Mandatory

The field indicating the type of settlement processing:

  • Close – standard settlement procedure.

  • Clear – remove all batch data without settlement. For emergency use only. -

  • Force – settle batch without additional validations (untipped transactions, open tabs).

RegisterId

Mandatory

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

TPN

Mandatory

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

SignCapable

Optional

Requests signature from touch screen terminal

PosID

Unique Register ID