v12.11.0

V2 Staging API Documentation

Download OpenAPI Document

JSON

Download OpenAPI Document

YAML

REST API v2. Authenticate with a Bearer JWT in the Authorization header unless an endpoint is marked public.

Servers

https://v2-staging.tscheckout.comCurrent host

---

Utilities

Endpoints the provide general utility functions

Operations

GET/api/v2/utilities/system-versionGET/api/v2/utilities/supported-countriesGET/api/v2/utilities/get-supported-currenciesGET/api/v2/utilities/get-currency-display-nameGET/api/v2/utilities/round-currency

---

Get system version information

GET

/api/v2/utilities/system-version

Returns version metadata about the running TicketSocket installation, including the application version, PHP version, last-updated timestamp, and copyright year.

Authorizations

bearerAuth

Type

HTTP (bearer)

Responses

System version information

Content-Type

application/json

{

  

"data": "string"

}

GET

/api/v2/utilities/system-version

Playground

Authorization

bearerAuth

Samples

---

Get supported countries

GET

/api/v2/utilities/supported-countries

Returns the map of supported ISO 3166-1 alpha-2 country codes to display names used by checkout and other settings.

Authorizations

bearerAuth

Type

HTTP (bearer)

Responses

Supported countries map

Content-Type

application/json

{

  

"data": "string"

}

GET

/api/v2/utilities/supported-countries

Playground

Authorization

bearerAuth

Samples

---

Get the currencies currently supported

GET

/api/v2/utilities/get-supported-currencies

Returns a list of supported 3-letter currencies

Authorizations

bearerAuth

Type

HTTP (bearer)

Responses

GET

/api/v2/utilities/get-supported-currencies

Playground

Authorization

bearerAuth

Samples

---

Get the display name of a currency

GET

/api/v2/utilities/get-currency-display-name

Returns a display name for the provided 3-letter currency name

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Query Parameters

currency*

The three letter currency that you want to get the display name for

Type

string

Required

Responses

GET

/api/v2/utilities/get-currency-display-name

Playground

Authorization

bearerAuth

Variables

Key

Value

currency*

Samples

---

Round an amount of a currency

GET

/api/v2/utilities/round-currency

Returns a rounded float to 2 decimals (currently), may be expanded to support other options in the future

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Query Parameters

amount*

Amount of the currency in raw form

Type

string

Required

Responses

GET

/api/v2/utilities/round-currency

Playground

Authorization

bearerAuth

Variables

Key

Value

amount*

Samples

---

Powered by VitePress OpenAPI