Send a Device Transaction request

post https://{environment}.{server}.com/v3/device/{devicekey}/transaction

Sends a transaction request to the device (sale or auth) associated to the provided devicekey. The payment will be performed on the Device, then the Device will return the results.

Path Params

devicekey

string

required

The Serial Number used to search for the associated Device.

Body Params

type

string

required

auth = auth only transaction requested

sale = sale transaction requested (default)

cancel = cancel the device transaction request

amount

number

required

Required amount in dollars of the transaction being requested.

key

string

This is the unique key generated for this device payment request. This is the value you will use to cancel or check on the status of this request.

status

string

requested, transaction complete, canceled via api, canceled via terminal, request timed out.

response_code

string

The response code from the Device. All responses that are OK will have a response code of '000000'.

transaction

object

Transactions require either a card or a check, but not both.

For new Transactions, if using a card, the card may be either tokenized or non-tokenized. Any non-tokenized card will be tokenized automatically by the PaidYET API.

device

object

Represents a terminal device.

Responses

Response body

object

messages

object

notice

array of objects

length ≥ 0

Any notice messages.

notice

object

code

integer

Message code. If not applicable, may be omitted or set to '0'.

content

string

The content of the message.

success

array of objects

length ≥ 0

Any success messages.

success

object

code

integer

Message code. If not applicable, may be omitted or set to '0'.

content

string

The content of the message.

warning

array of objects

length ≥ 0

Any warning messages.

warning

object

code

integer

Message code. If not applicable, may be omitted or set to '0'.

content

string

The content of the message.

error

array of objects

length ≥ 0

Any error messages.

error

object

code

integer

Message code. If not applicable, may be omitted or set to '0'.

content

string

The content of the message.

payload

object

The API Payload provides a standard payload format for consumers. It wraps any returned items into the 'items' array and describes the type of those items. It also describes how they have been paginated by the PaidYET API server.

If the called endpoint returns a single item, it will appear as the only object in the 'items' array. Otherwise, the 'items' array will contain all items that resulted from the request.

type

string

The type of data being returned in the payload.

items

array of objects

The Device Transaction result.

items

object

integer

Read-only unique identifier.

type

string

required

auth = auth only transaction requested

sale = sale transaction requested (default)

cancel = cancel the device transaction request

auth sale cancel

amount

number

required

Required amount in dollars of the transaction being requested.

key

string

This is the unique key generated for this device payment request. This is the value you will use to cancel or check on the status of this request.

status

string

requested, transaction complete, canceled via api, canceled via terminal, request timed out.

response_code

string

The response code from the Device. All responses that are OK will have a response code of '000000'.

transaction

object

device

object

Represents a terminal device.

count

integer

The total number of items that could have been returned matching the request criteria.

pages

integer

The total number of pages.

page

integer

The number of the page of items returned.

per_page

integer

The number of items per page of this payload.

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.sandbox-paidyet.com/v3/device/devicekey/transaction \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '{"type":"auth"}'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200PaidYET API Response containing the payload and any messages. The payload's items array contains ONE Device Transaction.

400Authentication Token error

401Authentication required