v2.84.0

TS Dev 108 API Documentation

Download OpenAPI Document

JSON

Download OpenAPI Document

YAML

---

SettingsPaymentProcessors

Endpoints to manage payment processor settings

Operations

GET/api/v2/settings/payment-processors/{processor}/connection/oauth-urlPUT/api/v2/settings/payment-processors/{processor}/connectionDELETE/api/v2/settings/payment-processors/{processor}/connectionGET/api/v2/settings/payment-processorsPATCH/api/v2/settings/payment-processorsGET/api/v2/settings/payment-processors/stripe/locationsGET/api/v2/settings/payment-processors/square/locationsGET/api/v2/settings/payment-processors/stripe/terminals

---

Get OAuth authorization URL for Stripe or Square Connect

GET

/api/v2/settings/payment-processors/{processor}/connection/oauth-url

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

processor*

Payment processor

Type

string

Required

Valid values

"stripe""square"

Responses

Authorization URL for the connect flow

Content-Type

application/json

"string"

GET

/api/v2/settings/payment-processors/{processor}/connection/oauth-url

Playground

Authorization

bearerAuth

Variables

Key

Value

processor*

Samples

---

Manually set connect access code (TicketSocket users only)

PUT

/api/v2/settings/payment-processors/{processor}/connection

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

processor*

Payment processor

Type

string

Required

Valid values

"stripe""square"

Request Body

application/json

"string"

Responses

Connection saved

PUT

/api/v2/settings/payment-processors/{processor}/connection

Playground

Authorization

bearerAuth

Variables

Key

Value

processor*

Body

Samples

---

Disconnect Stripe or Square Connect

DELETE

/api/v2/settings/payment-processors/{processor}/connection

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

processor*

Payment processor

Type

string

Required

Valid values

"stripe""square"

Responses

Connection removed

DELETE

/api/v2/settings/payment-processors/{processor}/connection

Playground

Authorization

bearerAuth

Variables

Key

Value

processor*

Samples

---

Get payment processors settings

GET

/api/v2/settings/payment-processors

Authorizations

bearerAuth

Type

HTTP (bearer)

Responses

Payment processors settings

Content-Type

application/json

{

  

"data": "string"

}

GET

/api/v2/settings/payment-processors

Playground

Authorization

bearerAuth

Samples

---

Update payment processors settings

PATCH

/api/v2/settings/payment-processors

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

"string"

Responses

Settings updated successfully

Content-Type

application/json

{

  

"data": "string"

}

PATCH

/api/v2/settings/payment-processors

Playground

Authorization

bearerAuth

Body

Samples

---

Get available Stripe locations

GET

/api/v2/settings/payment-processors/stripe/locations

Authorizations

bearerAuth

Type

HTTP (bearer)

Responses

Stripe locations

Content-Type

application/json

{

  

"data": [

  

  

{

  

  

  

"additionalProperties": "string"

  

  

}

  

]

}

GET

/api/v2/settings/payment-processors/stripe/locations

Playground

Authorization

bearerAuth

Samples

---

Get available Square locations

GET

/api/v2/settings/payment-processors/square/locations

Authorizations

bearerAuth

Type

HTTP (bearer)

Responses

Square locations

Content-Type

application/json

{

  

"data": [

  

  

{

  

  

  

"additionalProperties": "string"

  

  

}

  

]

}

GET

/api/v2/settings/payment-processors/square/locations

Playground

Authorization

bearerAuth

Samples

---

Get available Stripe terminals

GET

/api/v2/settings/payment-processors/stripe/terminals

Authorizations

bearerAuth

Type

HTTP (bearer)

Responses

Stripe terminals

Content-Type

application/json

{

  

"data": [

  

  

{

  

  

  

"additionalProperties": "string"

  

  

}

  

]

}

GET

/api/v2/settings/payment-processors/stripe/terminals

Playground

Authorization

bearerAuth

Samples

---

Powered by VitePress OpenAPI