Release a terminal occupied by a pending transaction

POST

/{tenantCode}/v1/transaction/terminal/release

Clears unfinished transactions on the given terminal so a new payment or refund can proceed.

Request

Path Params

Header Params

Body Params

application/json

Example

{
    "paymentChannelId": 1,
    "terminalId": "string"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://sandbox.api.confirmapay.com//v1/transaction/terminal/release' \
--header 'Device-Id;' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data '{
    "paymentChannelId": 1,
    "terminalId": "string"
}'

Responses

🟢200 - Terminal released or already free

application/json

Terminal released or already free

Bodyapplication/json

Example

{
    "data": {
        "terminalId": "string",
        "terminalAvailable": true,
        "releaseReference": "string"
    },
    "description": {
        "code": "string",
        "message": "string"
    },
    "narrative": {
        "code": "string",
        "message": "string"
    }
}

🟠400 - Terminal is still busy, the pending payment belongs to another POS device, payment channel not supported, or credentials missing

Modified at 2026-09-29 18:11:40

Submit refund pin

Get the current processing transaction for a terminal