Device Transaction

A Device Transaction represents a transaction and a device that are associated together.

Properties

Property	Type	Description	Example
id	Number(integer)	Read-only unique identifier.	1234567890
type*	String	The type of device transaction. "auth" means an auth only transaction is requested. "sale" means a sale transaction is requested (default). "cancel" is used to cancel a pending device transaction request.	"auth"
amount*	Number(float)	The required amount in dollars of the transaction being requested.	1.07
key	String	The unique key generated for a specific device payment request. This is the value you will use to cancel or check on the status of a particular request.	"1234567890"
status	String	"requested", "transaction complete", "canceled via api", "canceled via terminal", "request timed out"	"requested"
response_code	String	The response code from the POS Device. All responses that are OK will have a response code of "000000".	"000000"
transaction	Object(Transaction object)	The transaction object associated with a specific device transaction request. Will contain the associated transaction object if the status of the device transaction is "transaction complete".	See Transaction Examples
device	Object(Device object)	The device that the request was sent to.	See Device Example

Requirements

*Required for all Device Transactions. type defaults to a value of "sale" if omitted.

Example

JSON

{
  "id": 1234567890,
  "type": "auth",
  "amount": 1.07,
  "key": "1234567890",
  "status": "requested",
  "response_code": "000000",
  "transaction": null,
  "device": {
    "key": "1234567890",
    "name": "Test Terminal",
    "sn": "1234567890"
  }
}