1. Home
  2. Docs
  4. Run Transaction

Run Transaction

You would use this method to run a transaction on the terminal. The method is the same as runTransaction with the exception of having some additional fields, the return object is the same.

invoiceNumber (When using Vantiv, this value will be sent to Vantiv)
merchantId (Used for Multi Mid applications, current only available in Dejavoo’s)
token – Please contact support regarding token support on specific terminals and processors.
expDate – Needed when doing a token sale through TSYS or RapidConnect.

None of these fields are required to have a value but they all need to be in the request.
Please note that the amount needs to include the decimal point.

Tokens General
If tokenization is enabled in the terminal, Sale, Auth and Refund transactions will return a token and expiration date in the response. The token can be used to run a Sale, Auth or Refund at a later date without the card holder being present. TipAdjust, Capture and Void operate on the transaction level, which means that you are not using the token for these transactions but the RefId of the original transaction.

To run different types of transactions, change the command value in the request.  Valid command values:

Sale, Refund, Auth, Capture, Void, TipAdjust,
GiftActivate, GiftSale, GiftRefund, GiftAddValue, GiftBalance

In order to do a follow-up transaction (commands in italics), the batch needs to still be open and the RefId from the previous transaction needs to be sent instead of creating a new one. It is also recommended that you create a RefId value for all initial transactions as that will allow you to use the checkStatus() in the event of comm errors.

"Command" : "sale",      //Sale, Refund, Auth, Capture, Void, TipAdjust
"Key": "123456789-0",
"Password": "987654321-1",
"amount": 2.50,
"terminalId": 1234,
"refId": "987654321",
"token" : "",
"expDate" : "",
"invoiceNumber" : "",
"paymenttype":"ebtfood"  //credit,debit,ebtfood,ebtcash

JSON Response

  "TerminalID": "1234",
  "ResultCode": "Approved",
  "AuthCode": "abc1234",
  "TransType": "Sale",
  "Amount": 2.50,
  "CardType": "Visa",
  "Last4": "0026",
  "Name": "John Doe",
  "CashBack": 0.00,
  "CashBackString": "0.00",
  "Message": "This is a sample message",
  "RefID": "ee0252f6-38bf-4c3f-97d4-a3ecf87cf69b",
  "ProcessorExtraData1":"KaNb015170105002706cAAFEd5e00fJlA m000005",
  "Track1": null,
  "Track2": null,
  "EMV_TC": "B9AB420B0937438F",
  "EMV_TVR": "0800008000",
  "EMV_AID": "A0000000031010",
  "EMV_TSI": "F800",
  "EMV_ATC": "0016",
  "EMV_App_Label": "Visa Credit",
  "EMV_App_Name": "Visa Credit",
  "CardBin": "476173",
  "EntryMethod": "Chip",
  "receiptTerminal":"Blackline Partners

Client ID:  13318900010001
Cashier ID:
Lane:                            Store: 

05/01/2015                      16:56:25

                Invoice: 78

Account:  VISA 401200******0026
Cardholder:  TEST CARD   /VISA
Authorization Code:  000271


How can we help?