Payments & Vouchers

Terminal Requests

A TerminalRequest represents a request to a terminal, such as a payment request or a wearable association.

post/shop/terminal-requests/identity

Create a request to identify a Wearable Device

createIdentityRequest

This endpoint sends a request to the terminal to identify a wearable device.

Request body

terminal_idobject-idrequired
Identifier of the physical payment terminal that should prompt for the wearable tap. Must be a terminal registered to the caller's site; the terminal serves the prompt and relays the scanned wearable's identifier back to Trybe.

Responses

200
The Terminal Request was successfully retrieved
400
The request failed.
401
The user is unauthenticated
403
The authenticated user does not have permission.
422
The request didn't pass validation

curl -X POST "https://api.playground.try.be/shop/terminal-requests/identity" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "terminal_id": "64a9f3b2c3d8e1f4a5b6c7d8"
}'

const response = await fetch('https://api.playground.try.be/shop/terminal-requests/identity', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "terminal_id": "64a9f3b2c3d8e1f4a5b6c7d8"
  }),
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.post(
    "https://api.playground.try.be/shop/terminal-requests/identity",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "terminal_id": "64a9f3b2c3d8e1f4a5b6c7d8"
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.playground.try.be/shop/terminal-requests/identity', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'terminal_id' => '64a9f3b2c3d8e1f4a5b6c7d8'
        ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"bytes"
	"encoding/json"
	"net/http"
)

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"terminal_id": "64a9f3b2c3d8e1f4a5b6c7d8",
	})
	req, _ := http.NewRequest("POST", "https://api.playground.try.be/shop/terminal-requests/identity", bytes.NewBuffer(payload))
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

The Terminal Request was successfully retrieved

{
  "data": {
    "id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "site_id": "00000000-0000-0000-0000-000000000000",
    "terminal_id": "00000000-0000-0000-0000-000000000000",
    "service_id": "00000000-0000-0000-0000-000000000000",
    "status": "pending",
    "amount": 1,
    "succeeded_at": "2026-01-15T09:30:00+00:00",
    "failed_at": "2026-01-15T09:30:00+00:00",
    "processor_data": {}
  }
}

{
  "message": "string"
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "errors": {},
  "message": "The request didn't pass validation"
}

post/shop/terminal-requests/associate-wearable

Create a request to associate a Wearable Device

createWearableAssociationRequest

This endpoint sends a request to the terminal to associate a wearable device.

Request body

terminal_idobject-idrequired
Identifier of the physical terminal that should prompt for the wearable tap. Must be a terminal registered to the caller's site; the terminal scans the wearable and completes the link to customer_id.
customer_iduuidrequired
Identifier of the customer that the scanned wearable should be linked to. Once associated, the wearable can be used as a payment device for this customer's stays and visits.
order_idobject-idoptionalnullable
Optional identifier of an order to attach the wearable to at association time, useful for express check-in flows. Pass null to leave the wearable unattached.

Responses

200
The Terminal Request was successfully retrieved
400
The request failed.
401
The user is unauthenticated
403
The authenticated user does not have permission.
422
The request didn't pass validation

curl -X POST "https://api.playground.try.be/shop/terminal-requests/associate-wearable" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "terminal_id": "64a9f3b2c3d8e1f4a5b6c7d8",
  "customer_id": "00000000-0000-0000-0000-000000000000",
  "order_id": "64a9f3b2c3d8e1f4a5b6c7d8"
}'

const response = await fetch('https://api.playground.try.be/shop/terminal-requests/associate-wearable', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "terminal_id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "customer_id": "00000000-0000-0000-0000-000000000000",
    "order_id": "64a9f3b2c3d8e1f4a5b6c7d8"
  }),
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.post(
    "https://api.playground.try.be/shop/terminal-requests/associate-wearable",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "terminal_id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "customer_id": "00000000-0000-0000-0000-000000000000",
        "order_id": "64a9f3b2c3d8e1f4a5b6c7d8"
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.playground.try.be/shop/terminal-requests/associate-wearable', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'terminal_id' => '64a9f3b2c3d8e1f4a5b6c7d8',
            'customer_id' => '00000000-0000-0000-0000-000000000000',
            'order_id' => '64a9f3b2c3d8e1f4a5b6c7d8'
        ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"bytes"
	"encoding/json"
	"net/http"
)

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"terminal_id": "64a9f3b2c3d8e1f4a5b6c7d8",
		"customer_id": "00000000-0000-0000-0000-000000000000",
		"order_id": "64a9f3b2c3d8e1f4a5b6c7d8",
	})
	req, _ := http.NewRequest("POST", "https://api.playground.try.be/shop/terminal-requests/associate-wearable", bytes.NewBuffer(payload))
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

The Terminal Request was successfully retrieved

{
  "data": {
    "id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "site_id": "00000000-0000-0000-0000-000000000000",
    "terminal_id": "00000000-0000-0000-0000-000000000000",
    "service_id": "00000000-0000-0000-0000-000000000000",
    "status": "pending",
    "amount": 1,
    "succeeded_at": "2026-01-15T09:30:00+00:00",
    "failed_at": "2026-01-15T09:30:00+00:00",
    "processor_data": {}
  }
}

{
  "message": "string"
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "errors": {},
  "message": "The request didn't pass validation"
}

get/shop/terminal-requests/{terminalRequestId}

Show a Terminal Request

getTerminalRequest

This endpoint retrieves a Terminal Request by ID.

Path parameters

terminalRequestIdobject-idrequired
The ID of the TerminalRequest

Responses

200
The Terminal Request was successfully retrieved
401
The user is unauthenticated
404
The resource couldn't be found

curl "https://api.playground.try.be/shop/terminal-requests/abc123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/terminal-requests/abc123', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.get(
    "https://api.playground.try.be/shop/terminal-requests/abc123",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.playground.try.be/shop/terminal-requests/abc123', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.playground.try.be/shop/terminal-requests/abc123", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

The Terminal Request was successfully retrieved

{
  "data": {
    "id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "site_id": "00000000-0000-0000-0000-000000000000",
    "terminal_id": "00000000-0000-0000-0000-000000000000",
    "service_id": "00000000-0000-0000-0000-000000000000",
    "status": "pending",
    "amount": 1,
    "succeeded_at": "2026-01-15T09:30:00+00:00",
    "failed_at": "2026-01-15T09:30:00+00:00",
    "processor_data": {}
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "The requested resource could not be found"
}

post/shop/terminal-requests/{terminalRequestId}/cancel

Cancel a Terminal Request

actionCancelTerminalRequest

This endpoint cancels a Terminal Request.

Path parameters

terminalRequestIdobject-idrequired
The ID of the TerminalRequest

Responses

200
The Terminal Request was successfully retrieved
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found

curl -X POST "https://api.playground.try.be/shop/terminal-requests/abc123/cancel" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/terminal-requests/abc123/cancel', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.post(
    "https://api.playground.try.be/shop/terminal-requests/abc123/cancel",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.playground.try.be/shop/terminal-requests/abc123/cancel', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("POST", "https://api.playground.try.be/shop/terminal-requests/abc123/cancel", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

The Terminal Request was successfully retrieved

{
  "data": {
    "id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "site_id": "00000000-0000-0000-0000-000000000000",
    "terminal_id": "00000000-0000-0000-0000-000000000000",
    "service_id": "00000000-0000-0000-0000-000000000000",
    "status": "pending",
    "amount": 1,
    "succeeded_at": "2026-01-15T09:30:00+00:00",
    "failed_at": "2026-01-15T09:30:00+00:00",
    "processor_data": {}
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}