Invoke keyed

Initiate a keyed transaction on the POS device.

Initiate a keyed transaction

ℹ️

Before you can use this feature, you need to enable it at the device level in the Unity Portal.

To initiate a keyed transaction, add the following snippet to your transaction request.

{
  "pointOfInteraction": {
    "invokeKeyed": true
  }
}
ParameterDescription
pointOfInteraction
object
required
Details about the device and environment where a card present transaction takes place. It includes various attributes that help identify and describe the capabilities and configurations of the point-of-sale (POS) device.
pointOfInteraction.invokeKeyed
boolean
Indicates whether you want to initiate a keyed transaction . Keyed transactions involve manually entering the card details on the device. By default, this is set to false.

If your request is successful, you'll receive a 200 response that includes the transaction's updated state. You'll also receive a Transaction (Card Authorised) webhook notification.