Cancel a Pay Request

An async endpoint used for attempting to cancel a pending decision prompt on a terminal. There is no result to acknowledge that this cancellation was processed by the terminal. If the transaction is already in a fully processed state, this call will be rejected.

Request

Security:

JWT

path Parameters

payRequestId

required

string

header Parameters

Authorization

required

string

Default: Bearer {$$.env.access_token}

Responses

202

Accepted

403

When you don't have the right permissions to cancel a pending payRequest.

412

When the terminal is not paired.

delete/pay-terminal/requests/{payRequestId}

Request samples

curl
C#
Node.js

curl -i -X DELETE \
  'https://api.tyro.com/connect/pay-terminal/requests/{payRequestId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Response samples

application/json

{"error": "Terminal is not paired.",
"errorCode": "TERMINAL_NOT_PAIRED"
}