Payments & Vouchers

Terminal Tokenisations

A TerminalTokenisation represents a tokenisation request to a terminal.

post/shop/terminal-tokenisations

Create a request to tokenise a customer's card details

createCardTokenisationRequest

This endpoint sends a request to the terminal to tokenise a customer's card details.

Request body

terminal_idobject-idrequired
Identifier of the physical payment terminal that should prompt for the card. The terminal captures the card and returns a tokenised reference; no PAN is stored in Trybe. Must belong to the caller's site.
customer_iduuidrequired
Identifier of the customer whose card is being saved on file. The resulting payment-method token is attached to this customer and can be used for future charges (e.g. no-show fees, recurring bookings).

Responses

200
The Card Tokenisation 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-tokenisations" \
  -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"
}'

const response = await fetch('https://api.playground.try.be/shop/terminal-tokenisations', {
  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"
  }),
})

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-tokenisations",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "terminal_id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "customer_id": "00000000-0000-0000-0000-000000000000"
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

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

$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",
	})
	req, _ := http.NewRequest("POST", "https://api.playground.try.be/shop/terminal-tokenisations", 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 Card Tokenisation was successfully retrieved

{
  "data": {
    "id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "status": "pending",
    "site_id": "00000000-0000-0000-0000-000000000000",
    "terminal_id": "00000000-0000-0000-0000-000000000000",
    "service_id": "00000000-0000-0000-0000-000000000000",
    "processor_data": {}
  }
}

{
  "message": "string"
}

{
  "message": "Unauthenticated"
}

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

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

get/shop/terminal-tokenisations/{paymentId}

Show a Card Tokenisation Request

getCardTokenisationRequest

This endpoint retrieves a Card Tokenisation Request by Payment ID.

Path parameters

paymentIdobject-idrequired
The ID of the CardTokenisationRequest

Responses

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

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

const response = await fetch('https://api.playground.try.be/shop/terminal-tokenisations/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-tokenisations/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-tokenisations/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-tokenisations/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 Card Tokenisation was successfully retrieved

{
  "data": {
    "id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "status": "pending",
    "site_id": "00000000-0000-0000-0000-000000000000",
    "terminal_id": "00000000-0000-0000-0000-000000000000",
    "service_id": "00000000-0000-0000-0000-000000000000",
    "processor_data": {}
  }
}

{
  "message": "Unauthenticated"
}

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

post/shop/terminal-tokenisations/{paymentId}/cancel

Cancel a Card Tokenisation Request

actionCancelCardTokenisationRequest

This endpoint cancels a Card Tokenisation Request.

Path parameters

paymentIdobject-idrequired
The ID of the CardTokenisationRequest

Responses

200
The Card Tokenisation 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-tokenisations/abc123/cancel" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/terminal-tokenisations/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-tokenisations/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-tokenisations/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-tokenisations/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 Card Tokenisation was successfully retrieved

{
  "data": {
    "id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "status": "pending",
    "site_id": "00000000-0000-0000-0000-000000000000",
    "terminal_id": "00000000-0000-0000-0000-000000000000",
    "service_id": "00000000-0000-0000-0000-000000000000",
    "processor_data": {}
  }
}

{
  "message": "Unauthenticated"
}

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

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