Skip to content

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

Create a change-order/transfer cart for an order​

POST
/api/v2/change-order/cart/{id}

Creates a change-order cart (upgradeTickets or changeEvent) for an existing order, gated by changeOrdersActive plus upgradesActive/changeEventActive.

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

id*

Original order id.

Type
integer
Required
Format
"int64"

Request Body​

application/json
JSON
"string"

Responses​

Change-order cart created.

application/json
JSON
{
  
"data": "string"
}

Playground​

Authorization
Variables
Key
Value
Body

Samples​


Change/upgrade a ticket in the change-order cart​

POST
/api/v2/change-order/cart/ticket/{guid}/change

Selects the new ticket type (upgrade) or event ticket type (change-event) for one original ticket in the change-order cart. Computes max(0, newPrice - originalPrice) plus the flat upgradeTicketsFee/changeEventFee.

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

guid*

GUID of the original ticket being changed.

Type
string
Required

Request Body​

application/json
JSON
"string"

Responses​

Ticket changed successfully.

application/json
JSON
{
  
"data": "string"
}

Playground​

Authorization
Variables
Key
Value
Body

Samples​


Set attendee info for a change-order cart ticket​

PUT
/api/v2/change-order/cart/ticket/{guid}/attendee

Sets (or clears, when omitted) attendee info for the new ticket mapped to the given original ticket in the change-order cart.

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

guid*

GUID of the original ticket.

Type
string
Required

Request Body​

application/json
JSON
"string"

Responses​

Attendee saved.

application/json
JSON
{
  
"data": "string"
}

Playground​

Authorization
Variables
Key
Value
Body

Samples​


Remove a ticket from the change-order cart (undo)​

DELETE
/api/v2/change-order/cart/ticket/{guid}

Removes a staged original ticket from the change-order cart so POST /change can be called again with a different type.

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

guid*

GUID of the original ticket.

Type
string
Required

Request Body​

application/json
JSON
"string"

Responses​

Ticket removed from the cart.

application/json
JSON
{
  
"data": "string"
}

Playground​

Authorization
Variables
Key
Value
Body

Samples​


List questions for a change-order cart ticket​

GET
/api/v2/change-order/cart/ticket/{guid}/questions

Returns custom questions linked to the new ticket type already selected for this original ticket.

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

guid*

GUID of the original ticket.

Type
string
Required

Query Parameters

cartGuid*

The change-order cart guid.

Type
string
Required

Responses​

Questions for the selected type.

application/json
JSON
{
  
"data": "string"
}

Playground​

Authorization
Variables
Key
Value

Samples​


Set answers for a change-order cart ticket​

PUT
/api/v2/change-order/cart/ticket/{guid}/answers

Replaces custom-question answers for the new ticket mapped to the original ticket guid.

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

guid*

GUID of the original ticket.

Type
string
Required

Request Body​

application/json
JSON
"string"

Responses​

Answers saved.

application/json
JSON
{
  
"data": "string"
}

Playground​

Authorization
Variables
Key
Value
Body

Samples​


Override ticket price on a change-order cart item​

PUT
/api/v2/change-order/cart/ticket/{guid}/ticket-price

Overrides the new ticket list price used in difference math (admin box-office override).

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

guid*

GUID of the original ticket.

Type
string
Required

Request Body​

application/json
JSON
"string"

Responses​

Price override saved.

application/json
JSON
{
  
"data": "string"
}

Playground​

Authorization
Variables
Key
Value
Body

Samples​


Override add-on price on a change-order cart item​

PUT
/api/v2/change-order/cart/ticket/{guid}/addon-price/{answerId}

Overrides the charged amount for a priced question-answer add-on on a staged ticket.

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

guid*

GUID of the original ticket.

Type
string
Required
answerId*

system_questionAnswers id of the priced option.

Type
integer
Required

Request Body​

application/json
JSON
"string"

Responses​

Add-on price override saved.

application/json
JSON
{
  
"data": "string"
}

Playground​

Authorization
Variables
Key
Value
Body

Samples​


Start payment for a change-order/transfer cart​

POST
/api/v2/change-order/checkout

Starts the payment process for a change-order/transfer cart. The charge amount is the sum of each item's price/tax/gratuity differences plus the flat change/upgrade fee and priced add-ons (same formula as the cart total). For Square/NMI, send paymentToken after client-side tokenization; without it, credit checkout returns 412 with keys and missing.

Authorizations​

bearerAuth
Type
HTTP (bearer)

Request Body​

application/json
JSON
"string"

Responses​

Checkout started successfully.

application/json
JSON
{
  
"data": "string"
}

Playground​

Authorization
Body

Samples​


Verify payment and finalize a change-order/transfer cart​

POST
/api/v2/change-order/verify-payment

Verifies the payment status for a change-order/transfer cart. On success, finalizes the change order via ChangeOrderFinalizationService: transferState=transferred on the original ticket, upgradeState=upgraded|eventChange on the new ticket, and changeOrderLog/changeOrderTicketLog rows. The client should poll this endpoint after checkout.

Authorizations​

bearerAuth
Type
HTTP (bearer)

Request Body​

application/json
JSON
{
  
"guid": "string"
}

Responses​

Order finalized successfully.

application/json
JSON
{
  
"data": "string"
}

Playground​

Authorization
Body

Samples​


Cancel payment on a change-order/transfer cart​

POST
/api/v2/change-order/cancel-checkout

Cancels an in-progress payment on a change-order/transfer cart and resets it so the operator can modify the cart or retry checkout. Voids an uncaptured Stripe PaymentIntent. A Square/NMI/Digitzs sync charge is already captured — this resets the cart only and does not refund.

Authorizations​

bearerAuth
Type
HTTP (bearer)

Request Body​

application/json
JSON
{
  
"guid": "string"
}

Responses​

Payment cancelled (or cart reset after a captured sync charge). Does not refund Square/NMI/Digitzs.

Playground​

Authorization
Body

Samples​


Powered by VitePress OpenAPI