curl --request POST \
--url https://api-dashboard.payra.com/v1/terminals/{id}/check-out \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"checked_out_to": "Tablet TB0011",
"checked_out_by": "j.doe",
"replace": false
}
'import requests
url = "https://api-dashboard.payra.com/v1/terminals/{id}/check-out"
payload = {
"checked_out_to": "Tablet TB0011",
"checked_out_by": "j.doe",
"replace": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({checked_out_to: 'Tablet TB0011', checked_out_by: 'j.doe', replace: false})
};
fetch('https://api-dashboard.payra.com/v1/terminals/{id}/check-out', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-dashboard.payra.com/v1/terminals/{id}/check-out",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'checked_out_to' => 'Tablet TB0011',
'checked_out_by' => 'j.doe',
'replace' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-dashboard.payra.com/v1/terminals/{id}/check-out"
payload := strings.NewReader("{\n \"checked_out_to\": \"Tablet TB0011\",\n \"checked_out_by\": \"j.doe\",\n \"replace\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-dashboard.payra.com/v1/terminals/{id}/check-out")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"checked_out_to\": \"Tablet TB0011\",\n \"checked_out_by\": \"j.doe\",\n \"replace\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-dashboard.payra.com/v1/terminals/{id}/check-out")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"checked_out_to\": \"Tablet TB0011\",\n \"checked_out_by\": \"j.doe\",\n \"replace\": false\n}"
response = http.request(request)
puts response.read_body{
"object": "terminal",
"id": "019f2c4e-7b1a-7d3e-9a10-3c5b8e2f4a61",
"label": "Truck 412",
"model": "AMS1",
"serial_number": "1853000123",
"checked_out_to": "Tablet TB0011",
"checked_out_at": "2026-10-21T12:05:00.000Z",
"checked_out_by": "j.doe",
"livemode": false
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"param": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"param": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"param": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"param": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"param": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"param": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"param": "<string>"
}
}Check a terminal out
Hands the terminal to a tablet, truck or person until it is checked back in. A terminal checked out to someone else since the last nightly release (2 AM in your account’s time zone) answers 400 terminal_checked_out with checked_out_to naming who has it, unless replace is true; without replace, one still out from before that release is released first (end_reason nightly_release) and checked out to you. A check-out to whoever already has it since that release answers 200 as it is; list with checked_out=false to pick a free one. Payments are not affected: a checked-out terminal takes them as before.
curl --request POST \
--url https://api-dashboard.payra.com/v1/terminals/{id}/check-out \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"checked_out_to": "Tablet TB0011",
"checked_out_by": "j.doe",
"replace": false
}
'import requests
url = "https://api-dashboard.payra.com/v1/terminals/{id}/check-out"
payload = {
"checked_out_to": "Tablet TB0011",
"checked_out_by": "j.doe",
"replace": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({checked_out_to: 'Tablet TB0011', checked_out_by: 'j.doe', replace: false})
};
fetch('https://api-dashboard.payra.com/v1/terminals/{id}/check-out', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-dashboard.payra.com/v1/terminals/{id}/check-out",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'checked_out_to' => 'Tablet TB0011',
'checked_out_by' => 'j.doe',
'replace' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-dashboard.payra.com/v1/terminals/{id}/check-out"
payload := strings.NewReader("{\n \"checked_out_to\": \"Tablet TB0011\",\n \"checked_out_by\": \"j.doe\",\n \"replace\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-dashboard.payra.com/v1/terminals/{id}/check-out")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"checked_out_to\": \"Tablet TB0011\",\n \"checked_out_by\": \"j.doe\",\n \"replace\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-dashboard.payra.com/v1/terminals/{id}/check-out")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"checked_out_to\": \"Tablet TB0011\",\n \"checked_out_by\": \"j.doe\",\n \"replace\": false\n}"
response = http.request(request)
puts response.read_body{
"object": "terminal",
"id": "019f2c4e-7b1a-7d3e-9a10-3c5b8e2f4a61",
"label": "Truck 412",
"model": "AMS1",
"serial_number": "1853000123",
"checked_out_to": "Tablet TB0011",
"checked_out_at": "2026-10-21T12:05:00.000Z",
"checked_out_by": "j.doe",
"livemode": false
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"param": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"param": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"param": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"param": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"param": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"param": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"param": "<string>"
}
}Authorizations
A secret key, sk_test_... or sk_live_...; a publishable key (pk_...) on the browser routes only
Path Parameters
1 - 64Body
Who takes the terminal, 1 to 120 characters. Shown in RevOS next to the terminal.
1 - 120"Tablet TB0011"
Your user doing the check-out, kept in the terminal's check-out history for your audit.
1 - 120"j.doe"
Take the terminal over from whoever has it instead of answering terminal_checked_out. Send it only when you know the terminal is in hand, such as a check-in someone forgot since the last nightly release; one from before that release is released without it.
false
Response
The terminal, checked out
terminal Pass it as terminal on a payment.
"019f2c4e-7b1a-7d3e-9a10-3c5b8e2f4a61"
Your name for the terminal, such as the truck it rides in; null until you name it.
"Truck 412"
"AMS1"
Printed on the back of the terminal.
"1853000123"
Who has the terminal right now, as you named them at check-out: a tablet, a truck, a driver. null while it sits free.
"Tablet TB0011"
When it was checked out; null while it sits free.
"2026-10-21T12:05:00.000Z"
Your user who did the check-out, as you sent it; null when you sent none or while the terminal sits free.
"j.doe"
false