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

---

Fees

Fees

Operations

POST/api/v2/fee/get-processing-feePOST/api/v2/fee/get-individual-service-feePOST/api/v2/fee/get-individual-third-party-feePOST/api/v2/fee/get-fee1POST/api/v2/fee/get-fee2

---

Calculate the service fee for a given amount (front or backend)

POST

/api/v2/fee/get-processing-fee

Uses the front or backend service fee structure to calculate a fee - does not consider non-applicable items

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

{

  

"useBackendFees": "0 or 1",

  

"amount": "121.30"

}

Responses

POST

/api/v2/fee/get-processing-fee

Playground

Authorization

bearerAuth

Body

Samples

---

Calculate the service fee for a given amount (front or backend)

POST

/api/v2/fee/get-individual-service-fee

Uses the front or backend service fee structure to calculate a fee - does not consider non-applicable items

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

"string"

Responses

POST

/api/v2/fee/get-individual-service-fee

Playground

Authorization

bearerAuth

Body

Samples

---

Calculate the service fee for a given amount (front or backend)

POST

/api/v2/fee/get-individual-third-party-fee

Uses the front or backend service fee structure to calculate a fee - does not consider non-applicable items

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

"string"

Responses

POST

/api/v2/fee/get-individual-third-party-fee

Playground

Authorization

bearerAuth

Body

Samples

---

Calculate the fee1 (usually tax) for a given ticketType and amount

POST

/api/v2/fee/get-fee1

Uses the fee values from the ticketType to calculate the fee (normally tax)

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

{

  

"amount": "121.30",

  

"typeId": "6079"

}

Responses

POST

/api/v2/fee/get-fee1

Playground

Authorization

bearerAuth

Body

Samples

---

Calculate the fee2 (usually gratuity) for a given ticketType and amount

POST

/api/v2/fee/get-fee2

Uses the fee values from the ticketType to calculate the fee (normally gratuity)

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

"string"

Responses

POST

/api/v2/fee/get-fee2

Playground

Authorization

bearerAuth

Body

Samples

---

Powered by VitePress OpenAPI