Request a terminal to process an intent

Sends an intent for the terminal to be processed. Used to start the terminal to execute an intent. This terminal will only start executing the intent if the terminal is in an idle state.

Securityapi_key
Request
path Parameters
mid
required
string

Merchant Identifier.

intentId
required
string

Intent Identifier.

Request Body schema: application/json
tid
required
string

The Terminal Identity for

Responses
204

Expected response body.

400

Bad request.

401

Invalid API key/MID.

403

Forbidden from performing this action.

404

The intent to reverse could not be found.

422

Thrown when trying to process an intent on a device that is not AVAILABLE.

500
Callbacks
postProcess Callback(postback)
postTask Callback(postback)
postError Callback(postback)
post/merchant/{mid}/intent/{intentId}/process
Request samples
application/json
{
  • "tid": "string"
}
Response samples
application/json

Thrown when trying to process an intent without providing a tid in the request body.

{
  • "statusCode": 400,
  • "error": "BadRequest",
  • "code": "NoTerminalIDProvided",
  • "message": "Cannot process an intent without a Terminal ID."
}
Callback payload samples
application/json
{
  • "transactionId": "transaction-123",
  • "intentId": "intent-123",
  • "status": "completed",
  • "paymentAmount": 100,
  • "statusMessage": "string",
  • "amount": {
    },
  • "paymentMethod": {
    },
  • "host": {
    },
  • "externalRef": "string",
  • "merchantReference": "string",
  • "rawReceipt": "string",
  • "terminalId": "string",
  • "transactionData": {
    },
  • "metadata": { },
  • "cardInputMethod": "string",
  • "externalData": "string"
}