Tiquo

https://docs.tiquo.co/en
Admin
Tiquo is an operating system for the service industry that unifies booking management, point of...
Tokens:393,421
Snippets:3,240
Trust Score:6.1
Update:1 week ago
Show doc for...
Tokens:
Raw
### Start a setup

Source: https://docs.tiquo.co/en/docs/api-reference/customer-api/payment-methods

Start the setup process for a new payment method.

```APIDOC
## POST /payment-methods/setup

### Description
Start the setup process for a new payment method.

### Method
POST

### Endpoint
/payment-methods/setup

### Request Body
- **setupIntentId** (string) - Required - The identifier for the setup intent.

### Request Example
{
  "setupIntentId": "seti_123456"
}

### Response
#### Success Response (200)
- **setupIntentId** (string) - The identifier for the setup intent.

#### Response Example
{
  "setupIntentId": "seti_123456"
}

### Error Handling
- **400** - The payment operation could not be completed or `setupIntentId` is missing or invalid.
- **401** - Missing, invalid, or expired access token.
- **403** - No customer profile is linked to the authenticated account.
- **500** - Internal server error.
```

--------------------------------

### Start a setup - response

Source: https://docs.tiquo.co/en/docs/api-reference/customer-api/payment-methods

Example JSON response from the setup endpoint, containing success, setupIntentId, and clientSecret. Use the clientSecret with Stripe's client SDK to collect and confirm payment details.

```json
{
  "success": true,
  "setupIntentId": "seti_123",
  "clientSecret": "seti_123_secret_..."
}
```

--------------------------------

### Start a setup - POST /payment-methods/setup

Source: https://docs.tiquo.co/en/docs/api-reference/customer-api/payment-methods

Starts a payment method setup. The optional paymentMethodTypes array accepts 'card' and 'direct_debit'. When omitted or contains no supported value, the endpoint starts a card-only setup.

```http
POST /payment-methods/setup
```

--------------------------------

### Start a setup - curl request

Source: https://docs.tiquo.co/en/docs/api-reference/customer-api/payment-methods

Sends a POST request to start a payment method setup with a card payment method type. Requires an Authorization Bearer token.

```bash
curl -X POST "https://edge.tiquo.app/api/client/v1/payment-methods/setup" \
  -H "Authorization: Bearer eyJhbGciOiJSUzI1NiJ9..." \
  -H "Content-Type: application/json" \
  -d '{"paymentMethodTypes":["card"]}'
```

--------------------------------

### POST /payment-methods/setup

Source: https://docs.tiquo.co/en/docs/api-reference/customer-api/payment-methods

Starts a payment method setup. Optionally accepts a paymentMethodTypes array with 'card' and 'direct_debit'. If omitted or contains no supported value, a card-only setup is started.

```APIDOC
## POST /payment-methods/setup

### Description
Starts a payment method setup. Optionally accepts a paymentMethodTypes array with 'card' and 'direct_debit'. If omitted or contains no supported value, a card-only setup is started.

### Method
POST

### Endpoint
/payment-methods/setup

### Parameters
#### Request Body
- **paymentMethodTypes** (array of string) - Optional - Accepts `card` and `direct_debit`. When omitted or contains no supported value, the endpoint starts a card-only setup.

### Request Example
```
curl -X POST "https://edge.tiquo.app/api/client/v1/payment-methods/setup" \
  -H "Authorization: Bearer eyJhbGciOiJSUzI1NiJ9..." \
  -H "Content-Type: application/json" \
  -d '{"paymentMethodTypes":["card"]}'
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **setupIntentId** (string) - The ID of the SetupIntent.
- **clientSecret** (string) - The client secret for the SetupIntent.

#### Response Example
```
{
  "success": true,
  "setupIntentId": "seti_123",
  "clientSecret": "seti_123_secret_..."
}
```

### Notes
Use the `clientSecret` with Stripe's client SDK to collect and confirm the payment details. Tiquo does not receive raw card or bank-account details.
```

--------------------------------

### Kotlin OkHttp example

Source: https://docs.tiquo.co/en/docs/api-reference/customer-api/profile-get

Kotlin example using OkHttp to call the Get Profile endpoint.

```kotlin
val client = OkHttpClient()
val request = Request.Builder()
    .url("https://edge.tiquo.app/api/client/v1/profile")
    .addHeader("Authorization", "Bearer $accessToken")
    .build()

