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

---

Payment Processors

Endpoints to interact with the payment processors

Operations

POST/api/v2/payment-processor/square/mobile-authorization-codePOST/api/v2/payment-processor/square/device-codeGET/api/v2/payment-processor/square/device-code/{id}GET/api/v2/payment-processor/square/terminalsGET/api/v2/payment-processor/stripe/publishable-keyGET/api/v2/payment-processor/stripe/sdkGET/api/v2/payment-processor/stripe/terminalsPOST/api/v2/payment-processor/stripe/readersDELETE/api/v2/payment-processor/stripe/readers/{id}POST/api/v2/payment-processor/stripe/readers/{id}/simulate

---

Create a Square Mobile Authorization code

POST

/api/v2/payment-processor/square/mobile-authorization-code

Creates a short-lived Square Mobile Authorization code for the given location. The mobile app uses the returned authorizationCode to initialize Square Reader SDK / mobile payments. Codes are single-use and expire after 60 minutes.

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

{

  

"location_id": "LXXXX1XXXXXX"

}

Responses

The created mobile authorization code.

Content-Type

application/json

{

  

"data": {

  

  

"authorizationCode": "sq0cma-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

  

}

}

POST

/api/v2/payment-processor/square/mobile-authorization-code

Playground

Authorization

bearerAuth

Body

Samples

---

Create a Square Terminal device pairing code

POST

/api/v2/payment-processor/square/device-code

Creates a Square Terminal device pairing code. The operator enters the returned code on the physical Square Terminal to pair it; poll its status via GET /square/device-code/{id}.

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

{

  

"name": "string"

}

Responses

The created device pairing code.

Content-Type

application/json

{

  

"count": 0,

  

"data": {

  

  

"id": "string",

  

  

"code": "string",

  

  

"status": "string",

  

  

"deviceId": "string"

  

}

}

POST

/api/v2/payment-processor/square/device-code

Playground

Authorization

bearerAuth

Body

Samples

---

Get the status of a Square Terminal device pairing code

GET

/api/v2/payment-processor/square/device-code/{id}

Returns the pairing status of a Square Terminal device code. When status is PAIRED, deviceId is the terminal device used at checkout.

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Device code id.

Type

string

Required

Responses

The current pairing status.

Content-Type

application/json

{

  

"count": 0,

  

"data": {

  

  

"id": "string",

  

  

"status": "string",

  

  

"deviceId": "string"

  

}

}

GET

/api/v2/payment-processor/square/device-code/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Samples

---

List paired Square Terminal devices

GET

/api/v2/payment-processor/square/terminals

Lists the paired Square Terminal devices.

Authorizations

bearerAuth

Type

HTTP (bearer)

Responses

The list of paired Square devices.

Content-Type

application/json

{

  

"count": 0,

  

"data": [

  

  

{

  

  

  

"id": "string",

  

  

  

"label": "string",

  

  

  

"location": "string",

  

  

  

"serialNumber": "string",

  

  

  

"status": "string"

  

  

}

  

]

}

GET

/api/v2/payment-processor/square/terminals

Playground

Authorization

bearerAuth

Samples

---

Get Stripe publishable key

GET

/api/v2/payment-processor/stripe/publishable-key

Returns the active site/venue Stripe publishable key (pk_live_… / pk_test_…) for initialising the client Stripe SDK.

Authorizations

bearerAuth

Type

HTTP (bearer)

Responses

The Stripe publishable key.

Content-Type

application/json

{

  

"data": {

  

  

"publishableKey": "pk_test_51ExampleKey"

  

}

}

GET

/api/v2/payment-processor/stripe/publishable-key

Playground

Authorization

bearerAuth

Samples

---

Get a Stripe Terminal connection token

GET

/api/v2/payment-processor/stripe/sdk

Returns a Stripe Terminal connection token used to initialise the frontend Terminal SDK.

Authorizations

bearerAuth

Type

HTTP (bearer)

Responses

The connection token.

Content-Type

application/json

{

  

"count": 0,

  

"data": {

  

  

"token": "string"

  

}

}

GET

/api/v2/payment-processor/stripe/sdk

Playground

Authorization

bearerAuth

Samples

---

List Stripe Terminal readers

GET

/api/v2/payment-processor/stripe/terminals

Lists the Stripe Terminal readers registered on the account.

Authorizations

bearerAuth

Type

HTTP (bearer)

Responses

The list of registered Stripe readers.

Content-Type

application/json

{

  

"count": 0,

  

"data": [

  

  

{

  

  

  

"id": "string",

  

  

  

"label": "string",

  

  

  

"location": "string",

  

  

  

"serialNumber": "string",

  

  

  

"status": "string"

  

  

}

  

]

}

GET

/api/v2/payment-processor/stripe/terminals

Playground

Authorization

bearerAuth

Samples

---

Register a Stripe Terminal reader

POST

/api/v2/payment-processor/stripe/readers

Registers a physical Stripe Terminal reader against the configured terminal location using its pairing/registration code.

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

{

  

"registrationCode": "string",

  

"label": "string"

}

Responses

The reader was registered.

Content-Type

application/json

{

  

"count": 0,

  

"data": {

  

  

"id": "string",

  

  

"label": "string",

  

  

"status": "string",

  

  

"location": "string",

  

  

"serialNumber": "string"

  

}

}

POST

/api/v2/payment-processor/stripe/readers

Playground

Authorization

bearerAuth

Body

Samples

---

Remove a Stripe Terminal reader

DELETE

/api/v2/payment-processor/stripe/readers/{id}

Deregisters a Stripe Terminal reader.

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Stripe reader id.

Type

string

Required

Responses

The reader was removed.

DELETE

/api/v2/payment-processor/stripe/readers/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Samples

---

Simulate a Stripe Terminal reader payment

POST

/api/v2/payment-processor/stripe/readers/{id}/simulate

Sandbox-only: simulate a card tap on a simulated Stripe Terminal reader so an in-progress card_present PaymentIntent can complete without hardware.

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Simulated Stripe reader id.

Type

string

Required

Request Body

application/json

{

  

"testCardNumber": "string"

}

Responses

The simulated payment method was presented.

POST

/api/v2/payment-processor/stripe/readers/{id}/simulate

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Body

Samples

---

Powered by VitePress OpenAPI