---
title: "List TIDs in the pool"
method: GET
path: "/entities/{entityUid}/purchasedTid"
tags: ["Purchased TIDs"]
---

# List TIDs in the pool

`GET /entities/{entityUid}/purchasedTid`

Get list of TIDs from the TID pool.

## Path parameters

- `entityUid` string, uuid, required — The Verifone allocated unique id for this site.

## Query parameters

- `status` 'ALLOCATED' | 'UNALLOCATED' | 'RESERVED' | 'INACTIVE' — Allocation status of the purchased TID.
- `pageNumber` integer — Page number for records.
- `pageSize` integer — Page size for returned records.
- `range` string
- `orderBy` string

## Response `200`

Purchased TIDs results matching criteria

- TidPoolFetchResponse
  - `tids` TidPoolItem[], required
    - `altVfiPoiId` string — An alternative Verifone assigned identifier used for the POI within Verifone systems for transaction processing. This is also referred to as the Terminal ID (TID). This value maps to DE41 in ISO8583 specification. This identifier may also be used per contract if required. <strong>This value is not guaranteed to be globally unique. The unique value is the internally assigned uuid - poiUid which is returned on the response.</strong>
    - `createdDate` string, date-time
    - `modifiedDate` string, date-time
    - `reference` string — Order reference used while adding TID to pool
    - `status` 'ALLOCATED' | 'UNALLOCATED' | 'RESERVED' | 'INACTIVE' — Allocation status of the purchased TID.
  - `metadata` PagingMetadata, required — Metadata for searching/paging.
    - `totalPages` integer, required — Total pages of records.
    - `pageNumber` integer, required — Page number for records.
    - `pageSize` integer, required — Page size for returned records.
    - `totalItems` integer, required — Total number of records.

## Other responses

- `400` — Bad Request
- `401` — Unauthorised Request
- `403` — Forbidden Request.
- `404` — Not Found Request
- `429` — Too Many Requests
- `500` — Internal Error
- `503` — Service Not Available
- `504` — Service Timeout

---

[API](https://skmtc.net/verifone/apis/checkout-api.md) · [All operations](https://skmtc.net/verifone/apis/checkout-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/verifone/checkout-api/revisions/ed8dc1f12a5a/schema)