val response = client.newCall(request).execute()
```

--------------------------------

### JavaScript fetch example

Source: https://docs.tiquo.co/en/docs/api-reference/customer-api/profile-get

JavaScript example using fetch to call the Get Profile endpoint.

```javascript
const response = await fetch('https://edge.tiquo.app/api/client/v1/profile', {
  headers: {
    'Authorization': `Bearer ${accessToken}`,
  },
});

const { success, data, error } = await response.json();

if (success) {
  console.log(data.user.email);
  console.log(data.customer?.displayName);
  console.log(data.customer?.createdAt);
  console.log(data.customer?.firstActiveAt);
}
```

--------------------------------

### DOM Package example

Source: https://docs.tiquo.co/en/docs/api-reference/customer-api/companies

Example using the DOM package to get companies and colleagues.

```javascript
const { companies } = await auth.getCompanies();
const company = companies.find((item) => item.membership.isCompanyAdmin);

if (company) {
  const { colleagues } = await auth.getCompanyColleagues(company.id);
}
```

--------------------------------

### Example request: curl GET /orders

Source: https://docs.tiquo.co/en/docs/api-reference/customer-api/orders

Example curl command to fetch orders with limit and status query parameters.

```bash
curl -X GET "https://edge.tiquo.app/api/client/v1/orders?limit=10&status=completed" \
  -H "Authorization: Bearer eyJhbGciOiJSUzI1NiJ9..."
```

--------------------------------

### Swift URLSession example

Source: https://docs.tiquo.co/en/docs/api-reference/customer-api/profile-get

Swift example using URLSession to call the Get Profile endpoint.

```swift
var request = URLRequest(url: URL(string: "https://edge.tiquo.app/api/client/v1/profile")!)
request.setValue("Bearer \(accessToken)", forHTTPHeaderField: "Authorization")

let (data, _) = try await URLSession.shared.data(for: request)
let result = try JSONDecoder().decode(ProfileResponse.self, from: data)
```

--------------------------------

### GET /wallet-card-links endpoint

Source: https://docs.tiquo.co/en/docs/api-reference/customer-api/wallet

Returns install links for an active wallet-card design and the authenticated customer. Requires the designName query parameter.

```http
GET /wallet-card-links
```

--------------------------------

### Get company example request

Source: https://docs.tiquo.co/en/docs/api-reference/admin-api/companies/overview

Example curl request to get a company by its company number COMP-000001. Requires an API key in the Authorization header.

```bash
curl "https://api.tiquo.app/api/v1/companies/COMP-000001" \
  -H "Authorization: Bearer your_api_key_here"
```

--------------------------------

### Finish a setup

Source: https://docs.tiquo.co/en/docs/api-reference/customer-api/payment-methods

Finish the setup process for a new payment method.

```APIDOC
## POST /payment-methods/setup/finish

### Description
Finish the setup process for a new payment method.

### Method
POST

### Endpoint
/payment-methods/setup/finish

### Request Body
- **setupIntentId** (string) - Required - The identifier for the setup intent.

### Request Example
{
  "setupIntentId": "seti_123456"
}

### Response
#### Success Response (200)
- **setupIntentId** (string) - The identifier for the setup intent.

#### Response Example
{
  "setupIntentId": "seti_123456"
}

### Error Handling
- **400** - The payment operation could not be completed or `setupIntentId` is missing or invalid.
- **401** - Missing, invalid, or expired access token.
- **403** - No customer profile is linked to the authenticated account.
- **500** - Internal server error.
```

--------------------------------

### Finish a setup - response

Source: https://docs.tiquo.co/en/docs/api-reference/customer-api/payment-methods

Example JSON response from the confirm endpoint, containing the saved payment method details. The endpoint rejects a SetupIntent that is incomplete, belongs to another customer, or was not created by this customer payment-method flow.

```json
{
  "success": true,
  "paymentMethod": {
    "id": "pm_123",
    "kind": "card",
    "label": "Visa ending in 4242",
    "brand": "visa",
    "last4": "4242",
    "expMonth": 12,
    "expYear": 2029,
    "cardUseType": "personal",
    "isDefault": true
  }
}
```

--------------------------------

### Example curl request

Source: https://docs.tiquo.co/en/docs/api-reference/customer-api/profile-get

Example curl command to call the Get Profile endpoint.

```bash
curl -X GET "https://edge.tiquo.app/api/client/v1/profile" \
  -H "Authorization: Bearer eyJhbGciOiJSUzI1NiJ9..."
