Create terminal action

Beta

- POST /v2/terminals/actions

Creates a Terminal action request and sends it to the specified device.

Open in API Reference

Access Tokens Sign in to populate your access tokens from the developer dashboard Sign In

Body

action

The Action to create.

TerminalAction

deadline_duration

The duration as an RFC 3339 duration, after which the action will be automatically canceled. TerminalActions that are PENDING will be automatically CANCELED and have a cancellation reason of TIMED_OUT

Default: 5 minutes from creation

Maximum: 5 minutes

Example for 2 days, 12 hours, 30 minutes, and 15 seconds: P2DT12H30M15S

string

device_id

The unique Id of the device intended for this TerminalAction. The Id can be retrieved from /v2/devices api.

string

receipt_options

Describes configuration for the receipt action. Requires RECEIPT type.

ReceiptOptions

save_card_options

Describes configuration for the save-card action. Requires SAVE_CARD type.

SaveCardOptions

type

Represents the type of the action.

string

Select type

PING The action represents a request to check if the specific device is online or currently active with the merchant in question. Does not require an action options value.

idempotency_key

A unique string that identifies this CreateAction request. Keys can be any valid string but must be unique for every CreateAction request.

See Idempotency keys for more information.

Min Length 1 Max Length 64

string

You are viewing an old version of the API

All Versions

Request

cURL

Response

// No response received yet.

Thanks for the feedback. For more help, check out our support resources.

Developer Support Developer Forums

There was an error submitting feedback. Try again later.

Developer Support Developer Forums