Transaction Request

Runs a transaction against the payment terminal. TransType=Sale supports five optional add-on groups below (Custom Timeout, Auto Rental Data, Level 2 & Level 3 Data, Card Price for L2/L3, and HSA/FSA Card Acceptance) — enable a group's checkbox to include its fields in the generated request.

Request Body

application/json

AuthKey*string

Specifies the Auth-Key, which authorizes the Host system to use the SPIn Web Service.AuthKey generated in the portal STEAM -> Edit Pameters -> Integration (Necessary for all SPIn Proxy connections, optional for direct terminal connections).

PaymentType*string

EDC type. userChoice allows the customer to pick Credit/Debit/EBT at the terminal; the response echoes back the option chosen.

TransType*string

Type of transaction to run. Credit supports Sale/Return/Void/Auth/Capture/CashAdvance; Debit and EBT_Food/EBT_Cash support Sale/Return; Balance applies only to EBT_Food/EBT_Cash.

Amount*string

Total dollar amount of the transaction ($$$$$$$.CC), including tip if present. Must always be positive, even for Returns.

Tip?string

Dollar amount of the tip. Tip must be enabled on the terminal.

CustomFee?string

Dollar amount considered as custom fee, per the TPN's configured fee type.

RefId*string

Alphanumeric reference field, unique within an open batch. Mandatory for all deployments.

RegisterId*string

Alphanumeric reference field identifying the register/POS. Available in the portal Steam -> Edit Parameters -> Integration.

TPN?string

Can be used instead of RegisterId for Dejavoo SPIn Proxy connections.

CashbackAmount?string

Cashback amount. Only valid on Debit or EBT payment types.

PrintReceipt?string

No = suppress printing, Merchant/Customer = print one copy, Both = print both (default).

Value in"No" | "Merchant" | "Customer" | "Both"

SigCapture?string

No suppresses the signature capture event; Yes (or omitted) captures a signature if supported.

Value in"Yes" | "No"

Tag1?string

Merchant-configured tag; printed on the merchant receipt copy and filterable on the portal.

Tag2?string

Same as Tag1.

Tag3?string

Same as Tag1.

PerformedBy?string

Identifies the user (e.g. merchant email) who performed the transaction, uploaded with the signature.

MerchantId?string

Required when Multi MID (MMID) is enabled — the transacting TPN under the Master TPN.

ReconId?string

Fiserv North / Elavon reconciliation reference ID (11 chars for Fiserv North, 24 for Elavon).

IsvId?string

16-character alphanumeric ISV identifier.

CityTax?string

City tax applied to the transaction. Tax must be enabled on the terminal.

StateTax?string

State tax applied to the transaction. Tax must be enabled on the terminal.

ReducedStateTax?string

Reduced state tax (Hacienda) applied to eligible items. Must be enabled on the terminal.

CustomerEmail?string

Pre-fills the Send Email Receipt screen and sends the e-receipt to this address.

CustomerMobile?string

Pre-fills the Text Receipt screen. Must include country code, e.g. +15418996990.

Response Body

`application/json`

curl -X GET "https://example.com/cgi.html" \  -H "Content-Type: application/json" \  -d '{    "AuthKey": "",    "PaymentType": "Credit",    "TransType": "Sale",    "Amount": "1.00",    "Tip": "",    "CustomFee": "",    "RefId": "12234",    "RegisterId": "",    "TPN": "",    "CashbackAmount": "",    "PrintReceipt": "No",    "SigCapture": "No",    "Tag1": "",    "Tag2": "",    "Tag3": "",    "PerformedBy": "",    "MerchantId": "",    "ReconId": "",    "IsvId": "",    "CityTax": "",    "StateTax": "",    "ReducedStateTax": "",    "CustomerEmail": "",    "CustomerMobile": ""  }'

{
  "RefId": "string",
  "RegisterId": "string",
  "TPN": "string",
  "TransNum": "string",
  "InvNum": "string",
  "ResultCode": "string",
  "RespMSG": "string",
  "Message": "string",
  "AuthCode": "string",
  "PNRef": "string",
  "PaymentType": "string",
  "Voided": "string",
  "TransType": "string",
  "SN": "string",
  "ExtData": "string",
  "EMVData": "string",
  "Sign": "string",
  "iPOSToken": "string",
  "ContactDetailsError": "string"
}

Transaction Request

Request Body

Response Body

200application/json

`application/json`