```

--------------------------------

### Quick start: Initialize and authenticate with Tiquo DOM Package

Source: https://docs.tiquo.co/en/docs/api-reference/dom-package/customer-authentication

Initializes the Tiquo SDK with a public key, sends an OTP to the customer's email, verifies the code, and retrieves the user session.

```javascript
import { Tiquo } from '@tiquo/dom-package';

// Initialize with your public key
const tiquo = new Tiquo({
  publicKey: 'pk_dom_your_key_here',
});

// Step 1: Send an OTP to the customer's email
await tiquo.sendOTP('customer@example.com');

// Step 2: Verify the OTP code the customer received
const result = await tiquo.verifyOTP('customer@example.com', '123456');

// The customer is now authenticated
const session = await tiquo.getUser();
console.log(session?.user.email);
```

--------------------------------

### Finish a setup - curl request

Source: https://docs.tiquo.co/en/docs/api-reference/customer-api/payment-methods

Sends a POST request to confirm the setup with setupIntentId, cardUseType, and setAsDefaultPaymentMethod. The cardUseType defaults to 'personal' if not provided.

```bash
curl -X POST "https://edge.tiquo.app/api/client/v1/payment-methods/confirm" \
  -H "Authorization: Bearer eyJhbGciOiJSUzI1NiJ9..." \
  -H "Content-Type: application/json" \
  -d '{
    "setupIntentId": "seti_123",
    "cardUseType": "personal",
    "setAsDefaultPaymentMethod": true
  }'
```

--------------------------------

### Setup response JSON

Source: https://docs.tiquo.co/en/docs/api-reference/customer-api/membership-payments

Example response from the recovery endpoint when operation is 'create_payment_method_setup'. Contains the setupIntentId and clientSecret needed to confirm the new card with Stripe's client SDK.

```json
{
  "success": true,
  "setup": {
    "setupIntentId": "seti_123",
    "clientSecret": "seti_123_secret_..."
  }
}
```

--------------------------------

### Go request example

Source: https://docs.tiquo.co/en/docs/api-reference/admin-api/overview

Example request in Go.

```Go
Go
```

--------------------------------

### Initialize Tiquo SDK with public key

Source: https://docs.tiquo.co/en/docs/api-reference/dom-package/setup

Import the Tiquo class and create a new instance with your public key (starts with pk_dom_). Tiquo is the main SDK class for new integrations; TiquoAuth remains as a backwards-compatible alias.

```javascript
import { Tiquo } from '@tiquo/dom-package';

const tiquo = new Tiquo({
  publicKey: 'pk_dom_your_key_here',
});

```

--------------------------------

### cURL request example

Source: https://docs.tiquo.co/en/docs/api-reference/admin-api/customers/get

Example cURL command to call the Get Customer endpoint with a Bearer token.

```bash
curl -X GET "https://api.tiquo.app/api/v1/customers/string" \
  -H "Authorization: Bearer "
```

--------------------------------

### Example response

Source: https://docs.tiquo.co/en/docs/api-reference/customer-api/profile-get

Example JSON response showing the user and customer objects.

```json
{
  "success": true,
  "data": {
    "user": {
      "id": "user_abc123",
      "email": "customer@example.com"
    },
    "customer": {
      "id": "cust_456",
      "firstName": "John",
      "lastName": "Doe",
      "displayName": "John Doe",
      "customerNumber": "CUST-000001",
      "email": "customer@example.com",
      "phone": "+1234567890",
      "profilePhoto": "https://example.com/photo.jpg",
      "status": "active",
      "totalOrders": 5,
      "totalSpent": 150.00,
      "lifetimeValue": 200.00,
      "createdAt": 1704067200000,
      "firstActiveAt": 1706745600000
    }
  }
}
```

--------------------------------

### Success response body (GET ticket)

Source: https://docs.tiquo.co/en/docs/api-reference/admin-api/bookings/overview

Example success response for the GET ticket endpoint, returning a string (likely the ticket content).

```json
"string"
```

--------------------------------

### Get company response

Source: https://docs.tiquo.co/en/docs/api-reference/admin-api/companies/overview

Example JSON response for the get company endpoint. Contains detailed company information including address, industry, and company size.

```json
{
  "success": true,
  "data": {
    "id": "k1234567890abcdef",
    "companyNumber": "COMP-000001",
    "name": "Acme Corp",
    "displayName": "Acme",
    "description": "Industrial supplier headquartered in London.",
    "email": "billing@acme.com",
    "phone": "+15554567890",
    "website": "https://acme.com",
    "websites": ["https://acme.com"],
    "emailDomains": ["acme.com"],
    "logo": "https://example.com/acme-logo.png",
    "address": {
      "line1": "123 Industrial Way",
      "line2": "Suite 400",
      "city": "London",
      "state": null,
      "postalCode": "EC1A 1BB",
      "country": "GB"
    },
    "industry": "Manufacturing",
    "companySize": "200-500",
    "status": "active",
    "type": "customer",
    "tags": ["enterprise"],
    "notes": "Negotiated bulk pricing.",
    "totalCustomers": 12,
    "totalOrders": 84,
    "totalRevenue": 18450.00,
    "lastOrderDate": 1640995200000,
    "lastActivityDate": 1640995200000,
    "createdAt": 1640995200000,
    "updatedAt": 1640995200000
  },
  "timestamp": "2025-01-15T10:30:00.000Z"
}
```

--------------------------------

### Example request: POST /api/v1/customers

Source: https://docs.tiquo.co/en/docs/api-reference/admin-api/customers/create

Example curl command to create a customer. A successful request returns `201 Created` and the created customer in `data`. Duplicate email addresses or phone numbers return `409 Conflict`. Invalid fields return `400 Bad Request`.

```bash
curl -X POST "https://api.tiquo.app/api/v1/customers" \
  -H "Authorization: Bearer your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "firstName": "Jane",
    "lastName": "Smith",
    "emails": [
      { "address": "jane@example.com", "isPrimary": true }
    ],
    "phones": [
      { "number": "+15551234567", "isPrimary": true }
    ],
    "source": "referral"
  }'
```

--------------------------------

### 200 Success Response for GET /api/v1/enquiries

Source: https://docs.tiquo.co/en/docs/api-reference/admin-api/overview

Example of a successful response (HTTP 200) from the GET /api/v1/enquiries endpoint. Contains the enquiry data array, pagination information, and a timestamp.

```json
{
  "success": true,
  "data": [
    {
      "id": "string",
      "enquiryNumber": "string",
      "name": "string",
      "email": "user@example.com",
      "phone": "string",
      "customerId": "string",
      "type": "string",
      "typeLabel": "string",
      "subject": "string",
      "message": "string",
      "category": "string",
      "orderId": "string",
      "status": "string",
      "lostReason": "string",
      "priority": "low",
      "assignedTo": "string",
      "assignedToStaffIds": [
        "string"
      ],
      "assignedToStaffNames": [
        "string"
      ],
      "source": "string",
      "referrer": "string",
      "firstResponseAt": "2019-08-24T14:15:22Z",
      "resolvedAt": "2019-08-24T14:15:22Z",
      "responseCount": 0,
      "totalOrdersValue": 0,
      "totalPaid": 0,
      "orderCount": 0,
      "customFields": {},
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "pagination": {
    "hasMore": true,
    "nextCursor": "string",
    "pageSize": 0
  },
  "timestamp": "2019-08-24T14:15:22Z"
}
```

--------------------------------

### Response JSON

Source: https://docs.tiquo.co/en/docs/api-reference/customer-api/memberships

Example response containing memberships and available plans. Prices are in integer minor units.

```json
{
  "success": true,
  "data": {
    "memberships": [
      {
        "id": "membership_123",
        "planId": "plan_gold",
        "name": "Gold Member",
        "description": "Priority booking and guest passes",
        "type": "paid",
        "price": 2500,
        "currency": "GBP",
        "billingPeriod": "monthly",
        "status": "active",
        "paymentStatus": "paid",
        "startDate": 1749988800000,
        "renewalDate": 1784116800000,
        "features": ["Priority booking", "Guest passes"],
        "color": "#d4af37",
        "icon": "G",
        "isCurrent": true
      }
    ],
    "availablePlans": [
      {
        "id": "plan_gold",
        "name": "Gold",
        "description": "Priority booking and guest passes",
        "slug": "gold",
        "type": "paid",
        "price": 2500,
        "currency": "GBP",
        "billingPeriod": "monthly",
        "features": ["Priority booking", "Guest passes"],
        "color": "#d4af37",
        "icon": "G",
        "isPopular": true,
        "isCurrent": true,
        "signupUrl": "https://book.tiquo.app/embed/membership/plan_gold"
      }
    ]
  }
}
```
Tokens:
Raw